pjht/buku
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Changed references to markit to buku in help and man.

Browse Source 
Signed-off-by: Arun Prakash Jana <engineerarun@gmail.com>
This commit is contained in:
Arun Prakash Jana 2015-12-20 01:43:46 +05:30
parent 97ff185bb7
commit 562b95d72a
2 changed files with 59 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

98
README.md
View File

@ -1,14 +1,14 @@
# MarkIt # Buku
![Screenshot](markit.png) ![Screenshot](buku.png)
`markit` is a cmdline bookmark management utility written in Python3 and SQLite3. `markit` exists because of my monumental dependency on <a href="http://historio.us/">historious</a>. 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 <a href="http://historio.us/">historious</a>. 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.
<a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif" alt="Donate Button with Credit Cards" /></a> <a href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&amp;hosted_button_id=RMLTQ76JSXJ4Q"><img src="https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif" alt="Donate Button with Credit Cards" /></a>
# Features # Features
@ -42,21 +42,21 @@ If you find `markit` useful, please consider donating via PayPal.
# Installation # 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): 1. If you have git installed (the steps are tested on Ubuntu 14.04.3 x64_64):
<pre>$ git clone https://github.com/jarun/markit/ <pre>$ git clone https://github.com/jarun/buku/
$ cd markit $ cd buku
$ sudo make install</pre> $ sudo make install</pre>
To remove, run: To remove, run:
<pre>$ sudo make uninstall</pre> <pre>$ sudo make uninstall</pre>
2. If you do not have git installed: 2. If you do not have git installed:
Download the <a href="https://github.com/jarun/markit/releases/latest">latest stable release</a> or <a href="https://github.com/jarun/markit/archive/master.zip">development version</a> source code. Extract, cd into the directory and run: Download the <a href="https://github.com/jarun/buku/releases/latest">latest stable release</a> or <a href="https://github.com/jarun/buku/archive/master.zip">development version</a> source code. Extract, cd into the directory and run:
<pre>$ sudo make install</pre> <pre>$ sudo make install</pre>
If you do not want to install, `markit` is standalone: If you do not want to install, `buku` is standalone:
<pre>$ chmod +x markit <pre>$ chmod +x buku
$ ./markit ...</pre> $ ./buku ...</pre>
3. You need PyCrypto module for encryption support. To install it, run: 3. You need PyCrypto module for encryption support. To install it, run:
<pre>$ pip3 install pycrypto</pre> <pre>$ pip3 install pycrypto</pre>
@ -65,7 +65,7 @@ OR, on Ubuntu,
# Usage # Usage
<b>Operational notes:</b> <b>Operational notes:</b>
- 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 <title></title> 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 <title></title> 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. - 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. - 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. - 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 any of the keywords in URL or title. Order is irrelevant.
- `-S` : match all 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. - 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 <i>unecrypted on creation</i>. 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 <i>unecrypted on creation</i>. AES256 is used for encryption.
<b>Cmdline help:</b> <b>Cmdline help:</b>
<pre>Usage: markit [OPTIONS] KEYWORDS... <pre>Usage: buku [OPTIONS] KEYWORDS...
Bookmark manager. Your private Google. Bookmark manager. Your private Google.
Options Options
@ -100,70 +100,70 @@ Options
-x N works with -P, N=1: show only URL, N=2: show URL and tag -x N works with -P, N=1: show only URL, N=2: show URL and tag
-z show debug information -z show debug information
you can either add or update or delete in one instance 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 Keys
1-N open Nth search result in browser. Enter exits markit.</pre> 1-N open Nth search result in browser. Enter exits buku.</pre>
# Examples # Examples
1. <b>Add</b> a new bookmark with tags `linux news` and `open source`: 1. <b>Add</b> a new bookmark with tags `linux news` and `open source`:
<pre>$ markit -a http://tuxdiary.com linux news, open source <pre>$ buku -a http://tuxdiary.com linux news, open source
Added at index 15012014</pre> Added at index 15012014</pre>
The assigned automatic index 15012014 is unique, one greater than highest index already in use in database. The assigned automatic index 15012014 is unique, one greater than highest index already in use in database.
2. Add a bookmark, <b>fetch page title</b> information from web: 2. Add a bookmark, <b>fetch page title</b> information from web:
<pre>$ markit -a -w http://tuxdiary.com linux news, open source <pre>$ buku -a -w http://tuxdiary.com linux news, open source
Title: [TuxDiary | Linux, open source and a pinch of leisure.] Title: [TuxDiary | Linux, open source and a pinch of leisure.]
Added at index 15012014</pre> Added at index 15012014</pre>
3. <b>Update</b> existing bookmark at index 15012014 with a new tag: 3. <b>Update</b> existing bookmark at index 15012014 with a new tag:
<pre>$ markit -u 15012014 -w http://tuxdiary.com linux news, open source, magazine <pre>$ buku -u 15012014 -w http://tuxdiary.com linux news, open source, magazine
Title: [TuxDiary | Linux, open source and a pinch of leisure.] Title: [TuxDiary | Linux, open source and a pinch of leisure.]
Updated</pre> Updated</pre>
4. Update or <b>refresh full DB</b>: 4. Update or <b>refresh full DB</b>:
<pre>$ markit -R</pre> <pre>$ buku -R</pre>
5. <b>Delete</b> bookmark at index 15012014: 5. <b>Delete</b> bookmark at index 15012014:
<pre>$ markit -d 15012014</pre> <pre>$ buku -d 15012014</pre>
6. <b>Delete all</b> bookmarks: 6. <b>Delete all</b> bookmarks:
<pre>$ markit -D</pre> <pre>$ buku -D</pre>
7. <b>Insert</b> a bookmark at index 15012014 (fails if index or URL exists in database): 7. <b>Insert</b> a bookmark at index 15012014 (fails if index or URL exists in database):
<pre>$ markit -i 15012014 -w http://tuxdiary.com/about linux news, open source <pre>$ buku -i 15012014 -w http://tuxdiary.com/about linux news, open source
Title: [A journey with WordPress | TuxDiary] Title: [A journey with WordPress | TuxDiary]
Added at index 15012014</pre> Added at index 15012014</pre>
This option is useful in filling deleted indices from database manually. This option is useful in filling deleted indices from database manually.
8. <b>Show info</b> on bookmark at index 15012014: 8. <b>Show info</b> on bookmark at index 15012014:
<pre>$ markit -p 15012014</pre> <pre>$ buku -p 15012014</pre>
9. <b>Show all</b> bookmarks with real index from database: 9. <b>Show all</b> bookmarks with real index from database:
<pre>$ markit -P</pre> <pre>$ buku -P</pre>
10. <b>Open URL</b> at index 15012014 in browser: 10. <b>Open URL</b> at index 15012014 in browser:
<pre>$ markit -o 15012014</pre> <pre>$ buku -o 15012014</pre>
11. <b>Search</b> bookmarks for a tag matching `*kernel debugging*` or any of the keywords `*kernel*` and `*debugging*` in URL or title (separately): 11. <b>Search</b> bookmarks for a tag matching `*kernel debugging*` or any of the keywords `*kernel*` and `*debugging*` in URL or title (separately):
<pre>$ markit -s kernel debugging</pre> <pre>$ buku -s kernel debugging</pre>
12. <b>Search</b> bookmarks for a tag matching `*kernel debugging*` or all the keywords `*kernel*` and `*debugging*` in URL or title (separately): 12. <b>Search</b> bookmarks for a tag matching `*kernel debugging*` or all the keywords `*kernel*` and `*debugging*` in URL or title (separately):
<pre>$ markit -S kernel debugging</pre> <pre>$ buku -S kernel debugging</pre>
13. Show <b>debug info</b>: 13. Show <b>debug info</b>:
<pre>$ markit -z</pre> <pre>$ buku -z</pre>
14. Show <b>help</b>: 14. Show <b>help</b>:
<pre>$ markit</pre> <pre>$ buku</pre>
15. Check <b>manpage</b>: 15. Check <b>manpage</b>:
<pre>$ man markit</pre> <pre>$ man buku</pre>
16. `markit` doesn't have any <b>import feature</b> of its own. To import URLs in bulk, create a script with URLs and tags like the following (check TIP below): 16. `buku` doesn't have any <b>import feature</b> of its own. To import URLs in bulk, create a script with URLs and tags like the following (check TIP below):
<pre>#!/bin/bash <pre>#!/bin/bash
markit -aw https://wireless.wiki.kernel.org/ networking, device drivers buku -aw https://wireless.wiki.kernel.org/ networking, device drivers
markit -aw https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly buku -aw https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly
markit -aw http://www.tittbit.in/ buku -aw http://www.tittbit.in/
markit -aw http://www.mikroe.com/chapters/view/65/ electronics buku -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 buku -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</pre> buku -aw http://www.ibm.com/developerworks/linux/library/l-linuxboot/index.html boot process</pre>
Make the script executable and run to batch add bookmarks. Make the script executable and run to batch add bookmarks.
17. To <b>update selected URLs</b> (refresh) along with your tags, first get the unformatted selective output with URL and tags: 17. To <b>update selected URLs</b> (refresh) along with your tags, first get the unformatted selective output with URL and tags:
<pre>$ markit -P -x 2 | tee myurls</pre> <pre>$ buku -P -x 2 | tee myurls</pre>
Remove the lines you don't need. Add `markit -wu ` in front of all the other lines (check TIP below). Should look like: Remove the lines you don't need. Add `buku -wu ` in front of all the other lines (check TIP below). Should look like:
<pre>#!/bin/bash <pre>#!/bin/bash
markit -wu 50 https://wireless.wiki.kernel.org/ networking, device drivers buku -wu 50 https://wireless.wiki.kernel.org/ networking, device drivers
markit -wu 51 https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly buku -wu 51 https://courses.engr.illinois.edu/ece390/books/artofasm/ArtofAsm.html assembly
markit -wu 52 http://www.tittbit.in/ buku -wu 52 http://www.tittbit.in/
markit -wu 53 http://www.mikroe.com/chapters/view/65/ electronics buku -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 buku -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</pre> buku -wu 55 http://www.ibm.com/developerworks/linux/library/l-linuxboot/index.html boot process</pre>
Run the script: Run the script:
<pre>$ chmod +x myurls <pre>$ chmod +x myurls
$ ./myurls</pre> $ ./myurls</pre>
@ -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. - Hit `Esc`, wait 1 second and the inserted text will appear on every line.
Using sed: Using sed:
<pre>$ sed -i 's/^/markit -wu /' filename</pre> <pre>$ sed -i 's/^/buku -wu /' filename</pre>
#License #License
GPL v3 GPL v3

