From 97dc99931dd83b618f0b92cfd04b36173fcbc3dd Mon Sep 17 00:00:00 2001
From: Sighery <Sighery@users.noreply.github.com>
Date: Sat, 12 Oct 2019 00:03:45 +0200
Subject: Document the usage of ? (help)

---
 doc/cheatsheet.svg | 175 +++++++++++++++++++++++++++++------------------------
 1 file changed, 96 insertions(+), 79 deletions(-)

(limited to 'doc')

diff --git a/doc/cheatsheet.svg b/doc/cheatsheet.svg
index ac5cb4af..0a6e46e7 100644
--- a/doc/cheatsheet.svg
+++ b/doc/cheatsheet.svg
@@ -11,8 +11,8 @@
    xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
    xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
    width="1126"
-   height="830.00006"
-   viewBox="0 0 1126 830.00006"
+   height="842.93494"
+   viewBox="0 0 1126 842.93494"
    id="svg2"
    version="1.1"
    inkscape:version="0.92.4 5da689c313, 2019-01-14"
@@ -28,20 +28,20 @@
      borderopacity="1.0"
      inkscape:pageopacity="1"
      inkscape:pageshadow="2"
-     inkscape:zoom="2.8284271"
-     inkscape:cx="748.92357"
-     inkscape:cy="792.3976"
+     inkscape:zoom="0.99999999"
+     inkscape:cx="513.15525"
+     inkscape:cy="556.04639"
      inkscape:document-units="px"
      inkscape:current-layer="layer1"
      showgrid="true"
      units="mm"
-     inkscape:snap-bbox="false"
+     inkscape:snap-bbox="true"
      inkscape:bbox-paths="false"
      inkscape:bbox-nodes="true"
      inkscape:snap-text-baseline="true"
-     inkscape:snap-bbox-edge-midpoints="false"
+     inkscape:snap-bbox-edge-midpoints="true"
      inkscape:snap-nodes="false"
-     inkscape:snap-others="true"
+     inkscape:snap-others="false"
      inkscape:window-width="1920"
      inkscape:window-height="1056"
      inkscape:window-x="1920"
@@ -62,8 +62,8 @@
        spacingx="1"
        spacingy="1"
        enabled="true"
-       originx="-0.47216608"
-       originy="89.065153" />
+       originx="-0.47216607"
+       originy="102.00002" />
   </sodipodi:namedview>
   <metadata
      id="metadata7">
@@ -3414,23 +3414,23 @@
        id="g4738-4-8-1"
        transform="translate(710,-149.99998)">
       <rect
-         ry="1.02696e-15"
-         rx="2.1094199e-15"
-         y="676.86218"
-         x="175.5"
-         height="18.999977"
-         width="79"
+         ry="1.0240459e-15"
+         rx="2.3034712e-15"
+         y="676.86078"
+         x="175.5786"
+         height="18.946062"
+         width="86.267426"
          id="rect4230-1-8-4-4-9-9"
-         style="fill:#ffcc00;fill-opacity:1;stroke:#000000;stroke-width:0.99999994;stroke-opacity:1" />
+         style="fill:#ffcc00;fill-opacity:1;stroke:#000000;stroke-width:1.04350078;stroke-opacity:1" />
       <rect
-         ry="1.02696e-15"
-         rx="2.1094199e-15"
-         y="657.86218"
-         x="175.5"
-         height="18.999977"
-         width="79"
+         ry="1.0240459e-15"
+         rx="2.3034712e-15"
+         y="657.91467"
+         x="175.5786"
+         height="18.946062"
+         width="86.267426"
          id="rect4230-7-3-84-5-8"
-         style="fill:#ffcc00;fill-opacity:1;stroke:#ff0000;stroke-width:3;stroke-linecap:butt;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
+         style="fill:#ff7f2a;fill-opacity:1;stroke:#ff0000;stroke-width:3.13050246;stroke-linecap:butt;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1" />
       <text
          id="text4247-6-2-02-0-2"
          y="672.36218"
@@ -3446,13 +3446,15 @@
          id="text4251-5-3-5-7-2"
          y="670.36218"
          x="190"
-         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:'Sans, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:Sans;-inkscape-font-specification:Sans;text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
          xml:space="preserve"><tspan
-           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:80.00000119%;font-family:sans-serif;-inkscape-font-specification:'Sans, Normal';text-align:start;writing-mode:lr-tb;text-anchor:start"
+           style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:10px;line-height:80.00000119%;font-family:Sans;-inkscape-font-specification:Sans;text-align:start;writing-mode:lr-tb;text-anchor:start"
            y="670.36218"
            x="190"
            sodipodi:role="line"
-           id="tspan4438-4-1-4-5">show help</tspan></text>
+           id="tspan4438-4-1-4-5">show help <tspan
+   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:Sans;-inkscape-font-specification:'Sans Bold'"
+   id="tspan5329">(6)</tspan></tspan></text>
       <text
          id="text4247-5-2-9-2-8-5"
          y="691.36218"
