pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */
//: Spaces help isolate recipes from each other. You can create them at will,
//: and all addresses in arguments are implicitly based on the 'default-space'
//: (unless they have the /raw property)

//: A space is just an array of any scalar location.
:(before "End Mu Types Initialization")
put(Type_abbreviations, "space", new_type_tree("address:array:location"));
//: Spaces are often called 'scopes' in other languages.
put(Type_abbreviations, "scope", new_type_tree("address:array:location"));

:(scenario set_default_space)
# if default-space is 10, and if an array of 5 locals lies from location 12 to 16 (inclusive),
# then local 0 is really location 12, local 1 is really location 13, and so on.
def main [
  # pretend address:array:location; in practice we'll use new
  10:num <- copy 0  # refcount
  11:num <- copy 5  # length
  default-space:space <- copy 10/unsafe
  1:num <- copy 23
]
+mem: storing 23 in location 13

:(scenario lookup_sidesteps_default_space)
def main [
  # pretend pointer from outside (2000 reserved for refcount)
  2001:num <- copy 34
  # pretend address:array:location; in practice we'll use new
  1000:num <- copy 0  # refcount
  1001:num <- copy 5  # length
  # actual start of this recipe
  default-space:space <- copy 1000/unsafe
  1:&:num <- copy 2000/unsafe  # even local variables always contain raw addresses
  8:num/raw <- copy *1:&:num
]
+mem: storing 34 in location 8

//:: first disable name conversion for 'default-space'
:(scenario convert_names_passes_default_space)
% Hide_errors = true;
def main [
  default-space:num, x:num <- copy 0, 1
]
+name: assign x 1
-name: assign default-space 1

:(before "End is_disqualified Special-cases")
if (x.name == "default-space")
  x.initialized = true;
:(before "End is_special_name Special-cases")
if (s == "default-space") return true;

//:: now implement space support
:(before "End call Fields")
int default_space;
:(before "End call Constructor")
default_space = 0;

:(before "End canonize(x) Special-cases")
absolutize(x);
:(code)
void absolutize(reagent& x) {
  if (is_raw(x) || is_dummy(x)) return;
  if (x.name == "default-space") return;
  if (!x.initialized)
    raise << to_original_string(current_instruction()) << ": reagent not initialized: '" << x.original_string << "'\n" << end();
  x.set_value(address(x.value, space_base(x)));
  x.properties.push_back(pair<string, string_tree*>("raw", NULL));
  assert(is_raw(x));
}

//: hook replaced in a later layer
int space_base(const reagent& x) {
  return current_call().default_space ? (current_call().default_space+/*skip refcount*/1) : 0;
}

int address(int offset, int base) {
  assert(offset >= 0);
  if (base == 0) return offset;  // raw
  int size = get_or_insert(Memory, base);
  if (offset >= size) {
    // todo: test
    raise << "location " << offset << " is out of bounds " << size << " at " << base << '\n' << end();
    return 0;
  }
  return base + /*skip length*/1 + offset;
}

//:: reads and writes to the 'default-space' variable have special behavior

:(after "Begin Preprocess write_memory(x, data)")
if (x.name == "default-space") {
  if (!scalar(data) || !is_space(x))
    raise << maybe(current_recipe_name()) << "'default-space' should be of type address:array:location, but is " << to_string(x.type) << '\n' << end();
  current_call().default_space = data.at(0);
  return;
}
:(code)
bool is_space(const reagent& r) {
  return is_address_of_array_of_numbers(r);
}

:(scenario get_default_space)
def main [
  default-space:space <- copy 10/unsafe
  1:space/raw <- copy default-space:space
]
+mem: storing 10 in location 1

:(after "Begin Preprocess read_memory(x)")
if (x.name == "default-space") {
  vector<double> result;
  result.push_back(current_call().default_space);
  return result;
}

//:: fix 'get'

:(scenario lookup_sidesteps_default_space_in_get)
def main [
  # pretend pointer to container from outside (2000 reserved for refcount)
  2001:num <- copy 34
  2002:num <- copy 35
  # pretend address:array:location; in practice we'll use new
  1000:num <- copy 0  # refcount
  1001:num <- copy 5  # length
  # actual start of this recipe
  default-space:space <- copy 1000/unsafe
  1:&:point <- copy 2000/unsafe
  9:num/raw <- get *1:&:point, 1:offset
]
+mem: storing 35 in location 9

:(before "Read element" following "case GET:")
element.properties.push_back(pair<string, string_tree*>("raw", NULL));

//:: fix 'index'

:(scenario lookup_sidesteps_default_space_in_index)
def main [
  # pretend pointer to array from outside (2000 reserved for refcount)
  2001:num <- copy 2  # length
  2002:num <- copy 34
  2003:num <- copy 35
  # pretend address:array:location; in practice we'll use new
  1000:num <- copy 0  # refcount
  1001:num <- copy 5  # length
  # actual start of this recipe
  default-space:space <- copy 1000/unsafe
  1:&:@:num <- copy 2000/unsafe
  9:num/raw <- index *1:&:@:num, 1
]
+mem: storing 35 in location 9

:(before "Read element" following "case INDEX:")
element.properties.push_back(pair<string, string_tree*>("raw", NULL));

//:: convenience operation to automatically deduce the amount of space to
//:: allocate in a default space with names

:(scenario new_default_space)
def main [
  new-default-space
  x:num <- copy 0
  y:num <- copy 3
]
# allocate space for x and y, as well as the chaining slot at 0
+mem: array length is 3

:(before "End is_disqualified Special-cases")
if (x.name == "number-of-locals")
  x.initialized = true;
:(before "End is_special_name Special-cases")
if (s == "number-of-locals") return true;

:(before "End Rewrite Instruction(curr, recipe result)")
// rewrite `new-default-space` to
//   `default-space:space <- new location:type, number-of-locals:literal`
// where N is Name[recipe][""]
if (curr.name == "new-default-space") {
  rewrite_default_space_instruction(curr);
}
:(after "Begin Preprocess read_memory(x)")
if (x.name == "number-of-locals") {
  vector<double> result;
  result.push_back(Name[get(Recipe_ordinal, current_recipe_name())][""]);
  if (result.back() == 0)
    raise << "no space allocated for default-space in recipe " << current_recipe_name() << "; are you using names?\n" << end();
  return result;
}
:(after "Begin Preprocess write_memory(x, data)")
if (x.name == "number-of-locals") {
  raise << maybe(current_recipe_name()) << "can't write to special name 'number-of-locals'\n" << end();
  return;
}

//:: 'local-scope' is like 'new-default-space' except that we'll reclaim the
//:: default-space when the routine exits

:(scenario local_scope)
def main [
  1:&:@:location <- foo
  2:&:@:location <- foo
  3:bool <- equal 1:&, 2:&
]
def foo [
  local-scope
  x:num <- copy 34
  return default-space:space
]
# both calls to foo should have received the same default-space
+mem: storing 1 in location 3

:(scenario local_scope_frees_up_addresses)
def main [
  local-scope
  x:text <- new [abc]
]
+mem: clearing x:text

:(before "End Rewrite Instruction(curr, recipe result)")
if (curr.name == "local-scope") {
  rewrite_default_space_instruction(curr);
}

//: todo: do this in a transform, rather than magically in the 'return' instruction
:(after "Falling Through End Of Recipe")
try_reclaim_locals();
:(after "Starting Reply")
try_reclaim_locals();

:(code)
void try_reclaim_locals() {
  // only reclaim routines starting with 'local-scope'
  const recipe_ordinal r = get(Recipe_ordinal, current_recipe_name());
  const recipe& exiting_recipe = get(Recipe, r);
  if (exiting_recipe.steps.empty()) return;
  const instruction& inst = exiting_recipe.steps.at(0);
  if (inst.name_before_rewrite != "local-scope") return;
  // reclaim any local variables unless they're being returned
  vector<double> zeros;
  for (int i = /*leave default space for last*/1;  i < SIZE(exiting_recipe.steps);  ++i) {
    const instruction& inst = exiting_recipe.steps.at(i);
    for (int i = 0;  i < SIZE(inst.products);  ++i) {
      const reagent& product = inst.products.at(i);
      // local variables only
      if (has_property(product, "lookup")) continue;
      if (has_property(product, "raw")) continue;  // tests often want to check such locations after they run
      if (escaping(product)) continue;
      // End Checks For Reclaiming Locals
      trace(9999, "mem") << "clearing " << product.original_string << end();
      zeros.resize(size_of(product));
      write_memory(product, zeros);
    }
  }
  trace(9999, "mem") << "automatically abandoning " << current_call().default_space << end();
  abandon(current_call().default_space,
          inst.products.at(0).type->right,
          /*refcount*/1 + /*array length*/1 + /*number-of-locals*/Name[r][""]);
}