20
markit.1
View File

@ -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 .SH NAME
markit \- Bookmark manager. Your private Google. buku \- Bookmark manager. Your private Google.
.SH SYNOPSIS .SH SYNOPSIS
.B markit .B buku
.RI [ OPTIONS ] .RI [ OPTIONS ]
.I KEYWORDS... .I KEYWORDS...
.SH DESCRIPTION .SH DESCRIPTION
.B markit .B buku
is a command line tool to save and search bookmarks. is a command line tool to save and search bookmarks.
.PP .PP
The SQLite3 database file is stored in $HOME/.cache/bookmarks.db for each user. The SQLite3 database file is stored in $HOME/.cache/bookmarks.db for each user.
.SH OPERATIONAL NOTES .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 <title></title> 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 <title></title> tags of HTML) from the web ONLY for fully-formed HTTP(S) URLs.
.PP .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. 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 .PP
@ -26,7 +26,7 @@ Search works in mysterious ways:
- '-S' : match all 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. - 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 .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 .SH OPTIONS
.TP .TP
.BI \-a " URL" " " "tag 1", " tag 2", " ..." .BI \-a " URL" " " "tag 1", " tag 2", " ..."
@ -94,13 +94,13 @@ Show selective monochrome output. Works with '-P'. If
Enable debugging. Enable debugging.
.TP .TP
.BI "" .BI ""
Any other option shows help and exits markit. Any other option shows help and exits buku.
.SH KEYS .SH KEYS
.TP .TP
.BI "1-N" .BI "1-N"
Open Open
.I Nth .I Nth
search result in browser. Pressing 'Enter' exits markit. search result in browser. Pressing 'Enter' exits buku.
.SH ENVIRONMENT .SH ENVIRONMENT
.TP .TP
.BI BROWSER .BI BROWSER
@ -109,9 +109,9 @@ Overrides the default browser. Ref:
.SH AUTHOR .SH AUTHOR
Written by Arun Prakash Jana <engineerarun@gmail.com>. Written by Arun Prakash Jana <engineerarun@gmail.com>.
.SH HOME .SH HOME
.I https://github.com/jarun/markit .I https://github.com/jarun/buku
.SH REPORTING BUGS .SH REPORTING BUGS
.I https://github.com/jarun/markit/issues .I https://github.com/jarun/buku/issues
.SH COPYRIGHT .SH COPYRIGHT
Copyright \(co 2015 Arun Prakash Jana <engineerarun@gmail.com>. Copyright \(co 2015 Arun Prakash Jana <engineerarun@gmail.com>.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>.