Skip to content

Commit f708cb4

Browse files
committed
Use kbd tags in README
1 parent 04d9e7b commit f708cb4

File tree

2 files changed

+52
-51
lines changed

2 files changed

+52
-51
lines changed

README.md

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# FileCTRL
1+
# FileCtrl
22

3-
FileCTRL is a light, opinionated, responsive, theme-able, and simple Text User Interface (TUI) file manager for Linux and macOS
3+
FileCtrl is a light, opinionated, responsive, theme-able, and simple Text User Interface (TUI) file manager for Linux and macOS
44

55
![image](./screenshot.png)
66

@@ -32,7 +32,7 @@ Run `filectrl --help` to view the available command line arguments and options:
3232
```text
3333
Usage: filectrl [<directory>] [-c <config>] [--write-config]
3434
35-
FileCTRL is a light, opinionated, responsive, theme-able, and simple
35+
FileCtrl is a light, opinionated, responsive, theme-able, and simple
3636
Text User Interface (TUI) file manager for Linux and macOS
3737
3838
Positional Arguments:
@@ -47,54 +47,55 @@ Options:
4747

4848
### Copy / paste
4949

50-
When you copy/cut a file or directory, FileCTRL puts `${operation} ${path}` into your clipboard buffer
50+
When you copy/cut a file or directory, FileCtrl puts `${operation} ${path}` into your clipboard buffer
5151
(where `operation` is "cp" or "mv").
52-
If you then paste into a second FileCTRL window, this second instance of FileCTRL will perform the equivalent of:
52+
If you then paste into a second FileCtrl window, this second instance of FileCtrl will perform the equivalent of:
5353
`${operation} ${path} ${current_directory}`, e.g. `cp filectrl.desktop ~/.local/share/applications/`.
54-
Under the hood, FileCTRL doesn't actually invoke `cp` or `mv`, but implements similar operations using the Rust standard library.
54+
Under the hood, FileCtrl doesn't actually invoke `cp` or `mv`, but implements similar operations using the Rust standard library.
5555

5656
### Keyboard controls
5757

5858
_**Normal mode**_
5959

6060
Keys | Description
6161
--- | ---
62-
q | Quit
63-
↓/j, ↑/k, ←/h, →/l | Navigate
64-
~ | Go to home directory
65-
←/b/Backspace | Go to parent directory
66-
→/f/l/Enter | Open the selected file or navigate to the selected directory
67-
Home/g/^ | Select first row
68-
End/G/$ | Select last row
69-
z | Select middle of visible rows
70-
CTRL+f/CTRL+d/PgDn | Scroll down one page
71-
CTRL+b/CTRL+u/PgUp | Scroll up one page
72-
Delete | Delete the selected file or directory
73-
/ | Filter by name
74-
CTRL+r/F5 | Refresh the current directory
75-
r/F2 | Rename the selected file or directory
76-
w | Open a new `filectrl` window
77-
t | Open current directory in a terminal
78-
a, c, p | Clear alerts, clipboard content, or progress bars
79-
CTRL+c, CTRL+x, CTRL+v | Copy/Cut/Paste selected file or directory
80-
n, m, s | Sort by name, modified date, or size
81-
? | Toggle help
62+
<kbd>q</kbd> | Quit
63+
<kbd>↓</kbd> / <kbd>j</kbd>, <kbd>↑</kbd> / <kbd>k</kbd>, <kbd>←</kbd> / <kbd>h</kbd>, <kbd>→</kbd> / <kbd>l</kbd> | Navigate
64+
<kbd>~</kbd> | Go to home directory
65+
<kbd>←</kbd> / <kbd>b</kbd> / <kbd>Backspace</kbd> | Go to parent directory
66+
<kbd>→</kbd> / <kbd>f</kbd> / <kbd>l</kbd> / <kbd>Enter</kbd> | Open the selected file using the default application configured in your environment, or navigate to the selected directory
67+
<kbd>o</kbd> | Open the selected file using the program configured by: `templates.open_selected_file`
68+
<kbd>Home</kbd> / <kbd>g</kbd> / <kbd>^</kbd> | Select first row
69+
<kbd>End</kbd> / <kbd>G</kbd> / <kbd>$</kbd> | Select last row
70+
<kbd>z</kbd> | Select middle of visible rows
71+
<kbd>Ctrl</kbd>+<kbd>f</kbd> / <kbd>Ctrl</kbd>+<kbd>d</kbd> / <kbd>PgDn</kbd> | Scroll down one page
72+
<kbd>Ctrl</kbd>+<kbd>b</kbd> / <kbd>Ctrl</kbd>+<kbd>u</kbd> / <kbd>PgUp</kbd> | Scroll up one page
73+
<kbd>Delete</kbd> | Delete the selected file or directory
74+
<kbd> / </kbd> | Filter by name
75+
<kbd>Ctrl</kbd>+<kbd>r</kbd> / <kbd>F5</kbd> | Refresh the current directory
76+
<kbd>r</kbd> / <kbd>F2</kbd> | Rename the selected file or directory
77+
<kbd>w</kbd> | Open a new `filectrl` window in the terminal configured by: `templates.open_new_window`
78+
<kbd>t</kbd> | Open the current directory in the program configured by: `templates.open_current_directory`
79+
<kbd>a</kbd>, <kbd>c</kbd>, <kbd>p</kbd> | Clear alerts, clipboard content, or progress bars
80+
<kbd>Ctrl</kbd>+<kbd>c</kbd>, <kbd>Ctrl</kbd>+<kbd>x</kbd>, <kbd>Ctrl</kbd>+<kbd>v</kbd> | Copy/Cut/Paste selected file or directory
81+
<kbd>n</kbd>, <kbd>m</kbd>, <kbd>s</kbd> | Sort by name, modified date, or size
82+
<kbd>?</kbd> | Toggle help
8283

8384
_**Filtering / Renaming mode**_
8485

8586
Keys | Description
8687
--- | ---
87-
Esc | Cancel and exit filtering/renaming mode
88-
Enter | Submit your input and exit filtering/renaming mode
89-
←/→ | Move cursor
90-
CTRL+←/→ | Move cursor by word (delimited by whitespaces or punctuation)
91-
Home/End | Move cursor to beginning/end of line
92-
SHIFT+←/→ | Select text
93-
SHIFT+Home/End | Select to beginning/end of line
94-
CTRL+SHIFT+←/→ | Select by word (delimited by whitespaces or punctuation)
95-
CTRL+a | Select all
96-
CTRL+c, CTRL+x, CTRL+v | Copy/Cut/Paste text
97-
Backspace/Delete | Delete character before/after cursor
88+
<kbd>Esc</kbd> | Cancel and exit filtering/renaming mode
89+
<kbd>Enter</kbd> | Submit your input and exit filtering/renaming mode
90+
<kbd>←</kbd> / <kbd>→</kbd> | Move cursor
91+
<kbd>Ctrl</kbd>+<kbd>←</kbd> / <kbd>Ctrl</kbd>+<kbd>→</kbd> | Move cursor by word (delimited by whitespaces or punctuation)
92+
<kbd>Home</kbd> / <kbd>End</kbd> | Move cursor to beginning/end of line
93+
<kbd>Shift</kbd>+<kbd>←</kbd> / <kbd>Shift</kbd>+<kbd>→</kbd> | Select text
94+
<kbd>Shift</kbd>+<kbd>Home</kbd> / <kbd>Shift</kbd>+<kbd>End</kbd> | Select to beginning/end of line
95+
<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>←</kbd> / <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>→</kbd> | Select by word (delimited by whitespaces or punctuation)
96+
<kbd>Ctrl</kbd>+<kbd>a</kbd> | Select all
97+
<kbd>Ctrl</kbd>+<kbd>c</kbd>, <kbd>Ctrl</kbd>+<kbd>x</kbd>, <kbd>Ctrl</kbd>+<kbd>v</kbd> | Copy/Cut/Paste text
98+
<kbd>Backspace</kbd> / <kbd>Delete</kbd> | Delete character before/after cursor
9899

99100
## Configuration
100101

@@ -113,10 +114,10 @@ Run `filectrl --write-config` to write the [default configuration](./src/app/def
113114

114115
Keyboard key | Description
115116
--- | ---
116-
f | Open the selected file using the default application configured in your environment
117-
o | Open the selected file using the program configured by: `templates.open_selected_file`
118-
t | Open the current directory in the program configured by: `templates.open_current_directory`
119-
w | Open a new `filectrl` window in the terminal configured by: `templates.open_new_window`
117+
<kbd>f</kbd> | Open the selected file using the default application configured in your environment
118+
<kbd>o</kbd> | Open the selected file using the program configured by: `templates.open_selected_file`
119+
<kbd>t</kbd> | Open the current directory in the program configured by: `templates.open_current_directory`
120+
<kbd>w</kbd> | Open a new `filectrl` window in the terminal configured by: `templates.open_new_window`
120121

121122
```toml
122123
[templates]

