libervia-backend: doc/jp/file.rst annotate

annotate doc/jp/file.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	c3cb18236bdf
children

rev	line source
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	1 ========================================
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	2 file: files sending/receiving/management
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	3 ========================================
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	4
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	5 ``file`` group all commands related to file management, and allows you to send easily a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	6 file to a contact or device from the command line.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	7
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	8 send
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	9 ====
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	10
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	11 Send a file to a contact.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	12
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	13 The file will be sent using best available method (which is Jingle File Transfer when
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	14 available), and will try to send the file in P2P when possible. If P2P is possible, the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	15 signal is sent through the server (metadata, negotiation, etc.), while the file itself
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	16 goes directly from the source device to the target device. When P2P is not possible, the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	17 file may go through the server or an other one (if a proxy is used for instance).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	18
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	19 When sending a file, you specify one or more file(s) to send, and the either the bare jid
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	20 or the full jid of the target device. If bare jid is specified, the main resource will be
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	21 used.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	22
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	23 You'll usually want to see the progression of the transfer, use ``-P, --progress`` for
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	24 that.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	25
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	26 If you send several files at once, you may want to use ``-b, --bz2`` to group them in a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	27 single compressed ``tar.bz2`` archive (the client receiving the files will then receive a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	28 single file, than the user can then decompress).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	29
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	30 By default the name of the source file is used, but you use ``-n NAME, --name NAME`` to
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	31 specify another one.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	32
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	33 The path and namespace (set with ``-d PATH, --path PATH`` and ``-N NAMESPACE, --namespace
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	34 NAMESPACE``) are non-standard metadata used by SàT to organise files (``PATH`` being like
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	35 a file path on locale file system, and ``NAMESPACE`` being a name to associate to a group
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	36 of files, for instance for a photo album).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	37
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	38 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	39 --------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	40
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	41 Send a file to Louise, with a progress bar::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	42
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	43 $ jp file send -P some_file.ext louise@example.org
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	44
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	45 Send a picture to a file sharing component, putting it in the ``holidays`` namespace, in
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	46 the ``/some/path`` path::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	47
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	48 $ jp file send -P -N holidays -d /some/path some_photo.jpg files.example.org
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	49
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	50 .. _jp-file_request:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	51
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	52 request
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	53 =======
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	54
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	55 Ask to get a file from a device/sharing service. A file is requested using one or more
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	56 metadata, which can be the file name (with ``-n NAME, --name NAME``), its hash (with ``-H
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	57 HASH, --hash HASH`` and the algorithm may be specified with ``-a HASH_ALGO, --hash-algo
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	58 HASH_ALGO``), its path (with ``-d PATH, --path PATH``) and its namespace (with ``-N
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	59 NAMESPACE, --namespace NAMESPACE``). Note that ``PATH`` and ``NAMESPACE`` are SàT specific
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	60 and not (yet?) XMPP standards.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	61
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	62 If you already know the hash, it's the most efficient and recommended way to retrieve a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	63 file.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	64
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	65 You need to specify the full jid of the device or the sharing service as a positional
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	66 argument.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	67
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	68 By default the file is downloaded in current directory, but you can specify an other one
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	69 (and an other filename) with ``-D DEST, --dest DEST``.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	70
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	71 If you want to see progression of the transfer, use ``-P, --progress``.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	72
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	73 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	74 --------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	75
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	76 Request a file names ``some_file.jpg`` in path ``/photos/demo_album`` at service
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	77 ``files.example.org``, with a progress bar::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	78
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	79 $ jp file request -P -d photos/demo_album -n some_file.jpg files.example.org
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	80
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	81 Request file with given ``sha-256`` hash (which is default hash algorithm, so we don't
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	82 specify it), and save it to file ``dest_file.txt``::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	83
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	84 $ jp file request -H f2ca1bb6c7e907d06dafe4687e579fce76b37e4e93b7605022da52e6ccc26fd2 -D dest_file.txt files.example.org
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	85
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	86 receive
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	87 =======
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	88
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	89 Wait for a file (or several ones) to be received, and accept it if it match criteria.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	90
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	91 You should specify which jid you are expecting a file from, using the positional
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	92 arguments. If you don't, all files will be accepted, which can be dangerous if some
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	93 malicious user send you a file at this moment.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	94
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	95 To see progression (this is recommended), you can use the ``-P, --progress`` options.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	96
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	97 By default, if a file with the same name as the proposed one exists, the transfer will be
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	98 denied. You can override this behaviour with ``-f, --force``, but be sure to absolutely
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	99 trust the sender in this case, as the name is chosen by her, and could be malicious, or it
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	100 could override an important file.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	101
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	102 If you expect several files, you can use the ``-m, --multiple``, in this case the command
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	103 won't stop after the file received file, and you'll have to manually stop it with
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	104 ``Ctrl-C`` or by sending a ``SIGTERM``.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	105
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	106 File(s) will be written in the current directory, but you may specify an other destination
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	107 with ``--path DIR``.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	108
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	109 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	110 --------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	111
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	112 Accept and receive the next file, save it to local directory and show a progress bar::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	113
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	114 $ jp file receive --progress
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	115
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	116 Several files are expected from Louise, accept them and store them do
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	117 ``~/Downloads/Louise``::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	118
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	119 $ jp file receive --multiple --path ~/Downloads/Louise louise@example.org
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	120
3094 c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	121 get
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	122 ===
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	123
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	124 Download a file from an URI. This commands handle URI scheme common with XMPP, so in
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	125 addition to ``http`` and ``https``, you can use it with ``aesgcm`` scheme (encrypted files
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	126 with key in URL, this is notably used with OMEMO encryption).
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	127
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	128 As usual, you can use ``-P, --progress`` to see a progress bar.
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	129
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	130 example
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	131 -------
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	132
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	133 Download an encrypted file with a progress bar, and save it to current working directory
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	134 with the same name as in the URL (``some_image.jpg``). The URL fragment part (after ``#``)
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	135 is used for decryption, so be sure to not leak the URL when you manipulate one::
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	136
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	137 $ jp file get -P "aesgcm://upload.example.org/wvgSUlURU_UPspAv/some_image.jpg#7d8509c43479591f8d8492f84369875ca983db58f43225c40229eb06d05b2037c841b2346c9642a88ba4a91aa96a0e8f"
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	138
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	139 upload
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	140 ======
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	141
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	142 Upload a file to your XMPP server (or an other entity if specified). The upload will be
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	143 done using `XEP-0363 (HTTP File Upload)`_, and the public URL to retrieve the file will be
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	144 printed. Note that anybody knowing this URL can download the file you've uploaded.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	145
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	146 The path to the file to upload is expected as first argument, then optionally the entity
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	147 of the service to upload too (by default, this is autodetected if your server offers this
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	148 feature).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	149
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	150 As usual, you can use ``-P, --progress`` to see a progress bar.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	151
3094 c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	152 You can encrypt the file using ``AES GCM`` with the ``-e, --encrypt`` argument. You will
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	153 then get an ``aesgcm://`` link instead of the usual ``https``, this link contains the
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	154 decryption key (in the fragment part) so be sure to not leak it and to transmit it only
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	155 over encrypted communication channels.
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	156
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	157 .. _XEP-0363 (HTTP File Upload): XEP-0363: HTTP File Upload
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	158
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	159 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	160 -------
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	161
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	162 Upload a document to a server::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	163
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	164 $ jp file upload -P ~/Documents/something_interesting.odt
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	165
3094 c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	166 Encrypt and upload a document to server::
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	167
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	168 $ jp file upload -P -e ~/Documents/something_secret.odt
c3cb18236bdf jp (file): new `get` command + encryption with upload: Goffi <goffi@goffi.org> parents: 3041 diff changeset	169
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	170 share
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	171 =====
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	172
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	173 Subcommands for advanced file sharing. Please check :ref:`jp-file_share`.

Mercurial > libervia-backend

annotate doc/jp/file.rst @ 3350:cc6164a4973b