//: Reclaiming local variables above requires remembering what name an
//: instruction had before any rewrites or transforms.
:(before "End instruction Fields")
string name_before_rewrite;
:(before "End instruction Clear")
name_before_rewrite.clear();
:(before "End next_instruction(curr)")
curr->name_before_rewrite = curr->name;

:(code)
// is this reagent one of the values returned by the current (return) instruction?
// is the corresponding ingredient saved in the caller?
bool escaping(const reagent& r)
=encoding utf8
=head1 NAME

ranger - visual file manager




=head1 SYNOPSIS

B<ranger> [B<--version>] [B<--help>] [B<--debug>] [B<--clean>]
[B<--cachedir>=I<directory>] [B<--confdir>=I<directory>]
[B<--datadir>=I<directory>] [B<--copy-config>=I<which>]
[B<--choosefile>=I<target>] [B<--choosefiles>=I<target>]
[B<--choosedir>=I<target>] [B<--selectfile>=I<filepath>]
[B<--show-only-dirs>]
[B<--list-unused-keys>] [B<--list-tagged-files>=I<tag>]
[B<--profile>] [B<--cmd>=I<command>] [I<path ...>]




=head1 DESCRIPTION

ranger is a console file manager with VI key bindings.




=head1 RESOURCES

This I<manual> contains instructions on how to use and configure ranger.

Inside I<ranger>, you can press I<?> for a list of key bindings, commands or
settings.

The F<README> contains install instructions.

The file F<HACKING.md> contains guidelines for code modification.

The directory F<doc/configs> contains configuration files.  They are usually
installed to F</usr/share/doc/ranger/config> and can be obtained with ranger's
--copy-config option.

The directory F<examples> contains reference implementations for ranger
plugins, sample configuration files and some programs for integrating ranger
with other software.  They are usually installed to
F</usr/share/doc/ranger/examples>.

The man page of rifle(1) describes the functions of the file opener

The section I<LINKS> of this man page contains further resources.




=head1 POSITIONAL ARGUMENTS

=over 14

=item I<path ...>

Each path will be opened in a tab and if the path is a file it will be selected.
Omitting this is equivalent to providing the current directory.

=back




=head1 OPTIONS

=over 14

=item B<-d>, B<--debug>

Activate the debug mode: Whenever an error occurs, ranger will exit and print a
full traceback.  The default behavior is to merely print the name of the
exception in the statusbar/log and try to keep running.

=item B<-c>, B<--clean>

Activate the clean mode:  ranger will not access or create any configuration
files nor will it leave any traces on your system.  This is useful when your
configuration is broken, when you want to avoid clutter, etc.

=item B<--cachedir>=I<dir>

Change the cache directory of ranger from $XDG_CACHE_HOME or ~/.cache/ranger to "dir".

=item B<-r> I<dir>, B<--confdir>=I<dir>

Change the configuration directory of ranger from $XDG_CONFIG_HOME or ~/.config/ranger to "dir".

=item B<--datadir>=I<dir>

Change the data directory of ranger from $XDG_DATA_HOME or ~/.local/share/ranger to "dir".

=item B<--copy-config>=I<file>

Create copies of the default configuration files in your local configuration
directory.  Existing ones will not be overwritten.  Possible values: I<all>,
I<commands>, I<commands_full>, I<rc>, I<rifle>, I<scope>.

Note: You may want to disable loading of the global configuration files by
exporting I<RANGER_LOAD_DEFAULT_RC=FALSE> in your environment.  See also:
B<FILES>, B<ENVIRONMENT>

--copy-config=B<commands> will copy only a small sample configuration file with
a thoroughly commented example.  It is recommended to keep this file tidy to
avoid getting defunct commands on ranger upgrades.  The full default
commands.py can be copied with --copy-config=B<commands_full>, but that file
will be ignored by ranger and serves only as a reference for making your own
commands.

=item B<--choosefile>=I<targetfile>

Allows you to pick a file with ranger.  This changes the behavior so that when
you open a file, ranger will exit and write the absolute path of that file into
I<targetfile>.

=item B<--choosefiles>=I<targetfile>

Allows you to pick multiple files with ranger.  This changes the behavior so
that when you open a file, ranger will exit and write the absolute paths of all
selected files into I<targetfile>, adding one newline after each filename.

=item B<--choosedir>=I<targetfile>

Allows you to pick a directory with ranger.  When you exit ranger, it will
write the last visited directory into I<targetfile>.

=item B<--selectfile>=I<targetfile>

Open ranger with I<targetfile> selected. This is a legacy option, superseded by
the behavior for the POSITIONAL ARGUMENTS.

=item B<--show-only-dirs>

Display only the directories. May be used in conjunction with
B<--choosedir>=I<targetfile>.

=item B<--list-unused-keys>

List common keys which are not bound to any action in the "browser" context.
This list is not complete, you can bind any key that is supported by curses:
use the key code returned by C<getch()>.

=item B<--list-tagged-files>=I<tag>

List all files which are tagged with the given tag.  Note: Tags are single
characters.  The default tag is "*"

=item B<--profile>

Print statistics of CPU usage on exit.

=item B<--cmd>=I<command>

Execute the command after the configuration has been read.  Use this option
multiple times to run multiple commands.

=item B<--version>

Print the version and exit.

=item B<-h>, B<--help>

Print a list of options and exit.

=back




=head1 CONCEPTS

This part explains how certain parts of ranger work and how they can be used
efficiently.

=head2 TAGS

Tags are single characters which are displayed left of a filename.  You can use
tags however you want.  Press "t" to toggle tags and "ut" to remove any tags of
the selection. The default tag is an Asterisk ("*"), but you can use any tag by
typing I<"<tagnameE<gt>>.

=head2 PREVIEWS

By default, only text files are previewed, but you can enable external preview
scripts by setting the option C<use_preview_script> and C<preview_files> to true.

This default script is F<%rangerdir/data/scope.sh>. It contains more
documentation and calls to many external programs to generate previews. They
are automatically used when available but completely optional.

=over 2

=item For general usage:

=over 2

=item -

C<file> for determining file types

=item -

C<chardet> (Python package) for improved encoding detection of text files

=item -

C<sudo> to use the "run as root" feature

=item -

C<python-bidi> (Python package) to display right-to-left file names correctly
(Hebrew, Arabic)

=back

=item For enhanced file previews (with scope.sh):

=over 2

=item -

C<img2txt> (from C<caca-utils>) for ASCII-art image previews

=item -

C<w3mimgdisplay>, C<ueberzug>, C<mpv>, C<iTerm2>, C<kitty>, C<terminology> or
C<urxvt> for image previews

=item -

C<convert> (from C<imagemagick>) to auto-rotate images and for SVG previews

=item -

C<ffmpegthumbnailer> for video thumbnails

=item -

C<highlight>, C<bat> or C<pygmentize> for syntax highlighting of code

=item -

C<atool>, C<bsdtar>, C<unrar> and/or C<7z> to preview archives

=item -

C<bsdtar>, C<tar>, C<unrar>, C<unzip> and/or C<zipinfo> (and C<sed>) to preview archives as their first image

=item -

C<lynx>, C<w3m> or C<elinks> to preview html pages

=item -

C<pdftotext> or C<mutool> (and C<fmt>) for textual pdf previews, C<pdftoppm> to preview as image

=item -

C<djvutxt> for textual DjVu previews, C<ddjvu> to preview as image

=item -

C<calibre> or C<epub-thumbnailer> for image previews of ebooks

=item -

C<transmission-show> for viewing BitTorrent information

