-
Notifications
You must be signed in to change notification settings - Fork 1
/
Buku.txt
161 lines (115 loc) · 4.9 KB
/
Buku.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
Content-Type: text/x-zim-wiki
Wiki-Format: zim 0.4
Creation-Date: 2017-01-20T00:38:51+01:00
====== Buku ======
Created Friday 20 January 2017
**Buku is a CLI tool for managing URLs.**
== Installation ==
**# The **//buku//** package**
$ yaourt -S buku
**# To add auto-complete feature for Buku, create a file in **///usr/share/zsh/functions/Completion/_buku //
**# And add the content of **https://github.com/jarun/Buku/blob/master/auto-completion/zsh/_buku
**# Then reload Zsh**
$ compinit
**# **//Rofi//** like run panel (**//Ctrl+Alt+b//**)**
$ yaourt -S buku_run-git
**# The **//bukuadd//** script requires **//xsel //**(**//alt+b//**)**
$ pacman -S xsel
== Database ==
**# My Buku bookmark database file is stored on Dropbox**
**# Symlink to the default Buku db location**
$ ln -s /home/stick/Dropbox/buku/bookmarks.db /home/stick/.local/share/buku/
===== Usage =====
**# Buku defines bookmarks by 3 key values; Title, Tags (category) and Comments **
**#** **(and the URL of course)**
**# **//> //**=** **title**
**# **//+//** = comment**
**# **//# //** = tags (category)**
== Easy Handling (Rofi integration a.a.) ==
**# To easily add a link, Copy it (**//Ctrl+c//**) and hit **//Alt+b//
**# Easily Search bookmark in Rofi like environment with **//Ctrl+Alt+b//
==== Listing Bookmarks ====
**# Append **//-p//** to list (print) your bookmarks**
**# You can specify a specific index-number, to list information about that bookmark**
$ buku -p //<INDEX>//
**# You can also specify a range for the bookmarks you want listed**
$ buku -p 10-20
**# If **//-p//** is left blank, all bookmarks will be listed**
==== Searching Bookmarks ====
**# Append **//-s //**to search ANY keyword **
**# Append** //-S//** to search ALL keywords**
**# Append **//--stag//** to search Tags**
**# Append **//--deep//** to make a 'loose' search - Ex. **//note//** lists **//notebook//** too**
**# When you Search, you will be prompted to do additional actions**
**# **//q//** to quit**
**# **//a//** to open ALL the listed links**
**# **//s//** specify additional search criteria **
**# **//?//** for additional actions **
== Any ==
**# If you append the **//-s//** all bookmarks, with any of the keywords, will be listed**
$ buku -s category1, category2
== All ==
**# If you append the **//-S//** the bookmarks needs to match ALL of the keywords**
**# **//-S //**comes with a couple of unique keywords**
**# **//immutable//** = Entries with locked title**
**# **//blank//** = Entries with a blank title**
== Tags ==
**# To search for specific tag**
$ buku --stag //category//
**# If **//--stag//** is left blank, ALL tags will be listed**
== Loose ==
**# For wildcard searching, append the **//-s//** and **//--deep//
**# Ex, below will also find **//category//
$ buku -s cat --deep
==== Add Bookmarks ====
**# Append **//-a//** to add a new bookmark**
== Bukuadd Script ==
**# **//~/dotfiles/scripts/bukuadd.sh//** lets you add the latest content of Clipboard to Buku**
**# Copy a URL in the browser and hit **//Alt+b//
== Tags (categories) ==
**# Tags needs to be defined right after the URL - no need to append a option (ex, **//--tags//**)**
**# You can add multiple categories in a comma-separated list**
$ //buku// //-a <URL> category1, category2//
== Title ==
**# Titles - unless specified - is automatically set by the URLs title**
**# To define your own title, append **//--immutable 1//** and **//-t //
$ buku -a //<URL> //-t //<TITLE> //--immutable 1
**# If **//-t//** is left blank, no title will be set**
== Comments ==
**# Attach Comments with **//-c//
$ buku -a //<URL> //-c This is a comment
==== Edit Bookmarks ====
**# Append **//-u//** to edit (update) bookmarks**
== Title ==
**# To update the Title to the URLs title**
$ buku -u //<INDEX>//
**# Or to update it with your own title (as explained above)**
$ buku -u //<INDEX> //-t //<TITLE>// --immutable 1
== URL ==
**# To update the URL in a bookmark, append the **//--url//
$ buku -u //<INDEX>// --url //<NEW_URL>//
== Tags ==
**# Tags can modified by appending **//--tag//
**# To add additional tags, use the **//+//** operator**
$ buku -u //<INDEX> //--tag + category1, category2
**# To delete tags, use the **//-//** operator**
$ buku -u //<INDEX> --tag - //category1, category2
**# If neither the **//+//** or**// -//** operator is used, the current tags will be overwritten **
== Comments ==
**# To add/overwrite a comment**
$ buku -u //<INDEX> //-c This is a new comment
**# If **//-c//** is left blank, the current comment will be deleted**
==== Deleting Bookmarks ====
**# Append **//-d//** to delete bookmarks**
**# You can space-separate index values, to delete multiple bookmarks**
**# Ex, to delete 10, 15 and 20**
$ buku -d 10 15 20
**# You can also delete a range**
**# Ex, ALL bookmarks in the range of 10 to 20**
$ buku -d 10-20
==== Encryption ====
**# You are able to lock/unlock your bookmarks**
**# To lock it (encrypt with 8 hash iterations) **
$ buku -l
**# To open (decrypt)**
$ buku -k