Update docs

This commit is contained in:
Arun Prakash Jana 2020-04-03 07:28:37 +05:30
parent 3fc4d164d4
commit 11b869842f
No known key found for this signature in database
GPG Key ID: A75979F35C080412
2 changed files with 7 additions and 1 deletions

2
buku
View File

@ -4971,7 +4971,9 @@ POSITIONAL ARGUMENTS:
addarg('-V', dest='upstream', action='store_true', help=hide) addarg('-V', dest='upstream', action='store_true', help=hide)
addarg('-z', '--debug', action='store_true', help=hide) addarg('-z', '--debug', action='store_true', help=hide)
# Undocumented APIs # Undocumented APIs
# Fix uppercase tags allowed in releases before v2.7
addarg('--fixtags', action='store_true', help=hide) addarg('--fixtags', action='store_true', help=hide)
# App-use only, not for manual usage
addarg('--db', nargs=1, help=hide) addarg('--db', nargs=1, help=hide)
# Parse the arguments # Parse the arguments

6
buku.1
View File

@ -45,7 +45,7 @@ Bookmarks with immutable titles are listed with '(L)' after the title.
- Comma (',') is the tag delimiter in DB. A tag cannot have comma(s) in it. Tags are filtered (for unique tags) and sorted. Tags are stored in lower case and can be replaced, appended or deleted. - Comma (',') is the tag delimiter in DB. A tag cannot have comma(s) in it. Tags are filtered (for unique tags) and sorted. Tags are stored in lower case and can be replaced, appended or deleted.
- Page keywords having a word to comma ratio > 3 are appended to description rather than tags. - Page keywords having a word to comma ratio > 3 are appended to description rather than tags.
- Parent folder (and subfolder) names are converted to all-lowercase tags during bookmarks HTML import. - Parent folder (and subfolder) names are converted to all-lowercase tags during bookmarks HTML import.
- Releases prior to v2.7 support both capital and lower cases in tags. From v2.7 all tags are stored in lowercase. An undocumented option --\fIfixtags\fR is introduced to modify the older tags. It also fixes another issue where the same tag appears multiple times in the tagset of a record. Run \fBbuku --fixtags\fR once. - Releases prior to v2.7 support both capital and lower cases in tags. From v2.7 all tags are stored in lowercase. An undocumented option --fixtags is introduced to modify the older tags. It also fixes another issue where the same tag appears multiple times in the tagset of a record. Run \fBbuku --fixtags\fR once.
- Tags can be edited from the prompt very easily using '>>' (append), '>' (overwrite) and '<<' (remove) symbols. The LHS of the operands denotes the indices and ranges of tags to apply (as listed by --tag or key 't' at prompt) and the RHS denotes the actual DB indices and ranges of the bookmarks to apply the change to. - Tags can be edited from the prompt very easily using '>>' (append), '>' (overwrite) and '<<' (remove) symbols. The LHS of the operands denotes the indices and ranges of tags to apply (as listed by --tag or key 't' at prompt) and the RHS denotes the actual DB indices and ranges of the bookmarks to apply the change to.
.PP .PP
.IP 6. 4 .IP 6. 4
@ -92,6 +92,10 @@ Bookmarks with immutable titles are listed with '(L)' after the title.
.PP .PP
.IP 12. 4 .IP 12. 4
\fBProxy\fR support: please refer to the \fBENVIRONMENT\fR section. \fBProxy\fR support: please refer to the \fBENVIRONMENT\fR section.
.PP
.IP 13. 4
\fBAlternative DB file\fR:
- The option --db (to specify an alternative database file location) is app-only. Manual usage is prone to issues arising from human error.
.SH GENERAL OPTIONS .SH GENERAL OPTIONS
.TP .TP
.BI \-a " " \--add " URL [tag, ...]" .BI \-a " " \--add " URL [tag, ...]"