=item -

C<mediainfo> or C<exiftool> for viewing information about media files

=item -

C<odt2txt> for OpenDocument text files (odt, ods, odp and sxw)

=item -

C<python> or C<jq> for JSON files

=item -

C<fontimage> for font previews

=back

=back

Install these programs (just the ones you need) and scope.sh will automatically
use them.

Independently of the preview script, there is a feature to preview images
by drawing them directly into the terminal. To enable this feature, set the
option C<preview_images> to true and enable one of the image preview modes:

=head3 iTerm2

This only works in iTerm2 compiled with image preview support, but works over
ssh.

To enable this feature, set the option C<preview_images_method> to iterm2.

This feature relies on the dimensions of the terminal's font.  By default, a
width of 8 and height of 11 are used.  To use other values, set the options
C<iterm2_font_width> and C<iterm2_font_height> to the desired values.

=head3 kitty

This only works in Kitty. It requires PIL (or pillow) to work.
Allows remote image previews, for example in an ssh session.

To enable this feature, set the option C<preview_images_method> to kitty.

=head3 terminology

This only works in terminology. It can render vector graphics, but works only locally.

To enable this feature, set the option C<preview_images_method> to terminology.

=head3 ueberzug

Überzug is a command line utility which draws images on terminals using child
windows. It requires PIL (or pillow) and relies on X11. This makes it
compatible (in a limited way, i.e., tmux splits are not supported) with many
terminals and tmux but not the Linux console or Wayland.

To enable this feature, set the option C<preview_images_method> to ueberzug.

=head3 urxvt

This only works in urxvt compiled with pixbuf support. Does not work over ssh.

Essentially this mode sets an image as a terminal background temporarily, so it
will break any previously set image background.

To enable this feature, set the option C<preview_images_method> to urxvt.

=head3 urxvt-full

The same as urxvt but utilizing not only the preview pane but the whole terminal
window.

To enable this feature, set the option C<preview_images_method> to urxvt-full.

=head3 w3m

This does not work over ssh, requires certain terminals (tested on "xterm" and
"urxvt") and is incompatible with tmux, although it works with screen.

To enable this feature, install the program "w3m" and set the option
C<preview_images_method> to w3m.

When using a terminal with a nonzero border which is not automatically detected, the w3m preview will be misaligned.
Use the C<w3m_offset> option to manually adjust the image offset. This should be the same value as the terminal's border value.

=head2 SELECTION

The I<selection> is defined as "All marked files IF THERE ARE ANY, otherwise
the current file."  Be aware of this when using the :delete command, which
deletes all files in the selection.

You can mark files by pressing <Space>, v, etc.  A yellow B<Mrk> symbol at the
bottom right indicates that there are marked files in this directory.

=head2 MACROS

Macros can be used in commands to abbreviate things.

 %f   the highlighted file
 %d   the path of the current directory
 %s   the selected files in the current directory
 %t   all tagged files in the current directory
 %c   the full paths of the currently copied/cut files
 %p   the full paths of selected files

The macros %f, %d, %p, and %s also have upper case variants, %F, %D, %P, and
%S, which refer to the next tab.  To refer to specific tabs, add a number in
between.  (%7s = selection of the seventh tab.)

%c is the only macro which ranges out of the current directory. So you may
"abuse" the copying function for other purposes, like diffing two files which
are in different directories:

 Yank the file A (type yy), move to the file B, then type
 @diff %c %f

Macros for file paths are generally shell-escaped so they can be used in the
C<shell> command.

When mapping keys you can use the placeholder <any>, the key entered in that
position can be used through the %any and %any_path macros. (When using
multiple <any> placeholders you can index the macros: %any0, %any_path0, %any1,
%any_path1...) The macro %any will be replaced with the key pressed in the
position of the <any> placeholder. The macro %any_path will be replaced with
the path of the bookmark mapped to the key pressed in the position of the
<any> placeholder. For example this macro can be used to echo the key that was
pressed after "c":

 map c<any> echo %any

%any is used in the ranger configuration to create a keybinding for adding a
bookmark. c<set_bookmark> creates a bookmark for the current directory and the
key for the bookmark is the first supplied argument. In this case the key
pressed after "m":

 map m<any> set_bookmark %any

The %any_path macro can be used to echo the path of the bookmark that is set to
the key pressed after "c":

 map c<any> echo %any_path

A practical example of the use of %any_path is the pasting of cut/copied files
to a bookmarked directory:

 map p'<any> paste dest=%any_path

The macro %rangerdir expands to the directory of ranger's python library, you
can use it for something like this command:
 alias show_commands shell less %rangerdir/config/commands.py

%confdir expands to the directory given by B<--confdir>.

%datadir expands to the directory given by B<--datadir>.

The macro %space expands to a space character. You can use it to add spaces to
the end of a command when needed, while preventing editors to strip spaces off
the end of the line automatically.

To write a literal %, you need to escape it by writing %%.

Note that macros are expanded twice when using chain. For example, to insert
a space character in a chained command, you would write %%space:
 chain command1; command2%%space

=head2 BOOKMARKS

Type B<m<keyE<gt>> to bookmark the current directory. You can re-enter this
directory by typing B<`<keyE<gt>>. <key> can be any letter or digit.  Unlike vim,
both lowercase and uppercase bookmarks are persistent.

Each time you jump to a bookmark, the special bookmark at key ` will be set
to the last directory. So typing "``" gets you back to where you were before.

Bookmarks are selectable when tabbing in the :cd command.

Note: The bookmarks ' (Apostrophe) and ` (Backtick) are the same.

=head2 RIFLE

Rifle is the file opener of ranger.  It can be used as a standalone program or
a python module.  It is located at F<$repo/ranger/ext/rifle.py>.  In contrast to
other, more simple file openers, rifle can automatically find installed
programs so it can be used effectively out of the box on a variety of systems.

It's configured in F<rifle.conf> through a list of conditions and commands.
For each line the conditions are checked and if they are met, the respective
command is taken into consideration.  By default, simply the first matching
rule is used.  In ranger, you can list and choose rules by typing "r" or simply
by typing "<rulenumber><enter>".  If you use rifle standalone, you can list all
rules with the "-l" option and pick a rule with "-p <number>".

The rules, along with further documentation, are contained in
F<$repo/ranger/config/rifle.conf>.

=head2 FLAGS

Flags give you a way to modify the behavior of the spawned process.  They are
used in the commands C<:open_with> (key "r") and C<:shell> (key "!").

 f   Fork the process, i.e. run in background. Please use this flag
     instead of calling "disown" or "nohup", to avoid killing the
     background command when pressing Ctrl+C in ranger.
 c   Run the current file only, instead of the selection
 r   Run application with root privilege (requires sudo)
 t   Run application in a new terminal window

There are some additional flags that can currently be used only in the C<shell>
command: (for example C<:shell -w df>)

 p   Redirect output to the pager
 s   Silent mode.  Output will be discarded.
 w   Wait for an Enter-press when the process is done

By default, all the flags are off unless otherwise specified in F<rc.conf> key
bindings or F<rifle.conf> rules. You can specify as many flags as you want. An
uppercase flag negates the effect: "ffcccFsf" is equivalent to "cs".

The terminal program name for the "t" flag is taken from the environment
variable $TERMCMD.  If it doesn't exist, it tries to extract it from $TERM,
uses "x-terminal-emulator" as a fallback, and then "xterm" if that fails.

Examples: C<:open_with c> will open the file that you currently point at, even
if you have selected other files.  C<:shell -w df> will run "df" and wait for
you to press Enter before switching back to ranger.

=head2 PLUGINS

ranger's plugin system consists of python files which are located in
F<~/.config/ranger/plugins/> and are imported in alphabetical order when
starting ranger.  A plugin changes rangers behavior by overwriting or extending
a function that ranger uses.  This allows you to change pretty much every part
of ranger, but there is no guarantee that things will continue to work in
future versions as the source code evolves.

Adding new commands via a plugin as simple as specifying them like you would do
in the I<commands.py>.

There are some hooks that are specifically made for the use in plugins.  They
are functions that start with hook_ and can be found throughout the code.

 grep 'def hook_' -r /path/to/rangers/source

