diff --git a/README.md b/README.md
index 4eacdd8..5b1a366 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-# MarkIt
+# Buku
-
+
-`markit` is a cmdline bookmark management utility written in Python3 and SQLite3. `markit` 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, `MarkIt`!
+`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`!
-The SQLite3 database file is stored in `$HOME/.cache/markit/bookmarks.db` for each user.
+The SQLite3 database file is stored in `$HOME/.cache/buku/bookmarks.db` for each user.
-`markit` is GPLv3 licensed.
+`buku` is GPLv3 licensed.
-If you find `markit` useful, please consider donating via PayPal.
+If you find `buku` useful, please consider donating via PayPal.
# Features
@@ -42,21 +42,21 @@ If you find `markit` useful, please consider donating via PayPal.
# Installation
-`markit` requires Python 3.x to work.
+`buku` requires Python 3.x to work.
1. If you have git installed (the steps are tested on Ubuntu 14.04.3 x64_64):
-$ git clone https://github.com/jarun/markit/
-$ cd markit
+$ git clone https://github.com/jarun/buku/
+$ cd buku
$ sudo make install
To remove, run:
$ sudo make uninstall
2. If you do not have git installed:
-Download the latest stable release or development version source code. Extract, cd into the directory and run:
+Download the latest stable release or development version source code. Extract, cd into the directory and run:
$ sudo make install
-If you do not want to install, `markit` is standalone:
-$ chmod +x markit
-$ ./markit ...
+If you do not want to install, `buku` is standalone:
+$ chmod +x buku
+$ ./buku ...
3. You need PyCrypto module for encryption support. To install it, run:
$ pip3 install pycrypto
@@ -65,7 +65,7 @@ OR, on Ubuntu,
# 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.
+- 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.
- 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.
- The same URL cannot be added twice. You can update tags and re-fetch title data. You can also delete it and insert at the same index.
- You can either add or update or delete record(s) in one instance. A combination of these operations is not supported in a single run.
@@ -75,11 +75,11 @@ OR, on Ubuntu,
- `-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.
+- Encryption support is manual. Database file should be unlocked (`-k`) before using buku and locked (`-l`) afterwards. Note that the database file is unecrypted on creation. AES256 is used for encryption.
Cmdline help:
-Usage: markit [OPTIONS] KEYWORDS...
+Usage: buku [OPTIONS] KEYWORDS...
Bookmark manager. Your private Google.
Options
@@ -100,70 +100,70 @@ Options
-x N works with -P, N=1: show only URL, N=2: show URL and tag
-z show debug information
you can either add or update or delete in one instance
- any other option shows help and exits markit
+ any other option shows help and exits buku
Keys
- 1-N open Nth search result in browser. Enter exits markit.
+ 1-N open Nth search result in browser. Enter exits buku.
# Examples
1. Add a new bookmark with tags `linux news` and `open source`:
-$ markit -a http://tuxdiary.com linux news, open source
+$ buku -a http://tuxdiary.com linux news, open source
Added at index 15012014
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:
-$ markit -a -w http://tuxdiary.com linux news, open source
+$ buku -a -w http://tuxdiary.com linux news, open source
Title: [TuxDiary | Linux, open source and a pinch of leisure.]
Added at index 15012014
3. Update existing bookmark at index 15012014 with a new tag:
-$ markit -u 15012014 -w http://tuxdiary.com linux news, open source, magazine
+$ buku -u 15012014 -w http://tuxdiary.com linux news, open source, magazine
Title: [TuxDiary | Linux, open source and a pinch of leisure.]
Updated
4. Update or refresh full DB:
-$ markit -R
+$ buku -R
5. Delete bookmark at index 15012014:
-$ markit -d 15012014
+$ buku -d 15012014
6. Delete all bookmarks:
-$ markit -D
+$ buku -D
7. Insert a bookmark at index 15012014 (fails if index or URL exists in database):
-$ markit -i 15012014 -w http://tuxdiary.com/about linux news, open source
+$ buku -i 15012014 -w http://tuxdiary.com/about linux news, open source
Title: [A journey with WordPress | TuxDiary]
Added at index 15012014
This option is useful in filling deleted indices from database manually.
8. Show info on bookmark at index 15012014:
-$ markit -p 15012014
+$ buku -p 15012014
9. Show all bookmarks with real index from database:
-$ markit -P
+$ buku -P
10. Open URL at index 15012014 in browser:
-$ markit -o 15012014
+$ buku -o 15012014
11. Search bookmarks for a tag matching `*kernel debugging*` or any of the keywords `*kernel*` and `*debugging*` in URL or title (separately):
-$ markit -s kernel debugging
+$ buku -s kernel debugging
12. Search bookmarks for a tag matching `*kernel debugging*` or all the keywords `*kernel*` and `*debugging*` in URL or title (separately):
-$ markit -S kernel debugging
+$ buku -S kernel debugging
13. Show debug info:
-$ markit -z
+$ buku -z
14. Show help:
-$ markit
+$ buku
15. Check manpage:
-$ man markit
-16. `markit` doesn't have any import feature of its own. To import URLs in bulk, create a script with URLs and tags like the following (check TIP below):
+$ man buku
+16. `buku` doesn't have any import feature of its own. To import URLs in bulk, create a script with URLs and tags like the following (check TIP below):
#!/bin/bash
-markit -aw https://wireless.wiki.kernel.org/ networking, device drivers
-markit -aw https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly
-markit -aw http://www.tittbit.in/
-markit -aw http://www.mikroe.com/chapters/view/65/ electronics
-markit -aw "http://msdn.microsoft.com/en-us/library/bb470206(v=vs.85).aspx" file systems
-markit -aw http://www.ibm.com/developerworks/linux/library/l-linuxboot/index.html boot process
+buku -aw https://wireless.wiki.kernel.org/ networking, device drivers
+buku -aw https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly
+buku -aw http://www.tittbit.in/
+buku -aw http://www.mikroe.com/chapters/view/65/ electronics
+buku -aw "http://msdn.microsoft.com/en-us/library/bb470206(v=vs.85).aspx" file systems
+buku -aw http://www.ibm.com/developerworks/linux/library/l-linuxboot/index.html boot process
Make the script executable and run to batch add bookmarks.
17. To update selected URLs (refresh) along with your tags, first get the unformatted selective output with URL and tags:
-$ markit -P -x 2 | tee myurls
-Remove the lines you don't need. Add `markit -wu ` in front of all the other lines (check TIP below). Should look like:
+$ buku -P -x 2 | tee myurls
+Remove the lines you don't need. Add `buku -wu ` in front of all the other lines (check TIP below). Should look like:
#!/bin/bash
-markit -wu 50 https://wireless.wiki.kernel.org/ networking, device drivers
-markit -wu 51 https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly
-markit -wu 52 http://www.tittbit.in/
-markit -wu 53 http://www.mikroe.com/chapters/view/65/ electronics
-markit -wu 54 "http://msdn.microsoft.com/en-us/library/bb470206(v=vs.85).aspx" file systems
-markit -wu 55 http://www.ibm.com/developerworks/linux/library/l-linuxboot/index.html boot process
+buku -wu 50 https://wireless.wiki.kernel.org/ networking, device drivers
+buku -wu 51 https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly
+buku -wu 52 http://www.tittbit.in/
+buku -wu 53 http://www.mikroe.com/chapters/view/65/ electronics
+buku -wu 54 "http://msdn.microsoft.com/en-us/library/bb470206(v=vs.85).aspx" file systems
+buku -wu 55 http://www.ibm.com/developerworks/linux/library/l-linuxboot/index.html boot process
Run the script:
$ chmod +x myurls
$ ./myurls
@@ -175,7 +175,7 @@ To add the same text at the beginning of multiple lines using vim editor:
- Hit `Esc`, wait 1 second and the inserted text will appear on every line.
Using sed:
-$ sed -i 's/^/markit -wu /' filename
+$ sed -i 's/^/buku -wu /' filename
#License
GPL v3
diff --git a/markit.1 b/markit.1
index 7432c55..165bafc 100644
--- a/markit.1
+++ b/markit.1
@@ -1,17 +1,17 @@
-.TH "MARKIT" "1" "December 2015" "Version 1.5" "User Commands"
+.TH "BUKU" "1" "December 2015" "Version 1.5" "User Commands"
.SH NAME
-markit \- Bookmark manager. Your private Google.
+buku \- Bookmark manager. Your private Google.
.SH SYNOPSIS
-.B markit
+.B buku
.RI [ OPTIONS ]
.I KEYWORDS...
.SH DESCRIPTION
-.B markit
+.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
-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.
+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.
.PP
@@ -26,7 +26,7 @@ Search works in mysterious ways:
- '-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.
+Encryption support is manual. Database file should be unlocked ('-k') before using buku 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", " ..."
@@ -94,13 +94,13 @@ Show selective monochrome output. Works with '-P'. If
Enable debugging.
.TP
.BI ""
-Any other option shows help and exits markit.
+Any other option shows help and exits buku.
.SH KEYS
.TP
.BI "1-N"
Open
.I Nth
-search result in browser. Pressing 'Enter' exits markit.
+search result in browser. Pressing 'Enter' exits buku.
.SH ENVIRONMENT
.TP
.BI BROWSER
@@ -109,9 +109,9 @@ Overrides the default browser. Ref:
.SH AUTHOR
Written by Arun Prakash Jana .
.SH HOME
-.I https://github.com/jarun/markit
+.I https://github.com/jarun/buku
.SH REPORTING BUGS
-.I https://github.com/jarun/markit/issues
+.I https://github.com/jarun/buku/issues
.SH COPYRIGHT
Copyright \(co 2015 Arun Prakash Jana .
License GPLv3+: GNU GPL version 3 or later .