pjht/buku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat help and man.

Browse Source 
Signed-off-by: Arun Prakash Jana <engineerarun@gmail.com>
This commit is contained in:
Arun Prakash Jana 2016-03-25 14:59:19 +05:30
parent e8835504ff
commit 8fb1123831
3 changed files with 58 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
README.md
View File

@ -128,31 +128,31 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin
Bookmark manager. Your private Google.
Options
-a URL tag 1, tag 2, ... add URL as bookmark with comma separated tags
-d N delete entry at DB index N (from -P), move last entry to N
-D delete ALL bookmarks
-e show bookmarks with empty titles or no tags
-g show all tags (sorted alphabetically)
-i N insert entry at DB index N, useful to fill deleted index
-k decrypt (unlock) database file
-l encrypt (lock) database file
-m manually add or update the title offline
-o N open URL at DB index N in browser
-p N show details of bookmark record at DB index N
-P show all bookmarks along with index from DB
-R refresh all bookmarks, tags retained
-r oldtag [newtag] replace oldtag with newtag in DB, deletes oldtag if newtag empty
-s keyword(s) search all bookmarks for a (partial) tag or any keyword
-S keyword(s) search all bookmarks for a (partial) tag or all keywords
-t N use N (> 0) hash iterations to generate key, works with -k, -l
-u N update all fields of entry at DB index N
-w fetch title info from web, works with -a, -i, -u
-x N works with -P, N=1: show only URL, N=2: show URL and tag
-z show debug information
any other option shows help and exits buku
-a URL [tags] add URL as bookmark with comma separated tags
-d N delete entry at DB index N (from -P), move last entry to N
-D delete ALL bookmarks
-e show bookmarks with empty titles or no tags
-g show all tags (sorted alphabetically)
-i N insert entry at DB index N, useful to fill deleted index
-k decrypt (unlock) database file
-l encrypt (lock) database file
-m manually add or update the title offline, works with -a, -i, -u
-o N open URL at DB index N in browser
-p N show details of bookmark record at DB index N
-P show all bookmarks along with index from DB
-R refresh all bookmarks, tags retained
-r oldtag [newtag] replace oldtag with newtag in DB, deletes oldtag if newtag empty
-s keyword(s) search all bookmarks for a (partial) tag or any keyword
-S keyword(s) search all bookmarks for a (partial) tag or all keywords
-t N use N (> 0) hash iterations to generate key, works with -k, -l
-u N URL [tags] update all fields of entry at DB index N
-w fetch title info from web, works with -a, -i, -u
-x N works with -P, N=1: show only URL, N=2: show URL and tag
-z show debug information
any other option shows help and exits buku
Keys
1-N open Nth search result in browser. Enter exits buku.
1-N open Nth search result in browser. Enter exits buku.
# Examples
1. **Add** a new bookmark with title `Linux magazine` & tags `linux news` and `open source`:

46
buku
View File

