Merge branch 'linemode'

1 files changed, 66 insertions, 0 deletions

diff --git a/doc/ranger.pod b/doc/ranger.pod
index 370bbb85..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
@@ -674,6 +680,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 +825,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 +946,21 @@ See C<copymap>
 
 Removes key mappings of the console. Works like the C<unmap> command.
 
+=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 "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 +1001,15 @@ This command is based on the I<scout> command and supports all of its options.
 
 Looks for a string in all marked files or directories.
 
+=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>"
+ "permissions": display each line as "<permissions> <owner> <group> <basename>"
+ "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 +1052,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<authors>
+
+Tells the paper manager to set/update the authors of the current file
+
+=item paper_title I<title>
+
+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.