Update docs on update behaviour

This commit is contained in:
Arun Prakash Jana 2019-02-02 09:52:59 +05:30
parent ac42a075bd
commit 6ed9659efd
No known key found for this signature in database
GPG Key ID: A75979F35C080412
3 changed files with 5 additions and 5 deletions

View File

@ -171,7 +171,7 @@ GENERAL OPTIONS:
refresh title, desc, tags if no edit options refresh title, desc, tags if no edit options
if no arguments: if no arguments:
- update results when used with search - update results when used with search
- otherwise refresh all titles, desc, tags - otherwise refresh all titles and desc
-w, --write [editor|index] -w, --write [editor|index]
open editor to edit a fresh bookmark open editor to edit a fresh bookmark
edit last bookmark, if index=-1 edit last bookmark, if index=-1
@ -364,7 +364,7 @@ PROMPT KEYS:
$ buku -u $ buku -u
$ buku -u --tacit (show only failures and exceptions) $ buku -u --tacit (show only failures and exceptions)
This operation can update the title, tags (appended) or description fields of non-immutable bookmarks by parsing the fetched page. Fields are updated only if the fetched fields are non-empty. This operation can update the title or description fields of non-immutable bookmarks by parsing the fetched page. Fields are updated only if the fetched fields are non-empty. Tags remain untouched.
13. **Delete** bookmark at index 15012014: 13. **Delete** bookmark at index 15012014:
$ buku -d 15012014 $ buku -d 15012014

2
buku
View File

@ -4681,7 +4681,7 @@ POSITIONAL ARGUMENTS:
refresh title, desc, tags if no edit options refresh title, desc, tags if no edit options
if no arguments: if no arguments:
- update results when used with search - update results when used with search
- otherwise refresh all titles, desc, tags - otherwise refresh all titles and desc
-w, --write [editor|index] -w, --write [editor|index]
open editor to edit a fresh bookmark open editor to edit a fresh bookmark
edit last bookmark, if index=-1 edit last bookmark, if index=-1

4
buku.1
View File

@ -51,7 +51,7 @@ Bookmarks with immutable titles are listed with '(L)' after the title.
.IP 6. 4 .IP 6. 4
\fBUpdate\fR operation: \fBUpdate\fR operation:
- If --title, --tag or --comment is passed without argument, clear the corresponding field from DB. - If --title, --tag or --comment is passed without argument, clear the corresponding field from DB.
- If --url is passed (and --title is omitted), update the title from web using the URL. Description is updated (if --comment is omitted) and tags are appended to (if --tag is omitted). - If --url is passed (and --title is omitted), update the title from web using the URL. Description is updated (if --comment is omitted). Tags remain untouched.
- If indices are passed without any other options (--url, --title, --tag, --comment and --immutable), read the URLs from DB and update titles, description and append tags from web. Bookmarks marked immutable are skipped. - If indices are passed without any other options (--url, --title, --tag, --comment and --immutable), read the URLs from DB and update titles, description and append tags from web. Bookmarks marked immutable are skipped.
- Can update bookmarks matching a search, when combined with any of the search options and no arguments to update are passed. - Can update bookmarks matching a search, when combined with any of the search options and no arguments to update are passed.
.PP .PP
@ -576,7 +576,7 @@ Applies to --title and --tag too. URL cannot be deleted without deleting the boo
.EE .EE
.PP .PP
.IP "" 4 .IP "" 4
This operation can update the title, tags (appended) or description fields of non-immutable bookmarks by parsing the fetched page. Fields are updated only if the fetched fields are non-empty. This operation can update the title or description fields of non-immutable bookmarks by parsing the fetched page. Fields are updated only if the fetched fields are non-empty. Tags remain untouched.
.PP .PP
.IP 13. 4 .IP 13. 4
\fBDelete\fR bookmark at index 15012014: \fBDelete\fR bookmark at index 15012014: