Update help.

This commit is contained in:
Arun Prakash Jana 2016-09-05 21:21:06 +05:30
parent c5ac9b7c9a
commit aa321e5dd5
2 changed files with 4 additions and 11 deletions

View File

@ -216,7 +216,6 @@ Please substitute `$version` with the appropriate package version.
- -S : match all the keywords in URL, title or tags. - -S : match all the keywords in URL, title or tags.
- --deep : match **substrings** (`match` matches `rematched`) in URL, title and tags. - --deep : match **substrings** (`match` matches `rematched`) in URL, title and tags.
- --st : search bookmarks by tag, or show all tags alphabetically. - --st : search bookmarks by tag, or show all tags alphabetically.
- You can search bookmarks by tag (see [examples](#examples)).
- Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown in bold within `[]` after the URL. - Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown in bold within `[]` after the URL.
- **Encryption** is optional and manual. AES256 algorithm is used. If you choose to use encryption, the database file should be unlocked (-k) before using buku 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 *unencrypted on creation*. - **Encryption** is optional and manual. AES256 algorithm is used. If you choose to use encryption, the database file should be unlocked (-k) before using buku 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 *unencrypted on creation*.
@ -282,10 +281,9 @@ The last index is moved to the deleted index to keep the DB compact.
$ buku -S kernel debugging $ buku -S kernel debugging
15. **Search** bookmarks with **tag** `general kernel concepts`: 15. **Search** bookmarks **tagged** `general kernel concepts`:
$ buku --st general kernel concepts $ buku --st general kernel concepts
Note the commas (,) before and after the tag. Comma is the tag delimiter in DB.
16. List **all unique tags** alphabetically: 16. List **all unique tags** alphabetically:
$ buku --st $ buku --st
@ -293,7 +291,7 @@ Note the commas (,) before and after the tag. Comma is the tag delimiter in DB.
$ buku -l 15 $ buku -l 15
$ buku -k 15 $ buku -k 15
The same number of iterations must be used for one lock & unlock instance. Default is 8. The same number of iterations must be specified for one lock & unlock instance. Default is 8, if omitted.
18. **Show details** of bookmark at index 15012014: 18. **Show details** of bookmark at index 15012014:
$ buku -p 15012014 $ buku -p 15012014

9
buku.1
View File

@ -39,7 +39,6 @@ URLs are unique in DB. The same URL cannot be added twice. You can update tags a
- -S : match all the keywords in URL, title or tags. - -S : match all the keywords in URL, title or tags.
- --deep : match \fBsubstrings\fR (`match` matches `rematched`) in URL, title and tags. - --deep : match \fBsubstrings\fR (`match` matches `rematched`) in URL, title and tags.
- --st : search bookmarks by tag, or show all tags alphabetically. - --st : search bookmarks by tag, or show all tags alphabetically.
- You can search bookmarks by tag (see examples below).
- Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown in bold within '[]' after the URL. - Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown in bold within '[]' after the URL.
.PP .PP
\fIEncryption\fR is optional and manual. AES256 algorithm is used. If you choose to use encryption, the database file should be unlocked (-k) before using buku 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 \fBunencrypted on creation\fR. \fIEncryption\fR is optional and manual. AES256 algorithm is used. If you choose to use encryption, the database file should be unlocked (-k) before using buku 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 \fBunencrypted on creation\fR.
@ -295,15 +294,11 @@ The last index is moved to the deleted index to keep the DB compact.
.B buku -S kernel debugging .B buku -S kernel debugging
.PP .PP
.IP 15. 4 .IP 15. 4
\fBSearch\fR bookmarks with \fBtag\fR 'general kernel concepts': \fBSearch\fR bookmarks \fBtagged\fR 'general kernel concepts':
.PP .PP
.EX .EX
.IP .IP
.B buku --st general kernel concepts .B buku --st general kernel concepts
.EE
.PP
.IP "" 4
Note the commas (,) before and after the tag. Comma is the tag delimiter in DB.
.PP .PP
.IP 16. 4 .IP 16. 4
List \fBall unique tags\fR alphabetically: List \fBall unique tags\fR alphabetically:
@ -323,7 +318,7 @@ List \fBall unique tags\fR alphabetically:
.EE .EE
.PP .PP
.IP "" 4 .IP "" 4
The same number of iterations must be used for one lock & unlock instance. Default is 8. The same number of iterations must be specified for one lock & unlock instance. Default is 8, if omitted.
.PP .PP
.IP 18. 4 .IP 18. 4
\fBShow details\fR of bookmark at index 15012014: \fBShow details\fR of bookmark at index 15012014: