Skip to content

Commit 5a98355

Browse files
committed
Add man page. Version bump
1 parent 5b0db09 commit 5a98355

File tree

3 files changed

+61
-2
lines changed

3 files changed

+61
-2
lines changed

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "rbmenu"
3-
version = "0.1.0"
3+
version = "0.1.1"
44
authors = ["DevHyperCoder <[email protected]>"]
55
edition = "2018"
66
description = "Rust Bookmark (d)Menu"

res/rbmenu.1

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
.TH RBMENU 1 rbmenu\-0.1.0
2+
.SH NAME
3+
rbmenu \- Rust Bookmark (d)Menu
4+
.SH SYNOPSIS
5+
.B rbmenu
6+
.RB [ \-i
7+
.IR insert ]
8+
.RB [ \-n
9+
.IR name ]
10+
.RB [ \-l
11+
.IR list ]
12+
.SH DESCRIPTION
13+
.B rbmenu
14+
is a bookmark menu written in rust. It stores the bookmarks in json format.
15+
.SH OPTIONS
16+
.TP
17+
.B \-V
18+
Print version information
19+
.TP
20+
.B \-h, \-\-help
21+
Print help information
22+
.TP
23+
.B \-i
24+
Insert a new bookmark. Reads stdin for the link and uses the value of
25+
.B \-n
26+
for name of the bookmark.
27+
.TP
28+
.B \-l
29+
Lists all bookmarks available. If value of
30+
.B \-n
31+
is not provided, all bookmarks are shown. Value of
32+
.B \-n
33+
can be a regular expression to match against the bookmarks
34+
.TP
35+
.B \-n
36+
Name of the bookmark. Required for
37+
.B \-i
38+
Optional argument to
39+
.B \-l
40+
for regex matching.
41+
.SH USAGE
42+
.TP
43+
.B echo 'https://github.com' | rbmenu -in 'github'
44+
Adds a bookmark with name
45+
.IR github
46+
and link
47+
.IR https://github.com
48+
.TP
49+
.B rbmenu -l
50+
Displays all the bookmarks saved in a "space" seperated value.
51+
.TP
52+
.B rbmenu -ln 'git*'
53+
Displays all the bookmarks that match the given regular expression pattern.
54+
.SH FILES
55+
.TP
56+
.B ~/.local/share/rbmenu/bookmark.json
57+
All bookmarks are stored here. Directory will be created if it does not exist.
58+
.SH AUTHORS
59+
DevHyperCoder <[email protected]>

0 commit comments

Comments
 (0)