diff options
| -rw-r--r-- | doc/ranger.1 | 63 | ||||
| -rw-r--r-- | doc/ranger.pod | 66 |
2 files changed, 57 insertions, 72 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index 49339bf2..b27aa9f3 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.6.1" "01/01/2015" "ranger manual" +.TH RANGER 1 "ranger-1.6.1" "01/17/2015" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -686,14 +686,14 @@ limit. .IP "max_history_size [integer, none]" 4 .IX Item "max_history_size [integer, none]" How many directory changes should be kept in history? +.IP "metadata_deep_search [bool]" 4 +.IX Item "metadata_deep_search [bool]" +When the metadata manager module looks for metadata, should it only look for a +\&\*(L".metadata.json\*(R" file in the current directory, or do a deep search and check +all directories above the current one as well? .IP "mouse_enabled [bool] <zm>" 4 .IX Item "mouse_enabled [bool] <zm>" Enable mouse input? -.IP "papermanager_deep_search [bool]" 4 -.IX Item "papermanager_deep_search [bool]" -When the paper manager module looks for metadata, should it only look for a -\&\*(L".paperinfo\*(R" file in the current directory, or do a deep search and check all -directories above the current one as well? .IP "padding_right [bool]" 4 .IX Item "padding_right [bool]" When collapse_preview is on and there is no preview, should there remain a @@ -822,14 +822,11 @@ ranger. For your convenience, this is a list of the \*(L"public\*(R" commands i \& map key command \& mark pattern \& mark_tag [tags] +\& meta key value \& mkdir dirname \& open_with [application] [flags] [mode] -\& paper -\& paper_authors [authors] -\& paper_title [title] -\& paper_url [url] -\& paper_year [year] \& pmap key command +\& prompt_metadata [key1 [key2 [...]]] \& punmap keys... \& quit \& quit! @@ -930,8 +927,8 @@ Set the global default linemode to \*(L"permissions\*(R": Set the default linemode to \*(L"permissions\*(R" for all files tagged with \*(L"p\*(R" or \*(L"P\*(R": :default_linemode tag=pP permissions .Sp -Set the default linemode for all files in ~/books/ to \*(L"papertitle\*(R": - :default_linemode path=/home/.*?/books/.* papertitle +Set the default linemode for all files in ~/books/ to \*(L"metatitle\*(R": + :default_linemode path=/home/.*?/books/.* metatitle .IP "delete" 2 .IX Item "delete" Destroy all files in the selection with a roundhouse kick. ranger will ask for @@ -981,11 +978,12 @@ Looks for a string in all marked files or directories. .IX Item "linemode linemodename" Sets the linemode of all files in the current directory. The linemode may be: .Sp -.Vb 4 +.Vb 5 \& "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. +\& "metatitle": display metadata from .metadata.json files if +\& available, fall back to the "filename" linemode if no +\& metadata was found. See :meta command. .Ve .IP "load_copy_buffer" 2 .IX Item "load_copy_buffer" @@ -1010,6 +1008,17 @@ This command is based on the \fIscout\fR command and supports all of its options .IX Item "mark_tag [tags]" Mark all tags that are tagged with either of the given tags. When leaving out the tag argument, all tagged files are marked. +.IP "meta \fIkey\fR \fIvalue\fR" 2 +.IX Item "meta key value" +Set the metadata of the currently highlighted file. Example: +.Sp +.Vb 2 +\& :meta title The Hitchhiker\*(Aqs Guide to the Galaxy +\& :meta year 1979 +.Ve +.Sp +This metadata can be displayed by, for example, using the \*(L"metatitle\*(R" line mode +by typing Mt. .IP "mkdir \fIdirname\fR" 2 .IX Item "mkdir dirname" Creates a directory with the name \fIdirname\fR. @@ -1023,27 +1032,13 @@ of applications is generated by the external file opener \*(L"rifle\*(R" and can displayed when pressing \*(L"r\*(R" in ranger. .Sp Note that if you specify an application, the mode is ignored. -.IP "paper" 2 -.IX 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 \*(L"linemode\*(R" to \*(L"papertitle\*(R". -.IP "paper_authors \fIauthors\fR" 2 -.IX Item "paper_authors authors" -Tells the paper manager to set/update the authors of the current file -.IP "paper_title \fItitle\fR" 2 -.IX Item "paper_title title" -Tells the paper manager to set/update the title of the current file -.IP "paper_url \fIurl\fR" 2 -.IX Item "paper_url url" -Tells the paper manager to set/update the url of the current file -.IP "paper_year \fIyear\fR" 2 -.IX Item "paper_year year" -Tells the paper manager to set/update the year of the current file .IP "pmap \fIkey\fR \fIcommand\fR" 2 .IX Item "pmap key command" Binds keys for the pager. Works like the \f(CW\*(C`map\*(C'\fR command. +.IP "prompt_metadata [\fIkeys ...\fR]" 2 +.IX Item "prompt_metadata [keys ...]" +Prompt the user to input metadata with the \f(CW\*(C`meta\*(C'\fR command for multiple keys in +a row. .IP "punmap [\fIkeys ...\fR]" 2 .IX Item "punmap [keys ...]" Removes key mappings of the pager. Works like the \f(CW\*(C`unmap\*(C'\fR command. diff --git a/doc/ranger.pod b/doc/ranger.pod index 279e44fd..67297d18 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -676,15 +676,15 @@ limit. How many directory changes should be kept in history? -=item mouse_enabled [bool] <zm> +=item metadata_deep_search [bool] -Enable mouse input? +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 papermanager_deep_search [bool] +=item mouse_enabled [bool] <zm> -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? +Enable mouse input? =item padding_right [bool] @@ -839,14 +839,11 @@ ranger. For your convenience, this is a list of the "public" commands including map key command mark pattern mark_tag [tags] + meta key value mkdir dirname open_with [application] [flags] [mode] - paper - paper_authors [authors] - paper_title [title] - paper_url [url] - paper_year [year] pmap key command + prompt_metadata [key1 [key2 [...]]] punmap keys... quit quit! @@ -961,8 +958,8 @@ Set the global default linemode to "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 +Set the default linemode for all files in ~/books/ to "metatitle": + :default_linemode path=/home/.*?/books/.* metatitle =item delete @@ -1023,8 +1020,9 @@ 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. + "metatitle": display metadata from .metadata.json files if + available, fall back to the "filename" linemode if no + metadata was found. See :meta command. =item load_copy_buffer @@ -1053,6 +1051,16 @@ This command is based on the I<scout> command and supports all of its options. 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>. @@ -1068,33 +1076,15 @@ 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. +=item prompt_metadata [I<keys ...>] + +Prompt the user to input metadata with the C<meta> command for multiple keys in +a row. + =item punmap [I<keys ...>] Removes key mappings of the pager. Works like the C<unmap> command. |