mirrors/nnn
1
0
Fork 0
mirror of https://github.com/jarun/nnn.git synced 2024-11-27 13:21:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Usage (markdown)

Terminator X 2021-09-09 01:28:43 +05:30
parent 83d9fa2c34
commit eba1802172
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
Usage.md

@ -84,28 +84,29 @@ Use plugin `nbak` to backup configuration.
| `NNN_OPENER="/path/to/custom/opener"` | custom opener (see plugin `nuke`) | | `NNN_OPENER="/path/to/custom/opener"` | custom opener (see plugin `nuke`) |
| `NNN_BMS="d:$HOME/Documents;D:$HOME/Docs archive/"` <sup>1</sup> | key-bookmark pairs | | `NNN_BMS="d:$HOME/Documents;D:$HOME/Docs archive/"` <sup>1</sup> | key-bookmark pairs |
| `NNN_PLUG='o:fzopen;m:nmount;x:!chmod +x $nnn'` <sup>1</sup> | key-plugin (or cmd) pairs | | `NNN_PLUG='o:fzopen;m:nmount;x:!chmod +x $nnn'` <sup>1</sup> | key-plugin (or cmd) pairs |
| `NNN_ORDER='T:/home/user/Downloads;s=/usr/bin'` | directory-specific ordering | | `NNN_ORDER='T:/home/user/Downloads;s=/usr/bin'` <sup>2</sup> | directory-specific ordering |
| `NNN_ARCHIVE="\\.(7z\|bz2\|gz\|tar\|tgz\|zip)$"` <sup>2</sup> | archives [default: bzip2, (g)zip, tar] | `NNN_ARCHIVE="\\.(7z\|bz2\|gz\|tar\|tgz\|zip)$"` <sup>3</sup> | archives [default: bzip2, (g)zip, tar]
| `NNN_COLORS='1234'` (/`'#0a1b2c3d'`/`'#0a1b2c3d;1234'`) <sup>3</sup> <sup>5</sup>| context colors [default: '4444' (blue)] | | `NNN_COLORS='1234'` (/`'#0a1b2c3d'`/`'#0a1b2c3d;1234'`) <sup>4</sup> <sup>6</sup>| context colors [default: '4444' (blue)] |
| `NNN_FCOLORS='c1e2272e006033f7c6d6abc4'` <sup>4</sup> | file-specific colors | | `NNN_FCOLORS='c1e2272e006033f7c6d6abc4'` <sup>5</sup> | file-specific colors |
| `NNN_SSHFS='sshfs -o reconnect,idmap=user'` <sup>5</sup> | custom SSHFS cmd | | `NNN_SSHFS='sshfs -o reconnect,idmap=user'` <sup>6</sup> | custom SSHFS cmd |
| `NNN_RCLONE='rclone mount --read-only'` <sup>5</sup> | custom rclone cmd | | `NNN_RCLONE='rclone mount --read-only'` <sup>6</sup> | custom rclone cmd |
| `NNN_TRASH=n` (`n=1: trash-cli, n=2: gio trash`) | use desktop Trash [default: delete] | | `NNN_TRASH=n` (`n=1: trash-cli, n=2: gio trash`) | use desktop Trash [default: delete] |
| `NNN_SEL='/tmp/.sel'` | custom selection file | | `NNN_SEL='/tmp/.sel'` | custom selection file |
| `NNN_FIFO='/tmp/nnn.fifo'` <sup>6</sup> | FIFO to write hovered file path to | | `NNN_FIFO='/tmp/nnn.fifo'` <sup>7</sup> | FIFO to write hovered file path to |
| `NNN_LOCKER='saidar -c'` | terminal locker | | `NNN_LOCKER='saidar -c'` | terminal locker |
| `NNN_TMPFILE='/tmp/.lastd'` | always _cd on quit_ | | `NNN_TMPFILE='/tmp/.lastd'` | always _cd on quit_ |
| `NNN_HELP='pwy paris'` | run cmd, show o/p on help page | | `NNN_HELP='pwy paris'` | run cmd, show o/p on help page |
| `NNN_MCLICK='^R'` (/`'m'`) <sup>7</sup> | key emulated by middle mouse click | | `NNN_MCLICK='^R'` (/`'m'`) <sup>8</sup> | key emulated by middle mouse click |
| `NO_COLOR=1` <sup>8</sup> | disable ANSI color output | | `NO_COLOR=1` <sup>9</sup> | disable ANSI color output |
1. Key-bookmark and key-plugin pairs are listed in the help and config screen (key <kbd>?</kbd>). 1. Key-bookmark and key-plugin pairs are listed in the help and config screen (key <kbd>?</kbd>).
2. With `atool` or `bsdtar` and `(un)rar` installed you can have: 2. Sort keys can be a/d/e/s/t/v (see option -T). Capitalize to reverse. Path must be absolute.
3. With `atool` or `bsdtar` and `(un)rar` installed you can have:
export NNN_ARCHIVE="\\.(7z|a|ace|alz|arc|arj|bz|bz2|cab|cpio|deb|gz|jar|lha|lz|lzh|lzma|lzo|rar|rpm|rz|t7z|tar|tbz|tbz2|tgz|tlz|txz|tZ|tzo|war|xpi|xz|Z|zip)$" export NNN_ARCHIVE="\\.(7z|a|ace|alz|arc|arj|bz|bz2|cab|cpio|deb|gz|jar|lha|lz|lzh|lzma|lzo|rar|rpm|rz|t7z|tar|tbz|tbz2|tgz|tlz|txz|tZ|tzo|war|xpi|xz|Z|zip)$"
`bsdtar` can extract, list and `archivemount` can mount ISO 9660 cdrom images (extn: iso). `bsdtar` can extract, list and `archivemount` can mount ISO 9660 cdrom images (extn: iso).
3. Understands 8 color, xterm 256 color or both. 4. Understands 8 color, xterm 256 color or both.
<p align="center"><img src="https://user-images.githubusercontent.com/1482942/93023823-46a6ba80-f5e1-11ea-9ea3-6a3c757704f4.png" /></p> <p align="center"><img src="https://user-images.githubusercontent.com/1482942/93023823-46a6ba80-f5e1-11ea-9ea3-6a3c757704f4.png" /></p>
<p align="center"><i>Hexadecimal numbers representing xterm 256 colors, note that the width has to be 2, e.g. "5" becomes "05"</i></p> <p align="center"><i>Hexadecimal numbers representing xterm 256 colors, note that the width has to be 2, e.g. "5" becomes "05"</i></p>
@ -113,7 +114,7 @@ Use plugin `nbak` to backup configuration.
- 8 colors numbers: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white. - 8 colors numbers: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white.
- To specify xterm 256 color hex numbers, prefix with `#` (2 symbols per context). - To specify xterm 256 color hex numbers, prefix with `#` (2 symbols per context).
- To specify both, export 256 color hex numbers followed by 8 color number as fallback, separated by `;`. - To specify both, export 256 color hex numbers followed by 8 color number as fallback, separated by `;`.
4. Specify file-specific colors in xterm 256 color hex numbers (2 hex symbols per color). 5. Specify file-specific colors in xterm 256 color hex numbers (2 hex symbols per color).
Order is strict, use `00` to omit/use default terminal color. Defaults: Order is strict, use `00` to omit/use default terminal color. Defaults:
@ -136,10 +137,10 @@ Use plugin `nbak` to backup configuration.
- To force the 8-color scheme use option `-C`. - To force the 8-color scheme use option `-C`.
- If xterm 256 colors aren't supported, 8-color scheme will be used. - If xterm 256 colors aren't supported, 8-color scheme will be used.
- More [Themes](https://github.com/jarun/nnn/wiki/Themes). - More [Themes](https://github.com/jarun/nnn/wiki/Themes).
5. `nnn` v2.9 and below have `NNN_CONTEXT_COLORS`, `NNN_SSHFS_OPTS` and `NNN_RCLONE_OPTS`. 6. `nnn` v2.9 and below have `NNN_CONTEXT_COLORS`, `NNN_SSHFS_OPTS` and `NNN_RCLONE_OPTS`.
6. If the FIFO file doesn't exist it will be created, but it will never be removed. 7. If the FIFO file doesn't exist it will be created, but it will never be removed.
7. Only the first character is considered if _not_ a `Ctrl-key` combo. 8. Only the first character is considered if _not_ a `Ctrl-key` combo.
8. Overridden by `NNN_COLORS`. 9. Overridden by `NNN_COLORS`.
## Program options ## Program options