@ -77,30 +77,30 @@ def usage():
print("Usage: OPTIONS [URL] [TAGS] [KEYWORDS ...]\n")
print("Bookmark manager. Your private Google.\n")
print("Options")
print(" -a URL tag 1, tag 2, ... add URL as bookmark with comma separated tags")
print(" -d N delete entry at DB index N (from -P), move last entry to N")
print(" -D delete ALL bookmarks")
print(" -e show bookmarks with empty titles or no tags")
print(" -g show all tags (sorted alphabetically)")
print(" -i N insert entry at DB index N, useful to fill deleted index")
print(" -k decrypt (unlock) database file")
print(" -l encrypt (lock) database file")
print(" -m manually add or update the title offline")
print(" -o N open URL at DB index N in browser")
print(" -p N show details of bookmark record at DB index N")
print(" -P show all bookmarks along with index from DB")
print(" -R refresh all bookmarks, tags retained")
print(" -r oldtag [newtag] replace oldtag with newtag in DB, deletes oldtag if newtag empty")
print(" -s keyword(s) search all bookmarks for a (partial) tag or any keyword")
print(" -S keyword(s) search all bookmarks for a (partial) tag or all keywords")
print(" -t N use N (> 0) hash iterations to generate key, works with -k, -l")
print(" -u N update all fields of entry at DB index N")
print(" -w fetch title info from web, works with -a, -i, -u")
print(" -x N works with -P, N=1: show only URL, N=2: show URL and tag")
print(" -z show debug information")
print(" any other option shows help and exits buku\n")
print(" -a URL [tags] add URL as bookmark with comma separated tags")
print(" -d N delete entry at DB index N (from -P), move last entry to N")
print(" -D delete ALL bookmarks")
print(" -e show bookmarks with empty titles or no tags")
print(" -g show all tags (sorted alphabetically)")
print(" -i N insert entry at DB index N, useful to fill deleted index")
print(" -k decrypt (unlock) database file")
print(" -l encrypt (lock) database file")
print(" -m manually add or update the title offline, works with -a, -i, -u")
print(" -o N open URL at DB index N in browser")
print(" -p N show details of bookmark record at DB index N")
print(" -P show all bookmarks along with index from DB")
print(" -R refresh all bookmarks, tags retained")
print(" -r oldtag [newtag] replace oldtag with newtag in DB, deletes oldtag if newtag empty")
print(" -s keyword(s) search all bookmarks for a (partial) tag or any keyword")
print(" -S keyword(s) search all bookmarks for a (partial) tag or all keywords")
print(" -t N use N (> 0) hash iterations to generate key, works with -k, -l")
print(" -u N URL [tags] update all fields of entry at DB index N")
print(" -w fetch title info from web, works with -a, -i, -u")
print(" -x N works with -P, N=1: show only URL, N=2: show URL and tag")
print(" -z show debug information")
print(" any other option shows help and exits buku\n")
print("Keys")
print(" 1-N open Nth search result in browser. Enter exits buku.\n")
print(" 1-N open Nth search result in browser. Enter exits buku.\n")
print("Version 1.8")
print("Copyright (C) 2015 Arun Prakash Jana <engineerarun@gmail.com>")
print("License: GPLv3")

24
buku.1
View File

@ -26,16 +26,16 @@ You can either add or update or delete record(s) in one instance. A combination
Search works in mysterious ways:
- Substrings match ('match' matches 'rematched') for URL, tags and title.
- All the keywords are treated together as a 'single' tag in the 'same order'. Bookmarks with partial or complete tag matches are shown in results.
- '-s' : match any of the keywords in URL or title. Order is irrelevant.
- '-S' : match all the keywords in URL or title. Order is irrelevant.
- -s : match any of the keywords in URL or title. Order is irrelevant.
- -S : match all the keywords in URL or title. Order is irrelevant.
- Search results are indexed serially. This index is different from actual database index of a bookmark reord which is shown within '()' after the URL.
.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
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 unecrypted 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 unecrypted on creation.
.SH OPTIONS
.TP
.BI \-a " URL" " " "tag 1", " tag 2", " ..."
.BI \-a " URL" " " "[tags]"
Bookmark
.I URL
along with comma separated tags. A tag can have multiple words. The same URL cannot be added twice.
@ -43,7 +43,7 @@ along with comma separated tags. A tag can have multiple words. The same URL can
.BI \-d " N"
Delete bookmark at index
.I N
in DB (from '-P' output).
in DB (from -P output).
.TP
.B \-D
Delete ALL bookmarks.
@ -66,7 +66,7 @@ Decrypt (unlock) the DB file.
Encrypt (lock) the DB file.
.TP
.BI \-m " keywords"
Add or update the title manually.
Add or update the title manually, works with -a, -i, -u.
.TP
.BI \-o " N"
Open URL at DB index
@ -88,23 +88,23 @@ Refresh all bookmarks. Titles are fetched from the web and updated if non-empty.
Search bookmarks for a (partial) tag or any keyword and show the results. Prompts to enter result number to open in browser. Note that the sequential index number may not match the real index in database. DB index is shown in the end within '()'.
.TP
.BI \-S " keywords"
Search bookmarks for a (partial) tag or occurrence of all keywords in URL or title and show the results. Rest same as '-s'.
Search bookmarks for a (partial) tag or occurrence of all keywords in URL or title and show the results. Rest same as -s.
.TP
.BI \-t " N"
Use
.I N
(> 0) hash iterations to generate key, works with '-k', '-l'.
(> 0) hash iterations to generate key, works with -k, -l.
.TP
.BI \-u " N"
.BI \-u " N" " " "URL" " " "[tags]"
Update all fields of bookmark at index
.I N
in DB.
.TP
.BI \-w
Fetch title data from the web. Works with '-a', '-i' or '-u' options.
Fetch title data from the web. Works with -a, -i or -u options.
.TP
.BI \-x " N"
Show selective monochrome output. Works with '-P'. If
Show selective monochrome output. Works with -P. If
.I N
= 1, only URL is shown. If
.I N