Use man page.
Update README.md Update buku.1
This commit is contained in:
parent
8419f4ac79
commit
1b6c46fd1c
@ -34,8 +34,8 @@ Copyright (C) 2015-2016 [Arun Prakash Jana](mailto:engineerarun@gmail.com).
|
|||||||
- Modify or delete tags, list all unique tags alphabetically
|
- Modify or delete tags, list all unique tags alphabetically
|
||||||
- Refresh all bookmarks online
|
- Refresh all bookmarks online
|
||||||
- Tab-completion scripts for Bash, Fish and Zsh
|
- Tab-completion scripts for Bash, Fish and Zsh
|
||||||
- Manpage with examples
|
- Man page with examples
|
||||||
- Several options for power users (refer help or manpage)
|
- Several options for power users (see help or man page)
|
||||||
- Fast and clean interface
|
- Fast and clean interface
|
||||||
- Minimal dependencies
|
- Minimal dependencies
|
||||||
|
|
||||||
@ -103,7 +103,7 @@ Shell completion scripts for Bash, Fish and Zsh can be found in respective subdi
|
|||||||
|
|
||||||
## Cmdline options
|
## Cmdline options
|
||||||
|
|
||||||
**NOTE:** If you are using `buku` v1.9 or below please refer the installed manpage or program help.
|
**NOTE:** If you are using `buku` v1.9 or below please refer to the installed man page or program help.
|
||||||
|
|
||||||
usage: buku [-a URL [tags ...]] [-u [N [URL tags ...]]]
|
usage: buku [-a URL [tags ...]] [-u [N [URL tags ...]]]
|
||||||
[-t [...]] [-d [N]] [-h]
|
[-t [...]] [-d [N]] [-h]
|
||||||
@ -176,7 +176,7 @@ Shell completion scripts for Bash, Fish and Zsh can be found in respective subdi
|
|||||||
- Substrings match (`match` matches `rematched`) for URL, title and tags.
|
- Substrings match (`match` matches `rematched`) for URL, title and tags.
|
||||||
- `-s` : match any of the keywords in URL, title or tags.
|
- `-s` : match any of the keywords in URL, title or tags.
|
||||||
- `-S` : match all the keywords in URL, title or tags.
|
- `-S` : match all the keywords in URL, title or tags.
|
||||||
- You can search bookmarks by tag (refer examples).
|
- 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.
|
- 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.
|
- 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 <i>unencrypted on creation</i>.
|
- 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 <i>unencrypted on creation</i>.
|
||||||
|
1
buku
1
buku
@ -535,7 +535,6 @@ def searchdb(cur, keywords, all_keywords=False):
|
|||||||
print("\x1b[1mEXCEPTION\x1b[21m [searchdb]: (%s) %s" % (type(e).__name__, e))
|
print("\x1b[1mEXCEPTION\x1b[21m [searchdb]: (%s) %s" % (type(e).__name__, e))
|
||||||
else:
|
else:
|
||||||
break
|
break
|
||||||
|
|
||||||
else:
|
else:
|
||||||
print(formatJson(results))
|
print(formatJson(results))
|
||||||
|
|
||||||
|
2
buku.1
2
buku.1
@ -37,7 +37,7 @@ Search works in mysterious ways:
|
|||||||
- Substrings match ('match' matches 'rematched') for URL, title and tags.
|
- Substrings match ('match' matches 'rematched') for URL, title and tags.
|
||||||
- -s : match any of the keywords in URL, title or tags.
|
- -s : match any of the keywords in URL, title or tags.
|
||||||
- -S : match all the keywords in URL, title or tags.
|
- -S : match all the keywords in URL, title or tags.
|
||||||
- You can search bookmarks by tag (refer examples).
|
- You can search bookmarks by tag (see examples below).
|
||||||
- Search results are indexed serially. This index is different from actual database index of a bookmark record which is shown within '[]' after the URL.
|
- 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
|
.PP
|
||||||
Auto DB compaction: when a record is deleted, the last record is moved to the index.
|
Auto DB compaction: when a record is deleted, the last record is moved to the index.
|
||||||
|
Loading…
Reference in New Issue
Block a user