aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Arun Prakash Jana <engineerarun@gmail.com>2019-03-23 19:44:07 +0530
committerGravatar Arun Prakash Jana <engineerarun@gmail.com>2019-03-23 20:29:31 +0530
commitebe12e288ac1dd53b43e74ba927d0c0d8236d3ac (patch)
tree7aa464c80b6b6c58a5ee2a24bc0d95377bcc2169
parent9f2955435ed0d87fcb5ea29a6560c28fc15a32bc (diff)
downloadnnn-ebe12e288ac1dd53b43e74ba927d0c0d8236d3ac.tar.gz
Update docs
-rw-r--r--README.md27
-rw-r--r--nnn.118
2 files changed, 19 insertions, 26 deletions
diff --git a/README.md b/README.md
index 76301d9..3f4d8d1 100644
--- a/README.md
+++ b/README.md
@@ -70,7 +70,6 @@ Have as many scripts as you want! View file and directory diffs in vimdiff, inte
- [Why fork?](#why-fork)
- [Mentions](#mentions)
- [Developers](#developers)
-- [Contributions](#contributions)
#### 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 |
| file | determine file type |
| 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 |
| 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 |
@@ -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.
-- 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)
#### Shell completion
@@ -274,7 +273,7 @@ Help & settings, file details, media info and archive listing are shown in the P
#### 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 |
|:---:| --- |
@@ -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:
- the current context is in reverse
-- other used contexts are underlined
-- rest are unused
+- other active contexts are underlined
+- rest are inactive
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
-Each context can have its own color for directories specified:
+Each context can have its own directory color specified:
export NNN_CONTEXT_COLORS='1234'
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
- press <kbd>^Y</kbd> again to save the selection and exit selection mode.
-Selected files are visually indicated by a `+`.
+_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.
-The files in the list can now be copied (<kbd>P</kbd>), moved (<kbd>V</kbd>) or removed (<kbd>X</kbd>).
+Selected files are visually indicated by a `+`.
-To list the file paths copied to memory press <kbd>y</kbd>.
+The selection can now be listed, copied, moved, removed, archived or linked.
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.
-_**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 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:
- 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
3. Copyright © 2016-2019 [Arun Prakash Jana](https://github.com/jarun)
-#### CONTRIBUTIONS
-
-We need contributors. Please visit the [ToDo list](https://github.com/jarun/nnn/issues/213).
+Contributions are welcome. Please visit the [ToDo list](https://github.com/jarun/nnn/issues/213).
diff --git a/nnn.1 b/nnn.1
index 3a96e1b..7ecee23 100644
--- a/nnn.1
+++ b/nnn.1
@@ -76,31 +76,31 @@ supports the following options:
.Nm
uses \fIxdg-open\fR (on Linux) and \fIopen(1)\fR (on macOS) as the desktop opener.
.Pp
-There is no configuration file. Settings work on environment variables. Please
-refer to the ENVIRONMENT section below.
+There is no configuration file. Settings work on environment variables. See ENVIRONMENT section below.
.Pp
Configuring
.Nm
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
-instructions.
+few easy steps. Look up NNN_TMPFILE in the ENVIRONMENT section below.
.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:
.Pp
- the current context is in reverse
.br
-- other used contexts are underlined
+- other active contexts are underlined
.br
-- rest are unused
+- rest are inactive
.Pp
To switch to a context press the Leader key followed by the context number (1-4).
.Pp
The first time a context is entered, it copies the state of the last visited context. Each context remembers its last visited directory.
.Pp
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
-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.
.Pp
Common use cases:
@@ -135,9 +135,7 @@ Press \fI^Y\fR again to save the selection and exit selection mode.
.Pp
Selected files are visually indicated by a \fB+\fR.
.br
-The files in the list can now be copied, moved or removed using respective keyboard shortcuts.
-.Pp
-To list the selected files press \fIy\fR.
+The files in the list can now be listed, copied, moved, removed, archived or linked.
.Sh ENVIRONMENT
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.