Also try:

 pydoc ranger.api

Note that you should NOT simply overwrite a function unless you know what
you're doing.  Instead, save the existing function and call it from your new
one.  This way, multiple plugins can use the same hook.  There are several
sample plugins in the F</usr/share/doc/ranger/examples/> directory, including a
hello-world plugin that describes this procedure.




=head1 KEY BINDINGS

Key bindings are defined in the file F<%rangerdir/config/rc.conf>.  Check this
file for a list of all key bindings.  You can copy it to your local
configuration directory with the --copy-config=rc option.

Many key bindings take an additional numeric argument.  Type I<5j> to move
down 5 lines, I<2l> to open a file in mode 2, I<10<SpaceE<gt>> to mark 10 files.

This list contains the most useful bindings:

=head2 MAIN BINDINGS

=over 14

=item h, j, k, l

Move left, down, up or right

=item ^D or J, ^U or K

Move a half page down, up

=item H, L

Move back and forward in the history

=item gg

Move to the top

=item G

Move to the bottom

=item [, ]

Move up and down in the parent directory.

=item ^R

Reload everything

=item F

Toggle I<freeze_files> setting.  When active (indicated by a cyan I<FROZEN>
message in the status bar), directories and files will not be loaded, improving
performance when all the files you need are already loaded.  This does not
affect file previews, which can be toggled with I<zI>.  Also try disabling the
preview of directories with I<zP>.

=item ^L

Redraw the screen

=item i

Inspect the current file in a bigger window.

=item E

Edit the current file in $VISUAL otherwise $EDITOR otherwise "vim"

=item S

Open a shell in the current directory

=item ?

Opens this man page

=item W

Opens the log window where you can review messages that pop up at the bottom.

=item w

Opens the task window where you can view and modify background processes that
currently run in ranger.  In there, you can type "dd" to abort a process and
"J" or "K" to change the priority of a process.  Only one process is run at a
time.

=item ^C

Stop the currently running background process that ranger has started, like
copying files, loading directories or file previews.

=item <octal>=, +<who><what>, -<who><what>

Change the permissions of the selection.  For example, C<777=> is equivalent to
C<chmod 777 %s>, C<+ar> does C<chmod a+r %s>, C<-ow> does C<chmod o-w %s> etc.

=item yy

Copy (yank) the selection, like pressing Ctrl+C in modern GUI programs.  (You
can also type "ya" to add files to the copy buffer, "yr" to remove files again,
or "yt" for toggling.)

=item dd

Cut the selection, like pressing Ctrl+X in modern GUI programs.  (There are
also "da", "dr" and "dt" shortcuts equivalent to "ya", "yr" and "yt".)

=item pp

Paste the files which were previously copied or cut, like pressing Ctrl+V in
modern GUI programs.

Conflicts will be renamed by appending an '_' (and a counter if necessary),
resulting in C<file.ext_>, C<file.ext_0>, etc. If you prefer C<file_.ext> you
can use the C<paste_ext> command.

=item po

Paste the copied/cut files, overwriting existing files.

=item pP, pO

Like pp and po, but queues the operation so that it will be executed I<after>
any other operations.  Reminder: type C<w> to open the task window.

=item pl, pL

Create symlinks (absolute or relative) to the copied files

=item phl

Create hardlinks to the copied files

=item pht

Duplicate the subdirectory tree of the copied directory, then create
hardlinks for each contained file into the new directory tree.

=item mI<X>

Create a bookmark with the name I<X>

=item `I<X>

Move to the bookmark with the name I<X>

=item n

Find the next file.  By default, this gets you to the newest file in the
directory, but if you search something using the keys /, cm, ct, ..., it will
get you to the next found entry.

=item N

Find the previous file.

=item oI<X>

Change the sort method (like in mutt)

=item zI<X>

Change settings.  See the settings section for a list of settings and their
hotkey.

=item uI<?>

Universal undo-key.  Depending on the key that you press after "u", it either
restores closed tabs (uq), removes tags (ut), clears the copy/cut buffer (ud),
starts the reversed visual mode (uV) or clears the selection (uv).

=item f

Quickly navigate by entering a part of the filename.

=item Space

Mark a file.

=item v

Toggle the mark-status of all files

=item V

Starts the visual mode, which selects all files between the starting point and
the cursor until you press ESC.  To unselect files in the same way, use "uV".

=item /

Search for files in the current directory.

=item :

Open the console.

=item !

Open the console with the content "shell " so you can quickly run commands

=item @

Open the console with the content "shell  %s", placing the cursor before the
" %s" so you can quickly run commands with the current selection as the
argument.

=item r

Open the console with the content "open with " so you can decide which program
to use to open the current file selection.

=item cd

Open the console with the content "cd "

=item ^P

Open the console with the most recent command.

=item Alt-I<N>

Open a tab. N has to be a number from 0 to 9. If the tab doesn't exist yet, it
will be created.

=item Alt-l, Alt-r

Shift a tab left, respectively right.

=item gn, ^N

Create a new tab.

=item gt, gT

Go to the next or previous tab. You can also use TAB and SHIFT+TAB instead.

=item gc, ^W

Close the current tab.  The last tab cannot be closed this way.

=item M

A key chain that allows you to quickly change the line mode of all the files of
the current directory.  For a more permanent solution, use the command
"default_linemode" in your rc.conf.

=item .d

Apply the typefilter "directory".

=item .f

Apply the typefilter "file".

=item .l

Apply the typefilter "symlink".

=item .m

Apply a new mimetype filter.

=item .n

Apply a new filename filter.

=item .#

Apply a new hash filter.

=item ."

Apply a new duplicate filter.

=item .'

Apply a new unique filter.

=item .|

Combine the two topmost filters from the filter stack in the C<OR>
relationship, instead of the C<AND> used implicitly.

=item .&

Explicitly combine the two topmost filters in the C<AND> relationship.
Usually not needed because filters are implicitly in this relationship though
might be useful in more complicated scenarios.

=item .!

Negate the topmost filter.

=item .r

Rotate the filter stack by N elements. Where N is provided as a numeric prefix
like vim's I<count> and defaults to 1, i.e. move the topmost element to the
bottom of the stack.

=item .c

Clear the filter stack.

=item .*

Decompose the topmost filter combinator (e.g. C<.!>, C<.|>).

=item .p

Pop the topmost filter from the filter stack.

=item ..

Show the current filter stack state.

=back

=head2 READLINE-LIKE BINDINGS IN THE CONSOLE

=over 14

=item ^B, ^F

Move left and right (B for back, F for forward)

=item ^P, ^N

Move up and down (P for previous, N for Next)

=item ^A, ^E

Move to the start or to the end

=item Alt-B, Alt-LEFT

Move backwards by words.

=item Alt-F, Alt-RIGHT

Move forwards by words.

=item ^D

Delete the current character.

=item ^H

Backspace.

=back


=head1 MOUSE BUTTONS

=over

=item Left Mouse Button

Click on something and you'll move there.

=item Right Mouse Button

Enter a directory or run a file. To run a file you can either right click the
file in the main column or right click on the preview.

=item Scroll Wheel

Scrolls up or down.  You can point at the column of the parent directory while
scrolling to switch directories.

=back




=head1 SETTINGS

This section lists all built-in settings of ranger.  The valid types for the
value are in [brackets].  The hotkey to toggle the setting is in <brakets>, if
a hotkey exists.

Settings can be changed in the file F<~/.config/ranger/rc.conf> or on the
fly with the command B<:set option value>.  Examples:

 set column_ratios 1,2,3
 set show_hidden true

Toggling options can be done with:

 set show_hidden!

The different types of settings and an example for each type:

 setting type   | example values
 ---------------+----------------------------
 bool           | true, false
 integer        | 1, 23, 1337
 string         | foo, hello world
 list           | 1,2,3,4
 none           | none

You can view a list of all settings and their current values by pressing "3?"
in ranger.

=over

=item automatically_count_files [bool]

Should ranger count and display the number of files in each directory
as soon as it's visible?  This gets slow with remote file systems.  Turning it
off will still allow you to see the number of files after entering the
directory.

=item autosave_bookmarks [bool]

Save bookmarks (used with mX and `X) instantly?  This helps to synchronize
bookmarks between multiple ranger instances but leads to *slight* performance
loss.  When false, bookmarks are saved when ranger is exited.

