view doc/jp/uri.rst @ 3480:7550ae9cfbac

Renamed the project from "Salut à Toi" to "Libervia": This renaming follows the decision taken at the General Assemblee of January 27th 2021 (cf. https://repos.goffi.org/sat_docs/raw-file/tip/association/2021-01-27%20-%20compte%20rendu%20de%20l%27AG%20extraordinaire.pdf)
author Goffi <goffi@goffi.org>
date Sat, 20 Mar 2021 20:42:04 +0100
parents 72583524cfd3
children
line wrap: on
line source

================================
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