From 8b51a8a054978d40fb741e03dcfe64582868bf57 Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Tue, 26 Dec 2017 10:04:10 +0530 Subject: [PATCH] Update README Update documentation --- README.md | 11 ++++++++--- nnn.1 | 12 ++++-------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 98b367b0..7112f867 100644 --- a/README.md +++ b/README.md @@ -129,7 +129,7 @@ Have fun with it! PRs are welcome. Check out [#1](https://github.com/jarun/nnn/i 4949 vaio 20 0 17520 4224 2584 S 0.0 0.1 0:00.54 nnn -S / ``` -`nnn` vs. mc vs. ranger memory usage while viewing a directory with 13790 files, sorted by size: +`nnn` vs. midnight commander vs. ranger memory usage while viewing a directory with 13790 files, sorted by size: ``` PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND @@ -256,9 +256,14 @@ Help & settings, file details, media info and archive listing are shown in the P Filters support regexes to instantly (search-as-you-type) list the matching entries in the current directory. -There are 3 ways to reset a filter: ^L, a search with no matches or an extra backspace at the filter prompt (like vi). +There are 3 ways to reset a filter: +- pressing ^L +- a search with no matches +- an extra backspace at the filter prompt (like vi) -Common examples: If you want to list all matches starting with the filter expression, start the expression with a `^` (caret) symbol. Type `\.mkv` to list all MKV files. +Common use cases: +- to list all matches starting with the filter expression, start the expression with a `^` (caret) symbol +- type `\.mkv` to list all MKV files If `nnn` is invoked as root the default filter will also match hidden files. diff --git a/nnn.1 b/nnn.1 index 1141ea80..5563d4c8 100644 --- a/nnn.1 +++ b/nnn.1 @@ -171,15 +171,11 @@ instructions. Filters support regexes to instantly (search-as-you-type) list the matching entries in the current directory. .Pp -There are 3 ways to reset a filter: \fI^L\fR, a search with no matches or an -extra backspace at the filter prompt (like vi). +There are 3 ways to reset a filter: (1) pressing \fI^L\fR, (2) a search with no matches or +(3) an extra backspace at the filter prompt (like vi). .Pp -Common examples: If you want to list all matches starting with the filter -expression, start the expression with a -.Pa ^ -(caret) symbol. Type -.Pa \.mkv -to list all MKV files. +Common use cases: (1) To list all matches starting with the filter expression, +start the expression with a '^' (caret) symbol. (2) Type '\\.mkv' to list all MKV files. .Pp If .Nm