diff options
| author |  Arun Prakash Jana <engineerarun@gmail.com> | 2017-04-15 00:14:25 +0530 |
|---|---|---|
| committer | Arun Prakash Jana <engineerarun@gmail.com> | 2017-04-15 00:54:38 +0530 |
| commit | ccb320d6274d73017d2cab070732788a23fda66c (patch) | |
| tree | 9c0bd2f92cfeca19a3a078f589bc39c87f196ad4 /README.md | |
| parent | cd212b23b97a1072c54f2238958bc583035536c6 (diff) | |
| download | nnn-ccb320d6274d73017d2cab070732788a23fda66c.tar.gz | |
Add program help
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 35 |
1 files changed, 22 insertions, 13 deletions
@@ -27,10 +27,11 @@ Noice is Not Noice, a noicer fork... - [Installation](#installation) - [Quickstart](#quickstart) - [Usage](#usage) -- [Keyboard shortcuts](#keyboard-shortcuts) -- [Filters](#filters) -- [File type abbreviations](#file-type-abbreviations) -- [Help](#help) + - [Cmdline options](#cmdline-options) + - [Keyboard shortcuts](#keyboard-shortcuts) + - [Filters](#filters) + - [File type abbreviations](#file-type-abbreviations) + - [Help](#help) - [Copy current file path to clipboard](#copy-current-file-path-to-clipboard) - [Change file associations](#change-file-associations) @@ -168,16 +169,24 @@ Add the following to your shell's rc file for the best experience: ### Usage -Start nnn (default dir: current directory): +#### Cmdline options - $ nnn [-d] [-S] [-v] [dir] + usage: nnn [-d] [-S] [-v] [h] [PATH] + + The missing terminal file browser for X. + + positional arguments: + PATH directory to open [default: current dir] + + optional arguments: + -d start in detail view mode + -S start in disk usage analyzer mode + -v show program version and exit + -h show this help and exit - -d: start in detail view mode - -S: start in disk usage analyzer mode - -v: show version and exit `>` indicates the currently selected entry in nnn. -### Keyboard shortcuts +#### Keyboard shortcuts | Key | Function | | --- | --- | @@ -209,7 +218,7 @@ Start nnn (default dir: current directory): | `?` | Toggle help screen | | `q` | Quit | -### Filters +#### Filters Filters support regexes to display only the matched entries in the current directory view. This effectively allows searching through the directory tree for a particular entry. @@ -219,7 +228,7 @@ An empty filter expression resets the filter. If nnn is invoked as root the default filter will also match hidden files. -### File type abbreviations +#### File type abbreviations The following abbreviations are used in the detail view: @@ -233,7 +242,7 @@ The following abbreviations are used in the detail view: | `b` | Block Device | | `c` | Character Device | -### Help +#### Help $ man nnn To lookup keyboard shortcuts at runtime, press `?`. |