blob: 19176f0c68e014537613867866df2e6e8a39ad09 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# bk
bk is a terminal EPUB reader, written in Rust.
(dumb fork with keybindings changed
# Features
- Cross platform - Linux, macOS and Windows support
- Single binary, instant startup
- EPUB 2/3 support
- Vim bindings
- Incremental search
- Bookmarks
# Install
Install from crates.io:
cargo install bk
or from github:
git clone https://github.com/aeosynth/bk
cargo install --path bk
# Usage
Usage: bk [<path>] [-m] [-t] [-w <width>]
read a book
Options:
--bg background color (eg 282a36)
--fg foreground color (eg f8f8f2)
-m, --meta print metadata and exit
-t, --toc start with table of contents open
-w, --width characters per line
--help display usage information
Running `bk` without a path will load the most recent EPUB.
Type any function key (eg <kbd>F1</kbd>) to see the keybinds.
Check if your terminal supports italics:
echo -e "\e[3mitalic\e[0m"
# Comparison
| | bk | epr/epy |
| - | - | - |
| runtime deps | ❌ | python, curses |
| wide characters | ✔️ | ❌ |
| incremental search | ✔️ | ❌ |
| multi line search | ✔️ | ❌ |
| regex search | ❌ | ✔️ |
| links | ✔️ | ❌ |
| images | ❌ | ✔️ |
| themes | ✔️ | ✔️ |
| choose file from history | ❌ | ✔️ |
| additional formats | ❌ | FictionBook, Mobi, AZW3 |
| external integration | see 1 | dictionary |
1: you can use the `--meta` switch to use `bk` as a file previewer with eg [nnn](https://github.com/jarun/nnn/)
# Inspiration
<https://github.com/wustho/epr>
|
