From 05ae384b2debab8477131cc25213e6a0d5d21351 Mon Sep 17 00:00:00 2001
From: Arun Prakash Jana <engineerarun@gmail.com>
Date: Mon, 3 Feb 2020 08:46:14 +0530
Subject: [PATCH] Document list files

---
 nnn.1 | 45 ++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 38 insertions(+), 7 deletions(-)

diff --git a/nnn.1 b/nnn.1
index 38b01750..f92026dc 100644
--- a/nnn.1
+++ b/nnn.1
@@ -32,11 +32,11 @@
 .Sh DESCRIPTION
 .Nm
 (Nnn's Not Noice) is a performance-optimized, feature-packed fork of
-noice (http://git.2f30.org/noice/) with seamless desktop integration,
-simplified navigation, \fInavigate-as-you-type\fR mode with auto select,
-disk usage analyzer mode, bookmarks, contexts, application launcher,
-familiar navigation shortcuts, subshell spawning and much more.It
-remains a simple and efficient file manager that stays out of your way.
+noice (http://git.2f30.org/noice/) with seamless desktop
+integration, simplified navigation, \fInavigate-as-you-type\fR mode with
+auto select, disk usage analyzer mode, bookmarks, contexts, application
+launcher, familiar navigation shortcuts, subshell spawning and much
+more.It remains a simple and efficient file manager that stays out of your way.
 .Pp
 .Nm
 opens the current working directory by default if
@@ -205,14 +205,17 @@ Common regex use cases:
 .br
 (3) Use '.*' to match any character (\fIsort of\fR fuzzy search).
 .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.
+In the \fInavigate-as-you-type\fR mode directories are opened in filter
+mode, allowing continuous navigation. Works best with the \fBarrow keys\fR.
 .br
 When there's a unique match and it's a directory,
 .Nm
 auto selects the directory and enters it in this mode. Use the relevant
 program option to disable this behaviour.
 .Sh SELECTION
+.Nm
+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
@@ -233,6 +236,34 @@ file from selection after you navigate away from its directory. Editing doesn't
 end the selection mode. You can add more files to the selection and edit the
 list again. If no file is selected in the current session, this option attempts
 to list the selection file.
+.Sh LIST FILES
+.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.
+.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
+1M:
+.Bd -literal
+    find -maxdepth 1 -size +1M -print0 | nnn
+.Ed
+.Pp
+or you can redirect a list from a file:
+.Bd -literal
+    nnn < files.txt
+.Ed
+.Pp
+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. Invalid paths will be ignored.
 .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.