diff options
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | nnn.1 | 44 | ||||
| -rw-r--r-- | plugins/README.md | 4 |
3 files changed, 23 insertions, 27 deletions
@@ -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. +Once installed (instructions below), visit the [Wiki](https://github.com/jarun/nnn/wiki). + <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> </p> @@ -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 to specify a custom opener. See ENVIRONMENT section. .Sh 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: +Explore multiple directories simultaneously with 4 contexts. The status is +shown in the top left corner: .Pp - the current context is in reverse video .br @@ -150,11 +149,8 @@ corner: .br - rest are inactive .Pp -On context creation, the state of the previous context is copied. Each context -remembers its last visited directory. -.Pp -Each context can have its own directory color specified. See ENVIRONMENT -section. +A new context copies the state of the previous context. Each context can have +its own color. See ENVIRONMENT section. .Sh SESSIONS Sessions are a way to save and restore states of work. A session stores the settings and contexts. @@ -172,10 +168,10 @@ All the session files are located by session name in the directory .Pp "@" is the "last session" file. .Sh FILTERS -Filters are strings to find matching entries in the current directory -instantly (\fIsearch-as-you-type\fR). There is a program option to switch to -regex filters. Matches are case-insensitive by default. In each context the -last filter is persisted at runtime or in saved sessions. +Filters are strings (or regex patterns) to find matching entries in the current +directory instantly (\fIsearch-as-you-type\fR). Matches are case-insensitive by +default. The last filter in each context is persisted at runtime or in saved +sessions. .Pp Special keys at filter prompt: .Bd -literal @@ -233,7 +229,7 @@ Common regex use cases: (4) Exclude filenames having 'nnn' (compiled with PCRE lib): '^(?!nnn)' .Pp 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 When there's a unique match and it's a directory, .Nm @@ -245,11 +241,11 @@ allows file selection across directories and contexts! .Pp There are 3 groups of keybinds to add files to selection: .Pp -(1) hovered file selection toggle (deselects if '+' is visible before the - entry, else adds to selection) +(1) hovered file selection toggle + - deselects if '+' is visible before the entry, else adds to selection .br -(2) add a range of files to selection (repeat the range key on the same entry - twice to clear selection completely) +(2) add a range of files to selection + - repeat the range key on the same entry twice to clear selection completely .br (3) add all files in the current directory to selection .Pp @@ -265,22 +261,21 @@ list again. If no file is selected in the current session, this option attempts to list the selection file. .Sh LIST INPUT .Nm -can receive a list of files as input. The paths should be NUL-separated ('\\0') -but doesn't need to be NUL-terminated. Paths and can be relative to the current -directory or absolute. +can receive a list of NUL-separated ('\\0') file pathss as input. Paths and can +be relative to the current directory or absolute. .Pp Input is limited by 65,536 paths or 256 MiB of input. .Pp Start .Nm -in this mode by writing to its standard input. So the output of another command -can be piped to it. For example, to list files in current directory larger than +in this mode by writing to its standard input. E.g., to list files in current +directory larger than 1M: .Bd -literal find -maxdepth 1 -size +1M -print0 | nnn .Ed .Pp -or you can redirect a list from a file: +or redirect a list from a file: .Bd -literal nnn < files.txt .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 targets, after which they might become invalid. .Pp -Though the term "files" is used, any input is valid as long as it's a valid -path. \fBInvalid paths are ignored.\fR +\fBInvalid paths in the iput are ignored.\fR .Sh UNITS 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. diff --git a/plugins/README.md b/plugins/README.md index f46b8ce..109c7a8 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -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. -`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 @@ -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/) | | mp3conv | Extract audio from multimedia as mp3 | sh | ffmpeg | | 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 | | organize | Auto-organize files in directories by file type | sh | file | | pdfread | Read a PDF or text file aloud | sh | pdftotext, mpv,<br>pico2wave | |