Mercurial > libervia-backend
annotate doc/jp/index.rst @ 3350:cc6164a4973b
plugin list of interests: normalize item ID + added `get` method
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 05 Sep 2020 20:22:23 +0200 |
| parents | 92f8baec5e4f |
| children |
| rev | line source |
|---|---|
|
3021
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
1 .. _jp-documentation: |
|
8ec35cf13f66
doc: added, overview, configuration and Primitivus documentation + some small modifications
Goffi <goffi@goffi.org>
parents:
2946
diff
changeset
|
2 |
| 2946 | 3 == |
| 4 jp | |
| 5 == | |
| 6 | |
| 7 ``jp`` is the CLI (Command Line Interface) frontend of Salut à Toi | |
| 8 | |
| 9 Overview | |
| 10 ======== | |
| 11 | |
| 12 ``jp`` is a powerful tool to work with Salut à Toi/XMPP. | |
| 13 With it you can send chat messages, share files, retrieve avatars, write blog entries, etc. | |
| 14 | |
| 15 Usage | |
| 16 ===== | |
| 17 | |
| 18 To get help on commands or their options, use:: | |
| 19 | |
| 20 $ jp --help | |
| 21 | |
| 22 which can be used on any command, so if you need help on ``message send`` command, just do:: | |
| 23 | |
| 24 $ jp message send --help | |
| 25 | |
| 26 With jp, you always enter commands first, then options and arguments. | |
| 27 | |
| 3054 | 28 There are several levels of commands: first one is the main category (``message``, |
| 2946 | 29 ``blog``, ``avatar``, etc.), then there are often subcommands (e.g. ``message send``). |
| 30 | |
| 31 After the commands come the options. For instance if you want to send a message, you can | |
| 32 get the available options with ``--help`` as explained above:: | |
| 33 | |
| 34 $ jp message send --help | |
| 35 usage: jp message send [-h] [-p PROFILE] [--pwd PASSWORD] [-c] [-l LANG] [-s] | |
| 36 [-n] [-S SUBJECT] [-L SUBJECT_LANG] | |
| 37 [-t {chat,error,groupchat,headline,normal,auto}] | |
| 38 [-e ALGORITHM] [--encrypt-noreplace] [-x | -r] | |
| 39 jid | |
| 40 | |
| 41 positional arguments: | |
| 42 jid the destination jid | |
| 43 | |
| 44 optional arguments: | |
| 45 -h, --help show this help message and exit | |
| 46 -p PROFILE, --profile PROFILE | |
| 47 Use PROFILE profile key (default: @DEFAULT@) | |
| 48 --pwd PASSWORD Password used to connect profile, if necessary | |
| 49 -c, --connect Connect the profile before doing anything else | |
| 50 -l LANG, --lang LANG language of the message | |
| 51 -s, --separate separate xmpp messages: send one message per line | |
| 52 instead of one message alone. | |
| 53 -n, --new-line add a new line at the beginning of the input (usefull | |
| 54 for ascii art ;)) | |
| 55 -S SUBJECT, --subject SUBJECT | |
| 56 subject of the message | |
| 57 -L SUBJECT_LANG, --subject_lang SUBJECT_LANG | |
| 58 language of subject | |
| 59 -t {chat,error,groupchat,headline,normal,auto}, --type {chat,error,groupchat,headline,normal,auto} | |
| 60 type of the message | |
| 61 -e ALGORITHM, --encrypt ALGORITHM | |
| 62 encrypt message using given algorithm | |
| 63 --encrypt-noreplace don't replace encryption algorithm if an other one is | |
| 64 already used | |
| 65 -x, --xhtml XHTML body | |
| 66 | |
| 67 If you want to send a message to, say, ``pierre@example.net``, and encrypt it with OMEMO, | |
| 68 just do the following:: | |
| 69 | |
| 70 echo "hi, I'm writing with jp" | jp message send -e omemo pierre@example.net | |
| 71 | |
| 72 (note that with OMEMO, you need to have previously validated fingerprint of your contact | |
| 73 for this to work). | |
| 74 | |
| 75 The different commands are explained in dedicated sections. | |
| 76 | |
| 77 .. toctree:: | |
| 78 :caption: jp commands: | |
| 79 :glob: | |
| 80 :maxdepth: 2 | |
| 81 | |
| 82 common_arguments | |
| 83 * | |
| 84 | |
| 85 | |
| 86 Tutorial | |
| 87 ======== | |
| 88 | |
| 89 You can check this third party tutorial: https://blog.agayon.be/sat_jp.html |