Mercurial > libervia-backend
diff 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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/jp/uri.rst Tue Oct 01 22:49:06 2019 +0200 @@ -0,0 +1,39 @@ +================================ +uri: XMPP URI parsing/generation +================================ + +URI commands are helper to easily parse/build XMPP URIs. + +parse +===== + +Parse an XMPP URI, and print different parts. + +When possible, the ``type`` of URI is shown (e.g. ``pubsub``) and the ``sub_type`` (e.g. +``microblog``). + +The ``path`` is always displayed (see `RFC 5122 Path section`_ for details). + +If suitable, you'll also get data like ``node`` (for a PubSub URI). + +.. _RFC 5122 Path section: https://tools.ietf.org/html/rfc5122#section-2.4 + +examples +-------- + +Parse a blog URI:: + + $ jp uri parse "xmpp:somebody@example.org?;node=urn%3Axmpp%3Amicroblog%3A0" + +build +====== + +Build an XMPP URI according to arguments. 2 positional arguments are expected: ``type`` +and ``path``. For now, only ``pubsub`` type is supported. + +examples +-------- + +Build XMPP URI for a blog:: + + $ jp uri build pubsub somebody@example.org -f node urn:xmpp:microblog:0