diff options
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/README | 2 | ||||
| -rw-r--r-- | examples/plugin_chmod_keybindings.py | 18 | ||||
| -rw-r--r-- | examples/plugin_file_filter.py | 17 | ||||
| -rw-r--r-- | examples/plugin_hello_world.py | 21 | ||||
| -rw-r--r-- | examples/plugin_new_macro.py | 17 | ||||
| -rw-r--r-- | examples/plugin_new_sorting_method.py | 7 | ||||
| -rw-r--r-- | examples/plugin_skip_default_rc.py | 9 | ||||
| -rw-r--r-- | examples/rifle_different_file_opener.conf | 7 |
8 files changed, 97 insertions, 1 deletions
diff --git a/examples/README b/examples/README index 60f29ac6..8606a89d 100644 --- a/examples/README +++ b/examples/README @@ -1,2 +1,2 @@ -Thes files in this directory contain applications or extensions of ranger which +The files in this directory contain applications or extensions of ranger which are put here for your inspiration and as references. diff --git a/examples/plugin_chmod_keybindings.py b/examples/plugin_chmod_keybindings.py new file mode 100644 index 00000000..62ca6c58 --- /dev/null +++ b/examples/plugin_chmod_keybindings.py @@ -0,0 +1,18 @@ +# This plugin serves as an example for adding key bindings through a plugin. +# It could replace the ten lines in the rc.conf that create the key bindings +# for the "chmod" command. + +import ranger.api +old_hook_init = ranger.api.hook_init + +def hook_init(fm): + old_hook_init(fm) + + # Generate key bindings for the chmod command + command = "map {0}{1}{2} shell -d chmod {1}{0}{2} %s" + for mode in list('ugoa') + '': + for perm in "rwxXst": + fm.execute_console(command.format('-', mode, perm)) + fm.execute_console(command.format('+', mode, perm)) + +ranger.api.hook_init = hook_init diff --git a/examples/plugin_file_filter.py b/examples/plugin_file_filter.py new file mode 100644 index 00000000..99d026bb --- /dev/null +++ b/examples/plugin_file_filter.py @@ -0,0 +1,17 @@ +# This plugin hides the directories "boot", "sbin", "proc" and "sys" in the +# root directory. + +# Save the original filter function +import ranger.fsobject.directory +old_accept_file = ranger.fsobject.directory.accept_file + +# Define a new one +def custom_accept_file(fname, mypath, hidden_filter, name_filter): + if hidden_filter and mypath == '/' and fname in ('boot', 'sbin', 'proc', 'sys'): + return False + else: + return old_accept_file(fname, mypath, hidden_filter, name_filter) + +# Overwrite the old function +import ranger.fsobject.directory +ranger.fsobject.directory.accept_file = custom_accept_file diff --git a/examples/plugin_hello_world.py b/examples/plugin_hello_world.py new file mode 100644 index 00000000..187f428e --- /dev/null +++ b/examples/plugin_hello_world.py @@ -0,0 +1,21 @@ +# This is a sample plugin that displays "Hello World" in ranger's console after +# it started. + +# We are going to extend the hook "ranger.api.hook_ready", so first we need +# to import ranger.api: +import ranger.api + +# Save the previously existing hook, because maybe another module already +# extended that hook and we don't want to lose it: +old_hook_ready = ranger.api.hook_ready + +# Create a replacement for the hook that... +def hook_ready(fm): + # ...does the desired action... + fm.notify("Hello World") + # ...and calls the saved hook. If you don't care about the return value, simply + # return the return value of the previous hook to be on the safe side. + return old_hook_ready(fm) + +# Finally, "monkey patch" the existing hook_ready function with our replacement: +ranger.api.hook_ready = hook_ready diff --git a/examples/plugin_new_macro.py b/examples/plugin_new_macro.py new file mode 100644 index 00000000..ec0c487c --- /dev/null +++ b/examples/plugin_new_macro.py @@ -0,0 +1,17 @@ +# This plugin adds the new macro %date which is substituted with the current +# date in commands that allow macros. You can test it with the command +# ":shell echo %date; read" + +# Save the original macro function +import ranger.core.actions +old_get_macros = ranger.core.actions.Actions._get_macros + +# Define a new macro function +import time +def get_macros_with_date(self): + macros = old_get_macros(self) + macros['date'] = time.strftime('%m/%d/%Y') + return macros + +# Overwrite the old one +ranger.core.actions.Actions._get_macros = get_macros_with_date diff --git a/examples/plugin_new_sorting_method.py b/examples/plugin_new_sorting_method.py new file mode 100644 index 00000000..2500c1c1 --- /dev/null +++ b/examples/plugin_new_sorting_method.py @@ -0,0 +1,7 @@ +# This plugin adds the sorting algorithm called 'random'. To enable it, type +# ":set sort=random" or create a key binding with ":map oz set sort=random" + +from ranger.fsobject.directory import Directory +from random import random +Directory.sort_dict['random'] = lambda path: random() + diff --git a/examples/plugin_skip_default_rc.py b/examples/plugin_skip_default_rc.py new file mode 100644 index 00000000..6a657a99 --- /dev/null +++ b/examples/plugin_skip_default_rc.py @@ -0,0 +1,9 @@ +# This plugin inhibits the loading of the default rc.conf. This serves to +# speed up starting time by avoiding to load rc.conf twice if you have a full +# copy of it in ~/.config/ranger. +# +# Don't use this if you have a supplementary rc.conf or no rc.conf at all, or +# you will end up without key bindings and options. + +import ranger.core.main +ranger.core.main.load_default_config = False diff --git a/examples/rifle_different_file_opener.conf b/examples/rifle_different_file_opener.conf new file mode 100644 index 00000000..1362a1eb --- /dev/null +++ b/examples/rifle_different_file_opener.conf @@ -0,0 +1,7 @@ +# Replace your rifle.conf with this file to use xdg-open as your file opener. +# This is, of course, adaptable for use with any other file opener. +else = xdg-open "$1" + +# You need an "editor" and "pager" in order to use certain functions in ranger: +label editor = "$EDITOR" -- "$@" +label pager = "$PAGER" -- "$@" |