From 72b59e8f9101007e0d5cfab6cf8de2fb85f873d9 Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Thu, 3 Mar 2016 23:48:04 +0530 Subject: [PATCH] Help and documentation on option '-m'. Signed-off-by: Arun Prakash Jana --- README.md | 9 ++++++--- buku | 1 + buku.1 | 10 ++++++++-- 3 files changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ec500ce..95aaca7 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ `buku` (formerly `markit`) is a cmdline bookmark management utility written in Python3 and SQLite3. `buku` exists because of my monumental dependency on historious. I wanted the same database on my local system. However, I couldn't find an equally flexible cmdline solution. Hence, `Buku` (after my son's nickname). -You can add bookmarks to `buku` with tags, optionally fetch page title from web, search by keywords for matching tags or title or URL, update and remove bookmarks. You can open the URLs from search results directly in the browser. You can encrypt or decrypt the database file manually, optionally with custom number of hash passes for key generation. +You can add bookmarks to `buku` with title and tags, optionally fetch page title from web, search by keywords for matching tags or title or URL, update and remove bookmarks. You can open the URLs from search results directly in the browser. You can encrypt or decrypt the database file manually, optionally with custom number of hash passes for key generation. The SQLite3 database file is stored in `$HOME/.cache/buku/bookmarks.db` for each user. @@ -33,6 +33,7 @@ If you find `buku` useful, please consider donating via PayPal. - Add tags to bookmarks - Manual password protection using AES256 encryption algorithm - Optionally fetch page title data from the web (default: disabled) +- Add or update page title offline manually - Use (partial) tags or keywords to search bookmarks - Any or all search keyword match options - Unique URLs to avoid duplicates, show index if URL already exists @@ -124,6 +125,7 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin -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 @@ -141,10 +143,11 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin 1-N open Nth search result in browser. Enter exits buku. # Examples -1. **Add** a new bookmark with tags `linux news` and `open source`: +1. **Add** a new bookmark with title `Linux magazine` & tags `linux news` and `open source`: - $ buku -a http://tuxdiary.com linux news, open source + $ buku -a -m 'Linux magazine' http://tuxdiary.com linux news, open source Added at index 15012014 +Note that URL must precede tags. Multiple words in title must be within quotes. The assigned automatic index 15012014 is unique, one greater than highest index already in use in database. 2. Add a bookmark, **fetch page title** information from web: diff --git a/buku b/buku index 68b48fa..ad3d7bd 100755 --- a/buku +++ b/buku @@ -79,6 +79,7 @@ def usage(): 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") diff --git a/buku.1 b/buku.1 index 3ae88e3..abc7481 100644 --- a/buku.1 +++ b/buku.1 @@ -3,14 +3,17 @@ buku \- Bookmark manager. Your private Google. .SH SYNOPSIS .B buku -.RI [ OPTIONS ] -.I KEYWORDS... +.I OPTIONS +.RI [ URL ] +.RI [ TAGS ] .SH DESCRIPTION .B buku is a command line tool to save and search bookmarks. .PP The SQLite3 database file is stored in $HOME/.cache/bookmarks.db for each user. .SH OPERATIONAL NOTES +URL must precede the tags. Manual title with multiple keywords must be within quotes. +.PP It's advisable to copy URLs directly from the browser address bar, i.e., along with the leading 'http://' or 'https://' token. buku looks up title data (found within tags of HTML) from the web ONLY for fully-formed HTTP(S) URLs. .PP If the URL contains characters like ';', '&' or brackets they may be interpreted specially by the shell. To avoid it, add the URL within single ''' or double '"' qoutes. @@ -53,6 +56,9 @@ Decrypt (unlock) the DB file. .B \-l Encrypt (lock) the DB file. .TP +.BI \-m " keywords" +Add or update the title manually. +.TP .BI \-o " N" Open URL at DB index .I N