=item autoupdate_cumulative_size [bool]

You can display the "real" cumulative size of directories by using the command
:get_cumulative_size or typing "dc".  The size is expensive to calculate and
will not be updated automatically.  You can choose to update it automatically
though by turning on this option.

=item cd_bookmarks [bool]

Specify whether bookmarks should be included in the tab completion of the "cd"
command.

=item cd_tab_case [string]

Changes case sensitivity for the "cd" command tab completion. Possible values are:

 sensitive
 insensitive
 smart

=item cd_tab_fuzzy [bool]

Use fuzzy tab completion with the "cd" command. For example,
B<:cd /u/lo/b<TABE<gt>> expands to B<:cd /usr/local/bin>.

=item clear_filters_on_dir_change [bool]

If set to 'true', persistent filters would be cleared upon leaving the directory

=item collapse_preview [bool] <zc>

When no preview is visible, should the last column be squeezed to make use of
the whitespace?

=item colorscheme [string]

Which colorscheme to use?  These colorschemes are available by default:
B<default>, B<jungle>, B<snow>.  Snow is a monochrome scheme, jungle replaces
blue directories with green ones for better visibility on certain terminals.

=item column_ratios [list]

How many columns are there, and what are their relative widths?  For example, a
value of 1,1,1 would mean 3 evenly sized columns. 1,1,1,1,4 means 5 columns
with the preview column being as large as the other columns combined.

=item confirm_on_delete [string]

Ask for a confirmation when running the "delete" command?  Valid values are
"always" (default), "never", "multiple". With "multiple", ranger will ask only
if you delete multiple files at once.

=item dirname_in_tabs [bool]

Display the directory name in tabs?

=item display_size_in_main_column [bool]

Display the file size in the main column?

=item display_size_in_status_bar [bool]

Display the file size in the status bar?

=item display_free_space_in_status_bar [bool]

Display the free disk space in the status bar?

=item display_tags_in_all_columns [bool]

Display tags in all columns?

=item draw_borders [string]

Draw borders around or between the columns? Possible values are:

 none           no borders of any sort
 outline        draw an outline around all the columns
 separators     draw only vertical lines between columns
 both           both of the above

=item draw_borders_multipane [string]

Draw borders around or between the panes. This setting overrides
I<draw_borders> specifically for the multipane viewmode in case you want
different border styles in both viewmodes. There's one additional legal value
on top of those for I<draw_borders>:

 active-pane    draw an outline around the active pane only

=item draw_progress_bar_in_status_bar [bool]

Draw a progress bar in the status bar which displays the average state of all
currently running tasks which support progress bars?

=item flushinput [bool] <zi>

Flush the input after each key hit?  One advantage is that when scrolling down
with "j", ranger stops scrolling instantly when you release the key.  One
disadvantage is that when you type commands blindly, some keys might get lost.

=item freeze_files [bool] <F>

When active, directories and files will not be loaded, improving performance
when all the files you need are already loaded.  This does not affect file
previews.

=item global_inode_type_filter [string]

Like filter_inode_type, but globally for all directories.  Useful in
combination with B<--choosedir>:

 ranger --choosedir=/tmp/x --cmd='set global_inode_type_filter d'

=item hidden_filter [string]

A regular expression pattern for files which should be hidden.  For example,
this pattern will hide all files that start with a dot or end with a tilde.

 set hidden_filter ^\.|~$

=item hint_collapse_threshold [int]

The key hint lists up to this size have their sublists expanded.
Otherwise the submaps are replaced with "...".

=item hostname_in_titlebar [bool]

Show hostname in titlebar?

=item size_in_bytes [bool]

Print file sizes in bytes instead of the default human-readable format.

=item idle_delay [integer]

The delay that ranger idly waits for user input, in milliseconds, with a
resolution of 100ms.  Lower delay reduces lag between directory updates but
increases CPU load.

=item iterm2_font_height [integer]

Change the assumed font height in iTerm2, which may help with iTerm image
previews

=item iterm2_font_width [integer]

Change the assumed font width in iTerm2, which may help with iTerm image
previews

=item line_numbers [string]

Show line numbers in main column.  Possible values are:

 false      turn the feature off
 absolute   absolute line numbers for use with "<N>gg"
 relative   relative line numbers for "<N>k" or "<N>j"

=item max_console_history_size [integer, none]

How many console commands should be kept in history?  "none" will disable the
limit.

=item max_history_size [integer, none]

How many directory changes should be kept in history?

=item metadata_deep_search [bool]

When the metadata manager module looks for metadata, should it only look for a
".metadata.json" file in the current directory, or do a deep search and check
all directories above the current one as well?

=item mouse_enabled [bool] <zm>

Enable mouse input?

=item nested_ranger_warning [string]

Warn at startup if C<RANGER_LEVEL> is greater than 0, in other words give a
warning when you nest ranger in a subshell started by ranger. Allowed values
are C<true>, C<false> and C<error>. The special value C<error> promotes the
warning to an error, this is usually shown as red text but will crash ranger
when run with the C<--debug> flag.

=item one_indexed [bool]

Start line numbers from 1.  Possible values are:

 false      start line numbers from 0
 true       start line numbers from 1

=item open_all_images [bool]

Open all images in this directory when running certain image viewers like feh
or sxiv?  You can still open selected files by marking them.

If there would be too many files for the system to handle, this option
will be temporarily disabled automatically.

=item padding_right [bool]

When collapse_preview is on and there is no preview, should there remain a
little padding on the right?  This allows you to right click into that space to
run the file.

=item preview_directories [bool] <zP>

Preview directories in the preview column?

=item preview_files [bool] <zp>

Preview files in the preview column?

=item preview_images [bool]

Draw images inside the console with the external program w3mimgpreview?

=item preview_images_method [string]

Set the preview image method. Supported methods: w3m, iterm2, urxvt,
urxvt-full, terminology.  See I<PREVIEWS> section.

=item preview_max_size [int]

Avoid previewing files that exceed a certain size, in bytes.  Use a value of 0
to disable this feature.

=item preview_script [string, none]

Which script should handle generating previews?  If the file doesn't exist, or
use_preview_script is off, ranger will handle previews itself by just printing
the content.

=item relative_current_zero [bool]

When line_numbers is set to relative, show 0 on the current line if
true or show the absolute number of the current line when false.

=item save_backtick_bookmark [bool]

