1RANGER(1) ranger manual RANGER(1)
2ranger - visual file manager
6
8 ranger [--version] [--help] [--debug] [--clean] [--cachedir=directory]
9 [--confdir=directory] [--datadir=directory] [--copy-config=which]
10 [--choosefile=target] [--choosefiles=target] [--choosedir=target]
11 [--selectfile=filepath] [--show-only-dirs] [--list-unused-keys]
12 [--list-tagged-files=tag] [--profile] [--cmd=command] [path ...]
13
15 ranger is a console file manager with VI key bindings.
16
18 This manual contains instructions on how to use and configure ranger.
19 Inside ranger, you can press ? for a list of key bindings, commands or
21 settings.
22 The README contains install instructions.
24 The file HACKING.md contains guidelines for code modification.
26 The directory doc/configs contains configuration files. They are
28 usually installed to /usr/share/doc/ranger/config and can be obtained
29 with ranger's --copy-config option.
30 The directory examples contains reference implementations for ranger
32 plugins, sample configuration files and some programs for integrating
33 ranger with other software. They are usually installed to
34 /usr/share/doc/ranger/examples.
35 The man page of rifle(1) describes the functions of the file opener
37 The section LINKS of this man page contains further resources.
39
41 path ... Each path will be opened in a tab and if the path is a
42 file it will be selected. Omitting this is equivalent to
43 providing the current directory.
44
46 -d, --debug Activate the debug mode: Whenever an error occurs, ranger
47 will exit and print a full traceback. The default
48 behavior is to merely print the name of the exception in
49 the statusbar/log and try to keep running.
50 -c, --clean Activate the clean mode: ranger will not access or
52 create any configuration files nor will it leave any
53 traces on your system. This is useful when your
54 configuration is broken, when you want to avoid clutter,
55 etc.
56 --cachedir=dir
58 Change the cache directory of ranger from $XDG_CACHE_HOME
59 or ~/.cache/ranger to "dir".
60 -r dir, --confdir=dir
62 Change the configuration directory of ranger from
63 $XDG_CONFIG_HOME or ~/.config/ranger to "dir".
64 --datadir=dir Change the data directory of ranger from $XDG_DATA_HOME
66 or ~/.local/share/ranger to "dir".
67 --copy-config=file
69 Create copies of the default configuration files in your
70 local configuration directory. Existing ones will not be
71 overwritten. Possible values: all, commands,
72 commands_full, rc, rifle, scope.
73 Note: You may want to disable loading of the global
75 configuration files by exporting
76 RANGER_LOAD_DEFAULT_RC=FALSE in your environment. See
77 also: FILES, ENVIRONMENT
78 --copy-config=commands will copy only a small sample
80 configuration file with a thoroughly commented example.
81 It is recommended to keep this file tidy to avoid getting
82 defunct commands on ranger upgrades. The full default
83 commands.py can be copied with
84 --copy-config=commands_full, but that file will be
85 ignored by ranger and serves only as a reference for
86 making your own commands.
87 --choosefile=targetfile
89 Allows you to pick a file with ranger. This changes the
90 behavior so that when you open a file, ranger will exit
91 and write the absolute path of that file into targetfile.
92 --choosefiles=targetfile
94 Allows you to pick multiple files with ranger. This
95 changes the behavior so that when you open a file, ranger
96 will exit and write the absolute paths of all selected
97 files into targetfile, adding one newline after each
98 filename.
99 --choosedir=targetfile
101 Allows you to pick a directory with ranger. When you
102 exit ranger, it will write the last visited directory
103 into targetfile.
104 --selectfile=targetfile
106 Open ranger with targetfile selected. This is a legacy
107 option, superseded by the behavior for the POSITIONAL
108 ARGUMENTS.
109 --show-only-dirs
111 Display only the directories. May be used in conjunction
112 with --choosedir=targetfile.
113 --list-unused-keys
115 List common keys which are not bound to any action in the
116 "browser" context. This list is not complete, you can
117 bind any key that is supported by curses: use the key
118 code returned by "getch()".
119 --list-tagged-files=tag
121 List all files which are tagged with the given tag.
122 Note: Tags are single characters. The default tag is "*"
123 --profile Print statistics of CPU usage on exit.
125 --cmd=command Execute the command after the configuration has been
127 read. Use this option multiple times to run multiple
128 commands.
129 --version Print the version and exit.
131 -h, --help Print a list of options and exit.
133
135 This part explains how certain parts of ranger work and how they can be
136 used efficiently.
137 TAGS
139 Tags are single characters which are displayed left of a filename. You
140 can use tags however you want. Press "t" to toggle tags and "ut" to
141 remove any tags of the selection. The default tag is an Asterisk ("*"),
142 but you can use any tag by typing "<tagname>.
143 PREVIEWS
145 By default, only text files are previewed, but you can enable external
146 preview scripts by setting the option "use_preview_script" and
147 "preview_files" to true.
148 This default script is %rangerdir/data/scope.sh. It contains more
150 documentation and calls to many external programs to generate previews.
151 They are automatically used when available but completely optional.
152 For general usage:
154 - "file" for determining file types
155 - "chardet" (Python package) for improved encoding detection of text
157 files
158 - "sudo" to use the "run as root" feature
160 - "python-bidi" (Python package) to display right-to-left file names
162 correctly (Hebrew, Arabic)
163 For enhanced file previews (with scope.sh):
165 - "img2txt" (from "caca-utils") for ASCII-art image previews
166 - "w3mimgdisplay", "ueberzug", "mpv", "iTerm2", "kitty",
168 "terminology" or "urxvt" for image previews
169 - "convert" (from "imagemagick") to auto-rotate images and for SVG
171 previews
172 - "ffmpegthumbnailer" for video thumbnails
174 - "highlight", "bat" or "pygmentize" for syntax highlighting of code
176 - "atool", "bsdtar", "unrar" and/or "7z" to preview archives
178 - "bsdtar", "tar", "unrar", "unzip" and/or "zipinfo" (and "sed") to
180 preview archives as their first image
181 - "lynx", "w3m" or "elinks" to preview html pages
183 - "pdftotext" or "mutool" (and "fmt") for textual pdf previews,
185 "pdftoppm" to preview as image
186 - "djvutxt" for textual DjVu previews, "ddjvu" to preview as image
188 - "calibre" or "epub-thumbnailer" for image previews of ebooks
190 - "transmission-show" for viewing BitTorrent information
192 - "mediainfo" or "exiftool" for viewing information about media files
194 - "odt2txt" for OpenDocument text files (odt, ods, odp and sxw)
196 - "python" or "jq" for JSON files
198 - "fontimage" for font previews
200 Install these programs (just the ones you need) and scope.sh will
202 automatically use them.
203 Independently of the preview script, there is a feature to preview
205 images by drawing them directly into the terminal. To enable this
206 feature, set the option "preview_images" to true and enable one of the
207 image preview modes:
208 iTerm2
210 This only works in iTerm2 compiled with image preview support, but
212 works over ssh.
213 To enable this feature, set the option "preview_images_method" to
215 iterm2.
216 This feature relies on the dimensions of the terminal's font. By
218 default, a width of 8 and height of 11 are used. To use other values,
219 set the options "iterm2_font_width" and "iterm2_font_height" to the
220 desired values.
221 kitty
223 This only works in Kitty. It requires PIL (or pillow) to work. Allows
225 remote image previews, for example in an ssh session.
226 To enable this feature, set the option "preview_images_method" to
228 kitty.
229 terminology
231 This only works in terminology. It can render vector graphics, but
233 works only locally.
234 To enable this feature, set the option "preview_images_method" to
236 terminology.
237 ueberzug
239 Ueberzug is a command line utility which draws images on terminals
241 using child windows. It requires PIL (or pillow) and relies on X11.
242 This makes it compatible (in a limited way, i.e., tmux splits are not
243 supported) with many terminals and tmux but not the Linux console or
244 Wayland.
245 To enable this feature, set the option "preview_images_method" to
247 ueberzug.
248 urxvt
250 This only works in urxvt compiled with pixbuf support. Does not work
252 over ssh.
253 Essentially this mode sets an image as a terminal background
255 temporarily, so it will break any previously set image background.
256 To enable this feature, set the option "preview_images_method" to
258 urxvt.
259 urxvt-full
261 The same as urxvt but utilizing not only the preview pane but the whole
263 terminal window.
264 To enable this feature, set the option "preview_images_method" to
266 urxvt-full.
267 w3m
269 This does not work over ssh, requires certain terminals (tested on
271 "xterm" and "urxvt") and is incompatible with tmux, although it works
272 with screen.
273 To enable this feature, install the program "w3m" and set the option
275 "preview_images_method" to w3m.
276 When using a terminal with a nonzero border which is not automatically
278 detected, the w3m preview will be misaligned. Use the "w3m_offset"
279 option to manually adjust the image offset. This should be the same
280 value as the terminal's border value.
281 SELECTION
283 The selection is defined as "All marked files IF THERE ARE ANY,
284 otherwise the current file." Be aware of this when using the :delete
285 command, which deletes all files in the selection.
286 You can mark files by pressing <Space>, v, etc. A yellow Mrk symbol at
288 the bottom right indicates that there are marked files in this
289 directory.
290 MACROS
292 Macros can be used in commands to abbreviate things.
293 %f the highlighted file
295 %d the path of the current directory
296 %s the selected files in the current directory
297 %t all tagged files in the current directory
298 %c the full paths of the currently copied/cut files
299 %p the full paths of selected files
300 The macros %f, %d, %p, and %s also have upper case variants, %F, %D,
302 %P, and %S, which refer to the next tab. To refer to specific tabs,
303 add a number in between. (%7s = selection of the seventh tab.)
304 %c is the only macro which ranges out of the current directory. So you
306 may "abuse" the copying function for other purposes, like diffing two
307 files which are in different directories:
308 Yank the file A (type yy), move to the file B, then type
310 @diff %c %f
311 Macros for file paths are generally shell-escaped so they can be used
313 in the "shell" command.
314 When mapping keys you can use the placeholder <any>, the key entered in
316 that position can be used through the %any and %any_path macros. (When
317 using multiple <any> placeholders you can index the macros: %any0,
318 %any_path0, %any1, %any_path1...) The macro %any will be replaced with
319 the key pressed in the position of the <any> placeholder. The macro
320 %any_path will be replaced with the path of the bookmark mapped to the
321 key pressed in the position of the <any> placeholder. For example this
322 macro can be used to echo the key that was pressed after "c":
323 map c<any> echo %any
325 %any is used in the ranger configuration to create a keybinding for
327 adding a bookmark. c<set_bookmark> creates a bookmark for the current
328 directory and the key for the bookmark is the first supplied argument.
329 In this case the key pressed after "m":
330 map m<any> set_bookmark %any
332 The %any_path macro can be used to echo the path of the bookmark that
334 is set to the key pressed after "c":
335 map c<any> echo %any_path
337 A practical example of the use of %any_path is the pasting of
339 cut/copied files to a bookmarked directory:
340 map p'<any> paste dest=%any_path
342 The macro %rangerdir expands to the directory of ranger's python
344 library, you can use it for something like this command:
345 alias show_commands shell less %rangerdir/config/commands.py
346 %confdir expands to the directory given by --confdir.
348 %datadir expands to the directory given by --datadir.
350 The macro %space expands to a space character. You can use it to add
352 spaces to the end of a command when needed, while preventing editors to
353 strip spaces off the end of the line automatically.
354 To write a literal %, you need to escape it by writing %%.
356 Note that macros are expanded twice when using chain. For example, to
358 insert a space character in a chained command, you would write %%space:
359 chain command1; command2%%space
360 BOOKMARKS
362 Type m<key> to bookmark the current directory. You can re-enter this
363 directory by typing `<key>. <key> can be any letter or digit. Unlike
364 vim, both lowercase and uppercase bookmarks are persistent.
365 Each time you jump to a bookmark, the special bookmark at key ` will be
367 set to the last directory. So typing "``" gets you back to where you
368 were before.
369 Bookmarks are selectable when tabbing in the :cd command.
371 Note: The bookmarks ' (Apostrophe) and ` (Backtick) are the same.
373 RIFLE
375 Rifle is the file opener of ranger. It can be used as a standalone
376 program or a python module. It is located at
377 $repo/ranger/ext/rifle.py. In contrast to other, more simple file
378 openers, rifle can automatically find installed programs so it can be
379 used effectively out of the box on a variety of systems.
380 It's configured in rifle.conf through a list of conditions and
382 commands. For each line the conditions are checked and if they are
383 met, the respective command is taken into consideration. By default,
384 simply the first matching rule is used. In ranger, you can list and
385 choose rules by typing "r" or simply by typing "<rulenumber><enter>".
386 If you use rifle standalone, you can list all rules with the "-l"
387 option and pick a rule with "-p <number>".
388 The rules, along with further documentation, are contained in
390 $repo/ranger/config/rifle.conf.
391 FLAGS
393 Flags give you a way to modify the behavior of the spawned process.
394 They are used in the commands ":open_with" (key "r") and ":shell" (key
395 "!").
396 f Fork the process, i.e. run in background. Please use this flag
398 instead of calling "disown" or "nohup", to avoid killing the
399 background command when pressing Ctrl+C in ranger.
400 c Run the current file only, instead of the selection
401 r Run application with root privilege (requires sudo)
402 t Run application in a new terminal window
403 There are some additional flags that can currently be used only in the
405 "shell" command: (for example ":shell -w df")
406 p Redirect output to the pager
408 s Silent mode. Output will be discarded.
409 w Wait for an Enter-press when the process is done
410 By default, all the flags are off unless otherwise specified in rc.conf
412 key bindings or rifle.conf rules. You can specify as many flags as you
413 want. An uppercase flag negates the effect: "ffcccFsf" is equivalent to
414 "cs".
415 The terminal program name for the "t" flag is taken from the
417 environment variable $TERMCMD. If it doesn't exist, it tries to
418 extract it from $TERM, uses "x-terminal-emulator" as a fallback, and
419 then "xterm" if that fails.
420 Examples: ":open_with c" will open the file that you currently point
422 at, even if you have selected other files. ":shell -w df" will run
423 "df" and wait for you to press Enter before switching back to ranger.
424 PLUGINS
426 ranger's plugin system consists of python files which are located in
427 ~/.config/ranger/plugins/ and are imported in alphabetical order when
428 starting ranger. A plugin changes rangers behavior by overwriting or
429 extending a function that ranger uses. This allows you to change
430 pretty much every part of ranger, but there is no guarantee that things
431 will continue to work in future versions as the source code evolves.
432 Adding new commands via a plugin as simple as specifying them like you
434 would do in the commands.py.
435 There are some hooks that are specifically made for the use in plugins.
437 They are functions that start with hook_ and can be found throughout
438 the code.
439 grep 'def hook_' -r /path/to/rangers/source
441 Also try:
443 pydoc ranger.api
445 Note that you should NOT simply overwrite a function unless you know
447 what you're doing. Instead, save the existing function and call it
448 from your new one. This way, multiple plugins can use the same hook.
449 There are several sample plugins in the /usr/share/doc/ranger/examples/
450 directory, including a hello-world plugin that describes this
451 procedure.
452
454 Key bindings are defined in the file %rangerdir/config/rc.conf. Check
455 this file for a list of all key bindings. You can copy it to your
456 local configuration directory with the --copy-config=rc option.
457 Many key bindings take an additional numeric argument. Type 5j to move
459 down 5 lines, 2l to open a file in mode 2, 10<Space> to mark 10 files.
460 This list contains the most useful bindings:
462 MAIN BINDINGS
464 h, j, k, l Move left, down, up or right
465 ^D or J, ^U or K
467 Move a half page down, up
468 H, L Move back and forward in the history
470 gg Move to the top
472 G Move to the bottom
474 [, ] Move up and down in the parent directory.
476 ^R Reload everything
478 F Toggle freeze_files setting. When active (indicated by a
480 cyan FROZEN message in the status bar), directories and
481 files will not be loaded, improving performance when all
482 the files you need are already loaded. This does not
483 affect file previews, which can be toggled with zI. Also
484 try disabling the preview of directories with zP.
485 ^L Redraw the screen
487 i Inspect the current file in a bigger window.
489 E Edit the current file in $VISUAL otherwise $EDITOR
491 otherwise "vim"
492 S Open a shell in the current directory
494 ? Opens this man page
496 W Opens the log window where you can review messages that
498 pop up at the bottom.
499 w Opens the task window where you can view and modify
501 background processes that currently run in ranger. In
502 there, you can type "dd" to abort a process and "J" or
503 "K" to change the priority of a process. Only one
504 process is run at a time.
505 ^C Stop the currently running background process that ranger
507 has started, like copying files, loading directories or
508 file previews.
509 <octal>=, +<who><what>, -<who><what>
511 Change the permissions of the selection. For example,
512 "777=" is equivalent to "chmod 777 %s", "+ar" does "chmod
513 a+r %s", "-ow" does "chmod o-w %s" etc.
514 yy Copy (yank) the selection, like pressing Ctrl+C in modern
516 GUI programs. (You can also type "ya" to add files to
517 the copy buffer, "yr" to remove files again, or "yt" for
518 toggling.)
519 dd Cut the selection, like pressing Ctrl+X in modern GUI
521 programs. (There are also "da", "dr" and "dt" shortcuts
522 equivalent to "ya", "yr" and "yt".)
523 pp Paste the files which were previously copied or cut, like
525 pressing Ctrl+V in modern GUI programs.
526 Conflicts will be renamed by appending an '_' (and a
528 counter if necessary), resulting in "file.ext_",
529 "file.ext_0", etc. If you prefer "file_.ext" you can use
530 the "paste_ext" command.
531 po Paste the copied/cut files, overwriting existing files.
533 pP, pO Like pp and po, but queues the operation so that it will
535 be executed after any other operations. Reminder: type
536 "w" to open the task window.
537 pl, pL Create symlinks (absolute or relative) to the copied
539 files
540 phl Create hardlinks to the copied files
542 pht Duplicate the subdirectory tree of the copied directory,
544 then create hardlinks for each contained file into the
545 new directory tree.
546 mX Create a bookmark with the name X
548 `X Move to the bookmark with the name X
550 n Find the next file. By default, this gets you to the
552 newest file in the directory, but if you search something
553 using the keys /, cm, ct, ..., it will get you to the
554 next found entry.
555 N Find the previous file.
557 oX Change the sort method (like in mutt)
559 zX Change settings. See the settings section for a list of
561 settings and their hotkey.
562 u? Universal undo-key. Depending on the key that you press
564 after "u", it either restores closed tabs (uq), removes
565 tags (ut), clears the copy/cut buffer (ud), starts the
566 reversed visual mode (uV) or clears the selection (uv).
567 f Quickly navigate by entering a part of the filename.
569 Space Mark a file.
571 v Toggle the mark-status of all files
573 V Starts the visual mode, which selects all files between
575 the starting point and the cursor until you press ESC.
576 To unselect files in the same way, use "uV".
577 / Search for files in the current directory.
579 : Open the console.
581 ! Open the console with the content "shell " so you can
583 quickly run commands
584 @ Open the console with the content "shell %s", placing
586 the cursor before the " %s" so you can quickly run
587 commands with the current selection as the argument.
588 r Open the console with the content "open with " so you can
590 decide which program to use to open the current file
591 selection.
592 cd Open the console with the content "cd "
594 ^P Open the console with the most recent command.
596 Alt-N Open a tab. N has to be a number from 0 to 9. If the tab
598 doesn't exist yet, it will be created.
599 Alt-l, Alt-r Shift a tab left, respectively right.
601 gn, ^N Create a new tab.
603 gt, gT Go to the next or previous tab. You can also use TAB and
605 SHIFT+TAB instead.
606 gc, ^W Close the current tab. The last tab cannot be closed
608 this way.
609 M A key chain that allows you to quickly change the line
611 mode of all the files of the current directory. For a
612 more permanent solution, use the command
613 "default_linemode" in your rc.conf.
614 .d Apply the typefilter "directory".
616 .f Apply the typefilter "file".
618 .l Apply the typefilter "symlink".
620 .m Apply a new mimetype filter.
622 .n Apply a new filename filter.
624 .# Apply a new hash filter.
626 ." Apply a new duplicate filter.
628 .' Apply a new unique filter.
630 .| Combine the two topmost filters from the filter stack in
632 the "OR" relationship, instead of the "AND" used
633 implicitly.
634 .& Explicitly combine the two topmost filters in the "AND"
636 relationship. Usually not needed because filters are
637 implicitly in this relationship though might be useful in
638 more complicated scenarios.
639 .! Negate the topmost filter.
641 .r Rotate the filter stack by N elements. Where N is
643 provided as a numeric prefix like vim's count and
644 defaults to 1, i.e. move the topmost element to the
645 bottom of the stack.
646 .c Clear the filter stack.
648 .* Decompose the topmost filter combinator (e.g. ".!",
650 ".|").
651 .p Pop the topmost filter from the filter stack.
653 .. Show the current filter stack state.
655 READLINE-LIKE BINDINGS IN THE CONSOLE
657 ^B, ^F Move left and right (B for back, F for forward)
658 ^P, ^N Move up and down (P for previous, N for Next)
660 ^A, ^E Move to the start or to the end
662 Alt-B, Alt-LEFT
664 Move backwards by words.
665 Alt-F, Alt-RIGHT
667 Move forwards by words.
668 ^D Delete the current character.
670 ^H Backspace.
672
674 Left Mouse Button
675 Click on something and you'll move there. To run a file, "enter"
676 it, like a directory, by clicking on the preview.
677 Right Mouse Button
679 Enter a directory or run a file.
680 Scroll Wheel
682 Scrolls up or down. You can point at the column of the parent
683 directory while scrolling to switch directories.
684
686 This section lists all built-in settings of ranger. The valid types
687 for the value are in [brackets]. The hotkey to toggle the setting is
688 in <brakets>, if a hotkey exists.
689 Settings can be changed in the file ~/.config/ranger/rc.conf or on the
691 fly with the command :set option value. Examples:
692 set column_ratios 1,2,3
694 set show_hidden true
695 Toggling options can be done with:
697 set show_hidden!
699 The different types of settings and an example for each type:
701 setting type | example values
703 ---------------+----------------------------
704 bool | true, false
705 integer | 1, 23, 1337
706 string | foo, hello world
707 list | 1,2,3,4
708 none | none
709 You can view a list of all settings and their current values by
711 pressing "3?" in ranger.
712 automatically_count_files [bool]
714 Should ranger count and display the number of files in each
715 directory as soon as it's visible? This gets slow with remote file
716 systems. Turning it off will still allow you to see the number of
717 files after entering the directory.
718 autosave_bookmarks [bool]
720 Save bookmarks (used with mX and `X) instantly? This helps to
721 synchronize bookmarks between multiple ranger instances but leads
722 to *slight* performance loss. When false, bookmarks are saved when
723 ranger is exited.
724 autoupdate_cumulative_size [bool]
726 You can display the "real" cumulative size of directories by using
727 the command :get_cumulative_size or typing "dc". The size is
728 expensive to calculate and will not be updated automatically. You
729 can choose to update it automatically though by turning on this
730 option.
731 cd_bookmarks [bool]
733 Specify whether bookmarks should be included in the tab completion
734 of the "cd" command.
735 cd_tab_case [string]
737 Changes case sensitivity for the "cd" command tab completion.
738 Possible values are:
739 sensitive
741 insensitive
742 smart
743 cd_tab_fuzzy [bool]
745 Use fuzzy tab completion with the "cd" command. For example, :cd
746 /u/lo/b<TAB> expands to :cd /usr/local/bin.
747 clear_filters_on_dir_change [bool]
749 If set to 'true', persistent filters would be cleared upon leaving
750 the directory
751 collapse_preview [bool] <zc>
753 When no preview is visible, should the last column be squeezed to
754 make use of the whitespace?
755 colorscheme [string]
757 Which colorscheme to use? These colorschemes are available by
758 default: default, jungle, snow. Snow is a monochrome scheme,
759 jungle replaces blue directories with green ones for better
760 visibility on certain terminals.
761 column_ratios [list]
763 How many columns are there, and what are their relative widths?
764 For example, a value of 1,1,1 would mean 3 evenly sized columns.
765 1,1,1,1,4 means 5 columns with the preview column being as large as
766 the other columns combined.
767 confirm_on_delete [string]
769 Ask for a confirmation when running the "delete" command? Valid
770 values are "always" (default), "never", "multiple". With
771 "multiple", ranger will ask only if you delete multiple files at
772 once.
773 dirname_in_tabs [bool]
775 Display the directory name in tabs?
776 display_size_in_main_column [bool]
778 Display the file size in the main column?
779 display_size_in_status_bar [bool]
781 Display the file size in the status bar?
782 display_free_space_in_status_bar [bool]
784 Display the free disk space in the status bar?
785 display_tags_in_all_columns [bool]
787 Display tags in all columns?
788 draw_borders [string]
790 Draw borders around or between the columns? Possible values are:
791 none no borders of any sort
793 outline draw an outline around all the columns
794 separators draw only vertical lines between columns
795 both both of the above
796 draw_progress_bar_in_status_bar [bool]
798 Draw a progress bar in the status bar which displays the average
799 state of all currently running tasks which support progress bars?
800 flushinput [bool] <zi>
802 Flush the input after each key hit? One advantage is that when
803 scrolling down with "j", ranger stops scrolling instantly when you
804 release the key. One disadvantage is that when you type commands
805 blindly, some keys might get lost.
806 freeze_files [bool] <F>
808 When active, directories and files will not be loaded, improving
809 performance when all the files you need are already loaded. This
810 does not affect file previews.
811 global_inode_type_filter [string]
813 Like filter_inode_type, but globally for all directories. Useful
814 in combination with --choosedir:
815 ranger --choosedir=/tmp/x --cmd='set global_inode_type_filter d'
817 hidden_filter [string]
819 A regular expression pattern for files which should be hidden. For
820 example, this pattern will hide all files that start with a dot or
821 end with a tilde.
822 set hidden_filter ^\.|~$
824 hint_collapse_threshold [int]
826 The key hint lists up to this size have their sublists expanded.
827 Otherwise the submaps are replaced with "...".
828 hostname_in_titlebar [bool]
830 Show hostname in titlebar?
831 size_in_bytes [bool]
833 Print file sizes in bytes instead of the default human-readable
834 format.
835 idle_delay [integer]
837 The delay that ranger idly waits for user input, in milliseconds,
838 with a resolution of 100ms. Lower delay reduces lag between
839 directory updates but increases CPU load.
840 iterm2_font_height [integer]
842 Change the assumed font height in iTerm2, which may help with iTerm
843 image previews
844 iterm2_font_width [integer]
846 Change the assumed font width in iTerm2, which may help with iTerm
847 image previews
848 line_numbers [string]
850 Show line numbers in main column. Possible values are:
851 false turn the feature off
853 absolute absolute line numbers for use with "<N>gg"
854 relative relative line numbers for "<N>k" or "<N>j"
855 max_console_history_size [integer, none]
857 How many console commands should be kept in history? "none" will
858 disable the limit.
859 max_history_size [integer, none]
861 How many directory changes should be kept in history?
862 metadata_deep_search [bool]
864 When the metadata manager module looks for metadata, should it only
865 look for a ".metadata.json" file in the current directory, or do a
866 deep search and check all directories above the current one as
867 well?
868 mouse_enabled [bool] <zm>
870 Enable mouse input?
871 nested_ranger_warning [string]
873 Warn at startup if "RANGER_LEVEL" is greater than 0, in other words
874 give a warning when you nest ranger in a subshell started by
875 ranger. Allowed values are "true", "false" and "error". The special
876 value "error" promotes the warning to an error, this is usually
877 shown as red text but will crash ranger when run with the "--debug"
878 flag.
879 one_indexed [bool]
881 Start line numbers from 1. Possible values are:
882 false start line numbers from 0
884 true start line numbers from 1
885 open_all_images [bool]
887 Open all images in this directory when running certain image
888 viewers like feh or sxiv? You can still open selected files by
889 marking them.
890 If there would be too many files for the system to handle, this
892 option will be temporarily disabled automatically.
893 padding_right [bool]
895 When collapse_preview is on and there is no preview, should there
896 remain a little padding on the right? This allows you to click
897 into that space to run the file.
898 preview_directories [bool] <zP>
900 Preview directories in the preview column?
901 preview_files [bool] <zp>
903 Preview files in the preview column?
904 preview_images [bool]
906 Draw images inside the console with the external program
907 w3mimgpreview?
908 preview_images_method [string]
910 Set the preview image method. Supported methods: w3m, iterm2,
911 urxvt, urxvt-full, terminology. See PREVIEWS section.
912 preview_max_size [int]
914 Avoid previewing files that exceed a certain size, in bytes. Use a
915 value of 0 to disable this feature.
916 preview_script [string, none]
918 Which script should handle generating previews? If the file
919 doesn't exist, or use_preview_script is off, ranger will handle
920 previews itself by just printing the content.
921 relative_current_zero [bool]
923 When line_numbers is set to relative, show 0 on the current line if
924 true or show the absolute number of the current line when false.
925 save_backtick_bookmark [bool]
927 Save the "`" bookmark to disk. This bookmark is used to switch to
928 the last directory by typing "``".
929 save_console_history [bool]
931 Should the console history be saved on exit? If disabled, the
932 console history is reset when you restart ranger.
933 save_tabs_on_exit [bool]
935 Save all tabs, except the active, on exit? The last saved tabs are
936 restored once when starting the next session. Multiple sessions are
937 stored in a stack and the oldest saved tabs are restored first.
938 scroll_offset [integer]
940 Try to keep this much space between the top/bottom border when
941 scrolling.
942 shorten_title [integer]
944 Trim the title of the window if it gets long? The number defines
945 how many directories are displayed at once. A value of 0 turns off
946 this feature.
947 show_cursor [bool]
949 Always show the terminal cursor?
950 show_hidden_bookmarks [bool]
952 Show dotfiles in the bookmark preview window? (Type ')
953 show_hidden [bool] <zh>, <^H>
955 Show hidden files?
956 show_selection_in_titlebar [bool]
958 Add the highlighted file to the path in the titlebar
959 sort_case_insensitive [bool] <zc>
961 Sort case-insensitively? If true, "a" will be listed before "B"
962 even though its ASCII value is higher.
963 sort_directories_first [bool] <zd>
965 Sort directories first?
966 sort_reverse [bool] <or>
968 Reverse the order of files?
969 sort_unicode [bool]
971 When sorting according to some string, should the unicode
972 characters be compared, instead of looking at the raw character
973 values to save time?
974 sort [string] <oa>, <ob>, <oc>, <oe>, <om>, <on>, <ot>, <os>, <oz>
976 Which sorting mechanism should be used? Choose one of atime,
977 basename, ctime, extension, mtime, natural, type, size, random
978 Note: You can reverse the order by typing an uppercase second
980 letter in the key combination, e.g. "oN" to sort from Z to A.
981 status_bar_on_top [bool]
983 Put the status bar at the top of the window?
984 tilde_in_titlebar [bool]
986 Abbreviate $HOME with ~ in the titlebar (first line) of ranger?
987 unicode_ellipsis [bool]
989 Use a unicode "..." character instead of "~" to mark cut-off
990 filenames?
991 bidi_support [bool]
993 Try to properly display file names in RTL languages (Hebrew,
994 Arabic) by using a BIDI algorithm to reverse the relevant parts of
995 the text. Requires the python-bidi pip package.
996 update_title [bool]
998 Set a window title? Updates both the WM_NAME and WM_ICON_NAME
999 properties.
1000 update_tmux_title [bool]
1002 Set the tmux/screen window-name to "ranger"?
1003 use_preview_script [bool] <zv>
1005 Use the preview script defined in the setting preview_script?
1006 vcs_aware [bool]
1008 Gather and display data about version control systems. Supported
1009 vcs: git, hg.
1010 vcs_backend_git, vcs_backend_hg, vcs_backend_bzr, vcs_backend_svn
1012 [string]
1013 Sets the state for the version control backend. The possible values
1014 are:
1015 disabled Don't display any information.
1017 local Display only local state.
1018 enabled Display both, local and remote state.
1019 May be slow for hg and bzr.
1020 vcs_msg_length [int]
1022 Length to truncate first line of the commit messages to when shown
1023 in the statusbar. Defaults to 50.
1024 viewmode [string]
1026 Sets the view mode, which can be miller to display the files in the
1027 traditional miller column view that shows multiple levels of the
1028 hierarchy, or multipane to use multiple panes (one per tab) similar
1029 to midnight-commander.
1030 w3m_delay [float]
1032 Delay in seconds before displaying an image with the w3m method.
1033 Increase it in case of experiencing display corruption.
1034 w3m_offset [int]
1036 Offset in pixels for the inner border of the terminal. Some
1037 terminals require the offset to be specified explicitly, among
1038 others st and UXterm, some don't like urxvt.
1039 wrap_plaintext_previews [bool]
1041 Whether or not to wrap long lines in the pager, this includes
1042 previews of plain text files.
1043 wrap_scroll [bool]
1045 Enable scroll wrapping - moving down while on the last item will
1046 wrap around to the top and vice versa.
1047 xterm_alt_key [bool]
1049 Enable this if key combinations with the Alt Key don't work for
1050 you. (Especially on xterm)
1051
1053 You can enter the commands in the console which is opened by pressing
1054 ":".
1055 You can always get a list of the currently existing commands by typing
1057 "?c" in ranger. For your convenience, this is a list of the "public"
1058 commands including their parameters, excluding descriptions:
1059 alias [newcommand] [oldcommand]
1061 bulkrename
1062 cd [path]
1063 chain command1[; command2[; command3...]]
1064 chmod octal_number
1065 cmap key command
1066 console [-pSTARTPOSITION] command
1067 copycmap key newkey [newkey2...]
1068 copymap key newkey [newkey2...]
1069 copypmap key newkey [newkey2...]
1070 copytmap key newkey [newkey2...]
1071 cunmap keys...
1072 default_linemode [path=regexp | tag=tags] linemodename
1073 delete
1074 echo [text]
1075 edit [filename]
1076 eval [-q] python_code
1077 filter [string]
1078 filter_inode_type [dfl]
1079 find pattern
1080 flat level
1081 grep pattern
1082 help
1083 jump_non [-FLAGS...]
1084 linemode linemodename
1085 load_copy_buffer
1086 map key command
1087 mark pattern
1088 mark_tag [tags]
1089 meta key value
1090 mkdir dirname
1091 open_with [application] [flags] [mode]
1092 pmap key command
1093 prompt_metadata [key1 [key2 [...]]]
1094 punmap keys...
1095 quit
1096 quit!
1097 quitall
1098 quitall!
1099 relink newpath
1100 rename_append [-FLAGS...]
1101 rename newname
1102 save_copy_buffer
1103 scout [-FLAGS...] pattern
1104 search pattern
1105 search_inc pattern
1106 set option value
1107 setintag tags option value
1108 setlocal [path=<path>] option value
1109 shell [-FLAGS...] command
1110 source filename
1111 terminal
1112 tmap key command
1113 touch filename
1114 trash
1115 travel pattern
1116 tunmap keys...
1117 unmap keys...
1118 unmark pattern
1119 unmark_tag [tags]
1120 There are additional commands which are directly translated to python
1122 functions, one for every method in the ranger.core.actions.Actions
1123 class. They are not documented here, since they are mostly for key
1124 bindings, not to be typed in by a user. Read the source if you are
1125 interested in them.
1126 These are the public commands including their descriptions:
1128 alias [newcommand] [oldcommand]
1130 Copies the oldcommand as newcommand.
1131 bulkrename
1133 This command opens a list of selected files in an external editor.
1134 After you edit and save the file, it will generate a shell script
1135 which does bulk renaming according to the changes you did in the
1136 file.
1137 This shell script is opened in an editor for you to review. After
1139 you close it, it will be executed.
1140 cd [path]
1142 The cd command changes the directory. If path is a file, selects
1143 that file. The command ":cd -" is equivalent to typing ``.
1144 chain command1[; command2[; command3...]]
1146 Combines multiple commands into one, separated by semicolons.
1147 chmod octal_number
1149 Sets the permissions of the selection to the octal number.
1150 The octal number is between 000 and 777. The digits specify the
1152 permissions for the user, the group and others. A 1 permits
1153 execution, a 2 permits writing, a 4 permits reading. Add those
1154 numbers to combine them. So a 7 permits everything.
1155 Key bindings in the form of [-+]<who><what> and <octal>= also exist.
1157 For example, +ar allows reading for everyone, -ow forbids others to
1158 write and 777= allows everything.
1159 See also: man 1 chmod
1161 console [-pN] command
1163 Opens the console with the command already typed in. The cursor is
1164 placed at N.
1165 copymap key newkey [newkey2 ...]
1167 copycmap key newkey [newkey2 ...]
1168 copypmap key newkey [newkey2 ...]
1169 copytmap key newkey [newkey2 ...]
1170 Copies the keybinding key to newkey in the "browser" context. This
1171 is a deep copy, so if you change the new binding (or parts of it)
1172 later, the old one is not modified. For example, copymap j down will
1173 make the key sequence "down" move the cursor down one item.
1174 To copy key bindings of the console, pager or taskview use
1176 "copycmap", "copypmap" or "copytmap" respectively.
1177 default_linemode [path=regexp | tag=tags] linemodename
1179 Sets the default linemode. See linemode command.
1180 Examples:
1182 Set the global default linemode to "permissions":
1184 :default_linemode permissions
1185 Set the default linemode to "permissions" for all files tagged with
1187 "p" or "P":
1188 :default_linemode tag=pP permissions
1189 Set the default linemode for all files in ~/books/ to "metatitle":
1191 :default_linemode path=/home/.*?/books/.* metatitle
1192 delete
1194 Destroy all files in the selection with a roundhouse kick. ranger
1195 will ask for a confirmation if you attempt to delete multiple
1196 (marked) files or non-empty directories. This can be changed by
1197 modifying the setting "confirm_on_delete".
1198 echo text
1200 Display the text in the statusbar.
1201 edit [filename]
1203 Edit the current file or the file in the argument.
1204 eval [-q] python_code
1206 Evaluates the python code. `fm' is a reference to the FM instance.
1207 To display text, use the function `p'. The result is displayed on
1208 the screen unless you use the "-q" option.
1209 Examples:
1211 :eval fm
1212 :eval len(fm.tabs)
1213 :eval p("Hello World!")
1214 filter [string]
1216 Displays only the files which contain the string in their basename.
1217 Running this command without any parameter will reset the filter.
1218 This command is based on the scout command and supports all of its
1220 options.
1221 filter_inode_type [dfl]
1223 Displays only the files of specified inode type. To display only
1224 directories, use the 'd' parameter. To display only files, use the
1225 'f' parameter. To display only links, use the 'l' parameter.
1226 Parameters can be combined. To remove this filter, use no parameter.
1227 filter_stack [command [args]]
1229 Manage the filter stack, adding, removing and manipulating filters.
1230 For example, to show only duplicate files and symlinks:
1231 :filter_stack add type f
1233 :filter_stack add duplicate
1234 :filter_stack add and
1235 :filter_stack add type l
1236 :filter_stack add or
1237 Or using the mapped keys:
1239 .f ." .& .l .|
1241 Available subcommands:
1243 add FILTER_TYPE [ARGS...]
1245 Add a new filter to the top of the filter stack. Each filter on the
1246 stack is applied in turn, resulting in an implicit logical "AND"
1247 relation. The following "FILTER_TYPE"s are available:
1248 duplicate
1250 Filter files so only files that have duplicates in the same
1251 directory are shown. Useful when cleaning up identical songs and
1252 memes that were saved using distinct file names.
1253 filename NAME
1255 Filter files that contain NAME in the filename, regular
1256 expression syntax is allowed.
1257 hash PATH
1259 Filter files so only files with the same hash as PATH are shown.
1260 mimetype TYPE
1262 Filter files of a certain MIME type, regular expression syntax is
1263 allowed.
1264 typefilter [d|f|l]
1266 Filter files of a certain type, "d" for directories, "f" for
1267 files and "l" for symlinks.
1268 unique
1270 Filter files so only unique files and the oldest file of every
1271 set of duplicates is shown.
1272 and
1274 Explicitly combine the two topmost filters in the "AND"
1275 relationship. Usually not needed because filters are implicitly
1276 in this relationship though might be useful in more complicated
1277 scenarios.
1278 not
1280 Negate the topmost filter.
1281 or
1283 Combine the two topmost filters from the filter stack in the "OR"
1284 relationship, instead of the "AND" used implicitly.
1285 pop
1287 Pop the topmost filter from the filter stack.
1288 decompose
1290 Decompose the topmost filter combinator (e.g. ".!", ".|").
1291 rotate [N=1]
1293 Rotate the filter stack by N elements. Where N is passed as
1294 argument or as a numeric prefix like vim's count, default to 1,
1295 i.e. move the topmost element to the bottom of the stack.
1296 clear
1298 Clear the filter stack.
1299 show
1301 Show the current filter stack state.
1302 find pattern
1304 Search files in the current directory that contain the given (case-
1305 insensitive) string in their name as you type. Once there is an
1306 unambiguous result, it will be run immediately. (Or entered, if it's
1307 a directory.)
1308 This command is based on the scout command and supports all of its
1310 options.
1311 flat level
1313 Flattens the directory view up to the specified level. Level -1 means
1314 infinite level. Level 0 means standard view without flattened
1315 directory view. Level values -2 and less are invalid.
1316 grep pattern
1318 Looks for a string in all marked files or directories.
1319 help
1321 Provides a quick way to view ranger documentations.
1322 jump_non [-flags...]
1324 Jumps to first non-directory if highlighted file is a directory and
1325 vice versa.
1326 Flags:
1328 -r Jump in reverse order
1329 -w Wrap around if reaching end of filelist
1330 linemode linemodename
1332 Sets the linemode of all files in the current directory. The
1333 linemode may be:
1334 "filename":
1336 display each line as "<basename>...<size>"
1337 "fileinfo":
1338 display each line as "<basename>...<file(1) output>"
1339 "mtime":
1340 display each line as "<basename>...<mtime>" in ISO format
1341 "humanreadablemtime":
1342 display each line as "<basename>...<mtime>" in a human readable
1343 format, more precise the more recent.
1344 "sizemtime":
1345 display each line as "<basename>...<size> <mtime>" in ISO format
1346 "humanreadablesizemtime":
1347 display each line as "<basename>...<size> <mtime>" in a human
1348 readable format, more precise the more recent.
1349 "permissions":
1350 display each line as "<permissions> <owner> <group> <basename>"
1351 "metatitle":
1352 display metadata from .metadata.json files if available, fall back
1353 to the "filename" linemode if no metadata was found.
1354 See :meta command.
1355 The custom linemodes may be added by subclassing the LinemodeBase
1357 class. See the ranger.core.linemode module for some examples.
1358 load_copy_buffer
1360 Load the copy buffer from ~/.config/ranger/copy_buffer. This can be
1361 used to pass the list of copied files to another ranger instance.
1362 map key command
1364 cmap key command
1365 pmap key command
1366 tmap key command
1367 Assign the key combination to the given command. Whenever you type
1368 the key/keys, the command will be executed. Additionally, if you use
1369 a quantifier when typing the key, like 5j, it will be passed to the
1370 command as the attribute "self.quantifier".
1371 The keys you bind with this command are accessible in the file
1373 browser only, not in the console, pager or taskview. To bind keys
1374 there, use the commands "cmap", "pmap" or "tmap".
1375 mark pattern
1377 Mark all files matching the regular expression pattern.
1378 This command is based on the scout command and supports all of its
1380 options.
1381 mark_tag [tags]
1383 Mark all tags that are tagged with either of the given tags. When
1384 leaving out the tag argument, all tagged files are marked.
1385 meta key value
1387 Set the metadata of the currently highlighted file. Example:
1388 :meta title The Hitchhiker's Guide to the Galaxy
1390 :meta year 1979
1391 This metadata can be displayed by, for example, using the "metatitle"
1393 line mode by typing Mt.
1394 mkdir dirname
1396 Creates a directory with the name dirname.
1397 open_with [application] [flags] [mode]
1399 Open the selected files with the given application, unless it is
1400 omitted, in which case the default application is used. flags change
1401 the way the application is executed and are described in their own
1402 section in this man page. The mode is a number that specifies which
1403 application to use. The list of applications is generated by the
1404 external file opener "rifle" and can be displayed when pressing "r"
1405 in ranger.
1406 Note that if you specify an application, the mode is ignored.
1408 prompt_metadata [keys ...]
1410 Prompt the user to input metadata with the "meta" command for
1411 multiple keys in a row.
1412 quit
1414 Closes the current tab, if there's only one tab. Otherwise quits if
1415 there are no tasks in progress. The current directory will be
1416 bookmarked as ' so you can re-enter it by typing `` or '' the next
1417 time you start ranger.
1418 quit!
1420 Like "quit", except will force quit even if tasks are in progress.
1421 quitall
1423 Like "quit", except will quit even if multiple tabs are open.
1424 quitall!
1426 Like "quitall", except will force quit even if tasks are in progress.
1427 relink newpath
1429 Change the link destination of the current symlink file to <newpath>.
1430 First <tab> will load the original link.
1431 rename newname
1433 Rename the current file. If a file with that name already exists,
1434 the renaming will fail. Also try the key binding A for appending
1435 something to a file name.
1436 rename_append [-flags...]
1438 Opens the console with ":rename <current file>" with the cursor
1439 positioned before the file extension.
1440 Flags:
1442 -a Position before all extensions
1443 -r Remove everything before extensions
1444 save_copy_buffer
1446 Save the copy buffer to ~/.config/ranger/copy_buffer. This can be
1447 used to pass the list of copied files to another ranger instance.
1448 scout [-flags...] [--] pattern
1450 Swiss army knife command for searching, traveling and filtering
1451 files.
1452 Flags:
1454 -a Automatically open a file on unambiguous match
1455 -e Open the selected file when pressing enter
1456 -f Filter files that match the current search pattern
1457 -g Interpret pattern as a glob pattern
1458 -i Ignore the letter case of the files
1459 -k Keep the console open when changing a directory with the
1460 command
1461 -l Letter skipping; e.g. allow "rdme" to match the file "readme"
1462 -m Mark the matching files after pressing enter
1463 -M Unmark the matching files after pressing enter
1464 -p Permanent filter: hide non-matching files after pressing enter
1465 -r Interpret pattern as a regular expression pattern
1466 -s Smart case; like -i unless pattern contains upper case letters
1467 -t Apply filter and search pattern as you type
1468 -v Inverts the match
1469 Multiple flags can be combined. For example, ":scout -gpt" would
1471 create a :filter-like command using globbing.
1472 search pattern
1474 Search files in the current directory that match the given (case
1475 insensitive) regular expression pattern.
1476 This command is based on the scout command and supports all of its
1478 options.
1479 search_inc pattern
1481 Search files in the current directory that match the given (case
1482 insensitive) regular expression pattern. This command gets you to
1483 matching files as you type.
1484 This command is based on the scout command and supports all of its
1486 options.
1487 set option value
1489 Assigns a new value to an option. Valid options are listed in the
1490 settings section. Use tab completion to get the current value of an
1491 option, though this doesn't work for functions and regular
1492 expressions. Valid values are:
1493 setting type | example values
1495 ---------------+----------------------------
1496 bool | true, false
1497 integer | 1, 23, 1337
1498 string | foo, hello world
1499 list | 1,2,3,4
1500 none | none
1501 setintag tags option value
1503 Assigns a new value to an option, but locally for the directories
1504 that are marked with tag. This means, that this option only takes
1505 effect when visiting that directory.
1506 For example, to change the sorting order in your downloads directory,
1508 tag it with the v tag by typing "v, then use this command:
1509 setintag v sort ctime
1511 setlocal [path=path] option value
1513 Assigns a new value to an option, but locally for the directory given
1514 by path. This means, that this option only takes effect when visiting
1515 that directory. If no path is given, uses the current directory.
1516 path is a regular expression. This means that "path=~/dl" applies to
1518 all paths that start with ~/dl, e.g. ~/dl2 and ~/dl/foo. To avoid
1519 this, use "path=~/dl$".
1520 path can be quoted with either single or double quotes to prevent
1522 unwanted splitting. path='~/dl dl$' or path="~/dl dl$"
1523 shell [-flags] command
1525 Run a shell command. flags are discussed in their own section.
1526 source filename
1528 Reads commands from a file and executes them in the ranger console.
1529 This can be used to re-evaluate the rc.conf file after changing it:
1531 map X chain shell vim -p %confdir/rc.conf %rangerdir/config/rc.conf; \
1533 source %confdir/rc.conf
1534 scroll_preview value
1536 Scroll the file preview by value lines.
1537 terminal
1539 Spawns the x-terminal-emulator starting in the current directory.
1540 touch filename
1542 Creates an empty file with the name filename, unless it already
1543 exists.
1544 trash
1546 Move all files in the selection to the trash using rifle. Rifle tries
1547 to use a trash manager like trash-cli if available but will fall back
1548 to moving files to either $XDG_DATA_HOME/ranger-trash or
1549 ~/.ranger/ranger-trash. This is a less permanent version of delete,
1550 relying on the user to clear out the trash whenever it's convenient.
1551 While having the possibility of restoring trashed files until this
1552 happens. ranger will ask for a confirmation if you attempt to trash
1553 multiple (marked) files or non-empty directories. This can be changed
1554 by modifying the setting "confirm_on_delete".
1555 travel pattern
1557 Filters the current directory for files containing the letters in the
1558 string, possibly with other letters in between. The filter is
1559 applied as you type. When only one directory is left, it is entered
1560 and the console is automatically reopened, allowing for fast travel.
1561 To close the console, press ESC or execute a file.
1562 This command is based on the scout command and supports all of its
1564 options.
1565 unmap [keys ...]
1567 cunmap [keys ...]
1568 punmap [keys ...]
1569 tunmap [keys ...]
1570 Removes the given key mappings in the "browser" context. To unmap
1571 key bindings in the console, pager, or taskview use "cunmap",
1572 "punmap" or "tunmap".
1573 unmark pattern
1575 Unmark all files matching a regular expression pattern.
1576 This command is based on the scout command and supports all of its
1578 options.
1579 unmark_tag [tags]
1581 Unmark all tags that are tagged with either of the given tags. When
1582 leaving out the tag argument, all tagged files are unmarked.
1583
1585 ranger reads several configuration files which are located in
1586 $HOME/.config/ranger or $XDG_CONFIG_HOME/ranger if $XDG_CONFIG_HOME is
1587 defined. You can use the --copy-config option to obtain the default
1588 configuration files. The files contain further documentation.
1589 rc.conf, commands.py and colorschemes do not need to be copied fully as
1591 they will only be adding to the default configuration files except if
1592 explicitly overridden. This may lead to some confusing situations, for
1593 example when a key is being bound despite the corresponding line being
1594 removed from the user's copy of the configuration file. This behavior
1595 may be disabled with an environment variable (see also: ENVIRONMENT).
1596 Note: All other configuration files only read from one source; i.e.
1597 default OR user, not both. rc.conf and commands.py are additionally
1598 read from /etc/ranger if they exist for system-wide configuration, user
1599 configuration overrides system configuration which overrides the
1600 default configuration.
1601 When starting ranger with the --clean option, it will not access or
1603 create any of these files.
1604 CONFIGURATION
1606 rc.conf Contains a list of commands which are executed on startup.
1607 Mostly key bindings and settings are defined here.
1608 commands.py
1610 A python module that defines commands which can be used in
1611 ranger's console by typing ":" or in the rc.conf file. Note
1612 that you can define commands in the same manner within
1613 plugins.
1614 commands_full.py
1616 This file is copied by --copy-config=commands_full and serves
1617 as a reference for custom commands. It is entirely ignored
1618 by ranger.
1619 rifle.conf
1621 This is the configuration file for the built-in file launcher
1622 called "rifle".
1623 scope.sh This is a script that handles file previews. When the
1625 options use_preview_script and preview_files are set, the
1626 program specified in the option preview_script is run and its
1627 output and/or exit code determines rangers reaction.
1628 colorschemes/
1630 Colorschemes can be placed here.
1631 plugins/ Plugins can be placed here.
1633 STORAGE
1635 bookmarks This file contains a list of bookmarks. The syntax is
1636 /^(.):(.*)$/. The first character is the bookmark key and the
1637 rest after the colon is the path to the file. In ranger,
1638 bookmarks can be set by typing m<key>, accessed by typing
1639 '<key> and deleted by typing um<key>.
1640 copy_buffer
1642 When running the command :save_copy_buffer, the paths of all
1643 currently copied files are saved in this file. You can later
1644 run :load_copy_buffer to copy the same files again, pass them
1645 to another ranger instance or process them in a script.
1646 history Contains a list of commands that have been previously typed
1648 in.
1649 tagged Contains a list of tagged files. The syntax is /^(.:)?(.*)$/
1651 where the first letter is the optional name of the tag and
1652 the rest after the optional colon is the path to the file.
1653 In ranger, tags can be set by pressing t and removed with T.
1654 To assign a named tag, type "<tagname>.
1655
1657 These environment variables have an effect on ranger:
1658 RANGER_LEVEL
1660 ranger sets this environment variable to "1" or increments it
1661 if it already exists. External programs can determine whether
1662 they were spawned from ranger by checking for this variable.
1663 RANGER_LOAD_DEFAULT_RC
1665 If this variable is set to FALSE, ranger will not load the
1666 default rc.conf. This can save time if you copied the whole
1667 rc.conf to ~/.config/ranger/ and don't need the default one at
1668 all.
1669 VISUAL Defines the editor to be used for the "E" key. Falls back to
1671 EDITOR if undefined or empty.
1672 EDITOR Defines the editor to be used for the "E" key if VISUAL is
1674 undefined or empty. Defaults to "vim".
1675 SHELL Defines the shell that ranger is going to use with the :shell
1677 command and the "S" key. Defaults to "/bin/sh".
1678 TERMCMD Defines the terminal emulator command that ranger is going to
1680 use with the :terminal command and the "t" run flag. Defaults
1681 to "xterm".
1682 BAT_STYLE
1684 Specifies the theme to be used for syntax highlighting when bat
1685 is installed, unless highlight is also installed. Find out
1686 possible values by running "bat --list-themes".
1687 PYGMENTIZE_STYLE
1689 Specifies the theme to be used for syntax highlighting when
1690 pygmentize is installed, unless highlight is also installed.
1691 Find out possible values by running:
1692 python -c 'import pygments.styles; [print(stl) for stl in
1693 pygments.styles.get_all_styles()]'
1694 HIGHLIGHT_STYLE
1696 Specifies the theme to be used for syntax highlighting when
1697 highlight is installed. Find out possible values by running
1698 "highlight --list-themes".
1699 HIGHLIGHT_TABWIDTH
1701 Specifies the number of spaces to use to replace tabs in
1702 highlighted files.
1703 HIGHLIGHT_OPTIONS
1705 highlight will pick up command line options specified in this
1706 variable. A "--style=" option specified here will override
1707 "HIGHLIGHT_STYLE". Similarly, "--replace-tabs=" will override
1708 "HIGHLIGHT_TABWIDTH".
1709 OPENSCAD_COLORSCHEME
1711 Specifies the colorscheme used by openscad while previewing 3D
1712 models. Read openscad man page for colorschemes. Ranger will
1713 default to Tomorrow Night.
1714 OPENSCAD_IMGSIZE
1716 Specifies the internal resolution openscad will use for
1717 rendering 3D models. The image will be downscaled to fit the
1718 preview pane. This resolution will default to "1000,1000" if no
1719 value is set.
1720 XDG_CONFIG_HOME
1722 Specifies the directory for configuration files. Defaults to
1723 $HOME/.config.
1724 PYTHONOPTIMIZE
1726 This variable determines the optimize level of python.
1727 Using PYTHONOPTIMIZE=1 (like python -O) will make python
1729 discard assertion statements. You will gain efficiency at the
1730 cost of losing some debug info.
1731 Using PYTHONOPTIMIZE=2 (like python -OO) will additionally
1733 discard any docstrings. Using this will disable the <F1> key
1734 on commands.
1735 W3MIMGDISPLAY_PATH
1737 By changing this variable, you can change the path of the
1738 executable file for image previews. By default, it is set to
1739 /usr/lib/w3m/w3mimgdisplay.
1740
1742 There are various examples on how to extend ranger with plugins or
1743 combine ranger with other programs. These can be found in the
1744 /usr/share/doc/ranger/examples/ directory, or the doc/ranger/ that is
1745 provided along with the source code.
1746
1748 GNU General Public License 3 or (at your option) any later version.
1749
1751 Download: <https://ranger.github.io/ranger-stable.tar.gz>
1752 The project page: <https://ranger.github.io/>
1753 The mailing list: <https://savannah.nongnu.org/mail/?group=ranger>
1754 IRC channel: #ranger on freenode.net
1755 ranger is maintained with the git version control system. To fetch a
1757 fresh copy, run:
1758 git clone git@github.com:ranger/ranger.git
1760
1762 rifle(1)
1763
1765 Report bugs here: <https://github.com/ranger/ranger/issues>
1766 Please include as much relevant information as possible. For the most
1768 diagnostic output, run ranger like this: "PYTHONOPTIMIZE= ranger
1769 --debug"
17702019-12-31 ranger-1.9.3 RANGER(1)