Update docs

This commit is contained in:
Arun Prakash Jana 2019-03-23 19:44:07 +05:30
parent 9f2955435e
commit ebe12e288a
No known key found for this signature in database
GPG key ID: A75979F35C080412
2 changed files with 19 additions and 26 deletions

View file

@ -70,7 +70,6 @@ Have as many scripts as you want! View file and directory diffs in vimdiff, inte
- [Why fork?](#why-fork) - [Why fork?](#why-fork)
- [Mentions](#mentions) - [Mentions](#mentions)
- [Developers](#developers) - [Developers](#developers)
- [Contributions](#contributions)
#### FEATURES #### FEATURES
@ -136,7 +135,7 @@ Have as many scripts as you want! View file and directory diffs in vimdiff, inte
| xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | desktop opener | | xdg-open (Linux), open(1) (macOS), cygstart (Cygwin) | desktop opener |
| file | determine file type | | file | determine file type |
| coreutils (cp, mv, rm), findutils (xargs) | copy, move and remove files | | coreutils (cp, mv, rm), findutils (xargs) | copy, move and remove files |
| trash-cli | trash files (instead of delete) | | trash-cli | trash files (default: delete) |
| mediainfo or exiftool | multimedia file details | | mediainfo or exiftool | multimedia file details |
| atool, patool ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#integrate-patool)) | create, list and extract archives | | atool, patool ([integration](https://github.com/jarun/nnn/wiki/hacking-nnn#integrate-patool)) | create, list and extract archives |
| fzy | app launcher with drop-down menu | | fzy | app launcher with drop-down menu |
@ -185,7 +184,7 @@ To cook yourself, download the [latest stable release](https://github.com/jarun/
`PREFIX` is supported, in case you want to install to a different location. `PREFIX` is supported, in case you want to install to a different location.
- Compilation information for [Raspberry Pi](https://github.com/jarun/nnn/issues/182) - Compilation for [Raspberry Pi](https://github.com/jarun/nnn/issues/182)
- Instructions for [Cygwin](https://github.com/jarun/nnn/wiki/Cygwin-instructions) - Instructions for [Cygwin](https://github.com/jarun/nnn/wiki/Cygwin-instructions)
#### Shell completion #### Shell completion
@ -274,7 +273,7 @@ Help & settings, file details, media info and archive listing are shown in the P
#### Leader key #### Leader key
The Leader key (<kbd>`</kbd> or <kbd>^/</kbd>) provides a powerful multi-functional navigation mechanism. It is case-sensitive and understands contexts, bookmarks and handy location shortcuts. The Leader key provides a powerful multi-functional navigation mechanism. It is case-sensitive and understands contexts, bookmarks and location shortcuts.
| Key | Function | | Key | Function |
|:---:| --- | |:---:| --- |
@ -292,8 +291,8 @@ The Leader key (<kbd>`</kbd> or <kbd>^/</kbd>) provides a powerful multi-functio
Contexts serve the purpose of exploring multiple directories simultaneously. 4 contexts are available. The status of the contexts are shown in the top left corner: Contexts serve the purpose of exploring multiple directories simultaneously. 4 contexts are available. The status of the contexts are shown in the top left corner:
- the current context is in reverse - the current context is in reverse
- other used contexts are underlined - other active contexts are underlined
- rest are unused - rest are inactive
To switch to a context press the Leader key followed by the context number (1-4). To switch to a context press the Leader key followed by the context number (1-4).
@ -303,7 +302,7 @@ When a context is quit, the next active context is selected. If the last active
##### Context-specific color ##### Context-specific color
Each context can have its own color for directories specified: Each context can have its own directory color specified:
export NNN_CONTEXT_COLORS='1234' export NNN_CONTEXT_COLORS='1234'
colors: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white colors: 0-black, 1-red, 2-green, 3-yellow, 4-blue (default), 5-magenta, 6-cyan, 7-white
@ -319,11 +318,11 @@ To copy multiple absolute file paths:
- navigate to another file in the same directory to select a range of files - navigate to another file in the same directory to select a range of files
- press <kbd>^Y</kbd> again to save the selection and exit selection mode. - press <kbd>^Y</kbd> again to save the selection and exit selection mode.
_NOTE:_ If you are on BSD/macOS, please check the [BSD terminal issue](https://github.com/jarun/nnn#bsd-terminal-issue) with <kbd>^Y</kbd> for workaround.
Selected files are visually indicated by a `+`. Selected files are visually indicated by a `+`.
The files in the list can now be copied (<kbd>P</kbd>), moved (<kbd>V</kbd>) or removed (<kbd>X</kbd>). The selection can now be listed, copied, moved, removed, archived or linked.
To list the file paths copied to memory press <kbd>y</kbd>.
File paths are copied to the temporary file `DIR/.nnncp`, where `DIR` (by priority) is: File paths are copied to the temporary file `DIR/.nnncp`, where `DIR` (by priority) is:
@ -333,11 +332,9 @@ File paths are copied to the temporary file `DIR/.nnncp`, where `DIR` (by priori
The path is shown in the help and configuration screen. The path is shown in the help and configuration screen.
_**NOTE:**_ If you are on BSD/macOS, please check the [BSD terminal issue](https://github.com/jarun/nnn#bsd-terminal-issue) with <kbd>^Y</kbd> for workaround.
#### Filters #### Filters
Filters support regexes by default to instantly (search-as-you-type) list the matching entries in the current directory. Filters support regexes (default) to instantly (search-as-you-type) list the matching entries in the current directory.
Common use cases: Common use cases:
- to list all matches starting with the filter expression, start the expression with a `^` (caret) symbol - to list all matches starting with the filter expression, start the expression with a `^` (caret) symbol
@ -466,6 +463,4 @@ Restrict opening 0-byte files due to [unexpected behaviour](https://github.com/j
2. Copyright © 2014-2016 Dimitris Papastamos 2. Copyright © 2014-2016 Dimitris Papastamos
3. Copyright © 2016-2019 [Arun Prakash Jana](https://github.com/jarun) 3. Copyright © 2016-2019 [Arun Prakash Jana](https://github.com/jarun)
#### CONTRIBUTIONS Contributions are welcome. Please visit the [ToDo list](https://github.com/jarun/nnn/issues/213).
We need contributors. Please visit the [ToDo list](https://github.com/jarun/nnn/issues/213).

18
nnn.1
View file

@ -76,31 +76,31 @@ supports the following options:
.Nm .Nm
uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on macOS) as the desktop opener. uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on macOS) as the desktop opener.
.Pp .Pp
There is no configuration file. Settings work on environment variables. Please There is no configuration file. Settings work on environment variables. See ENVIRONMENT section below.
refer to the ENVIRONMENT section below.
.Pp .Pp
Configuring Configuring
.Nm .Nm
to change to the last visited directory on quit requires shell integration in a to change to the last visited directory on quit requires shell integration in a
few easy steps. Please visit the project page (linked below) for the few easy steps. Look up NNN_TMPFILE in the ENVIRONMENT section below.
instructions.
.Sh CONTEXTS .Sh CONTEXTS
Contexts serve the purpose of exploring multiple directories simultaneously. 4 contexts Contexts serve the purpose of exploring multiple directories simultaneously. 4 contexts
are available. The status of the contexts are shown in the top left corner: are available. The status of the contexts are shown in the top left corner:
.Pp .Pp
- the current context is in reverse - the current context is in reverse
.br .br
- other used contexts are underlined - other active contexts are underlined
.br .br
- rest are unused - rest are inactive
.Pp .Pp
To switch to a context press the Leader key followed by the context number (1-4). To switch to a context press the Leader key followed by the context number (1-4).
.Pp .Pp
The first time a context is entered, it copies the state of the last visited context. Each context remembers its last visited directory. The first time a context is entered, it copies the state of the last visited context. Each context remembers its last visited directory.
.Pp .Pp
When a context is quit, the next active context is selected. If the last active context is quit, the program quits. When a context is quit, the next active context is selected. If the last active context is quit, the program quits.
.Pp
Each context can have its own directory color specified. See ENVIRONMENT section below.
.Sh FILTERS .Sh FILTERS
Filters support regexes by default to instantly (search-as-you-type) list the matching Filters support regexes (default) to instantly (search-as-you-type) list the matching
entries in the current directory. entries in the current directory.
.Pp .Pp
Common use cases: Common use cases:
@ -135,9 +135,7 @@ Press \fI^Y\fR again to save the selection and exit selection mode.
.Pp .Pp
Selected files are visually indicated by a \fB+\fR. Selected files are visually indicated by a \fB+\fR.
.br .br
The files in the list can now be copied, moved or removed using respective keyboard shortcuts. The files in the list can now be listed, copied, moved, removed, archived or linked.
.Pp
To list the selected files press \fIy\fR.
.Sh ENVIRONMENT .Sh ENVIRONMENT
The SHELL, EDITOR (VISUAL, if defined) and PAGER environment variables take precedence The SHELL, EDITOR (VISUAL, if defined) and PAGER environment variables take precedence
when dealing with the !, e and p commands respectively. A single combination to arguments is supported for SHELL and PAGER. when dealing with the !, e and p commands respectively. A single combination to arguments is supported for SHELL and PAGER.