doc/ranger.1: documented :scout command

1 files changed, 24 insertions, 0 deletions

diff --git a/doc/ranger.pod b/doc/ranger.pod
index beaf1030..e418e1ea 100644
--- a/doc/ranger.pod
+++ b/doc/ranger.pod
@@ -747,6 +747,7 @@ ranger.  For your convenience, this is a list of the "public" commands including
  relink newpath
  rename newname
  save_copy_buffer
+ scout [-FLAGS] pattern
  search pattern
  search_inc pattern
  set option value
@@ -944,6 +945,29 @@ will fail.  Also try the key binding A for appending something to a file name.
 Save the copy buffer to I<~/.config/ranger/copy_buffer>.  This can be used to
 pass the list of copied files to another ranger instance.
 
+=item scout [-I<flags>...] [--] I<pattern>
+
+Swiss army knife command for searching, traveling and filtering files.
+The command takes various flags as arguments which can be used to
+influence its behaviour:
+
+ -a = automatically open a file on unambiguous match
+ -e = open the selected file when pressing enter
+ -f = filter files that match the current search pattern
+ -g = interpret pattern as a glob pattern
+ -i = ignore the letter case of the files
+ -k = keep the console open when changing a directory with the command
+ -l = letter skipping; e.g. allow "rdme" to match the file "readme"
+ -m = mark the matching files after pressing enter
+ -M = unmark the matching files after pressing enter
+ -p = permanent filter: hide non-matching files after pressing enter
+ -s = smart case; like -i unless pattern contains upper case letters
+ -t = apply filter and search pattern as you type
+ -v = inverts the match
+
+Multiple flags can be combined.  For example, ":scout -gpt" would create
+a :filter-like command using globbing.
+
 =item search I<pattern>
 
 Search files in the current directory that match the given (case insensitive)