Mercurial > libervia-backend
comparison doc/jp/message.rst @ 2946:ce16847a7b6d
doc: documentation first draft:
this patch starts the local documentation, existing documentation will be imported from wiki/other places to this folder and updated.
This doc is using reStructuredText format and will be generated with Sphinx.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 22 Feb 2019 18:58:59 +0100 |
| parents | |
| children | 72583524cfd3 |
comparison
equal
deleted
inserted
replaced
| 2945:6c264c224614 | 2946:ce16847a7b6d |
|---|---|
| 1 .. highlight:: sh | |
| 2 | |
| 3 ================================ | |
| 4 message: chat message management | |
| 5 ================================ | |
| 6 | |
| 7 Message commands let you send chat messages or manage your server message archives. | |
| 8 | |
| 9 send | |
| 10 ==== | |
| 11 | |
| 12 send a message to a contact or a chat room. | |
| 13 ``stdin`` is used as message source. | |
| 14 You can encrypt your message using ``--encrypt [ALGORITHM]`` argument, this will create an encrypted session and replace existing one if needed. | |
| 15 You can manage your encrypted session using ``encryption`` command. | |
| 16 | |
| 17 examples | |
| 18 -------- | |
| 19 | |
| 20 Send a message to a contact:: | |
| 21 | |
| 22 $ echo 'Salut à Toi!' | jp message send louise@example.net | |
| 23 | |
| 24 Send a message encrypted with OMEMO:: | |
| 25 | |
| 26 $ echo 'pssst, this message is encrypted' | jp message send -o omemo louise@example.net | |
| 27 | |
| 28 .. note:: | |
| 29 | |
| 30 Fingerprints of your destinee must have been accepted before using OMEMO, else message can't be encrypted | |
| 31 | |
| 32 Send a ``normal`` message marked as French with a subject:: | |
| 33 | |
| 34 $ echo 'Bonjour, je vous écris avec « Salut à Toi »' | jp message send -l fr -t normal -S 'Ceci est un message de test' | |
| 35 | |
| 36 mam | |
| 37 === | |
| 38 | |
| 39 query archives using MAM. | |
| 40 This command allows you to check message archive kept on the server (i.e. not the local copy). | |
| 41 You usually want to specify a starting point, and a number of message to retrieve. If too many messages | |
| 42 are available, you'll have to use RSM commands to navigate through the results. | |
| 43 | |
| 44 examples | |
| 45 -------- | |
| 46 | |
| 47 Retrieve messages from last 2 days:: | |
| 48 | |
| 49 $ jp message mam -S "2 days ago" | |
| 50 | |
| 51 Retrieve messages from last 5 hours on SàT official chat room:: | |
| 52 | |
| 53 $ jp message mam -S "2 hours ago" -s sat@chat.jabberfr.org | |
| 54 | |
| 55 Retrieve 2 first messages of 2019 on SàT official chat room:: | |
| 56 | |
| 57 $ jp message mam -S 2019-01-01 -s sat@chat.jabberfr.org -m 2 |