ranger.commands
index
/home/hut/ranger/ranger/commands.py

# Copyright (c) 2009, 2010 hut <hut@lavabit.com>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

 
Modules
       
ranger.gui.widgets.console_mode
os

 
Classes
       
ranger.shared.FileManagerAware(ranger.shared.Awareness)
Command
cd
chmod
delete
edit
filter
find
grep
mkdir
quit
rename
touch

 
class Command(ranger.shared.FileManagerAware)
    Abstract command class
 
 
Method resolution order:
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
__init__(self, line, mode)
execute(self)
Override this
quick_open(self)
Override this
tab(self)
Override this

Data and other attributes defined here:
allow_abbrev = True
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 cd(Command)
    :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
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)
quick_open(self)
tab(self)

Methods inherited from Command:
__init__(self, line, mode)

Data and other attributes inherited from Command:
allow_abbrev = True
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 chmod(Command)
    :chmod <octal number>
 
Sets the permissions of the selection to the octal number.
 
The octal number is between 0 and 777. The digits specify the
permissions for the user, the group and others.
 
A 1 permits execution, a 2 permits writing, a 4 permits reading.
Add those numbers to combine them. So a 7 permits everything.
 
 
Method resolution order:
chmod
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this
tab(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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 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
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)

Data and other attributes defined here:
allow_abbrev = False

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

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 edit(Command)
    :edit <filename>
 
Opens the specified file in vim
 
 
Method resolution order:
edit
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)
tab(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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
__builtin__.object

Methods defined here:
execute(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this
tab(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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 find(Command)
    :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
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)
quick_open(self)
tab = _tab_directory_content(self)

Data and other attributes defined here:
count = 0

Methods inherited from Command:
__init__(self, line, mode)

Data and other attributes inherited from Command:
allow_abbrev = True
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 grep(Command)
    :grep <string>
 
Looks for a string in all marked files or directories
 
 
Method resolution order:
grep
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this
tab(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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 mkdir(Command)
    :mkdir <dirname>
 
Creates a directory with the name <dirname>.
 
 
Method resolution order:
mkdir
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this
tab(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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 quit(Command)
    :quit
 
Quits the program immediately.
 
 
Method resolution order:
quit
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this
tab(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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 rename(Command)
    :rename <newname>
 
Changes the name of the currently highlighted file to <newname>
 
 
Method resolution order:
rename
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)
tab(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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 touch(Command)
    :touch <fname>
 
Creates a file with the name <fname>.
 
 
Method resolution order:
touch
Command
ranger.shared.FileManagerAware
ranger.shared.Awareness
__builtin__.object

Methods defined here:
execute(self)

Methods inherited from Command:
__init__(self, line, mode)
quick_open(self)
Override this
tab(self)
Override this

Data and other attributes inherited from Command:
allow_abbrev = True
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)

 
Functions
       
alias(**kw)
Create an alias for commands, eg: alias(quit=exit)
command_generator(start)
get_command(name, abbrev=True)

 
Data
        by_name = {'cd': <class 'ranger.commands.cd'>, 'chmod': <class 'ranger.commands.chmod'>, 'delete': <class 'ranger.commands.delete'>, 'edit': <class 'ranger.commands.edit'>, 'filter': <class 'ranger.commands.filter'>, 'find': <class 'ranger.commands.find'>, 'grep': <class 'ranger.commands.grep'>, 'mkdir': <class 'ranger.commands.mkdir'>, 'quit': <class 'ranger.commands.quit'>, 'rename': <class 'ranger.commands.rename'>, ...}