Save the C<`> bookmark to disk.  This bookmark is used to switch to the last
directory by typing C<``>.

=item save_console_history [bool]

Should the console history be saved on exit?  If disabled, the console history
is reset when you restart ranger.

=item save_tabs_on_exit [bool]

Save all tabs, except the active, on exit? The last saved tabs are restored once
when starting the next session. Multiple sessions are stored in a stack and the
oldest saved tabs are restored first.

=item scroll_offset [integer]

Try to keep this much space between the top/bottom border when scrolling.

=item shorten_title [integer]

Trim the title of the window if it gets long?  The number defines how many
directories are displayed at once. A value of 0 turns off this feature.

=item show_cursor [bool]

Always show the terminal cursor?

=item show_hidden_bookmarks [bool]

Show dotfiles in the bookmark preview window? (Type ')

=item show_hidden [bool] <zh>, <^H>

Show hidden files?

=item show_selection_in_titlebar [bool]

Add the highlighted file to the path in the titlebar

=item sort_case_insensitive [bool] <zc>

Sort case-insensitively?  If true, "a" will be listed before "B" even though
its ASCII value is higher.

=item sort_directories_first [bool] <zd>

Sort directories first?

=item sort_reverse [bool] <or>

Reverse the order of files?

=item sort_unicode [bool]

When sorting according to some string, should the unicode characters be
compared, instead of looking at the raw character values to save time?

=item sort [string] <oa>, <ob>, <oc>, <oe>, <om>, <on>, <ot>, <os>, <oz>

Which sorting mechanism should be used?  Choose one of B<atime>, B<basename>,
B<ctime>, B<extension>, B<mtime>, B<natural>, B<type>, B<size>, B<random>

Note: You can reverse the order by typing an uppercase second letter in the key
combination, e.g. "oN" to sort from Z to A.

=item status_bar_on_top [bool]

Put the status bar at the top of the window?

=item tilde_in_titlebar [bool]

Abbreviate $HOME with ~ in the titlebar (first line) of ranger?

=item unicode_ellipsis [bool]

Use a unicode "..." character instead of "~" to mark cut-off filenames?

=item bidi_support [bool]

Try to properly display file names in RTL languages (Hebrew, Arabic) by using
a BIDI algorithm to reverse the relevant parts of the text.
Requires the python-bidi pip package.

=item update_title [bool]

Set a window title? Updates both the I<WM_NAME> and I<WM_ICON_NAME> properties.

=item update_tmux_title [bool]

Set the tmux/screen I<window-name> to "ranger"?

=item use_preview_script [bool] <zv>

Use the preview script defined in the setting I<preview_script>?

=item vcs_aware [bool]

Gather and display data about version control systems. Supported vcs: git, hg.

=item vcs_backend_git, vcs_backend_hg, vcs_backend_bzr, vcs_backend_svn [string]

Sets the state for the version control backend. The possible values are:

 disabled   Don't display any information.
 local      Display only local state.
 enabled    Display both, local and remote state.
            May be slow for hg and bzr.

=item vcs_msg_length [int]

Length to truncate first line of the commit messages to when shown in
the statusbar.  Defaults to 50.

=item viewmode [string]

Sets the view mode, which can be B<miller> to display the files in the
traditional miller column view that shows multiple levels of the hierarchy, or
B<multipane> to use multiple panes (one per tab) similar to midnight-commander.

=item w3m_delay [float]

Delay in seconds before displaying an image with the w3m method.
Increase it in case of experiencing display corruption.

=item w3m_offset [int]

Offset in pixels for the inner border of the terminal. Some terminals require
the offset to be specified explicitly, among others st and UXterm, some don't
like urxvt.

=item wrap_plaintext_previews [bool]

Whether or not to wrap long lines in the pager, this includes previews of plain
text files.

=item wrap_scroll [bool]

Enable scroll wrapping - moving down while on the last item will wrap around to
the top and vice versa.

=item xterm_alt_key [bool]

Enable this if key combinations with the Alt Key don't work for you.
(Especially on xterm)

=back


=head1 COMMANDS

You can enter the commands in the console which is opened by pressing ":".

You can always get a list of the currently existing commands by typing "?c" in
ranger.  For your convenience, this is a list of the "public" commands including their parameters, excluding descriptions:

 alias [newcommand] [oldcommand]
 bulkrename
 cd [path]
 chain command1[; command2[; command3...]]
 chmod octal_number
 cmap key command
 console [-pSTARTPOSITION | -s SENTINEL] command
 copycmap key newkey [newkey2...]
 copymap key newkey [newkey2...]
 copypmap key newkey [newkey2...]
 copytmap key newkey [newkey2...]
 cunmap keys...
 default_linemode [path=regexp | tag=tags] linemodename
 delete
 echo [text]
 edit [filename]
 eval [-q] python_code
 filter [string]
 filter_inode_type [dfl]
 find pattern
 flat level
 grep pattern
 help
 jump_non [-FLAGS...]
 linemode linemodename
 load_copy_buffer
 map key command
 mark pattern
 mark_tag [tags]
 meta key value
 mkdir dirname
 open_with [application] [flags] [mode]
 pmap key command
 prompt_metadata [key1 [key2 [...]]]
 punmap keys...
 quit
 quit!
 quitall
 quitall!
 relink newpath
 rename_append [-FLAGS...]
 rename newname
 save_copy_buffer
 scout [-FLAGS...] pattern
 search pattern
 search_inc pattern
 set option value
 setintag tags option value
 setlocal [path=<path>] option value
 shell [-FLAGS...] command
 source filename
 terminal
 tmap key command
 touch filename
 trash
 travel pattern
 tunmap keys...
 unmap keys...
 unmark pattern
 unmark_tag [tags]

There are additional commands which are directly translated to python
functions, one for every method in the ranger.core.actions.Actions class.
They are not documented here, since they are mostly for key bindings, not to be
typed in by a user.  Read the source if you are interested in them.

These are the public commands including their descriptions:

=over 2

=item alias [I<newcommand>] [I<oldcommand>]

Copies the oldcommand as newcommand.

=item bulkrename

This command opens a list of selected files in an external editor.  After you
edit and save the file, it will generate a shell script which does bulk
renaming according to the changes you did in the file.

This shell script is opened in an editor for you to review.  After you close
it, it will be executed.

=item cd [I<path>]

The cd command changes the directory.  If path is a file, selects that file.
The command C<:cd -> is equivalent to typing ``.

=item chain I<command1>[; I<command2>[; I<command3>...]]

Combines multiple commands into one, separated by semicolons.

=item chmod I<octal_number>

Sets the permissions of the selection to the octal number.

The octal number is between 000 and 777. The digits specify the permissions for
the user, the group and others.  A 1 permits execution, a 2 permits writing, a
4 permits reading.  Add those numbers to combine them. So a 7 permits
everything.

Key bindings in the form of [-+]<who><what> and <octal>= also exist.  For
example, B<+ar> allows reading for everyone, -ow forbids others to write and
777= allows everything.

See also: man 1 chmod

=item console [-pI<N> | -s I<sentinel>] I<command>

Opens the console with the command already typed in. The cursor is placed at
I<N> or at the first occurrence of I<sentinel>. Note that sentinel strings can
potentially occur inside macro expansions. If you cannot provide a sentinel
which is guaranteed to be unique, you should use C<-p>.

=item copymap  I<key> I<newkey> [I<newkey2> ...]

=item copycmap I<key> I<newkey> [I<newkey2> ...]

=item copypmap I<key> I<newkey> [I<newkey2> ...]

=item copytmap I<key> I<newkey> [I<newkey2> ...]

Copies the keybinding I<key> to I<newkey> in the "browser" context.  This is a
deep copy, so if you change the new binding (or parts of it) later, the old one
is not modified. For example, I<copymap j down> will make the key sequence
"down" move the cursor down one item.

To copy key bindings of the console, pager or taskview use "copycmap",
"copypmap" or "copytmap" respectively.

=item default_linemode [I<path=regexp> | I<tag=tags>] I<linemodename>

Sets the default linemode.  See I<linemode> command.

Examples:

Set the global default linemode to "permissions":
 :default_linemode permissions

Set the default linemode to "permissions" for all files tagged with "p" or "P":
 :default_linemode tag=pP permissions

Set the default linemode for all files in ~/books/ to "metatitle":
 :default_linemode path=/home/.*?/books/.* metatitle

=item delete

Destroy all files in the selection with a roundhouse kick.  ranger will ask for
a confirmation if you attempt to delete multiple (marked) files or non-empty
directories.  This can be changed by modifying the setting "confirm_on_delete".

=item echo I<text>

Display the text in the statusbar.

=item edit [I<filename>]

Edit the current file or the file in the argument.

=item eval [I<-q>] I<python_code>

Evaluates the python code.  `fm' is a reference to the FM instance.  To display
text, use the function `p'.  The result is displayed on the screen unless you
use the "-q" option.

Examples:
 :eval fm
 :eval len(fm.tabs)
 :eval p("Hello World!")

=item filter [I<string>]

Displays only the files which contain the I<string> in their basename.  Running
this command without any parameter will reset the filter.

This command is based on the I<scout> command and supports all of its options.

=item filter_inode_type [dfl]

Displays only the files of specified inode type. To display only directories,
use the 'd' parameter. To display only files, use the 'f' parameter. To display
only links, use the 'l' parameter. Parameters can be combined. To remove this
filter, use no parameter.

=item filter_stack [I<command> [I<args>]]

Manage the filter stack, adding, removing and manipulating filters. For
example, to show only duplicate files and symlinks:

  :filter_stack add type f
  :filter_stack add duplicate
  :filter_stack add and
  :filter_stack add type l
  :filter_stack add or

Or using the mapped keys:

  .f ." .& .l .|

Available subcommands:

=over 2

=item add FILTER_TYPE [ARGS...]

Add a new filter to the top of the filter stack. Each filter on the stack is
applied in turn, resulting in an implicit logical C<AND> relation. The
following C<FILTER_TYPE>s are available:

=over 2

=item duplicate

Filter files so only files that have duplicates in the same directory are
shown. Useful when cleaning up identical songs and memes that were saved using
distinct file names.

=item filename NAME

Filter files that contain NAME in the filename, regular expression syntax is
allowed.

=item hash PATH

Filter files so only files with the same hash as PATH are shown.

=item mimetype TYPE

Filter files of a certain MIME type, regular expression syntax is allowed.

=item typefilter [d|f|l]

Filter files of a certain type, C<d> for directories, C<f> for files and C<l>
for symlinks.

=item unique

Filter files so only unique files and the oldest file of every set of
duplicates is shown.

=item and

Explicitly combine the two topmost filters in the "AND" relationship.
Usually not needed because filters are implicitly in this relationship though
might be useful in more complicated scenarios.

=item not

Negate the topmost filter.

=item or

Combine the two topmost filters from the filter stack in the "OR"
relationship, instead of the "AND" used implicitly.

=back

=item pop

Pop the topmost filter from the filter stack.

=item decompose

Decompose the topmost filter combinator (e.g. C<.!>, C<.|>).

=item rotate [N=1]

Rotate the filter stack by N elements. Where N is passed as argument or as a
numeric prefix like vim's I<count>, default to 1, i.e. move the topmost element
to the bottom of the stack.

=item clear

Clear the filter stack.

=item show

Show the current filter stack state.

=back

=item find I<pattern>

Search files in the current directory that contain the given (case-insensitive)
string in their name as you type.  Once there is an unambiguous result, it will
be run immediately. (Or entered, if it's a directory.)

This command is based on the I<scout> command and supports all of its options.

=item flat level

Flattens the directory view up to the specified level. Level -1 means infinite
level. Level 0 means standard view without flattened directory view. Level
values -2 and less are invalid.

=item grep I<pattern>

Looks for a string in all marked files or directories.

=item help

Provides a quick way to view ranger documentations.

=item jump_non [-I<flags>...]

Jumps to first non-directory if highlighted file is a directory and vice versa.

Flags:
 -r    Jump in reverse order
 -w    Wrap around if reaching end of filelist

=item linemode I<linemodename>

Sets the linemode of all files in the current directory.  The linemode may be:

 "filename":
   display each line as "<basename>...<size>"
 "fileinfo":
   display each line as "<basename>...<file(1) output>"
 "mtime":
   display each line as "<basename>...<mtime>" in ISO format
 "humanreadablemtime":
   display each line as "<basename>...<mtime>" in a human readable
   format, more precise the more recent.
 "sizemtime":
   display each line as "<basename>...<size> <mtime>" in ISO format
 "humanreadablesizemtime":
   display each line as "<basename>...<size> <mtime>" in a human
   readable format, more precise the more recent.
 "permissions":
   display each line as "<permissions> <owner> <group> <basename>"
 "metatitle":
   display metadata from .metadata.json files if available, fall back
   to the "filename" linemode if no metadata was found.
   See :meta command.

The custom linemodes may be added by subclassing the I<LinemodeBase> class.
See the I<ranger.core.linemode> module for some examples.

=item load_copy_buffer

Load the copy buffer from F<~/.config/ranger/copy_buffer>.  This can be used to
pass the list of copied files to another ranger instance.

=item map  I<key> I<command>

=item cmap I<key> I<command>

=item pmap I<key> I<command>

=item tmap I<key> I<command>

Assign the key combination to the given command.  Whenever you type the
key/keys, the command will be executed.  Additionally, if you use a quantifier
when typing the key, like 5j, it will be passed to the command as the attribute
"self.quantifier".

The keys you bind with this command are accessible in the file browser only,
not in the console, pager or taskview.  To bind keys there, use the commands
"cmap", "pmap" or "tmap".

=item mark I<pattern>

Mark all files matching the regular expression pattern.

This command is based on the I<scout> command and supports all of its options.

=item mark_tag [I<tags>]

Mark all tags that are tagged with either of the given tags.  When leaving out
the tag argument, all tagged files are marked.

=item meta I<key> I<value>

Set the metadata of the currently highlighted file.  Example:

 :meta title The Hitchhiker's Guide to the Galaxy
 :meta year 1979

This metadata can be displayed by, for example, using the "metatitle" line mode
by typing Mt.

=item mkdir I<dirname>

Creates a directory with the name I<dirname>.

=item open_with [I<application>] [I<flags>] [I<mode>]

Open the selected files with the given application, unless it is omitted, in
which case the default application is used.  I<flags> change the way the
application is executed and are described in their own section in this man
page.  The I<mode> is a number that specifies which application to use.  The list
of applications is generated by the external file opener "rifle" and can be
displayed when pressing "r" in ranger.

Note that if you specify an application, the mode is ignored.

=item prompt_metadata [I<keys ...>]

Prompt the user to input metadata with the C<meta> command for multiple keys in
a row.

=item quit

Closes the current tab, if there's only one tab. Otherwise quits if there are no tasks in progress.
The current directory will be bookmarked as ' so you can re-enter it by typing `` or '' the next time you
start ranger.

=item quit!

Like C<quit>, except will force quit even if tasks are in progress.

=item quitall

Like C<quit>, except will quit even if multiple tabs are open.

=item quitall!

Like C<quitall>, except will force quit even if tasks are in progress.

=item relink I<newpath>

Change the link destination of the current symlink file to <newpath>. First
<tab> will load the original link.

=item rename I<newname>

Rename the current file.  If a file with that name already exists, the renaming
will fail.  Also try the key binding A for appending something to a file name.

=item rename_append [-I<flags>...]

Opens the console with ":rename <current file>" with the cursor positioned
before the file extension.

Flags:
 -a    Position before all extensions
 -r    Remove everything before extensions

=item save_copy_buffer

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.

Flags:
 -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
 -r    Interpret pattern as a regular expression pattern
 -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)
regular expression pattern.

This command is based on the I<scout> command and supports all of its options.

=item search_inc I<pattern>

Search files in the current directory that match the given (case insensitive)
regular expression pattern.  This command gets you to matching files as you
type.

This command is based on the I<scout> command and supports all of its options.

=item set I<option> I<value>

Assigns a new value to an option.  Valid options are listed in the settings
section.  Use tab completion to get the current value of an option, though this
doesn't work for functions and regular expressions. Valid values are:

 setting type   | example values
 ---------------+----------------------------
 bool           | true, false
 integer        | 1, 23, 1337
 string         | foo, hello world
 list           | 1,2,3,4
 none           | none

=item setintag I<tags> I<option> I<value>

Assigns a new value to an option, but locally for the directories that are
marked with I<tag>.  This means, that this option only takes effect when
visiting that directory.

For example, to change the sorting order in your downloads directory, tag it
with the I<v> tag by typing I<"v>, then use this command:

 setintag v sort ctime

=item setlocal [path=I<path>] I<option> I<value>

Assigns a new value to an option, but locally for the directory given by
I<path>. This means, that this option only takes effect when visiting that
directory. If no path is given, uses the current directory.

I<path> is a regular expression.  This means that C<path=~/dl> applies to all
paths that start with I<~/dl>, e.g. I<~/dl2> and I<~/dl/foo>. To avoid this,
use C<path=~/dl$>.

I<path> can be quoted with either single or double quotes to prevent unwanted
splitting. I<path='~/dl dl$'> or I<path="~/dl dl$">

=item shell [-I<flags>] I<command>

Run a shell command.  I<flags> are discussed in their own section.

=item source I<filename>

Reads commands from a file and executes them in the ranger console.

This can be used to re-evaluate the rc.conf file after changing it:

 map X chain shell vim -p %confdir/rc.conf %rangerdir/config/rc.conf; \
                   source %confdir/rc.conf

=item scroll_preview I<value>

Scroll the file preview by I<value> lines.

=item terminal

Spawns the I<x-terminal-emulator> starting in the current directory.

=item touch I<filename>

Creates an empty file with the name I<filename>, unless it already exists.

=item trash

Move all files in the selection to the trash using rifle. Rifle tries to use a
trash manager like I<trash-cli> if available but will fall back to moving files
to either F<$XDG_DATA_HOME/ranger/trash> or F<~/.local/share/ranger/trash>.
This is a less permanent version of I<delete>, relying on the user to clear out
the trash whenever it's convenient. While having the possibility of restoring
trashed files until this happens. ranger will ask for a confirmation if you
attempt to trash multiple (marked) files or non-empty directories. This can be
changed by modifying the setting "confirm_on_delete".

=item travel I<pattern>

Filters the current directory for files containing the letters in the
string, possibly with other letters in between.  The filter is applied as
you type.  When only one directory is left, it is entered and the console
is automatically reopened, allowing for fast travel.
To close the console, press ESC or execute a file.

This command is based on the I<scout> command and supports all of its options.

=item unmap  [I<keys> ...]

=item cunmap [I<keys> ...]

=item punmap [I<keys> ...]

=item tunmap [I<keys> ...]

Removes the given key mappings in the "browser" context.  To unmap key bindings
in the console, pager, or taskview use "cunmap", "punmap" or "tunmap".

=item unmark I<pattern>

Unmark all files matching a regular expression pattern.

This command is based on the I<scout> command and supports all of its options.

=item unmark_tag [I<tags>]

Unmark all tags that are tagged with either of the given tags.  When leaving
out the tag argument, all tagged files are unmarked.

=back




=head1 FILES

ranger reads several configuration files which are located in
F<$HOME/.config/ranger> or F<$XDG_CONFIG_HOME/ranger> if $XDG_CONFIG_HOME is
defined.  You can use the --copy-config option to obtain the default
configuration files.  The files contain further documentation.

F<rc.conf>, F<commands.py> and F<colorschemes> do not need to be copied fully
as they will only be adding to the default configuration files except if explicitly
overridden. This may lead to some confusing situations, for example when a key is
being bound despite the corresponding line being removed from the user's copy of
the configuration file. This behavior may be disabled with an environment
variable (see also: B<ENVIRONMENT>). Note: All other configuration files only
read from one source; i.e. default OR user, not both.
F<rc.conf> and F<commands.py> are additionally read from F</etc/ranger> if they
exist for system-wide configuration, user configuration overrides system
configuration which overrides the default configuration.

When starting ranger with the B<--clean> option, it will not access or create
any of these files.

=head2 CONFIGURATION

=over 10

=item rc.conf

Contains a list of commands which are executed on startup.  Mostly key bindings
and settings are defined here.

=item commands.py

A python module that defines commands which can be used in ranger's console by
typing ":" or in the rc.conf file.  Note that you can define commands in the
same manner within plugins.

=item commands_full.py

This file is copied by --copy-config=commands_full and serves as a reference
for custom commands.  It is entirely ignored by ranger.

=item rifle.conf

This is the configuration file for the built-in file launcher called "rifle".

=item scope.sh

This is a script that handles file previews.  When the options
I<use_preview_script> and I<preview_files> are set, the program specified in
the option I<preview_script> is run and its output and/or exit code determines
rangers reaction.

=item colorschemes/

Colorschemes can be placed here.

=item plugins/

Plugins can be placed here.

=back

=head2 STORAGE

=over 10

=item bookmarks

This file contains a list of bookmarks.  The syntax is /^(.):(.*)$/. The first
character is the bookmark key and the rest after the colon is the path to the
file.  In ranger, bookmarks can be set by typing m<key>, accessed by typing
'<key> and deleted by typing um<key>.

=item copy_buffer

When running the command :save_copy_buffer, the paths of all currently copied
files are saved in this file.  You can later run :load_copy_buffer to copy the
same files again, pass them to another ranger instance or process them in a
script.

=item history

Contains a list of commands that have been previously typed in.

=item tagged

Contains a list of tagged files. The syntax is /^(.:)?(.*)$/ where the first
letter is the optional name of the tag and the rest after the optional colon is
the path to the file.  In ranger, tags can be set by pressing t and removed
with T.  To assign a named tag, type "<tagname>.

=back




=head1 ENVIRONMENT

These environment variables have an effect on ranger:

=over 8

=item RANGER_LEVEL

ranger sets this environment variable to "1" or increments it if it already
exists.  External programs can determine whether they were spawned from ranger
by checking for this variable.

=item RANGER_LOAD_DEFAULT_RC

If this variable is set to FALSE, ranger will not load the default rc.conf.
This can save time if you copied the whole rc.conf to I<~/.config/ranger/> and
don't need the default one at all.

=item VISUAL

Defines the editor to be used for the "E" key.  Falls back to EDITOR if
undefined or empty.

=item EDITOR

Defines the editor to be used for the "E" key if VISUAL is undefined or empty.
Defaults to "vim".

=item SHELL

Defines the shell that ranger is going to use with the :shell command and
the "S" key.  Defaults to "/bin/sh".

=item TERMCMD

Defines the terminal emulator command that ranger is going to use with the
:terminal command and the "t" run flag.  Defaults to "xterm".

=item BAT_THEME

Specifies the theme to be used for syntax highlighting when I<bat> is
installed, unless I<highlight> is also installed. Find out possible values by
running C<bat --list-themes>.

=item PYGMENTIZE_STYLE

Specifies the theme to be used for syntax highlighting when I<pygmentize> is
installed, unless I<highlight> is also installed. Find out possible values by
running:
 python -c 'import pygments.styles; [print(stl) for stl in
 pygments.styles.get_all_styles()]'

=item HIGHLIGHT_STYLE

Specifies the theme to be used for syntax highlighting when I<highlight> is
installed. Find out possible values by running C<highlight --list-themes>.

=item HIGHLIGHT_TABWIDTH

Specifies the number of spaces to use to replace tabs in I<highlight>ed files.

=item HIGHLIGHT_OPTIONS

I<highlight> will pick up command line options specified in this variable. A
C<--style=> option specified here will override C<HIGHLIGHT_STYLE>. Similarly,
C<--replace-tabs=> will override C<HIGHLIGHT_TABWIDTH>.

=item OPENSCAD_COLORSCHEME

Specifies the colorscheme used by I<openscad> while previewing 3D models. Read
I<openscad> man page for colorschemes. Ranger will default to Tomorrow Night.

=item OPENSCAD_IMGSIZE

Specifies the internal resolution I<openscad> will use for rendering 3D models.
The image will be downscaled to fit the preview pane. This resolution will
default to "1000,1000" if no value is set.

=item XDG_CONFIG_HOME

Specifies the directory for configuration files. Defaults to F<$HOME/.config>.

=item PYTHONOPTIMIZE

This variable determines the optimize level of python.

Using PYTHONOPTIMIZE=1 (like python -O) will make python discard assertion
statements.  You will gain efficiency at the cost of losing some debug info.

Using PYTHONOPTIMIZE=2 (like python -OO) will additionally discard any
docstrings.  Using this will disable the <F1> key on commands.

=item W3MIMGDISPLAY_PATH

By changing this variable, you can change the path of the executable file for
image previews.  By default, it is set to F</usr/lib/w3m/w3mimgdisplay>.

=back




=head1 EXAMPLES

There are various examples on how to extend ranger with plugins or combine
ranger with other programs.  These can be found in the
F</usr/share/doc/ranger/examples/> directory, or the F<doc/ranger/> that is
provided along with the source code.




=head1 LICENSE

GNU General Public License 3 or (at your option) any later version.




=head1 LINKS

=over

=item Download: L<https://ranger.github.io/ranger-stable.tar.gz>

=item The project page: L<https://ranger.github.io/>

=item The mailing list: L<https://savannah.nongnu.org/mail/?group=ranger>

=item IRC channel: #ranger on irc.libera.chat

=back

ranger is maintained with the git version control system.  To fetch a fresh
copy, run:

 git clone git@github.com:ranger/ranger.git




=head1 SEE ALSO

rifle(1)




=head1 BUGS

Report bugs here: L<https://github.com/ranger/ranger/issues>

Please include as much relevant information as possible.  For the most
diagnostic output, run ranger like this: C<PYTHONOPTIMIZE= ranger --debug>