From 40d65528b284bc035fb152e08e6d9dde17d0d7d7 Mon Sep 17 00:00:00 2001 From: Michael Anckaert Date: Tue, 8 May 2018 14:42:45 +0200 Subject: [PATCH] Added README file for bashmarks plugin --- plugins/bashmarks/README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 plugins/bashmarks/README.md diff --git a/plugins/bashmarks/README.md b/plugins/bashmarks/README.md new file mode 100644 index 0000000..83dd996 --- /dev/null +++ b/plugins/bashmarks/README.md @@ -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.