Mercurial > libervia-backend

annotate doc/libervia-cli/bookmarks.rst @ 4328:f72d6b86f8dc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
author Goffi <goffi@goffi.org>
date Wed, 20 Nov 2024 11:49:46 +0100
parents d6837db456fd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
1 ===========================
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
2 bookmarks: Manage bookmarks
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
3 ===========================
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
4 Bookmarks are used to store a list of group chat rooms and indicate which ones are
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
5 currently joined. Libervia offers commands to list, set, and remove bookmarks.
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
6
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
7 list
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
8 ====
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
9
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
10 Get and print available bookmarks.
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
11
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
12 example
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
13 -------
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
14 Retrieve all bookmarks::
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
15
3488
c80a0f864b5d doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents: 3041
diff changeset
16 $ li bookmarks list
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
17
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
18 set
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
19 ===
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
20
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
21 Add or update a bookmark.
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
22
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
23 You can use ``-n NAME, --name NAME`` to specify a name for the bookmark. This option
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
24 allows you to provide a human-readable name for the bookmark, making it easier to
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
25 identify.
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
26
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
27 ``-N NICK, --nick NICK`` set the nickname to use in the room.
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
28
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
29 ``-j [BOOL], --join [BOOL]`` indicates whether you want to join the room. If the value is not set or ``true``, the room will be joined; otherwise, it will be left if the user is currently in it.
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
30
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
31 example
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
32 -------
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
33 Add a bookmark to a chat room with a name and join it::
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
34
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
35 $ li bookmarks set lunch@conference.example.net -n "Lunch Organization" -j
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
36
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
37 remove
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
38 ======
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
39 Remove a bookmark.
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
40
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
41 example
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
42 -------
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
43 Remove a bookmark for a chat room::
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
44
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
45 $ li bookmarks remove lunch@conference.example.net
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
46
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
47 legacy
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
48 ======
3041
72583524cfd3 doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff changeset
49
4328
f72d6b86f8dc doc (cli/bookmarks): move old bookmarks doc to bookmarks_legacy, and add new bookmarks doc.
Goffi <goffi@goffi.org>
parents: 4077
diff changeset
50 Manage legacy bookmarks. Please check :ref:`libervia-cli_bookmarks_legacy`.