man

.TH bm 1 22.02.2016
.SH NAME
bm \- POSIX compliant bookmarking system for shell
.SH SYNOPSIS
.B bm
[\fBls\fR]
[\fBadd\fR]
[\fBrm\fR \fIbookmark\fR]
.IR bookmark ...
.SH DESCRIPTION
.B bm
can be used to create new bookmarks pointing to a directory, jump to
a specified bookmark, remove an existing bookmark and list existing
bookmarks.
.SH OPTIONS
Without options go to \fIbookmark\fR.  Description of available options:
.TP
.BR ls
List existing bookmarks
.TP
.BR add " " \fINAME\fR
Add a new bookmark named \fINAME\fR. \fINAME\fR must match \fI^[a-zA-Z0-9_]+$\fR regex
.TP
.BR rm " " \fINAME\fR
Remove bookmark named \fINAME\fR
.SH EXAMPLE
Source \fIbm.sh\fR in your shell startup file.  Then:
.BR
 $ mkdir /tmp/test-dir/
 $ cd /tmp/test-dir/
 $ bm add first_bookmark
 $ bm ls
 /tmp/test-dir first_bookmark
 $ cd ~ja
 $ pwd
 /home/ja
 $ bm first_bookmark
 $ pwd
 /tmp/test-dir
 $ bm rm first_bookmark
 $ bm ls
 $
.SH EXIT CODES
.TP
.BR 1
Requested bookmark does not exist
.TP
.BR 2
cd command failed
.TP
.BR 3
Name of a bookmark to add missing
.TP
.BR 4
A bookmark to add already exists
.TP
.BR 5
Incorrect name of a bookmark to add
.TP
.BR 6
Name of a bookmark to remove missing
.TP
.BR 7
Bookmark to remove not found
.TP
.BR 8
Failed to read $bm_config
.TP
.BR 9
Argument missing
.SH AUTHORS
.TP
Arkadiusz Drabczyk <arkadiusz@drabczyk.org>