view doc/jp/pipe.rst @ 3303:f17379123571

plugin list of interest: new "interestRetract" method
author Goffi <goffi@goffi.org>
date Fri, 19 Jun 2020 15:37:02 +0200
parents 72583524cfd3
children
line wrap: on
line source

==================================================
pipe: send/receive data stream through shell pipes
==================================================

``pipe`` commands allow you to send or receive data stream through a Unix shell pipe.
Salut à Toi will create a network connection (using XMPP and Jingle) between you an your
contact.

in
==

Receive data stream. Data will be send to stdout, so it can be piped out or simply print
to the screen. You can specify bare jids of entities to accept stream for, by default all
streams are accepted.

example
-------

Receive a video stream, and redirect it to mpv_ so show the video::

  $ jp pipe in | mpv -

.. _mpv: https://mpv.io/

out
===

Send data stream. Data comes from stdin, so you may use pipe in something or just write
some text.

The only expected argument is the full jid of the device where the stream must be piped
out.

example
-------

Send a video to louise::

 $ jp pipe out louise@example.org/sat < some_video.webm

Send output from ``cal`` command to louise::

 $ cal | jp pipe out louise@example.org/sat