Merge remote-tracking branch 'upstream/master' into json-output
Conflicts: README.md buku
This commit is contained in:
commit
d290dd7197
34
Makefile
34
Makefile
@ -1,30 +1,22 @@
|
||||
PREFIX=/usr/local
|
||||
BINDIR=$(PREFIX)/bin
|
||||
MANDIR=$(PREFIX)/share/man/man1
|
||||
DOCDIR=$(PREFIX)/share/doc/buku
|
||||
UNAME_S:=$(shell uname -s)
|
||||
PREFIX?= /usr/local
|
||||
BINDIR?= $(PREFIX)/bin
|
||||
MANDIR?= $(PREFIX)/share/man/man1
|
||||
DOCDIR?= $(PREFIX)/share/doc/buku
|
||||
|
||||
|
||||
.PHONY: install uninstall
|
||||
|
||||
install:
|
||||
install -m755 -d $(BINDIR)
|
||||
install -m755 -d $(MANDIR)
|
||||
install -m755 -d $(DOCDIR)
|
||||
install -m755 -d $(DESTDIR)$(BINDIR)
|
||||
install -m755 -d $(DESTDIR)$(MANDIR)
|
||||
install -m755 -d $(DESTDIR)$(DOCDIR)
|
||||
gzip -c buku.1 > buku.1.gz
|
||||
@if [ "$(UNAME_S)" = "Linux" ]; then\
|
||||
install -m755 -t $(BINDIR) buku; \
|
||||
install -m644 -t $(MANDIR) buku.1.gz; \
|
||||
install -m644 -t $(DOCDIR) README.md; \
|
||||
fi
|
||||
@if [ "$(UNAME_S)" = "Darwin" ]; then\
|
||||
install -m755 buku $(BINDIR); \
|
||||
install -m644 buku.1.gz $(MANDIR); \
|
||||
install -m644 README.md $(DOCDIR); \
|
||||
fi
|
||||
install -m755 buku $(DESTDIR)$(BINDIR)
|
||||
install -m644 buku.1.gz $(DESTDIR)$(MANDIR)
|
||||
install -m644 README.md $(DESTDIR)$(DOCDIR)
|
||||
rm -f buku.1.gz
|
||||
|
||||
uninstall:
|
||||
rm -f $(BINDIR)/buku
|
||||
rm -f $(MANDIR)/buku.1.gz
|
||||
rm -rf $(DOCDIR)
|
||||
rm -f $(DESTDIR)$(BINDIR)/buku
|
||||
rm -f $(DESTDIR)$(MANDIR)/buku.1.gz
|
||||
rm -rf $(DESTDIR)$(DOCDIR)
|
||||
|
182
README.md
182
README.md
@ -2,29 +2,35 @@
|
||||
|
||||
![Screenshot](http://i.imgur.com/UPKcSuN.png)
|
||||
|
||||
`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` (after my son's nickname).
|
||||
`buku` is a powerful 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` (after my son's nickname).
|
||||
|
||||
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.
|
||||
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, title or tags. 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.
|
||||
`buku` can also handle piped input, which lets you combine it with `xsel` (on Linux) and use a shortcut to add selected or copied text as bookmark without touching the terminal.
|
||||
Ref: [buku & xsel: add selected or copied URL as bookmark](http://tuxdiary.com/2016/03/26/buku-xsel/)
|
||||
|
||||
The SQLite3 database file is stored in `$HOME/.local/share/buku/bookmarks.db` (or `$XDG_DATA_HOME/buku/bookmarks.db`, if XDG_DATA_HOME is defined) for each user.
|
||||
|
||||
Before version 1.9, buku stored database in `$HOME/.cache/buku/bookmarks.db`. If the file exists, buku automatically moves it to new location.
|
||||
|
||||
`buku` is **GPLv3** licensed. Copyright (C) 2015 [Arun Prakash Jana](mailto:engineerarun@gmail.com).
|
||||
|
||||
If you find `buku` useful, please consider donating via PayPal.
|
||||
[![Donate Button](https://img.shields.io/badge/paypal-donate-orange.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q)
|
||||
Find `buku` useful? If you would like to donate, visit the
|
||||
[![Donate Button](https://img.shields.io/badge/paypal-donate-orange.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RMLTQ76JSXJ4Q) page.
|
||||
|
||||
# Table of Contents
|
||||
|
||||
- [Features](#features)
|
||||
- [Installation](#installation)
|
||||
- [Dependencies](#dependencies)
|
||||
- [Installating from source](#installing-from-source)
|
||||
- [Installing from this repository](#installing-from-this-repository)
|
||||
- [Running as a standalone utility](#running-as-a-standalone-utility)
|
||||
- [Installing with a package manager](#installing-with-a-package-manager)
|
||||
- [Usage](#usage)
|
||||
- [Cmdline options](#cmdline-options)
|
||||
- [Operational notes](#operational-notes)
|
||||
- [cmdline help](#cmdline-help)
|
||||
- [Examples](#examples)
|
||||
- [Bookkeeping](#bookkeeping)
|
||||
- [Contributions](#contributions)
|
||||
- [Developers](#developers)
|
||||
|
||||
@ -33,23 +39,27 @@ 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
|
||||
- Add a custom page title 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
|
||||
- Open bookmark in browser using index
|
||||
- Open search results in browser
|
||||
- Modify or delete tags in DB
|
||||
- Show all unique tags sorted alphabetically
|
||||
- Browser (Chromium and Firefox based) errors and warnings suppression
|
||||
- Show single bookmark by ID or all bookmarks in a go
|
||||
- Refresh all bookmarks online
|
||||
- Delete all bookmarks
|
||||
- Auto-compact DB on a single bookmark removal
|
||||
- Delete all bookmarks from DB
|
||||
- Show all bookmarks with empty titles or no tags (for bookkeeping)
|
||||
- Add a bookmark at N<sup>th</sup> index, to fill deleted bookmark indices
|
||||
- Secure parameterized SQLite3 queries to access database
|
||||
- Handle first level of redirections (reports IP blocking)
|
||||
- Supports HTTP compression
|
||||
- Handle multiple HTTP redirections (reports redirected URL, loops, IP blocking)
|
||||
- Unicode in URL works
|
||||
- UTF-8 request and response, page character set detection
|
||||
- Works with Python 3.x
|
||||
- Handle piped input
|
||||
- Coloured output for clarity
|
||||
- Easily create compatible batch add or update scripts
|
||||
- Unformatted selective output (for creating batch update scripts)
|
||||
@ -71,7 +81,7 @@ For optional encryption support, install PyCrypto module. Run:
|
||||
or on Ubuntu:
|
||||
|
||||
$ sudo apt-get install python3-crypto
|
||||
## Installing from source
|
||||
## Installing from this repository
|
||||
If you have git installed, run:
|
||||
|
||||
$ git clone https://github.com/jarun/buku/
|
||||
@ -79,12 +89,12 @@ or download the latest [stable release](https://github.com/jarun/Buku/releases/l
|
||||
|
||||
Install to default location:
|
||||
|
||||
$ sudo make install
|
||||
$ sudo make install
|
||||
or, a custom location (PREFIX):
|
||||
|
||||
$ PREFIX=/path/to/prefix make install
|
||||
|
||||
To remove, run:
|
||||
|
||||
To remove, run:
|
||||
|
||||
$ sudo make uninstall
|
||||
or, if you have installed to a custom location (PREFIX):
|
||||
@ -99,53 +109,61 @@ You may need to use `sudo` with `PREFIX` depending on your permissions on destin
|
||||
## Installing with a package manager
|
||||
`buku` is also available on
|
||||
- [AUR](https://aur.archlinux.org/packages/buku/) for Arch Linux;
|
||||
- Void Linux repos. Run: `$ sudo xbps-install -S buku`
|
||||
- [Homebrew](http://braumeister.org/formula/buku) for OS X
|
||||
- Void Linux repos.
|
||||
|
||||
$ sudo xbps-install -S buku
|
||||
- [Homebrew](http://braumeister.org/formula/buku) for OS X, or its Linux fork, [Linuxbrew](https://github.com/Linuxbrew/linuxbrew/blob/master/Library/Formula/buku.rb).
|
||||
|
||||
# Usage
|
||||
|
||||
## Cmdline options
|
||||
|
||||
Usage: buku OPTIONS [URL] [TAGS] [KEYWORDS ...]
|
||||
|
||||
A private cmdline bookmark manager. Your mini web!
|
||||
|
||||
General options
|
||||
-a URL [tags] add URL as bookmark with comma separated tags
|
||||
-d N delete entry at DB index N (from -P), move last entry to N
|
||||
-g list all tags alphabetically
|
||||
-m title manually specify the title, for -a, -i, -u
|
||||
-s keyword(s) search all bookmarks for a (partial) tag or any keyword
|
||||
-S keyword(s) search all bookmarks for a (partial) tag or all keywords
|
||||
-u N URL [tags] update all fields of entry at DB index N
|
||||
-w fetch title from web, for -a, -i, -u
|
||||
|
||||
Power toys
|
||||
-D delete ALL bookmarks
|
||||
-e show bookmarks with empty titles or no tags
|
||||
-i N insert new bookmark at free DB index N
|
||||
-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
|
||||
-r oldtag [newtag] replace oldtag with newtag, delete oldtag if newtag empty
|
||||
-R refresh title from web for all bookmarks, update if non-empty
|
||||
-t N use N (> 0) hash iterations to generate key, for -k, -l
|
||||
-x N modify -P behaviour, N=1: show only URL, N=2: show URL and tag
|
||||
-z show debug information
|
||||
|
||||
Keys
|
||||
1-N open Nth search result in browser. Enter exits buku.
|
||||
|
||||
## Operational notes
|
||||
|
||||
- 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.
|
||||
- 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 insert a new bookmark at a free 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.
|
||||
- Search works in mysterious ways:
|
||||
- Substrings match (`match` matches `rematched`) for URL, tags and title.
|
||||
- All the keywords are treated together as a `single` tag in the `same order`. Bookmarks with partial or complete tag matches are shown in results.
|
||||
- `-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 buku and locked (`-l`) afterwards. Note that the database file is <i>unecrypted on creation</i>. AES256 is used for encryption. Optionally specify (`-t`) the number of hash iterations to use to generate key. Default is 8 iterations.
|
||||
|
||||
## cmdline help
|
||||
|
||||
Usage: buku [OPTIONS] KEYWORDS...
|
||||
Bookmark manager. Your private Google.
|
||||
|
||||
Options
|
||||
-a URL tag 1, tag 2, ... add URL as bookmark with comma separated tags
|
||||
-d N delete entry at DB index N (from -P output)
|
||||
-D delete ALL bookmarks
|
||||
-g show all tags (sorted alphabetically)
|
||||
-i N insert entry at DB index N, useful to fill deleted index
|
||||
-j Output data formatted as json (works with -P, -p and -s)
|
||||
-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
|
||||
-R refresh all bookmarks, tags retained
|
||||
-s keyword(s) search all bookmarks for a (partial) tag or any keyword
|
||||
-S keyword(s) search all bookmarks for a (partial) tag or all keywords
|
||||
-t N use N (> 0) hash iterations to generate key, works with -k, -l
|
||||
-u N update entry at DB index N
|
||||
-w fetch title info from web, works with -a, -i, -u
|
||||
-x N works with -P, N=1: show only URL, N=2: show URL and tag
|
||||
-z show debug information
|
||||
any other option shows help and exits buku
|
||||
|
||||
Keys
|
||||
1-N open Nth search result in browser. Enter exits buku.
|
||||
- Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown within `()` after the URL.
|
||||
- AES256 is used for encryption. Optionally specify (`-t`) the number of hash iterations to use to generate key. Default is 8 iterations.
|
||||
- Encryption is optional and manual. 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 <i>unencrypted on creation</i>.
|
||||
|
||||
# Examples
|
||||
1. **Add** a new bookmark with title `Linux magazine` & tags `linux news` and `open source`:
|
||||
@ -163,53 +181,70 @@ The assigned automatic index 15012014 is unique, one greater than highest index
|
||||
|
||||
$ buku -u 15012014 -w http://tuxdiary.com linux news, open source, magazine
|
||||
Title: [TuxDiary | Linux, open source and a pinch of leisure.]
|
||||
Updated
|
||||
Updated index 15012014
|
||||
Tags are updated too. Original tags are removed.
|
||||
4. Update or **refresh full DB**:
|
||||
|
||||
$ buku -R
|
||||
This operation does not modify the indexes, URLs or tags. Only titles, if non-empty, are refreshed.
|
||||
5. **Delete** bookmark at index 15012014:
|
||||
|
||||
$ buku -d 15012014
|
||||
Index 15012020 moved to 15012014
|
||||
The last index is moved to the deleted index to keep the DB compact.
|
||||
6. **Delete all** bookmarks:
|
||||
|
||||
$ buku -D
|
||||
7. **Insert** a bookmark at index 15012014 (fails if index or URL exists in database):
|
||||
7. List **all unique tags** alphabetically:
|
||||
|
||||
$ buku -g
|
||||
8. **Insert** a bookmark at index 15012014 (fails if index or URL exists in database):
|
||||
|
||||
$ 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:
|
||||
9. **Replace a tag** with new one:
|
||||
|
||||
$ buku -r 'old tag' 'new tag'
|
||||
10. **Delete a tag** from DB:
|
||||
|
||||
$ buku -r 'old tag'
|
||||
11. **Show info** on bookmark at index 15012014:
|
||||
|
||||
$ buku -p 15012014
|
||||
9. **Show all** bookmarks with real index from database:
|
||||
12. **Show all** bookmarks with real index from database:
|
||||
|
||||
$ buku -P
|
||||
10. **Open URL** at index 15012014 in browser:
|
||||
13. **Open URL** at index 15012014 in browser:
|
||||
|
||||
$ 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):
|
||||
14. **Search** bookmarks for a tag matching `*kernel debugging*` or **ANY** of the keywords `*kernel*` and `*debugging*` in URL or title (separately):
|
||||
|
||||
$ 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):
|
||||
15. **Search** bookmarks for a tag matching `*kernel debugging*` or **ALL** the keywords `*kernel*` and `*debugging*` in URL or title (separately):
|
||||
|
||||
$ buku -S kernel debugging
|
||||
|
||||
13. Encrypt/decrypt DB with **custom number of iterations** to generate key:
|
||||
16. Encrypt/decrypt DB with **custom number of iterations** to generate key:
|
||||
|
||||
$ buku -l -t 15
|
||||
$ buku -k -t 15
|
||||
The same number of iterations must be used for one lock & unlock instance.
|
||||
14. Show **debug info**:
|
||||
17. Show **debug info**:
|
||||
|
||||
$ buku -z ...
|
||||
15. Show **help**:
|
||||
18. More **help**:
|
||||
|
||||
$ buku
|
||||
16. Check **manpage**:
|
||||
|
||||
$ man buku
|
||||
17. `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):
|
||||
|
||||
## Bookkeeping
|
||||
|
||||
1. To list bookmarks with **no title or tags**:
|
||||
|
||||
$ buku -e
|
||||
Use the `-u` option to add title or tags to those entries, if you want to.
|
||||
2. `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
|
||||
buku -aw https://wireless.wiki.kernel.org/ networking, device drivers
|
||||
@ -219,7 +254,7 @@ The same number of iterations must be used for one lock & unlock instance.
|
||||
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.
|
||||
18. To **update selected URLs** (refresh) along with your tags, first get the unformatted selective output with URL and tags:
|
||||
3. To **update selected URLs** (refresh) along with your tags, first get the unformatted selective output with URL and tags:
|
||||
|
||||
$ 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:
|
||||
@ -236,20 +271,27 @@ Run the script:
|
||||
$ chmod +x myurls
|
||||
$ ./myurls
|
||||
|
||||
**TIP:**
|
||||
To add the same text at the beginning of multiple lines using vim editor:
|
||||
|
||||
####TIP
|
||||
|
||||
Add the same text at the beginning of multiple lines:
|
||||
|
||||
**vim**
|
||||
- Press `Ctrl-v` to select the first column of text in the lines you want to change (visual mode).
|
||||
- Press `Shift-i` and type the text you want to insert.
|
||||
- Hit `Esc`, wait 1 second and the inserted text will appear on every line.
|
||||
|
||||
Using sed:
|
||||
**sed**
|
||||
|
||||
$ sed -i 's/^/buku -wu /' filename
|
||||
|
||||
# Contributions
|
||||
I would love to see pull requests with the following features:
|
||||
Pull requests are welcome. Some of the features I have in mind are:
|
||||
- Support subcommands using argparse
|
||||
- Merge bookmark database files (for users who work on multiple systems)
|
||||
- Exact word match (against substring in a word as it works currently. Hint: REGEXP)
|
||||
- Parse full page data??? Might end up writing a search engine like Google. ;)
|
||||
- Anything else which would add value (please raise an issue for discussion)
|
||||
|
||||
# Developers
|
||||
[Arun Prakash Jana](mailto:engineerarun@gmail.com)
|
||||
|
200
buku.1
200
buku.1
@ -1,16 +1,21 @@
|
||||
.TH "BUKU" "1" "Mar 2016" "Version 1.7" "User Commands"
|
||||
.TH "BUKU" "8" "Apr 2016" "Version 1.9" "User Commands"
|
||||
.SH NAME
|
||||
buku \- Bookmark manager. Your private Google.
|
||||
buku \- A private cmdline bookmark manager. Your mini web!
|
||||
.SH SYNOPSIS
|
||||
.B buku
|
||||
.I OPTIONS
|
||||
.RI [ URL ]
|
||||
.RI [ TAGS ]
|
||||
.I [KEYWORDS ...]
|
||||
.SH DESCRIPTION
|
||||
.B buku
|
||||
is a command line tool to save and search bookmarks.
|
||||
is a command-line tool to save, tag and search bookmarks.
|
||||
.PP
|
||||
The SQLite3 database file is stored in $HOME/.cache/bookmarks.db for each user.
|
||||
The SQLite3 database file is stored in \fB$HOME/.local/share/buku/bookmarks.db\fR (or \fB$XDG_DATA_HOME/buku/bookmarks.db\fR, if XDG_DATA_HOME is defined) for each user.
|
||||
.PP
|
||||
Before version 1.9,
|
||||
.B buku
|
||||
stored database in \fB$HOME/.cache/buku/bookmarks.db\fR. If the file exists, buku automatically moves it to new location.
|
||||
.SH OPERATIONAL NOTES
|
||||
URL must precede the tags. Manual title with multiple keywords must be within quotes.
|
||||
.PP
|
||||
@ -18,21 +23,23 @@ It's advisable to copy URLs directly from the browser address bar, i.e., along w
|
||||
.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
|
||||
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 insert a new bookmark at a free index.
|
||||
.PP
|
||||
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.
|
||||
.PP
|
||||
Search works in mysterious ways:
|
||||
- Substrings match ('match' matches 'rematched') for URL, tags and title.
|
||||
- All the keywords are treated together as a 'single' tag in the 'same order'. Bookmarks with partial or complete tag matches are shown in results.
|
||||
- '-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.
|
||||
- -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 record which is shown within '()' after the URL.
|
||||
.PP
|
||||
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. Optionally specify ('-t') the number of hash iterations to use to generate key. Default is 8 iterations.
|
||||
AES256 is used for encryption. Optionally specify (-t) the number of hash iterations to use to generate key. Default is 8 iterations.
|
||||
.PP
|
||||
Encryption is optional and manual. 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.
|
||||
.SH OPTIONS
|
||||
.TP
|
||||
.BI \-a " URL" " " "tag 1", " tag 2", " ..."
|
||||
.BI \-a " URL" " " "[tags]"
|
||||
Bookmark
|
||||
.I URL
|
||||
along with comma separated tags. A tag can have multiple words. The same URL cannot be added twice.
|
||||
@ -40,18 +47,21 @@ along with comma separated tags. A tag can have multiple words. The same URL can
|
||||
.BI \-d " N"
|
||||
Delete bookmark at index
|
||||
.I N
|
||||
in DB (from '-P' output).
|
||||
in DB (from -P output).
|
||||
.TP
|
||||
.B \-D
|
||||
Delete ALL bookmarks.
|
||||
.TP
|
||||
.B \-e
|
||||
Show all bookmarks with empty titles or no tags (for bookkeeping).
|
||||
.TP
|
||||
.B \-g
|
||||
Show all unique tags sorted aplhabetically.
|
||||
List all unique tags sorted alphabetically.
|
||||
.TP
|
||||
.BI \-i " N"
|
||||
Add a new record at index
|
||||
Add a new record at free index
|
||||
.I N
|
||||
in DB. Use this option to fill blank indices left by deleted bookmarks.
|
||||
in DB.
|
||||
.TP
|
||||
.B \-j
|
||||
Output data formatted as json (works with -P, -p and -s)
|
||||
@ -62,8 +72,8 @@ Decrypt (unlock) the DB file.
|
||||
.B \-l
|
||||
Encrypt (lock) the DB file.
|
||||
.TP
|
||||
.BI \-m " keywords"
|
||||
Add or update the title manually.
|
||||
.BI \-m " title"
|
||||
Manually specify the title, works with -a, -i, -u.
|
||||
.TP
|
||||
.BI \-o " N"
|
||||
Open URL at DB index
|
||||
@ -79,29 +89,29 @@ in DB.
|
||||
Show all bookmark records from the DB along with actual index. Shows URL, title and tags.
|
||||
.TP
|
||||
.B \-R
|
||||
Refresh all bookmarks. Titles are fetched from the web. Tags are retained.
|
||||
Refresh titles for all bookmarks from the web. Titles are updated only if non-empty. Indexes, URLs and tags are retained.
|
||||
.TP
|
||||
.BI \-s " keywords"
|
||||
Search bookmarks for a (partial) tag or any keyword and show the results. Prompts to enter result number to open in browser. Note that the sequential index number may not match the real index in database. DB index is shown in the end within '()'.
|
||||
.TP
|
||||
.BI \-S " keywords"
|
||||
Search bookmarks for a (partial) tag or occurrence of all keywords in URL or title and show the results. Rest same as '-s'.
|
||||
Search bookmarks for a (partial) tag or occurrence of all keywords in URL or title and show the results. Rest same as -s.
|
||||
.TP
|
||||
.BI \-t " N"
|
||||
Use
|
||||
.I N
|
||||
(> 0) hash iterations to generate key, works with '-k', '-l'.
|
||||
(> 0) hash iterations to generate key, works with -k, -l.
|
||||
.TP
|
||||
.BI \-u " N"
|
||||
Update bookmark at index
|
||||
.BI \-u " N" " " "URL" " " "[tags]"
|
||||
Update all fields of bookmark at index
|
||||
.I N
|
||||
in DB.
|
||||
.TP
|
||||
.BI \-w
|
||||
Fetch title data from the web. Works with '-a', '-i' or '-u' options.
|
||||
Fetch title data from the web. Works with -a, -i or -u options.
|
||||
.TP
|
||||
.BI \-x " N"
|
||||
Show selective monochrome output. Works with '-P'. If
|
||||
Show selective monochrome output. Works with -P. If
|
||||
.I N
|
||||
= 1, only URL is shown. If
|
||||
.I N
|
||||
@ -123,6 +133,150 @@ search result in browser. Pressing 'Enter' exits buku.
|
||||
.BI BROWSER
|
||||
Overrides the default browser. Ref:
|
||||
.I http://docs.python.org/library/webbrowser.html
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.IP 1. 4
|
||||
\fBAdd\fR a new bookmark with title \fBLinux magazine\fR & tags \fBlinux news\fR and \fBopen source\fR:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -a -m 'Linux magazine' http://tuxdiary.com linux news, open source
|
||||
.EE
|
||||
.PP
|
||||
.IP "" 4
|
||||
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.
|
||||
.PP
|
||||
.IP 2. 4
|
||||
Add a bookmark, \fBfetch page title\fR information from web:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -a -w http://tuxdiary.com linux news, open source
|
||||
.PP
|
||||
.IP 3. 4
|
||||
\fBUpdate\fR existing bookmark at index 15012014 with a new tag:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -u 15012014 -w http://tuxdiary.com linux news, open source, magazine
|
||||
.EE
|
||||
.PP
|
||||
.IP "" 4
|
||||
Tags are updated too. Original tags are removed.
|
||||
.PP
|
||||
.IP 4. 4
|
||||
Update or \fBrefresh full DB\fR:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -R
|
||||
.EE
|
||||
.PP
|
||||
.IP "" 4
|
||||
This operation does not modify the indexes, URLs or tags. Only titles, if non-empty, are refreshed.
|
||||
.PP
|
||||
.IP 5. 4
|
||||
\fBDelete\fR bookmark at index 15012014:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -d 15012014
|
||||
.EE
|
||||
.PP
|
||||
.IP "" 4
|
||||
The last index is moved to the deleted index to keep the DB compact.
|
||||
.PP
|
||||
.IP 6. 4
|
||||
\fBDelete all\fR bookmarks:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -D
|
||||
.PP
|
||||
.IP 7. 4
|
||||
List \fBall unique tags\fR alphabetically:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -g
|
||||
.PP
|
||||
.IP 8. 4
|
||||
\fBInsert\fR a bookmark at index 15012014 (fails if index or URL exists in database):
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -i 15012014 -w http://tuxdiary.com/about linux news, open source
|
||||
.PP
|
||||
.IP 9. 4
|
||||
\fBReplace a tag\fR with new one:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -r 'old tag' 'new tag'
|
||||
.PP
|
||||
.IP 10. 4
|
||||
\fBDelete a tag\fR from DB:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -r 'old tag'
|
||||
.PP
|
||||
.IP 11. 4
|
||||
\fBShow info\fR on bookmark at index 15012014:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -p 15012014
|
||||
.PP
|
||||
.IP 12. 4
|
||||
\fBShow all\fR bookmarks with real index from database:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -P
|
||||
.PP
|
||||
.IP 13. 4
|
||||
\fBOpen URL\fR at index 15012014 in browser:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -o 15012014
|
||||
.PP
|
||||
.IP 14. 4
|
||||
\fBSearch\fR bookmarks for a tag matching \fBkernel debugging\fR or \fBANY\fR of the keywords \fBkernel\fR and \fBdebugging\fR in URL or title (separately):
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -s kernel debugging
|
||||
.PP
|
||||
.IP 15. 4
|
||||
\fBSearch\fR bookmarks for a tag matching \fBkernel debugging\fR or \fBALL\fR the keywords \fBkernel\fR and \fBdebugging\fR in URL or title (separately):
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -S kernel debugging
|
||||
.PP
|
||||
.IP 16. 4
|
||||
Encrypt/decrypt DB with \fBcustom number of iteration\fR to generate key:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -l -t 15
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -k -t 15
|
||||
.EE
|
||||
.PP
|
||||
.IP "" 4
|
||||
The same number of iterations must be used for one lock & unlock instance.
|
||||
.PP
|
||||
.IP 17. 4
|
||||
Show \fBdebug info\fR:
|
||||
.PP
|
||||
.EX
|
||||
.IP
|
||||
.B buku -z ...
|
||||
.SH AUTHOR
|
||||
Written by Arun Prakash Jana <engineerarun@gmail.com>.
|
||||
.SH HOME
|
||||
|
Loading…
Reference in New Issue
Block a user