App::Term::Jump - searcheable database of often visited directories
A utility to navigate your filesystem. It can ither be used directly on the command line or integrated with Bash.
Entry point of the module; called by the jump script.
Arguments -
@command_line_arguments - options and values pased on the comman line
Returns -
$matches - list of matches for the passed options and values
$options - parsed options
Exceptions - invalid options
Note - May call exit
Called to execute commands after the command line is parsed
If multipe commands are given on the command line, jump will run them at the same time
\%options - options parsed from the command line
\@command_line_arguments - arguments parsed from the command line
Returns - An aray refeence - empty or the result of a search
Parses the command line and loads the configuration file
@command_line_arguments -
Parses a file that contains the default configuration
$config_location - a string - path to the configuraation file
Returns - A hash ref - configuration file with defualt values if they are not present in the file
Exceptions - On config evaluation errors
Prints and returns all the matches for a set of search options
\@search_arguments -
Returns - an array reference - an array containing all the matches
Exceptions - None
Returns all the matches for a set of search options
Prints the first match (truncated to the closes path) and returns all the matches for a set of search options
Prints the field, selected by $field, for all the matches
$field - an enum used to select which feld to print
\@smatches - an array containing matches
Returns - Nothing
Searches the Jump database and the filesystem for matches to the paths
$find_all - an enum - when set, the filesystem is also searches for matches
\@paths - elements of the query
Returns - An array reference containing the matches, empty if no matches are found
Searches for $option-{file}> in each of the directories passees as argument
\@directories - directoris to search
Returns - An array reference containing the directories containing a matching file
Given the succesive directories of a path, finds and cumulates the weight of each directory
\@db - Jump database
@directories - directories of a single path to weight
Returns - A cumulated path weight
Remove an entry from the database
\@arguments - path, [weight] to be removed
Add an entry to the database with the given weight, unless it is blacklisted.
Remove some or all entrie from the database.
\@arguments - path regext array, if empty, all entries are removed
Prints out the database.
Prints out the database and the configuration locations.
Prints out the ons
s<Arguments> - None
Reads a Jump database from disk.
Returns - The database as a hash reference
Exceptions - Error readin the database
\%dbs - Jump database
Returns - Noting
Exceptions - Error writing the database
Verifies its arguments, swapping them if necessary.
$weight - weight of the path to be worked on
$path - path to be worked on
Returns - tuple ($weight, $path)
Verifies if the path can be added to the database or not
$path - path to verify
Returns - True if the path can not be added to the database
Extracts the documentation and displays it via man
Arguments - None
Exceptions - Exits the program
Implements Bash completion for this modules.
Arguments received from bash:
$index - index of the command line argument to complete (starting at '1')
$command - a string containing the command name
\@arguments - list of the arguments typed on the command line
To install App::Term::Jump, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Term::Jump
CPAN shell
perl -MCPAN -e shell install App::Term::Jump
For more information on module installation, please visit the detailed CPAN module installation guide.