From 0cb2fd8070b42bef2ca9e454b2e115093c12925f Mon Sep 17 00:00:00 2001 From: Arun Prakash Jana Date: Mon, 23 May 2016 12:03:57 +0530 Subject: [PATCH] Update README. Signed-off-by: Arun Prakash Jana --- README.md | 14 +++++++------- buku.1 | 6 +++--- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 6805f6b..5e36815 100644 --- a/README.md +++ b/README.md @@ -171,19 +171,19 @@ Shell completion scripts for Bash, Fish and Zsh can be found in respective subdi - 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 (`'`/`"`) quotes. - URLs are unique in DB. The same URL cannot be added twice. You can update tags and re-fetch title data. - Update operation: - - if --title, --tag or --comment is passed without argument, clear the corresponding field from DB - - if --url is passed (and --title is omitted), update the title from web using the URL - - if index number is passed without any other options (--url, --title, --tag and --comment), read the URL from DB and update title from web + - If --title, --tag or --comment is passed without argument, clear the corresponding field from DB. + - If --url is passed (and --title is omitted), update the title from web using the URL. + - If index number is passed without any other options (--url, --title, --tag and --comment), read the URL from DB and update title from web. - Search works in mysterious ways: - Case-insensitive. - Substrings match (`match` matches `rematched`) for URL, title and tags. - - `-s` : match any of the keywords in URL, title or tags. - - `-S` : match all the keywords in URL, title or tags. - - `--st` : search bookmarks by tag, or show all tags alphabetically. + - -s : match any of the keywords in URL, title or tags. + - -S : match all the keywords in URL, title or tags. + - --st : search bookmarks by tag, or show all tags alphabetically. - You can search bookmarks by tag (see [examples](#examples)). - Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown within `[]` after the URL. - Auto DB compaction: when a record is deleted, the last record is moved to the index. -- Encryption is optional and manual. AES256 algorithm is used. 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 unencrypted on creation. +- Encryption is optional and manual. AES256 algorithm is used. 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 unencrypted on creation. # Examples 1. **Add** a bookmark with **tags** `linux news` and `open source`, **comment** `Informative website on Linux and open source`, **fetch page title** from the web: diff --git a/buku.1 b/buku.1 index 5a473e0..f7a07f5 100644 --- a/buku.1 +++ b/buku.1 @@ -33,9 +33,9 @@ If the URL contains characters like ';', '&' or brackets they may be interpreted URLs are unique in DB. The same URL cannot be added twice. You can update tags and re-fetch title data. .pp Update operation: - - if --title, --tag or --comment is passed without argument, clear the corresponding field from DB - - if --url is passed (and --title is omitted), update the title from web using the URL - - if index number is passed without any other options (--url, --title, --tag and --comment), read the URL from DB and update title from web + - If --title, --tag or --comment is passed without argument, clear the corresponding field from DB. + - If --url is passed (and --title is omitted), update the title from web using the URL. + - If index number is passed without any other options (--url, --title, --tag and --comment), read the URL from DB and update title from web. .PP Search works in mysterious ways: - Case-insensitive.