Update readme with latest help.

This commit is contained in:
Arun Prakash Jana 2016-04-29 23:39:39 +05:30
parent f86bb4e741
commit addeecff94
No known key found for this signature in database
GPG Key ID: C0A712ED95043DCB

View File

@ -117,37 +117,59 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin
## Cmdline options ## Cmdline options
Usage: buku OPTIONS [URL] [TAGS] [KEYWORDS ...] **NOTE:** If you are using `buku` v1.9 or below please refer to the installed manpage or program help. The development version has significant changes.
usage: buku [-a URL [tags ...]] [-u [N [URL tags ...]]]
[-t [...]] [-d [N]] [-h]
[-s keyword [...]] [-S keyword [...]]
[-k [N]] [-l [N]] [-p [N]] [-f N]
[-r oldtag [newtag ...]] [-j] [-o N] [-z]
A private cmdline bookmark manager. Your mini web! A private cmdline bookmark manager. Your mini web!
General options general options:
-a URL [tags] add URL as bookmark with comma separated tags -a, --add URL [tags ...]
-d N delete entry at DB index N (from -p 0), N=0 deletes all bookmark URL with comma separated tags
-g list all tags alphabetically -u, --update [N [URL tags ...]]
-m title manually set title, for -a, -i, -u; '-m none' clears title update fields of bookmark at DB index N
-s keyword(s) search bookmarks for any keyword refresh all titles, if no arguments
-S keyword(s) search bookmarks with all keywords if URL omitted and -t is unused, update
-u N [URL] [tags] update fields of the entry at DB index N title of bookmark at index N from web
The first keyword, if available, is treated as the URL. -t, --title [...] manually set title, works with -a, -u
If URL is omitted (and -m is not used) the title of entry at do not set title, if no arguments
index N is refreshed from the web, N=0 refreshes all titles. -d, --delete [N] delete bookmark at DB index N
delete all bookmarks, if no arguments
-h, --help show this information
Power toys search options:
-e show bookmarks with empty titles or no tags -s, --sany keyword [...]
-i N insert new bookmark at free DB index N search bookmarks for ANY matching keyword
-j show results in Json format -S, --sall keyword [...]
-k decrypt (unlock) database file search bookmarks with ALL keywords
-l encrypt (lock) database file special keywords -
-o N open URL at DB index N in browser "tags" : list all tags alphabetically
-p N show details of bookmark record at DB index N, N=0 shows all "blank": list entries with empty title/tag
-r oldtag [newtag] replace oldtag with newtag, delete oldtag if newtag empty
-t N use N (> 0) hash iterations to generate key, for -k, -l
-x N modify -p behaviour, N=1: show only URL, N=2: show URL & tag
-z show debug information
Prompt keys encryption options:
1-N open Nth search result in browser -l, --lock [N] encrypt DB file with N (> 0, default 8)
hash iterations to generate key
-k, --unlock [N] decrypt DB file with N (> 0, default 8)
hash iterations to generate key
power toys:
-p, --print [N] show details of bookmark at DB index N
show all bookmarks, if no arguments
-f, --format N modify -p output
N=1: show only URL, N=2: show URL and tag
-r, --replace oldtag [newtag ...]
replace oldtag with newtag in all bookmarks
delete oldtag, if no newtag
-j, --jason Json formatted output, works with -p, -s
-o, --open open bookmark at DB index N in web browser
-z, --debug show debug information and additional logs
prompt keys:
1-N open the Nth search result in web browser
Enter exit buku Enter exit buku
## Operational notes ## Operational notes