Update docs

This commit is contained in:
Arun Prakash Jana 2020-04-09 09:48:04 +05:30
parent 341b1ccb00
commit e5ba4f69bb
No known key found for this signature in database
GPG key ID: A75979F35C080412
3 changed files with 23 additions and 27 deletions

View file

@ -21,6 +21,8 @@
It runs smoothly on the Pi, [Termux](https://www.youtube.com/watch?v=AbaauM7gUJw) (Android), Linux, macOS, BSD, Haiku, Cygwin, WSL, across DEs and GUI utilities or a strictly CLI environment. It runs smoothly on the Pi, [Termux](https://www.youtube.com/watch?v=AbaauM7gUJw) (Android), Linux, macOS, BSD, Haiku, Cygwin, WSL, across DEs and GUI utilities or a strictly CLI environment.
Once installed (instructions below), visit the [Wiki](https://github.com/jarun/nnn/wiki).
<p align="center"> <p align="center">
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://img.shields.io/badge/PayPal-donate-1eb0fc.svg" alt="Donate via PayPal!" /></a> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://img.shields.io/badge/PayPal-donate-1eb0fc.svg" alt="Donate via PayPal!" /></a>
</p> </p>

44
nnn.1
View file

@ -140,9 +140,8 @@ uses \fIxdg-open\fR (on Linux), \fIopen(1)\fR (on macOS), \fIcygstart\fR on
(Cygwin) and \fIopen\fR on (Haiku) as the desktop opener. It's also possible (Cygwin) and \fIopen\fR on (Haiku) as the desktop opener. It's also possible
to specify a custom opener. See ENVIRONMENT section. to specify a custom opener. See ENVIRONMENT section.
.Sh CONTEXTS .Sh CONTEXTS
Contexts serve the purpose of exploring multiple directories simultaneously. 4 Explore multiple directories simultaneously with 4 contexts. The status is
contexts are available. The status of the contexts are shown in the top left shown in the top left corner:
corner:
.Pp .Pp
- the current context is in reverse video - the current context is in reverse video
.br .br
@ -150,11 +149,8 @@ corner:
.br .br
- rest are inactive - rest are inactive
.Pp .Pp
On context creation, the state of the previous context is copied. Each context A new context copies the state of the previous context. Each context can have
remembers its last visited directory. its own color. See ENVIRONMENT section.
.Pp
Each context can have its own directory color specified. See ENVIRONMENT
section.
.Sh SESSIONS .Sh SESSIONS
Sessions are a way to save and restore states of work. A session stores the Sessions are a way to save and restore states of work. A session stores the
settings and contexts. settings and contexts.
@ -172,10 +168,10 @@ All the session files are located by session name in the directory
.Pp .Pp
"@" is the "last session" file. "@" is the "last session" file.
.Sh FILTERS .Sh FILTERS
Filters are strings to find matching entries in the current directory Filters are strings (or regex patterns) to find matching entries in the current
instantly (\fIsearch-as-you-type\fR). There is a program option to switch to directory instantly (\fIsearch-as-you-type\fR). Matches are case-insensitive by
regex filters. Matches are case-insensitive by default. In each context the default. The last filter in each context is persisted at runtime or in saved
last filter is persisted at runtime or in saved sessions. sessions.
.Pp .Pp
Special keys at filter prompt: Special keys at filter prompt:
.Bd -literal .Bd -literal
@ -233,7 +229,7 @@ Common regex use cases:
(4) Exclude filenames having 'nnn' (compiled with PCRE lib): '^(?!nnn)' (4) Exclude filenames having 'nnn' (compiled with PCRE lib): '^(?!nnn)'
.Pp .Pp
In the \fInavigate-as-you-type\fR mode directories are opened in filter In the \fInavigate-as-you-type\fR mode directories are opened in filter
mode, allowing continuous navigation. Works best with the \fBarrow keys\fR. mode, allowing continuous navigation.
.br .br
When there's a unique match and it's a directory, When there's a unique match and it's a directory,
.Nm .Nm
@ -245,11 +241,11 @@ allows file selection across directories and contexts!
.Pp .Pp
There are 3 groups of keybinds to add files to selection: There are 3 groups of keybinds to add files to selection:
.Pp .Pp
(1) hovered file selection toggle (deselects if '+' is visible before the (1) hovered file selection toggle
entry, else adds to selection) - deselects if '+' is visible before the entry, else adds to selection
.br .br
(2) add a range of files to selection (repeat the range key on the same entry (2) add a range of files to selection
twice to clear selection completely) - repeat the range key on the same entry twice to clear selection completely
.br .br
(3) add all files in the current directory to selection (3) add all files in the current directory to selection
.Pp .Pp
@ -265,22 +261,21 @@ list again. If no file is selected in the current session, this option attempts
to list the selection file. to list the selection file.
.Sh LIST INPUT .Sh LIST INPUT
.Nm .Nm
can receive a list of files as input. The paths should be NUL-separated ('\\0') can receive a list of NUL-separated ('\\0') file pathss as input. Paths and can
but doesn't need to be NUL-terminated. Paths and can be relative to the current be relative to the current directory or absolute.
directory or absolute.
.Pp .Pp
Input is limited by 65,536 paths or 256 MiB of input. Input is limited by 65,536 paths or 256 MiB of input.
.Pp .Pp
Start Start
.Nm .Nm
in this mode by writing to its standard input. So the output of another command in this mode by writing to its standard input. E.g., to list files in current
can be piped to it. For example, to list files in current directory larger than directory larger than
1M: 1M:
.Bd -literal .Bd -literal
find -maxdepth 1 -size +1M -print0 | nnn find -maxdepth 1 -size +1M -print0 | nnn
.Ed .Ed
.Pp .Pp
or you can redirect a list from a file: or redirect a list from a file:
.Bd -literal .Bd -literal
nnn < files.txt nnn < files.txt
.Ed .Ed
@ -289,8 +284,7 @@ A temporary directory will be created containing symlinks to the given
paths. Any action performed on these symlinks will be performed only on their paths. Any action performed on these symlinks will be performed only on their
targets, after which they might become invalid. targets, after which they might become invalid.
.Pp .Pp
Though the term "files" is used, any input is valid as long as it's a valid \fBInvalid paths in the iput are ignored.\fR
path. \fBInvalid paths are ignored.\fR
.Sh UNITS .Sh UNITS
The minimum file size unit is byte (B). The rest are K, M, G, T, P, E, Z, Y The minimum file size unit is byte (B). The rest are K, M, G, T, P, E, Z, Y
(powers of 1024), same as the default units in \fIls\fR. (powers of 1024), same as the default units in \fIls\fR.

View file

@ -10,7 +10,7 @@
Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or binaries) which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins. Plugins extend the capabilities of `nnn`. They are _executable_ scripts (or binaries) which `nnn` can communicate with and trigger. This mechanism fits perfectly with the fundamental design to keep the core file manager lean and fast, by delegating repetitive (but not necessarily file manager-specific) tasks to the plugins.
`nnn` is language-agnostic when it comes to plugins. You can write a plugin in any (scripting) language you are comfortable in! `nnn` is _**language-agnostic**_ when it comes to plugins. You can write a plugin in any (scripting) language you are comfortable in!
## Installing plugins ## Installing plugins
@ -51,7 +51,7 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`.
| mocplay | Append (and/or play) selection/dir/file in moc | sh | [moc](http://moc.daper.net/) | | mocplay | Append (and/or play) selection/dir/file in moc | sh | [moc](http://moc.daper.net/) |
| mp3conv | Extract audio from multimedia as mp3 | sh | ffmpeg | | mp3conv | Extract audio from multimedia as mp3 | sh | ffmpeg |
| nmount | Toggle mount status of a device as normal user | sh | pmount, udisks2 | | nmount | Toggle mount status of a device as normal user | sh | pmount, udisks2 |
| nuke | Sample file opener (CLI-only by default) | sh | various | | nuke | Sample file opener (CLI-only by default) | sh | _see in-file docs_ |
| oldbigfile | List large files by access time | sh | find, sort | | oldbigfile | List large files by access time | sh | find, sort |
| organize | Auto-organize files in directories by file type | sh | file | | organize | Auto-organize files in directories by file type | sh | file |
| pdfread | Read a PDF or text file aloud | sh | pdftotext, mpv,<br>pico2wave | | pdfread | Read a PDF or text file aloud | sh | pdftotext, mpv,<br>pico2wave |