@@ -4058,14 +4060,14 @@
          style="font-weight:normal;font-size:15px;line-height:1.25;font-family:sans-serif"
          id="tspan5624">They can be escaped by replacing % with %%.</tspan></text>
     <rect
-       style="fill:#e6e6e6;fill-opacity:1;stroke:#000000;stroke-width:0.99999994;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       style="fill:#e6e6e6;fill-opacity:1;stroke:#000000;stroke-width:1.02173042;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
        id="rect5634"
-       width="689"
-       height="289"
-       x="430.5"
-       y="602.86218"
-       rx="2.1094199e-15"
-       ry="1.0269601e-15" />
+       width="688.97827"
+       height="301.70618"
+       x="430.51086"
+       y="602.87305"
+       rx="2.1093534e-15"
+       ry="1.0721115e-15" />
     <text
        xml:space="preserve"
        style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:'Sans, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
@@ -4155,7 +4157,7 @@
          style="font-size:15px;line-height:1.25;font-family:sans-serif"
          id="tspan6426"><tspan
    style="font-weight:bold;font-family:sans-serif"
-   id="tspan6475">(4) d </tspan>also starts the keybindings <tspan
+   id="tspan6475">(4) d </tspan>also starts the key bindings <tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan6432">dc</tspan> (calculate size of the content of a directory), <tspan
    style="font-weight:bold;font-family:sans-serif"
@@ -4202,25 +4204,40 @@
          x="433.52783"
          y="880.79724"
          style="font-style:italic;font-size:15px;line-height:1.25;font-family:sans-serif"
-         id="tspan6483">/usr/share/doc/ranger/examples/plugin_linemode.py</tspan></text>
+         id="tspan6483">/usr/share/doc/ranger/examples/plugin_linemode.py</tspan><tspan
+         sodipodi:role="line"
+         x="433.52783"
+         y="899.54724"
+         style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-size:15px;line-height:1.25;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold'"
+         id="tspan5331">(6) ?<tspan
+   style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:sans-serif"
+   id="tspan5341"> starts the key bindings <tspan
+   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold'"
+   id="tspan5343">m</tspan> (man page), <tspan
+   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold'"
+   id="tspan5345">k</tspan> (key bindings), <tspan
+   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold'"
+   id="tspan5347">c</tspan> (commands), <tspan
+   style="font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;font-family:sans-serif;-inkscape-font-specification:'sans-serif Bold'"
+   id="tspan5349">s</tspan> (settings)</tspan></tspan></text>
     <rect
-       style="fill:#e6e6e6;fill-opacity:1;stroke:#000000;stroke-width:1;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       style="fill:#e6e6e6;fill-opacity:1;stroke:#000000;stroke-width:1.02717781;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
        id="rect5539-8"
-       width="414"
-       height="233.99998"
-       x="5.5"
-       y="842.86218"
-       rx="2.1094199e-15"
-       ry="1.0269599e-15" />
+       width="413.97375"
+       height="246.9077"
+       x="5.5135803"
+       y="842.87579"
+       rx="2.1092861e-15"
+       ry="1.0836082e-15" />
     <text
        xml:space="preserve"
        style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:'Sans, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
        x="9.5532236"
-       y="858.75867"
+       y="862.75867"
        id="text5541-5"><tspan
          sodipodi:role="line"
          x="9.5532236"
-         y="858.75867"
+         y="862.75867"
          style="font-weight:bold;font-size:15px;line-height:1.25;font-family:sans-serif"
          id="tspan5756">Config files<tspan
    style="font-weight:normal;font-family:sans-serif"
@@ -4229,83 +4246,83 @@
    id="tspan5762">&quot; to</tspan></tspan><tspan
          sodipodi:role="line"
          x="9.5532236"
-         y="877.50867"
+         y="881.50867"
          style="font-weight:normal;font-size:15px;line-height:1.25;font-family:sans-serif"
          id="tspan5772">copy the default config files to ~/.config/ranger/.</tspan></text>
     <text
        xml:space="preserve"
        style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:'Sans, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
        x="9.3225098"
-       y="901.85925"
+       y="905.85925"
        id="text5776"><tspan
          sodipodi:role="line"
          id="tspan5778"
          x="9.3225098"
-         y="901.85925"
+         y="905.85925"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"><tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan5782">rc.conf</tspan>: A list of commands that are executed when ranger</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="917.48425"
+         y="921.48425"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5780">starts. Options, key bindings and aliases are found here.</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="933.10925"
+         y="937.10925"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5816">Pro tip: Adding &quot;export RANGER_LOAD_DEFAULT_RC=FALSE&quot; to</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="948.73425"
+         y="952.73425"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5820">your shell rc will skip loading the default rc.conf before your own.</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="964.35925"
+         y="968.35925"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5828"><tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan5830">commands.py</tspan>: A python script containing custom commands</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="979.98425"
+         y="983.98425"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5836"><tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan5834">rifle.conf</tspan>: Rules for rifle, the file opener. Each line looks like</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="995.60925"
+         y="999.60925"
          style="font-style:italic;font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5842">    list of conditions = command</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="1011.2343"
