-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathbuku.htm
2177 lines (1593 loc) · 55.2 KB
/
buku.htm
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!-- Creator : groff version 1.22.4 -->
<!-- CreationDate: Wed Jan 26 08:47:13 2022 -->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="generator" content="groff -Thtml, see www.gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<meta name="Content-Style" content="text/css">
<style type="text/css">
p { margin-top: 0; margin-bottom: 0; vertical-align: top }
pre { margin-top: 0; margin-bottom: 0; vertical-align: top }
table { margin-top: 0; margin-bottom: 0; vertical-align: top }
h1 { text-align: center }
</style>
<title>BUKU</title>
<!-- Bronto custom css --> <style type="text/css"> p { margin-top: 0; margin-bottom: 0; vertical-align: top; font-family: 'Noto Serif', serif; font-size: large } a { font-family: 'Noto Sans', sans; font-size: large } pre { margin-top: 0; margin-bottom: 0; vertical-align: top; font-size: large } table { margin-top: 0; margin-bottom: 0; vertical-align: top } h1 { text-align: center; font-family: 'Noto Serif', serif; font-size: xx-large } h2 { font-family: 'Noto Sans', sans; } hr { border-top: 1px solid black; visibility: hidden; } a:link { text-decoration: none; } a:visited { text-decoration: none; } a:hover { text-decoration: underline; } a:active { text-decoration: underline; } body { background-color: #F5F5F5; color: #111111; line-height: 1.6; } </style> </head>
<body>
<h1 align="center">BUKU</h1>
<a href="#NAME">NAME</a><br>
<a href="#SYNOPSIS">SYNOPSIS</a><br>
<a href="#DESCRIPTION">DESCRIPTION</a><br>
<a href="#OPERATIONAL NOTES">OPERATIONAL NOTES</a><br>
<a href="#GENERAL OPTIONS">GENERAL OPTIONS</a><br>
<a href="#EDIT OPTIONS">EDIT OPTIONS</a><br>
<a href="#SEARCH OPTIONS">SEARCH OPTIONS</a><br>
<a href="#ENCRYPTION OPTIONS">ENCRYPTION OPTIONS</a><br>
<a href="#POWER OPTIONS">POWER OPTIONS</a><br>
<a href="#PROMPT KEYS">PROMPT KEYS</a><br>
<a href="#ENVIRONMENT">ENVIRONMENT</a><br>
<a href="#COLORS">COLORS</a><br>
<a href="#EXAMPLES">EXAMPLES</a><br>
<a href="#AUTHOR">AUTHOR</a><br>
<a href="#HOME">HOME</a><br>
<a href="#WIKI">WIKI</a><br>
<a href="#REPORTING BUGS">REPORTING BUGS</a><br>
<a href="#LICENSE">LICENSE</a><br>
<hr>
<h2>NAME
<a name="NAME"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em">buku - Bookmark
manager like a text-based mini-web</p>
<h2>SYNOPSIS
<a name="SYNOPSIS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>buku
[OPTIONS] [KEYWORD [KEYWORD ...]]</b></p>
<h2>DESCRIPTION
<a name="DESCRIPTION"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>buku</b> is
a command-line utility to store, tag, search and organize
bookmarks.</p>
<p style="margin-left:11%; margin-top: 1em"><b>Features</b></p>
<p style="margin-left:11%; margin-top: 1em">* Store
bookmarks with auto-fetched title, tags and description <br>
* Auto-import from Firefox, Google Chrome and Chromium <br>
* Open bookmarks and search results in browser <br>
* Shorten, expand URLs, browse cached page from Wayback
Machine <br>
* Text editor integration <br>
* Lightweight, clean interface, custom colors <br>
* Powerful search options (regex, substring...) <br>
* Continuous search with on the fly mode switch <br>
* Portable, merge-able database to sync between systems <br>
* Import/export bookmarks from/to HTML, Markdown or Orgfile
<br>
* Smart tag management using redirection (>>, >,
<<) <br>
* Multithreaded full DB refresh, manual encryption support
<br>
* Shell completion scripts, man page with handy examples</p>
<h2>OPERATIONAL NOTES
<a name="OPERATIONAL NOTES"></a>
</h2>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p style="margin-top: 1em">1.</p></td>
<td width="3%"></td>
<td width="48%">
<p style="margin-top: 1em">The database file is stored
in:</p> </td>
<td width="35%">
</td></tr>
</table>
<p style="margin-left:17%;">-
<i>$XDG_DATA_HOME/buku/bookmarks.db</i>, if XDG_DATA_HOME is
defined (first preference), or <br>
- <i>$HOME/.local/share/buku/bookmarks.db</i>, if HOME is
defined (second preference), or <br>
- <i>%APPDATA%\buku\bookmarks.db</i>, if you are on Windows,
or <br>
- the current directory.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p style="margin-top: 1em">2.</p></td>
<td width="3%"></td>
<td width="83%">
<p style="margin-top: 1em">If the URL contains characters
like ’;’, ’&’ or brackets they
may be interpreted specially by the shell. To avoid it, add
the URL within single or double quotes (’/").</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p>3.</p></td>
<td width="3%"></td>
<td width="83%">
<p>URLs are unique in DB. The same URL cannot be added
twice.</p> </td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p>4.</p></td>
<td width="3%"></td>
<td width="83%">
<p>Bookmarks with immutable titles are listed with
’(L)’ after the title.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p>5.</p></td>
<td width="3%"></td>
<td width="83%">
<p><b>Tags</b>:</p></td></tr>
</table>
<p style="margin-left:17%;">- Comma (’,’) is
the tag delimiter in DB. A tag cannot have comma(s) in it.
Tags are filtered (for unique tags) and sorted. Tags are
stored in lower case and can be replaced, appended or
deleted. <br>
- Page keywords having a word to comma ratio > 3 are
appended to description rather than tags. <br>
- Parent folder (and subfolder) names are converted to
all-lowercase tags during bookmarks HTML import. <br>
- Releases prior to v2.7 support both capital and lower
cases in tags. From v2.7 all tags are stored in lowercase.
An undocumented option --fixtags is introduced to modify the
older tags. It also fixes another issue where the same tag
appears multiple times in the tagset of a record. Run
<b>buku --fixtags</b> once. <br>
- Tags can be edited from the prompt very easily using
’>>’ (append), ’>’
(overwrite) and ’<<’ (remove) symbols. The
LHS of the operands denotes the indices and ranges of tags
to apply (as listed by --tag or key ’t’ at
prompt) and the RHS denotes the actual DB indices and ranges
of the bookmarks to apply the change to.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p style="margin-top: 1em">6.</p></td>
<td width="3%"></td>
<td width="26%">
<p style="margin-top: 1em"><b>Update</b> operation:</p></td>
<td width="57%">
</td></tr>
</table>
<p style="margin-left:17%;">- If --title, --tag or
--comment is passed without argument, clear the
corresponding field from DB. <br>
- If --url is passed (and --title is omitted), update the
title from web using the URL. Description is updated (if
--comment is omitted). Tags remain untouched. <br>
- If indices are passed without any other options (--url,
--title, --tag, --comment and --immutable), read the URLs
from DB and update titles, description and append tags from
web. Bookmarks marked immutable are skipped. <br>
- Can update bookmarks matching a search, when combined with
any of the search options and no arguments to update are
passed.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p style="margin-top: 1em">7.</p></td>
<td width="3%"></td>
<td width="26%">
<p style="margin-top: 1em"><b>Delete</b> operation:</p></td>
<td width="57%">
</td></tr>
</table>
<p style="margin-left:17%;">- When a record is deleted, the
last record is moved to the index. <br>
- Delete doesn’t work with range and indices provided
together as arguments. It’s an intentional decision to
avoid extra sorting, in-range checks and to keep the auto-DB
compaction functionality intact. On the same lines, indices
are deleted in descending order. <br>
- Can delete bookmarks matching a search, when combined with
any of the search options and no arguments to delete are
passed.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p style="margin-top: 1em">8.</p></td>
<td width="3%"></td>
<td width="49%">
<p style="margin-top: 1em"><b>Search</b> works in
mysterious ways:</p></td>
<td width="34%">
</td></tr>
</table>
<p style="margin-left:17%;">- Case-insensitive. <br>
- Matches words in URL, title and tags. <br>
- --sany : match any of the keywords in URL, title or tags.
Default search option. <br>
- --sall : match all the keywords in URL, title or tags.
<br>
- --deep : match <b>substrings</b> (’match’
matches ’rematched’) in URL, title and tags.
<br>
- --sreg : match a regular expression (ignores --deep). <br>
- --stag : search bookmarks by tags, or list all tags
alphabetically with usage count (if no arguments). Delimit
the list of tags in the query with ’,’ to search
for bookmarks that match ANY of the listed tags. Delimit
tags with ’+’ to search for bookmarks that match
ALL of the listed tags. Note that ’,’ and
’+’ cannot be used together in the same search.
Exclude bookmarks matching certain tags from the results by
using ’ - ’ followed by the tags. Note that the
’ - ’ operator and the ’ + ’
delimiter must be space separated: ’ - ’ instead
of ’-’ and ’ + ’ instead of
’+’. This is to distinguish them from hyphenated
tags (e.g., ’some-tag-name’) and tags with
’+’s (e.g., ’some+tag+name’). <br>
- Search for keywords along with tag filtering is possible.
Two searches are issued (one for keywords and another for
tags) and the intersection of the 2 sets is returned as the
resultset. <br>
- Search results are indexed incrementally. This index is
different from actual database index of a bookmark record
which is shown within ’[]’ after the title. <br>
- Results for <i>any</i> keyword matches are ordered by the
number of keyword matches - results matching more keywords
(<i>match score</i>) will appear earlier in the list.
Results having the same number of matches will be ranked by
their record DB index. If only one keyword is searched,
results will be ordered by DB index, since all matching
records will have the same <i>match score</i>.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p style="margin-top: 1em">9.</p></td>
<td width="3%"></td>
<td width="11%">
<p style="margin-top: 1em"><b>Import</b>:</p></td>
<td width="72%">
</td></tr>
</table>
<p style="margin-left:17%;">- Auto-import looks in the
default installation path and default user profile. <br>
- URLs starting with ’place:’,
’file://’ and ’apt:’ are ignored
during import. <br>
- Parent folder (and subfolder) names are automatically
imported as tags if --tacit is used. <br>
- Tags are merged even if bookmark URL exists when --tacit
is used.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p style="margin-top: 1em">10.</p></td>
<td width="2%"></td>
<td width="83%">
<p style="margin-top: 1em"><b>Encryption</b> is optional
and manual. AES256 algorithm is used. To use encryption, the
database file should be unlocked (-k) before using
<b>buku</b> and locked (-l) afterwards. Between these 2
operations, the database file lies unencrypted on the disk,
and NOT in memory. Also, note that the database file is
<b>unencrypted on creation</b>.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p>11.</p></td>
<td width="2%"></td>
<td width="83%">
<p><b>Editor</b> support:</p></td></tr>
</table>
<p style="margin-left:17%;">- A single bookmark can be
edited before adding. The editor can be set using the
environment variable *EDITOR* or by explicitly specifying
the editor. The latter takes precedence. If -a is used along
with -w, the details are populated in the editor template.
<br>
- In case of edit and update (a single bookmark), the
existing record details are fetched from DB and populated in
the editor template. The environment variable EDITOR must be
set. Note that -u works independently of -w. <br>
- All lines beginning with "#" will be stripped.
Then line 1 will be treated as the URL, line 2 will be the
title, line 3 will be comma separated tags, and the rest of
the lines will be parsed as descriptions.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p style="margin-top: 1em">12.</p></td>
<td width="2%"></td>
<td width="83%">
<p style="margin-top: 1em"><b>Proxy</b> support: please
refer to the <b>ENVIRONMENT</b> section.</p></td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p>13.</p></td>
<td width="2%"></td>
<td width="83%">
<p><b>Alternative DB file</b>:</p></td></tr>
</table>
<p style="margin-left:17%;">- The option --db (to specify
an alternative database file location) is app-only. Manual
usage is prone to issues arising from human error.</p>
<h2>GENERAL OPTIONS
<a name="GENERAL OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>-a --add</b>
<i>URL [tag, ...]</i></p>
<p style="margin-left:22%;">Bookmark <i>URL</i> along with
comma-separated tags. A tag can have multiple words.</p>
<p style="margin-left:11%;"><b>-u --update</b>
<i>[...]</i></p>
<p style="margin-left:22%;">Update fields of the bookmarks
at specified indices in DB. If no arguments are specified,
all titles and descriptions are refreshed from the web. Tags
remain untouched. Works with update modifiers for the fields
url, title, tag and comment. If only indices are passed
without any edit options, titles and descriptions are
fetched and updated (if not empty). Accepts hyphenated
ranges and space-separated indices. Updates search results
when used with search options, if no arguments.</p>
<p style="margin-left:11%;"><b>-w --write</b>
<i>[editor|index]</i></p>
<p style="margin-left:22%;">Edit a bookmark in
<i>editor</i> before adding it. To edit and update an
existing bookmark, the <i>index</i> should be passed.
However, in this case the environment variable EDITOR must
be set. The last record is opened in EDITOR if index=-1.</p>
<p style="margin-left:11%;"><b>-d --delete</b>
<i>[...]</i></p>
<p style="margin-left:22%;">Delete bookmarks. Accepts
space-separated list of indices (e.g. 5 6 23 4 110 45) or a
single hyphenated range (e.g. 100-200). Note that range and
list don’t work together. Deletes search results when
combined with search options, if no arguments.</p>
<p style="margin-left:11%;"><b>-v --version</b></p>
<p style="margin-left:22%;">Show program version and
exit.</p>
<p style="margin-left:11%;"><b>-h --help</b></p>
<p style="margin-left:22%;">Show program help and exit.</p>
<h2>EDIT OPTIONS
<a name="EDIT OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>--url</b>
<i>[...]</i></p>
<p style="margin-left:22%;">Specify the URL, works with
--update only. Fetches and updates title if --title is not
used.</p>
<p style="margin-left:11%;"><b>--tag</b> <i>[+|-]
[...]</i></p>
<p style="margin-left:22%;">Specify comma separated tags,
works with --add, --update. Clears the tags, if no arguments
passed. Appends or deletes tags, if list of tags is preceded
by ’+’ or ’-’ respectively.</p>
<p style="margin-left:11%;"><b>--title</b> <i>[...]</i></p>
<p style="margin-left:22%;">Manually specify the title,
works with --add, --update. Omits or clears the title, if no
arguments passed.</p>
<p style="margin-left:11%;"><b>-c --comment</b>
<i>[...]</i></p>
<p style="margin-left:22%;">Add notes or description of the
bookmark, works with --add, --update. Clears the comment, if
no arguments passed.</p>
<p style="margin-left:11%;"><b>--immutable</b> <i>N</i></p>
<p style="margin-left:22%;">Set the title, description and
tags of a bookmark immutable during autorefresh. Works with
--add, --update. N=1 sets the immutable flag, N=0 removes
it. If omitted, bookmarks are added with N=0.</p>
<h2>SEARCH OPTIONS
<a name="SEARCH OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>-s
--sany</b> <i>keyword [...]</i></p>
<p style="margin-left:22%;">Search bookmarks with ANY of
the keyword(s) in URL, title or tags and show the results.
Prompts to enter result number to open in browser. Note that
the sequential result index is not the DB index. The DB
index is shown within ’[]’ after the title. <br>
This is the default search option for positional arguments
if no other search option is specified.</p>
<p style="margin-left:11%;"><b>-S --sall</b> <i>keyword
[...]</i></p>
<p style="margin-left:22%;">Search bookmarks with ALL
keywords in URL, title or tags and show the results.
Behaviour same as --sany. <br>
Special keywords: <br>
"blank": list entries with empty title/tag <br>
"immutable": list entries with locked title <br>
NOTE: To search the keywords, use --sany</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>--deep</b></p></td>
<td width="2%"></td>
<td width="78%">
<p>Search modifier to match substrings. Works with --sany,
--sall.</p> </td></tr>
</table>
<p style="margin-left:11%;"><b>-r --sreg</b>
<i>expression</i></p>
<p style="margin-left:22%;">Scan for a regular expression
match.</p>
<p style="margin-left:11%;"><b>-t --stag</b> <i>[tag [,|+]
...] [- tag, ...]</i></p>
<p style="margin-left:22%;">Search bookmarks by tags. <br>
Use ’,’ delimiter to find entries matching ANY
of the tags <br>
Use ’ + ’ delimiter to find entries matching ALL
of the tags. (Note that the ’ + ’ delimiter must
be space separated) <br>
NOTE: Cannot combine ’,’ and ’+’ in
the same search <br>
Use ’ - ’ to exclude bookmarks that match the
tags that follow. (Note that the ’-’ operator
must be space separated). <br>
List all tags alphabetically, if no arguments. The usage
count (number of bookmarks having the tag) is shown within
first brackets.</p>
<p style="margin-left:11%;"><b>-x --exclude</b> <i>keyword
[...]</i></p>
<p style="margin-left:22%;">Exclude bookmarks matching the
specified keywords. Works with --sany, --sall, --sreg and
--stag.</p>
<h2>ENCRYPTION OPTIONS
<a name="ENCRYPTION OPTIONS"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>-l
--lock</b> <i>[N]</i></p>
<p style="margin-left:22%;">Encrypt (lock) the DB file with
<i>N</i> (> 0, default 8) hash passes to generate
key.</p>
<p style="margin-left:11%;"><b>-k --unlock</b>
<i>[N]</i></p>
<p style="margin-left:22%;">Decrypt (unlock) the DB file
with <i>N</i> (> 0, default 8) hash passes to generate
key.</p>
<h2>POWER OPTIONS
<a name="POWER OPTIONS"></a>
</h2>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">
<p style="margin-top: 1em"><b>--ai</b></p></td>
<td width="5%"></td>
<td width="78%">
<p style="margin-top: 1em">Auto-import bookmarks from
Firefox, Google Chrome and Chromium browsers.</p></td></tr>
</table>
<p style="margin-left:11%;"><b>-e --export</b>
<i>file</i></p>
<p style="margin-left:22%;">Export bookmarks to Firefox
bookmarks formatted HTML. Works with all search options.
<br>
Markdown is used if <i>file</i> has extension
’.md’. Markdown format: [title](url), 1 entry
per line. <br>
Orgfile is used if <i>file</i> has extension
’.org’ Orgfile format: * [[url][title]], 1 entry
per line. <br>
A buku database is generated if <i>file</i> has extension
’.db’.</p>
<p style="margin-left:11%;"><b>-i --import</b>
<i>file</i></p>
<p style="margin-left:22%;">Import bookmarks from Firefox
bookmarks formatted HTML. <i>file</i> is considered
Firefox-exported JSON if it has ’.json’
extension, Markdown (compliant with --export format) if it
is ’.md’, Orgfile if the extension is
’.org’ or another buku database if the extension
is ’.db’.</p>
<p style="margin-left:11%;"><b>-p --print</b>
<i>[...]</i></p>
<p style="margin-left:22%;">Show details (DB index, URL,
title, tags and comment) of bookmark record by DB index. If
no arguments, all records with actual index from DB are
shown. Accepts hyphenated ranges and space-separated
indices. A negative value (introduced for convenience)
behaves like the tail utility, e.g., -n shows the details of
the last n bookmarks.</p>
<p style="margin-left:11%;"><b>-f --format</b> <i>N</i></p>
<p style="margin-left:22%;">Show selective monochrome
output with specific fields. Works with --print. Search
results honour the option when used along with --json.
Useful for creating batch scripts. <i><br>
N</i> = 1, show only URL. <i><br>
N</i> = 2, show URL and tags in a single line. <i><br>
N</i> = 3, show only title. <i><br>
N</i> = 4, show URL, title and tags in a single line.
<i><br>
N</i> = 5, show title and tags in a single line. <br>
To omit DB index from printed results, use N0, e.g., 10, 20,
30, 40, 50.</p>
<p style="margin-left:11%;"><b>-j --json</b></p>
<p style="margin-left:22%;">Output data formatted as JSON,
works with --print output and search results.</p>
<p style="margin-left:11%;"><b>--colors</b>
<i>COLORS</i></p>
<p style="margin-left:22%;">Set output colors. Refer to the
<b>COLORS</b> section below for details.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">
<p><b>--nc</b></p></td>
<td width="5%"></td>
<td width="78%">
<p>Disable color output in all messages. Useful on
terminals which can’t handle ANSI color codes or
scripted environments.</p></td></tr>
</table>
<p style="margin-left:11%;"><b>-n --count</b> <i>N</i></p>
<p style="margin-left:22%;">Number of results to show per
page (default 10).</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">
<p><b>--np</b></p></td>
<td width="5%"></td>
<td width="56%">
<p>Do not show the prompt, run and exit.</p></td>
<td width="22%">
</td></tr>
</table>
<p style="margin-left:11%;"><b>-o --open</b>
<i>[...]</i></p>
<p style="margin-left:22%;">Open bookmarks by DB indices or
ranges in browser. Open a random index if argument is
omitted.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">
<p><b>--oa</b></p></td>
<td width="5%"></td>
<td width="78%">
<p>Open all search results immediately in the browser.
Works best with --np. When used along with --update or
--delete, URLs are opened in the browser first and then
modified or deleted.</p></td></tr>
</table>
<p style="margin-left:11%;"><b>--replace</b> <i>old
new</i></p>
<p style="margin-left:22%;">Replace <i>old</i> tag with
<i>new</i> tag if both are passed; delete <i>old</i> tag if
<i>new</i> tag is not specified.</p>
<p style="margin-left:11%;"><b>--shorten</b>
<i>index|URL</i></p>
<p style="margin-left:22%;">Shorten the URL at DB
<i>index</i> or an independent <i>URL</i> using the tny.im
URL shortener service.</p>
<p style="margin-left:11%;"><b>--expand</b>
<i>index|URL</i></p>
<p style="margin-left:22%;">Expand the URL at DB
<i>index</i> or an independent <i>URL</i> shortened using
tny.im.</p>
<p style="margin-left:11%;"><b>--cached</b>
<i>index|URL</i></p>
<p style="margin-left:22%;">Browse the latest cached
version of the URL at DB <i>index</i> or an independent
<i>URL</i> using the Wayback Machine. Useful for viewing the
content of bookmarks which are not live any more.</p>
<p style="margin-left:11%;"><b>--suggest</b></p>
<p style="margin-left:22%;">Show a list of similar tags to
choose from when adding a new bookmark.</p>
<p style="margin-left:11%;"><b>--tacit</b></p>
<p style="margin-left:22%;">Show lesser output. Reduces the
verbosity of certain operations like add, update etc.</p>
<p style="margin-left:11%;"><b>--threads</b></p>
<p style="margin-left:22%;">Maximum number of parallel
network connection threads to use during full DB refresh. By
default 4 connections are spawned. <i>N</i> can range from 1
to 10.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="3%">
<p><b>-V</b></p></td>
<td width="8%"></td>
<td width="78%">
<p>Check the latest upstream version available. This is
FYI. It is possible the latest upstream released version is
still not available in your package manager as the process
takes a while.</p></td></tr>
</table>
<p style="margin-left:11%;"><b>-g --debug</b></p>
<p style="margin-left:22%;">Show debug information and
additional logs.</p>
<h2>PROMPT KEYS
<a name="PROMPT KEYS"></a>
</h2>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="4%">
<p style="margin-top: 1em"><b>1-N</b></p></td>
<td width="7%"></td>
<td width="67%">
<p style="margin-top: 1em">Browse search results by indices
and ranges.</p></td>
<td width="11%">
</td></tr>
</table>
<p style="margin-left:11%;"><b>O</b> <i>[id|range
[...]]</i></p>
<p style="margin-left:22%;">Try to open search results or
indices (when not in a search context) in a GUI browser.
Toggle try to open urls in a GUI based browser (even if
BROWSER is set) if no arguments. Toggling is useful when
trying to open bookmarks by DB index.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p><b>a</b></p></td>
<td width="10%"></td>
<td width="53%">
<p>Open all search results in browser.</p></td>
<td width="25%">
</td></tr>
</table>
<p style="margin-left:11%;"><b>s</b> <i>keyword
[...]</i></p>
<p style="margin-left:22%;">Search for records with ANY
keyword.</p>
<p style="margin-left:11%;"><b>S</b> <i>keyword
[...]</i></p>
<p style="margin-left:22%;">Search for records with ALL
keywords.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="1%">
<p><b>d</b></p></td>
<td width="10%"></td>
<td width="78%">
<p>Toggle deep search to match substrings
(’pen’ matches ’opened’).</p></td></tr>
</table>
<p style="margin-left:11%;"><b>r</b> <i>expression</i></p>
<p style="margin-left:22%;">Run a regular expression
search.</p>
<p style="margin-left:11%;"><b>t</b> <i>[...]</i></p>
<p style="margin-left:22%;">Search bookmarks by a tag. List
all tags alphabetically, if no arguments.</p>
<p style="margin-left:11%;"><b>g</b> <i>taglist id|range
[...] [>>|>|<<] [record id|range ...]</i></p>
<p style="margin-left:22%;">Append, set, remove specific or
all tags by indices and/or ranges to bookmark indices and/or
ranges (see <b>EXAMPLES</b> section below). Search by
space-separated taglist id(s) and/or range if records are
omitted.</p>
<p style="margin-left:11%;"><b>o</b> <i>id|range
[...]</i></p>
<p style="margin-left:22%;">Browse bookmarks by indices
and/or ranges.</p>
<p style="margin-left:11%;"><b>p</b> <i>id|range
[...]</i></p>
<p style="margin-left:22%;">Print bookmarks by indices
and/or ranges.</p>
<p style="margin-left:11%;"><b>w</b> <i>[editor|id]</i></p>
<p style="margin-left:22%;">Edit and add or update a
bookmark.</p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">
<p><b>c id</b></p></td>
<td width="5%"></td>
<td width="69%">
<p>Copy url at search result index to clipboard.</p></td>
<td width="9%">
</td></tr>
<tr valign="top" align="left">
<td width="11%"></td>
<td width="6%">
<p><b>?</b></p></td>
<td width="5%"></td>
<td width="69%">
<p>Show help on prompt keys.</p></td>
<td width="9%">
</td></tr>
</table>
<p style="margin-left:11%;"><b>q, ^D, double Enter</b></p>
<p style="margin-left:22%;">Exit buku.</p>
<h2>ENVIRONMENT
<a name="ENVIRONMENT"></a>
</h2>
<p style="margin-left:11%; margin-top: 1em"><b>Completion
scripts</b></p>
<p style="margin-left:22%;">Shell completion scripts for
Bash, Fish and Zsh can be found in: <i><br>
https://github.com/jarun/buku/blob/master/auto-completion</i></p>
<p style="margin-left:11%;"><b>BROWSER</b></p>
<p style="margin-left:22%;">Overrides the default browser.
Refer to: <i><br>
http://docs.python.org/library/webbrowser.html</i></p>
<table width="100%" border="0" rules="none" frame="void"
cellspacing="0" cellpadding="0">
<tr valign="top" align="left">
<td width="11%"></td>
<td width="9%">
<p><b>EDITOR</b></p></td>
<td width="2%"></td>
<td width="78%">