Mercurial > libervia-backend
comparison doc/jp/uri.rst @ 3041:72583524cfd3
doc (jp): jp commands are now fully documented:
rel 232
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 01 Oct 2019 22:49:06 +0200 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| 3040:fee60f17ebac | 3041:72583524cfd3 |
|---|---|
| 1 ================================ | |
| 2 uri: XMPP URI parsing/generation | |
| 3 ================================ | |
| 4 | |
| 5 URI commands are helper to easily parse/build XMPP URIs. | |
| 6 | |
| 7 parse | |
| 8 ===== | |
| 9 | |
| 10 Parse an XMPP URI, and print different parts. | |
| 11 | |
| 12 When possible, the ``type`` of URI is shown (e.g. ``pubsub``) and the ``sub_type`` (e.g. | |
| 13 ``microblog``). | |
| 14 | |
| 15 The ``path`` is always displayed (see `RFC 5122 Path section`_ for details). | |
| 16 | |
| 17 If suitable, you'll also get data like ``node`` (for a PubSub URI). | |
| 18 | |
| 19 .. _RFC 5122 Path section: https://tools.ietf.org/html/rfc5122#section-2.4 | |
| 20 | |
| 21 examples | |
| 22 -------- | |
| 23 | |
| 24 Parse a blog URI:: | |
| 25 | |
| 26 $ jp uri parse "xmpp:somebody@example.org?;node=urn%3Axmpp%3Amicroblog%3A0" | |
| 27 | |
| 28 build | |
| 29 ====== | |
| 30 | |
| 31 Build an XMPP URI according to arguments. 2 positional arguments are expected: ``type`` | |
| 32 and ``path``. For now, only ``pubsub`` type is supported. | |
| 33 | |
| 34 examples | |
| 35 -------- | |
| 36 | |
| 37 Build XMPP URI for a blog:: | |
| 38 | |
| 39 $ jp uri build pubsub somebody@example.org -f node urn:xmpp:microblog:0 |