Comprehensive manpage.

Signed-off-by: Arun Prakash Jana <engineerarun@gmail.com>
This commit is contained in:
Arun Prakash Jana 2015-11-09 02:46:01 +05:30
parent aa595325bd
commit bf7048b3f0
2 changed files with 43 additions and 35 deletions

4
markit
View File

@ -56,7 +56,9 @@ def usage():
print(" -u N update entry at index N (from output of -p)") print(" -u N update entry at index N (from output of -p)")
print(" -z show debug information") print(" -z show debug information")
print(" you can either add or update or delete in one instance") print(" you can either add or update or delete in one instance")
print(" any other input shows help and exits markit\n") print(" any other option shows help and exits markit\n")
print("Keys")
print(" 1-N open Nth search result in browser. Enter exits markit.\n")
print("Version 0.1") print("Version 0.1")
print("Copyright (C) 2015 Arun Prakash Jana <engineerarun@gmail.com>") print("Copyright (C) 2015 Arun Prakash Jana <engineerarun@gmail.com>")
print("Webpage: https://github.com/jarun/markit") print("Webpage: https://github.com/jarun/markit")

View File

@ -8,57 +8,63 @@ markit \- Bookmark manager. Your private Google.
.SH DESCRIPTION .SH DESCRIPTION
.B markit .B markit
is a command line tool to save and search bookmarks. is a command line tool to save and search bookmarks.
.PP
The Sqlite3 database file is stored in $HOME/.cache/bookmarks.db of the user.
.PP
It's advisable to copy URLs directly from the browser address bar, i.e., along with the leading `http://` or `htts://` token. markit looks up title data from the web only for fully-formed HTTP or HTTPS URLs.
.PP
You can either add or update or delete record(s) in one instance. A combination of these operations are not supported in a single instance.
.PP
Search works in mysterious ways. All the keywords are treated as a single tag together. Partial sequential tag matches are shown in results. The same keywords are separately searched as unique tokens so that entries with matching URL or title data are also shown in results.
.SH OPTIONS .SH OPTIONS
.TP .TP
.BI \-s " N" .BI \-a " URL" " " "tag 1", " tag 2", " ..."
Start at the Bookmark
.I Nth .I URL
result. along with comma separated tags. A tag can have multiple words.
.TP .TP
.BI \-n " N" .BI \-d " N"
Show Delete bookmark at index
.I N .I N
results (default 10). (as shown in `-p` output).
.TP .TP
.BI \-N .B \-D
Show results from news section. Delete ALL bookmarks.
.TP .TP
.BI \-c " SERV" .BI \-i " N"
Country-specific search [added TLDs: ar, au, be, br, ca, ch, cz, de, es, fi, fr, id, in, it, jp, kr, mx, nl, ph, pl, pt, ro, ru, se, tw, ua, uk]. Add a new record at index
.I N
of the database. Works only if `-a` option is used. Use this option to fill blank indexes left by deleted bookmarks.
.TP .TP
.BI \-l " LANG" .BI \-o
Search for the language LANG, such as Fetch Title information from the web. Works only with `-a` or `-u` options.
.I fi
for Finnish.
.TP .TP
.B \-j .B \-p
Open the first result in a web browser. Show all bookmark records from the database along with actual index.
.TP .TP
.B \-C .BI \-s " keywords"
Enable color output. Search bookmarks for a (partial) tag or keywords 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.
.TP .TP
.BI \-t " dN" .BI \-u " N"
Time limit search [h5 (5 hrs), d5 (5 days), w5 (5 weeks), m5 (5 months), y5 (5 years)]. Update bookmark at index
.I N
(as shown in `-p` output).
.TP .TP
.BI \-d .BI \-z
Enable debugging. Enable debugging.
.SH KEYS
.TP
.BI g " terms"
Enter 'g' followed by keywords to initiate a new search (with original options).
.TP
.BI "n, p"
Enter 'n' or 'p' to navigate forward or backward.
.TP
.BI "1-N"
Enter a number to open that result in browser.
.TP .TP
.BI "" .BI ""
Any other input exits googler. Any other option shows help and exits markit.
.SH KEYS
.TP
.BI "1-N"
Open
.I Nth
search result in browser. Pressing `Enter` exits markit.
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
.BI BROWSER .BI BROWSER
Overrides the default browser. For full details, see Overrides the default browser. Ref:
.I http://docs.python.org/library/webbrowser.html .I http://docs.python.org/library/webbrowser.html
.SH AUTHOR .SH AUTHOR
Written by Arun Prakash Jana <engineerarun@gmail.com>. Written by Arun Prakash Jana <engineerarun@gmail.com>.