libervia-backend: doc/jp/file

annotate doc/jp/file_share.rst @ 3398:467d6c709f1d

test: fixed use of `client.host` in legacy test: those tests are not maintained anymore, but as the use of `client.host` as been fixed elsewhere, it was the occasion to do it there too. Those legacy tests should be ported or to the new workflow, or deleted if they are not relevant anymore.

author	Goffi <goffi@goffi.org>
date	Thu, 12 Nov 2020 14:53:15 +0100
parents	7ebda4b54170
children

rev	line source
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	1 .. _jp-file_share:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	2
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	3 ==================================
3052 60a63723ecea doc (jp/file_share): typo Goffi <goffi@goffi.org> parents: 3041 diff changeset	4 file/share: advanced files sharing
3041 72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	5 ==================================
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 ``share`` groups commands for listing file available on a device/service, sharing a file
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	8 or directory, and inviting people to retrieve files.
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 .. _jp-file_share_list:
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	11
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	12 list
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	13 ====
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	14
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	15 List files available on a device or sharing service. You mainly have to specify the jid of
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	16 the device/service where the files are stored (if jid is omitted, your own jid will be
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	17 used, so you can check what you are sharing).
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 .. note::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	20
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	21 you have to use the full jid of the device if you want to list files available on a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	22 device.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	23
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	24 You may specify a path using ``-d PATH, --path PATH``.
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 File and directories are printed with a different colour if you use default output.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	27
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	28 examples
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
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	31 List files shared from a device (note that we use a full jid here)::
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 $ jp file share list louise@example.org/some_resource
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	34
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	35 List files available on a sharing service at the path ``/photos``::
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 $ jp file share list -d photos files.example.org
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	38
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	39 Louise wants to list the file shared by Pierre::
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 $ jp file share list pierre@files.example.org
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 path
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
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	46 Share a local file or directory with a list of entities, or publicly. The files can then
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	47 be listed or requested using jp-file_share_list_ or :ref:`jp-file_request`.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	48
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	49 You specify the file or directory the positional ``path`` argument. By default the name of
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	50 the file/directory is used, but you can give a different one using ``-n NAME, --name
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	51 NAME``.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	52
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	53 You can specify entities allowed to see your files using ``-j JID, --jid JID`` as many
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	54 time as necessary. If you don't specify any entity, the file will only be accessible by
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	55 your own devices. If you want to make your file accessible to everybody, use ``--public``
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	56 (note that this means that your file is accessible to the world, i.e. also to people you
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	57 don't know, so use this option carefully).
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	58
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	59 examples
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	60 --------
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 Share the file ``interesting_doc.odt`` with Pierre and Louise::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	63
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	64 $ jp file share path -j pierre@example.net -j louise@example.org interesting_doc.odt
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	65
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	66 Imagine that you have built a weather station and want to make its data public. You can
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	67 share the directory ``~/weather_station_data`` with the world, using the name ``public
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	68 weather data``::
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	69
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	70 $ jp file share path --public --name "public weather data" ~/weather_station_data
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	71
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	72 invite
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	73 ======
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 This command send an invitation for a file sharing repository to an XMPP entity.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	76
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	77 The invitation is a non standard (yet?) way to notify somebody of the existence of a files
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	78 repository.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	79
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	80 Beside the positional arguments ``service`` and ``jid``, which are respectively the
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	81 service where is the files repository and the jid of the entity to invite, you mainly have
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	82 to indicate the path and namespace of your repository, using ``-P PATH, --path PATH`` and
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	83 ``N NAMESPACE, --namespace NAMESPACE``.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	84
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	85 Use the ``-t {files,photos}, --type {files,photos}`` to specify if you repository is a
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	86 generic files repository or a photo album.
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 Optionally, you can associate a thumbnail to the repository ``with -T THUMBNAIL,
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	89 --thumbnail THUMBNAIL``. This is recommended to have more user friendly representation of
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	90 the album in e.g. Libervia.
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	91
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	92 example
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	93 -------
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 Pierre wants to invite Louise to view his ``summer holidays`` photo album::
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 $ jp file share invite -P "photos/summer holidays" -t photos pierre@files.example.net
72583524cfd3 doc (jp): jp commands are now fully documented: Goffi <goffi@goffi.org> parents: diff changeset	98 louise@example.org
3325 7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	99
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	100 affiliations
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	101 ============
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	102
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	103 subcommands for file sharing affiliations management. please check :ref:`jp-file_share_affiliations`.
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	104
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	105 configuration
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	106 =============
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	107
7ebda4b54170 jp (file/share): added commands to manage affiliations and configuration + documentation Goffi <goffi@goffi.org> parents: 3052 diff changeset	108 subcommands for retrieving/modifying file sharing node configuration. please check :ref:`jp-file_share_configuration`.

Mercurial > libervia-backend

annotate doc/jp/file_share.rst @ 3398:467d6c709f1d