src/views/help.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -25,30 +25,30 @@ const DEFAULT_KEYBOARD_SHORTCUTS: [(&str, &str); 19] = [
2525
("Select first row: ", "Home/g/^"),
2626
("Select last row: ", "End/G/$"),
2727
("Select middle of visible rows: ", "z"),
28-
("Page down: ", "CTRL+f/CTRL+d/PgDn"),
29-
("Page up: ", "CTRL+b/CTRL+u/PgUp"),
28+
("Page down: ", "Ctrl+f/Ctrl+d/PgDn"),
29+
("Page up: ", "Ctrl+b/Ctrl+u/PgUp"),
3030
("Delete: ", "Delete"),
3131
("Filter: ", "/"),
32-
("Refresh: ", "CTRL+r/F5"),
32+
("Refresh: ", "Ctrl+r/F5"),
3333
("Rename: ", "r/F2"),
3434
("New window: ", "w"),
3535
("Open terminal: ", "t"),
3636
("Clear alerts, clipboard, progress: ", "a, c, p"),
37-
("Copy/Cut/Paste selected: ", "CTRL+c, CTRL+x, CTRL+v"),
37+
("Copy/Cut/Paste selected: ", "Ctrl+c, Ctrl+x, Ctrl+v"),
3838
("Sort by name, modified, size: ", "n, m, s"),
3939
];
4040

