From 4c13e1f2d85483e026d79ab05da9f1e8e4b45293 Mon Sep 17 00:00:00 2001 From: hut Date: Sat, 2 Jan 2010 00:10:49 +0100 Subject: updated pydoc documentation --- doc/pydoc/ranger.commands.html | 217 ++++++++++++++++++++++++++--------------- 1 file changed, 139 insertions(+), 78 deletions(-) (limited to 'doc/pydoc/ranger.commands.html') diff --git a/doc/pydoc/ranger.commands.html b/doc/pydoc/ranger.commands.html index d89a7ff3..f41c3a1a 100644 --- a/doc/pydoc/ranger.commands.html +++ b/doc/pydoc/ranger.commands.html @@ -17,8 +17,9 @@ Modules         -
os
-

+
ranger.gui.widgets.console_mode
+		os
+

- + - + + +
 
@@ -26,12 +27,6 @@
       
-
builtins.object -
-
-
parse -
-
ranger.shared.FileManagerAware(ranger.shared.Awareness)
@@ -40,10 +35,12 @@
cd
delete -
delete +
filter
find +
grep
mkdir
quit +
rename
@@ -68,18 +65,14 @@ Methods defined here:
__init__(self, line, mode)
-
execute(self)
+
execute(self)
Override this
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes defined here:
-
line = ''
- -
mode = ':'
-
name = None
@@ -101,10 +94,13 @@ Data descriptors inherited from ranger.sh class cd(Command)
   The cd command changes the directory. The command 'cd -' is
-equivalent to typing ``. In the quick console, the directory
-will be entered without the need to press enter, as soon as there
-is one unambiguous match.
 
:cd <dirname>
+ 
+The cd command changes the directory.
+The command 'cd -' is equivalent to typing ``.
+ 
+In the quick console, the directory will be entered without the
+need to press enter, as soon as there is one unambiguous match.
 
 
Method resolution order:
cd
@@ -127,10 +123,6 @@ Methods inherited from Command:
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -151,7 +143,15 @@ Data descriptors inherited from ranger.sh
 
class delete(Command)
    
   :delete
+ 
+Tries to delete the selection.
+ 
+"Selection" is defined as all the "marked files" (by default, you
+can mark files with space or v). If there are no marked files,
+use the "current file" (where the cursor is)
 
 
Method resolution order:
delete
Command
@@ -167,16 +167,58 @@ Methods defined here:
Methods inherited from Command:
__init__(self, line, mode)
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
+
name = None
+ +
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = None
+ +
+Data descriptors inherited from ranger.shared.Awareness:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + + + + - +
 
+class filter(Command)
   :filter <string>
+ 
+Displays only the files which contain <string> in their basename.
 
 
Method resolution order:
+
filter
+
Command
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
builtins.object
+
+
+Methods defined here:
+
execute(self)
+ +
+Methods inherited from Command:
+
__init__(self, line, mode)
+ +
quick_open(self)
Override this
-
mode = ':'
+
tab(self)
Override this
+
+Data and other attributes inherited from Command:
name = None
@@ -198,10 +240,13 @@ Data descriptors inherited from ranger.sh class find(Command)
   The find command will attempt to find a partial, case insensitive
-match in the filenames of the current directory. In the quick command
-console, once there is one unambiguous match, the file will be run
-automatically.
 
:find <string>
+ 
+The find command will attempt to find a partial, case insensitive
+match in the filenames of the current directory.
+ 
+In the quick command console, once there is one unambiguous match,
+the file will be run automatically.
 
 
Method resolution order:
find
@@ -216,6 +261,8 @@ Methods defined here:
quick_open(self)
+
tab(self)
+
Data and other attributes defined here:
count = 0
@@ -224,14 +271,8 @@ Data and other attributes defined here:
Methods inherited from Command:
__init__(self, line, mode)
-
tab(self)
-
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -250,11 +291,15 @@ Data descriptors inherited from ranger.sh +class grep(Command) - + + +
 
-class mkdir(Command)
    
   :grep <string>
+ 
+Looks for a string in all marked files or directories
 
 
Method resolution order:
-
mkdir
+
grep
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
@@ -262,22 +307,18 @@ Data descriptors inherited from ranger.sh
Methods defined here:
-
execute(self)
+
execute(self)
Methods inherited from Command:
-
__init__(self, line, mode)
+
__init__(self, line, mode)
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -296,20 +337,42 @@ Data descriptors inherited from ranger.sh +class mkdir(Command) - + - - +
 
-class parse(builtins.object)
   Parse commands and extract information
 
:mkdir <dirname>
+ 
+Creates a directory with the name <dirname>.
 
 Methods defined here:
-
__add__(self, newpart)
+
Method resolution order:
+
mkdir
+
Command
+
ranger.shared.FileManagerAware
+
ranger.shared.Awareness
+
builtins.object
+
+
+Methods defined here:
+
execute(self)
-
__init__(self, line)
+
+Methods inherited from Command:
+
__init__(self, line, mode)
+ +
quick_open(self)
Override this
+ +
tab(self)
Override this
+ +
+Data and other attributes inherited from Command:
+
name = None
-
chunk(self, n, otherwise='')
+
+Data and other attributes inherited from ranger.shared.FileManagerAware:
+
fm = None
-Data descriptors defined here:
+Data descriptors inherited from ranger.shared.Awareness:
__dict__
dictionary for instance variables (if defined)
@@ -323,7 +386,9 @@ Data descriptors defined here:
class quit(Command)
   Quits the program.
 
:quit
+ 
+Quits the program immediately.
 
 
Method resolution order:
quit
@@ -340,16 +405,12 @@ Methods defined here:
Methods inherited from Command:
__init__(self, line, mode)
-
quick_open(self)
+
quick_open(self)
Override this
-
tab(self)
+
tab(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -368,11 +429,15 @@ Data descriptors inherited from ranger.sh +class rename(Command) - + + +
 
-var = class delete(Command)
    
   :rename <newname>
+ 
+Changes the name of the currently highlighted file to <newname>
 
 
Method resolution order:
-
delete
+
rename
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
@@ -380,22 +445,18 @@ Data descriptors inherited from ranger.sh
Methods defined here:
-
execute(self)
+
execute(self)
+ +
tab(self)
Methods inherited from Command:
-
__init__(self, line, mode)
- -
quick_open(self)
+
__init__(self, line, mode)
-
tab(self)
+
quick_open(self)
Override this
Data and other attributes inherited from Command:
-
line = ''
- -
mode = ':'
-
name = None
@@ -418,6 +479,7 @@ Data descriptors inherited from ranger.sh
       
alias(**kw)
+
command_generator(start)

@@ -425,6 +487,5 @@ Data descriptors inherited from ranger.sh Data -
       by_name = {'cd': <class 'ranger.commands.cd'>, 'delete': <class 'ranger.commands.delete'>, 'find': <class 'ranger.commands.find'>, 'mkdir': <class 'ranger.commands.mkdir'>, 'q': <class 'ranger.commands.quit'>, 'quit': <class 'ranger.commands.quit'>}
-varname = 'delete'
+

by_name = {'cd': <class 'ranger.commands.cd'>, 'delete': <class 'ranger.commands.delete'>, 'filter': <class 'ranger.commands.filter'>, 'find': <class 'ranger.commands.find'>, 'grep': <class 'ranger.commands.grep'>, 'mkdir': <class 'ranger.commands.mkdir'>, 'q': <class 'ranger.commands.quit'>, 'quit': <class 'ranger.commands.quit'>, 'rename': <class 'ranger.commands.rename'>}
 \ No newline at end of file -- cgit 1.4.1-2-gfad0