From bf6158a1088c7e2bb1f83d6a48c8de3f9c9c88f6 Mon Sep 17 00:00:00 2001 From: hut Date: Fri, 5 Dec 2014 01:39:10 +0100 Subject: doc/ranger.1: added documentation on linemodes and :paper commands --- doc/ranger.pod | 60 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) (limited to 'doc/ranger.pod') diff --git a/doc/ranger.pod b/doc/ranger.pod index 370bbb85..43003380 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -674,6 +674,12 @@ How many directory changes should be kept in history? Enable mouse input? +=item papermanager_deep_search [bool] + +When the paper manager module looks for metadata, should it only look for a +".paperinfo" file in the current directory, or do a deep search and check all +directories above the current one as well? + =item padding_right [bool] When collapse_preview is on and there is no preview, should there remain a @@ -813,18 +819,25 @@ ranger. For your convenience, this is a list of the "public" commands including copypmap key newkey [newkey2...] copytmap key newkey [newkey2...] cunmap keys... + default_linemode [path=regexp | tag=tags] linemodename delete edit [filename] eval [-q] python_code filter [string] find pattern grep pattern + linemode linemodename load_copy_buffer map key command mark pattern mark_tag [tags] mkdir dirname open_with [application] [flags] [mode] + paper + paper_authors [authors] + paper_title [title] + paper_url [url] + paper_year [year] pmap key command punmap keys... quit @@ -927,6 +940,21 @@ See C Removes key mappings of the console. Works like the C command. +=item default_linemode [I | I] I + +Sets the default linemode. See I 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 "papertitle": + :default_linemode path=/home/.*?/books/.* papertitle + =item delete Destroy all files in the selection with a roundhouse kick. ranger will ask for @@ -967,6 +995,15 @@ This command is based on the I command and supports all of its options. Looks for a string in all marked files or directories. +=item linemode I + +Sets the linemode of all files in the current directory. The linemode may be: + + "filename": display each line as "..." + "permissions": display each line as " " + "papertitle": display metadata from .paperinfo files if available, fall back + to the "filename" linemode if no metadata was found. See :paper commands. + =item load_copy_buffer Load the copy buffer from F<~/.config/ranger/copy_buffer>. This can be used to @@ -1009,6 +1046,29 @@ displayed when pressing "r" in ranger. Note that if you specify an application, the mode is ignored. +=item paper + +This command opens a series of commands on the console that will ask the user +to input metadata about the current file. This is used by the paper manager +module of ranger and can be later displayed in ranger, for example by setting +the option "linemode" to "papertitle". + +=item paper_authors I + +Tells the paper manager to set/update the authors of the current file + +=item paper_title I + +Tells the paper manager to set/update the title of the current file + +=item paper_url I<url> + +Tells the paper manager to set/update the url of the current file + +=item paper_year I<year> + +Tells the paper manager to set/update the year of the current file + =item pmap I<key> I<command> Binds keys for the pager. Works like the C<map> command. -- cgit 1.4.1-2-gfad0 From 8e0e465774d541181f27cd9e92a79ed01c84d115 Mon Sep 17 00:00:00 2001 From: hut <hut@lepus.uberspace.de> Date: Fri, 5 Dec 2014 01:44:16 +0100 Subject: doc/ranger.1: document M* keybindings --- doc/ranger.1 | 5 +++++ doc/ranger.pod | 6 ++++++ 2 files changed, 11 insertions(+) (limited to 'doc/ranger.pod') diff --git a/doc/ranger.1 b/doc/ranger.1 index 5b245dd8..27de2aa9 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -539,6 +539,11 @@ Go to the next or previous tab. You can also use \s-1TAB\s0 and \s-1SHIFT+TAB\s0 .IP "gc, ^W" 14 .IX Item "gc, ^W" Close the current tab. The last tab cannot be closed this way. +.IP "M" 14 +.IX 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 +\&\*(L"default_linemode\*(R" in your rc.conf. .SS "READLINE-LIKE \s-1BINDINGS IN THE CONSOLE\s0" .IX Subsection "READLINE-LIKE BINDINGS IN THE CONSOLE" .IP "^B, ^F" 14 diff --git a/doc/ranger.pod b/doc/ranger.pod index 43003380..7a6de447 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -490,6 +490,12 @@ Go to the next or previous tab. You can also use TAB and SHIFT+TAB instead. 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. + =back =head2 READLINE-LIKE BINDINGS IN THE CONSOLE -- cgit 1.4.1-2-gfad0