4141
const PROMPT_KEYBOARD_SHORTCUTS: [(&str, &str); 11] = [
4242
("Submit: ", "Enter"),
4343
("Cancel: ", "Esc"),
4444
("Move cursor: ", "←/→"),
45-
("Move cursor by word: ", "CTRL+←/→"),
45+
("Move cursor by word: ", "Ctrl+←/→"),
4646
("Move cursor to beginning/end of line: ", "Home/End"),
47-
("Select text: ", "SHIFT+←/→"),
48-
("Select to beginning/end of line: ", "SHIFT+Home/End"),
49-
("Select by word: ", "CTRL+SHIFT+←/→"),
50-
("Select all: ", "CTRL+a"),
51-
("Copy/Cut/Paste text: ", "CTRL+c, CTRL+x, CTRL+v"),
47+
("Select text: ", "Shift+←/→"),
48+
("Select to beginning/end of line: ", "Shift+Home/End"),
49+
("Select by word: ", "Ctrl+Shift+←/→"),
50+
("Select all: ", "Ctrl+a"),
51+
("Copy/Cut/Paste text: ", "Ctrl+c, Ctrl+x, Ctrl+v"),
5252
("Delete before/after cursor: ", "Backspace/Delete"),
5353
];
5454

0 commit comments

Comments
 (0)