summary refs log tree commit diff stats
path: root/doc/ranger.pod
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ranger.pod')
-rw-r--r--doc/ranger.pod24
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)
a> 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348