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