summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorhut <hut@lavabit.com>2010-02-15 23:50:07 +0100
committerhut <hut@lavabit.com>2010-02-15 23:56:56 +0100
commit8f50c0045fb1f737c6ef8f99f665adac0915e3a0 (patch)
tree14b8be2f79df347e593528f369f68666f55974b4
parent0086b834f25578ce74a3d3e16978e4a0b913c9ef (diff)
downloadranger-8f50c0045fb1f737c6ef8f99f665adac0915e3a0.tar.gz
defaults/apps: added documentation
-rw-r--r--ranger/defaults/apps.py27
1 files changed, 27 insertions, 0 deletions
diff --git a/ranger/defaults/apps.py b/ranger/defaults/apps.py
index 5003294b..62cd3b91 100644
--- a/ranger/defaults/apps.py
+++ b/ranger/defaults/apps.py
@@ -1,6 +1,33 @@
 """
 This is the default ranger configuration file for filetype detection
 and application handling.
+
+You can place this file in your ~/.ranger/ directory and it will be used
+instead of this one.  Though, to minimize your effort when upgrading ranger,
+you may want to subclass CustomApplications rather than making a full copy.
+            
+This example modifies the behaviour of "feh" and adds a custom media player:
+
+#### start of the ~/.ranger/apps.py example
+from ranger.defaults.apps import CustomApplications as DefaultApps
+from ranger.api.apps import *
+        
+class CustomApplications(DefaultApps):
+    def app_kaffeine(self, c):
+        return tup('kaffeine', *c)
+
+    def app_feh_fullscreen_by_default(self, c):
+        return tup('feh', '-F', *c)
+
+    def app_default(self, c):
+        if c.file.video or c.file.audio:
+            return self.app_kaffeine(c)
+
+        if c.file.image and c.mode == 0:
+            return self.app_feh_fullscreen_by_default(c)
+
+        return DefaultApps.app_default(self, c)
+#### end of the example
 """
 
 from ranger.api.apps import *