diff options
| author | hut <hut@lepus.uberspace.de> | 2016-05-24 15:22:01 +0200 |
|---|---|---|
| committer | hut <hut@lepus.uberspace.de> | 2016-05-24 15:23:30 +0200 |
| commit | fe56c9c8494f961505c6f63d9814f961ec070ae3 (patch) | |
| tree | 085ba8ec49f0d459febfc335a287cb9775494746 | |
| parent | e9091956d414bf599d9a3c5f452dc345f72e92ba (diff) | |
| download | ranger-fe56c9c8494f961505c6f63d9814f961ec070ae3.tar.gz | |
Manpage: added documentation about commands in plugins
| -rw-r--r-- | doc/ranger.1 | 8 | ||||
| -rw-r--r-- | doc/ranger.pod | 6 |
2 files changed, 11 insertions, 3 deletions
diff --git a/doc/ranger.1 b/doc/ranger.1 index ac655e78..7e57307e 100644 --- a/doc/ranger.1 +++ b/doc/ranger.1 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "RANGER 1" -.TH RANGER 1 "ranger-1.7.2" "04/15/2016" "ranger manual" +.TH RANGER 1 "ranger-1.7.2" "05/24/2016" "ranger manual" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -406,6 +406,9 @@ 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. .PP +Adding new commands via a plugin as simple as specifying them like you would do +in the \fIcommands.py\fR. +.PP 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. .PP @@ -1287,7 +1290,8 @@ and settings are defined here. .IP "commands.py" 10 .IX Item "commands.py" A python module that defines commands which can be used in ranger's console by -typing \*(L":\*(R" or in the rc.conf file. +typing \*(L":\*(R" or in the rc.conf file. Note that you can define commands in the +same manner within plugins. .IP "commands_full.py" 10 .IX Item "commands_full.py" This file is copied by \-\-copy\-config=commands_full and serves as a reference diff --git a/doc/ranger.pod b/doc/ranger.pod index 6b5b1593..a21bcde0 100644 --- a/doc/ranger.pod +++ b/doc/ranger.pod @@ -302,6 +302,9 @@ 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. @@ -1358,7 +1361,8 @@ 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. +typing ":" or in the rc.conf file. Note that you can define commands in the +same manner within plugins. =item commands_full.py |