Help update.

This commit is contained in:
Arun Prakash Jana 2016-04-20 21:11:07 +05:30
parent 18c42dc9f4
commit b3675594e1
No known key found for this signature in database
GPG Key ID: C0A712ED95043DCB
3 changed files with 8 additions and 5 deletions

View File

@ -121,7 +121,7 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin
General options General options
-a URL [tags] add URL as bookmark with comma separated tags -a URL [tags] add URL as bookmark with comma separated tags
-d N delete entry at DB index N (from -p 0), move last entry to N -d N delete entry at DB index N (from -p 0)
-g list all tags alphabetically -g list all tags alphabetically
-m title manually specify the title, for -a, -i, -u -m title manually specify the title, for -a, -i, -u
-s keyword(s) search bookmarks for any keyword -s keyword(s) search bookmarks for any keyword
@ -137,7 +137,7 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin
-k decrypt (unlock) database file -k decrypt (unlock) database file
-l encrypt (lock) database file -l encrypt (lock) database file
-o N open URL at DB index N in browser -o N open URL at DB index N in browser
-p N show details of bookmark record at DB index N (0 for all) -p N show details of bookmark record at DB index N, N=0 shows all
-r oldtag [newtag] replace oldtag with newtag, delete oldtag if newtag empty -r oldtag [newtag] replace oldtag with newtag, delete oldtag if newtag empty
-R refresh title from web for all bookmarks, update if non-empty -R refresh title from web for all bookmarks, update if non-empty
-t N use N (> 0) hash iterations to generate key, for -k, -l -t N use N (> 0) hash iterations to generate key, for -k, -l
@ -162,6 +162,7 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin
- `-S` : match all the keywords in URL, title or tags. - `-S` : match all the keywords in URL, title or tags.
- You can search bookmarks by tag (see example). - You can search bookmarks by tag (see example).
- Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown within `()` after the URL. - Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown within `()` after the URL.
- When a record is deleted, the last record is moved to the index.
- AES256 is used for encryption. Optionally specify (`-t`) the number of hash iterations to use to generate key. Default is 8 iterations. - AES256 is used for encryption. Optionally specify (`-t`) the number of hash iterations to use to generate key. Default is 8 iterations.
- Encryption is optional and manual. 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 <i>unencrypted on creation</i>. - Encryption is optional and manual. 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 <i>unencrypted on creation</i>.

4
buku
View File

@ -961,7 +961,7 @@ def usage():
"General options\n" "General options\n"
" -a URL [tags] add URL as bookmark with comma separated tags\n" " -a URL [tags] add URL as bookmark with comma separated tags\n"
" -d N delete entry at DB index N (from -p 0), move last entry to N\n" " -d N delete entry at DB index N (from -p 0)\n"
" -g list all tags alphabetically\n" " -g list all tags alphabetically\n"
" -m title manually specify the title, for -a, -i, -u\n" " -m title manually specify the title, for -a, -i, -u\n"
" -s keyword(s) search bookmarks for any keyword\n" " -s keyword(s) search bookmarks for any keyword\n"
@ -977,7 +977,7 @@ def usage():
" -k decrypt (unlock) database file\n" " -k decrypt (unlock) database file\n"
" -l encrypt (lock) database file\n" " -l encrypt (lock) database file\n"
" -o N open URL at DB index N in browser\n" " -o N open URL at DB index N in browser\n"
" -p N show details of bookmark record at DB index N (0 for all)\n" " -p N show details of bookmark record at DB index N, N=0 shows all\n"
" -r oldtag [newtag] replace oldtag with newtag, delete oldtag if newtag empty\n" " -r oldtag [newtag] replace oldtag with newtag, delete oldtag if newtag empty\n"
" -R refresh title from web for all bookmarks, update if non-empty\n" " -R refresh title from web for all bookmarks, update if non-empty\n"
" -t N use N (> 0) hash iterations to generate key, for -k, -l\n" " -t N use N (> 0) hash iterations to generate key, for -k, -l\n"

4
buku.1
View File

@ -32,6 +32,8 @@ Search works in mysterious ways:
- You can search bookmarks by tag (see example). - You can search bookmarks by tag (see example).
- Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown within '()' after the URL. - Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown within '()' after the URL.
.PP .PP
When a record is deleted, the last record is moved to the index.
.PP
AES256 is used for encryption. Optionally specify (-t) the number of hash iterations to use to generate key. Default is 8 iterations. AES256 is used for encryption. Optionally specify (-t) the number of hash iterations to use to generate key. Default is 8 iterations.
.PP .PP
Encryption is optional and manual. 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. 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.
@ -45,7 +47,7 @@ along with comma separated tags. A tag can have multiple words. The same URL can
.BI \-d " N" .BI \-d " N"
Delete bookmark at index Delete bookmark at index
.I N .I N
in DB (from -p 0 output). in DB (from -p 0 output). The last record is moved to the removed index.
.TP .TP
.B \-D .B \-D
Delete ALL bookmarks. Delete ALL bookmarks.