mirror of
https://github.com/ohmybash/oh-my-bash.git
synced 2024-05-11 05:55:37 +00:00
Added README file for bashmarks plugin
This commit is contained in:
37
plugins/bashmarks/README.md
Normal file
37
plugins/bashmarks/README.md
Normal file
@ -0,0 +1,37 @@
|
||||
# Bashmarks plugin
|
||||
|
||||
The Bashmarks plugin allows you to create and use bookmarks for directories on your filesystems.
|
||||
|
||||
## Quickstart
|
||||
|
||||
Create a new bookmark using the *bm -a* command:
|
||||
|
||||
`$ bm -a mydir`
|
||||
|
||||
The command above creates a bookmark for the current directory with the name *mydir*.
|
||||
|
||||
You can navigate to the location of a bookmark using the *bm -g* command:
|
||||
|
||||
`$ bm -g mydir`
|
||||
|
||||
Tab completion is available when you need to enter a bookmark name in a command, such as when using *bm -g*
|
||||
|
||||
Easily list all bookmarks you have setup using the *bm -l* command.
|
||||
|
||||
## Commands
|
||||
|
||||
**bm -h** Print short help text
|
||||
|
||||
**bm -a bookmarkname** Save the current directory as bookmarkname
|
||||
|
||||
**bm -g bookmarkname** Go to the specified bookmark
|
||||
|
||||
**bm -p bookmarkname** Print the bookmark
|
||||
|
||||
**bm -d bookmarkname** Delete a bookmark
|
||||
|
||||
**bm -l** List all bookmarks
|
||||
|
||||
## Valid bookmark names
|
||||
|
||||
A bookmark name can contain lower and upper case characters (A-Z), numbers and underscore characters. No periods, semicolons, spaces or other characters are allowed in a bookmark name.
|
Reference in New Issue
Block a user