+         y="1015.2343"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5844">When ranger opens a file, it tests those conditions. The first</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="1026.8593"
+         y="1030.8593"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5846">command where all conditions are true will be executed.</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="1042.4843"
+         y="1046.4843"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5854"><tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan5856">scope.sh</tspan>: The script that generates file previews.</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="1058.1093"
+         y="1062.1093"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5858">Plugins can be put in the <tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan5860">plugins/ </tspan>subdirectory, colorschemes</tspan><tspan
          sodipodi:role="line"
          x="9.3225098"
-         y="1073.7343"
+         y="1077.7343"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5864">in<tspan
    style="font-weight:bold;font-family:sans-serif"
@@ -4324,65 +4341,65 @@
    style="font-weight:bold;font-family:sans-serif"
    id="tspan5683">#ranger</tspan> on irc.freenode.net</tspan></text>
     <rect
-       style="fill:#e6e6e6;fill-opacity:1;stroke:#000000;stroke-width:0.99999994;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
+       style="fill:#e6e6e6;fill-opacity:1;stroke:#000000;stroke-width:1.0020833;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
        id="rect5634-3"
-       width="689"
-       height="173.99998"
-       x="430.5"
-       y="902.86224"
-       rx="2.1094199e-15"
-       ry="1.0269601e-15" />
+       width="688.99841"
+       height="174.7262"
+       x="430.50052"
+       y="915.06982"
+       rx="2.1094151e-15"
+       ry="1.0312463e-15" />
     <text
        xml:space="preserve"
        style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:'Sans, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
        x="434.37744"
-       y="916.85925"
+       y="928.85925"
        id="text5541-2"><tspan
          sodipodi:role="line"
          x="434.37744"
-         y="916.85925"
+         y="928.85925"
          style="font-weight:normal;font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4932"><tspan
    id="tspan4923"
    style="font-weight:bold;font-size:12.5px;font-family:sans-serif">Commands</tspan> can be typed in by pressing : or added to ~/.config/ranger/rc.conf to apply then whenever</tspan><tspan
          sodipodi:role="line"
          x="434.37744"
-         y="932.48425"
+         y="944.48425"
          style="font-weight:normal;font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4931">ranger starts. All commands are listed in the man page. Some important ones:</tspan></text>
     <text
        xml:space="preserve"
        style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;line-height:0%;font-family:sans-serif;-inkscape-font-specification:'Sans, Normal';text-align:start;letter-spacing:0px;word-spacing:0px;writing-mode:lr-tb;text-anchor:start;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
        x="434.66431"
-       y="948.36206"
+       y="960.36206"
        id="text5776-0"><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="948.36206"
+         y="960.36206"
          style="font-weight:bold;font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5864-8">:shell [&lt;flags&gt;] &lt;command&gt;<tspan
    style="font-weight:normal;font-family:sans-serif"
    id="tspan4899"> calls the given &lt;command&gt; with the shell specified in the environment</tspan></tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="963.98706"
+         y="975.98706"
          style="font-weight:normal;font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4907">variable $SHELL. &lt;flags&gt; can be &quot;-f&quot; to fork the process or &quot;-p&quot; to pipe the output to a pager. Macros like</tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="979.61206"
+         y="991.61206"
          style="font-weight:normal;font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4905">%f and %s are especially useful here. Example: &quot;:shell -f inkscape %f&quot; or &quot;:shell sudo cp %c ./&quot;</tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="995.23706"
+         y="1007.2371"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4895"><tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan4897">:alias &lt;new&gt; &lt;old&gt;</tspan> creates the command &lt;new&gt; that calls &lt;old&gt;. The neat thing is that you can pass</tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="1010.8621"
+         y="1022.8621"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4935">arguments to the next command. Example: &quot;:alias <tspan
    style="font-family:sans-serif;fill:#ff0000"
@@ -4393,26 +4410,26 @@
    id="tspan5114">touch</tspan> FILE&quot;,</tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="1026.4871"
+         y="1038.4871"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan5116">which will be translated to &quot;:<tspan
    style="font-family:sans-serif;fill:#0000ff"
    id="tspan5118">shell touch</tspan> FILE&quot;.</tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="1042.1121"
+         y="1054.1121"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4915"><tspan
    style="font-weight:bold;font-family:sans-serif"
    id="tspan4933">:map &lt;key&gt; &lt;command&gt;</tspan> makes the &lt;key&gt; run &lt;command&gt; when pressed. This is the typical way to</tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="1057.7371"
+         y="1069.7371"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4917">define key bindings in rc.conf. There is also &quot;pmap&quot; to define keys in the pager and &quot;unmap&quot; and &quot;punmap&quot;</tspan><tspan
          sodipodi:role="line"
          x="434.66431"
-         y="1073.3621"
+         y="1085.3621"
          style="font-size:12.5px;line-height:1.25;font-family:sans-serif"
          id="tspan4924">to remove key bindings.</tspan></text>
     <g
-- 
cgit 1.4.1-2-gfad0