From aea8f737f6168303a583bc35c4fb00b0fc25f7a2 Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Tue, 9 Jun 2020 10:44:09 +0530 Subject: [PATCH] Update docs --- nnn.1 | 20 +++++++++++--------- plugins/README.md | 7 +++---- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/nnn.1 b/nnn.1 index 7655af35..c09eb46c 100644 --- a/nnn.1 +++ b/nnn.1 @@ -278,16 +278,20 @@ 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 INPUT -.Nm -can receive a list of NUL-separated ('\\0') file paths as input. Paths and can -be relative to the current directory or absolute. +.Sh FIND AND LIST +There are two ways to search and list: .Pp -Input is limited by 65,536 paths or 256 MiB of input. +- feed a list of file paths as input +.br +- search using a plugin (e.g. \fIfinder\fR) and list the results .Pp -Start +File paths must be NUL-separated ('\\0'). Paths and can be relative to the +current directory or absolute. Invalid paths in the input are ignored. Input +is limited by 65,536 paths or 256 MiB of input. +.Pp +To list the input stream, start .Nm -in this mode by writing to its standard input. E.g., to list files in current +by writing to its standard input. E.g., to list files in current directory larger than 1M: .Bd -literal @@ -315,8 +319,6 @@ targets, after which they might become invalid. .Pp Right arrow or 'l' on a symlink in the listing dir takes to the target file. Press '-' to return to the listing dir. Press 'Enter' to open the symlink. -.Pp -\fBInvalid paths in the input 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 e5c0667b..4f2068e1 100644 --- a/plugins/README.md +++ b/plugins/README.md @@ -40,8 +40,7 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. | fzz | Change to any directory in the z database with fzf | sh | fzf, z | | getplugs | Update plugins to installed `nnn` version | sh | curl | | gutenread | Browse, download, read from Project Gutenberg | sh | curl, unzip, w3m
[epr](https://github.com/wustho/epr) (optional) | -| gpgd | Decrypt files using gpg | sh | gpg | -| gpge | Encrypt files using gpg | sh | gpg, fzf | +| gpg\* | Encrypt/decrypt files using GPG | sh | gpg | | hexview | View a file in hex in `$PAGER` | sh | xxd | | imgresize | Resize images in dir to screen resolution | sh | [imgp](https://github.com/jarun/imgp) | | imgthumb | View thumbnail of an image or dir of images | sh | [lsix](https://github.com/hackerb9/lsix) | @@ -63,8 +62,8 @@ Plugins are installed to `${XDG_CONFIG_HOME:-$HOME/.config}/nnn/plugins`. | pdfread | Read a PDF or text file aloud | sh | pdftotext, mpv,
pico2wave | | pdfview | View PDF file in `$PAGER` | sh | pdftotext/
mupdf-tools | | picker | Pick files and list one per line (to pipe) | sh | nnn | -| preview-tabbed | `tabbed`/xembed based file previewer | bash | _see in-file docs_ | -| preview-tui | Tmux/kitty/`$TERMINAL` based file previewer | sh | _see in-file docs_ | +| preview-tabbed | Tabbed/xembed based file previewer | bash | _see in-file docs_ | +| preview-tui | Tmux/kitty/xterm/`$TERMINAL` based file previewer | sh | _see in-file docs_ | | pskill | Fuzzy list by name and kill process or zombie | sh | fzf, ps, sudo/doas | | renamer | Batch rename selection or files in dir | sh | [qmv](https://www.nongnu.org/renameutils/)/[vidir](https://joeyh.name/code/moreutils/) | | ringtone | Create a variable bitrate mp3 ringtone from file | sh | date, ffmpeg |