From afe3ab8a36dd6682bf10ec4dd2ab774fb51e148e Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Sat, 19 Dec 2015 23:45:22 +0530 Subject: [PATCH] Update help, readme, manpage. Signed-off-by: Arun Prakash Jana --- README.md | 9 +++++++++ markit | 4 ++-- markit.1 | 8 ++++++++ 3 files changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 09395b3..4eacdd8 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,7 @@ If you find `markit` useful, please consider donating via PayPal. # Features - Add, update or remove a bookmark - Add tags to bookmarks +- Manually encrypt and decrypt database (AES256 algorithm) - Optionally fetch page title data from the web (default: disabled) - Use (partial) tags or keywords to search bookmarks - Any or all search keyword match options @@ -57,6 +58,11 @@ If you do not want to install, `markit` is standalone: 
$ chmod +x markit
 $ ./markit ...
+3. You need PyCrypto module for encryption support. To install it, run: +
$ pip3 install pycrypto
+OR, on Ubuntu, +
$ sudo apt-get install python3-crypto
+ # Usage Operational notes: - It's advisable to copy URLs directly from the browser address bar, i.e., along with the leading `http://` or `https://` token. `markit` looks up title data (found within tags of HTML) from the web ONLY for fully-formed HTTP(S) URLs. @@ -69,6 +75,7 @@ $ ./markit ... - `-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. +- Encryption support is manual. Database file should be unlocked (`-k`) before using markit and locked (`-l`) afterwards. Note that the database file is unecrypted on creation. AES256 is used for encryption. Cmdline help: @@ -80,6 +87,8 @@ Options -d N delete entry at DB index N (from -P output) -D delete ALL bookmarks -i N insert entry at DB index N, useful to fill deleted index + -k decrypt (unlock) database file + -l encrypt (lock) database file -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 diff --git a/markit b/markit index 5c61531..58f7a7c 100755 --- a/markit +++ b/markit @@ -70,8 +70,8 @@ def usage(): print(" -d N delete entry at DB index N (from -P output)") print(" -D delete ALL bookmarks") print(" -i N insert entry at DB index N, useful to fill deleted index") - print(" -k decrypt database file (needs PyCrypto)") - print(" -l encrypt database file (needs PyCrypto)") + print(" -k decrypt (unlock) database file") + print(" -l encrypt (lock) database file") 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/markit.1 b/markit.1 index 222cab2..4597a65 100644 --- a/markit.1 +++ b/markit.1 @@ -25,6 +25,8 @@ Search works in mysterious ways: - '-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 +Encryption support is manual. Database file should be unlocked ('-k') before using markit and locked ('-l') afterwards. Note that the database file is unecrypted on creation. AES256 is used for encryption. .SH OPTIONS .TP .BI \-a " URL" " " "tag 1", " tag 2", " ..." @@ -45,6 +47,12 @@ Add a new record at index .I N in DB. Use this option to fill blank indices left by deleted bookmarks. .TP +.B \-k +Decrypt (unlock) the DB file. +.TP +.B \-l +Encrypt (lock) the DB file. +.TP .BI \-o " N" Open URL at DB index .I N