Mercurial > libervia-backend
diff doc/libervia-cli/pipe.rst @ 3488:c80a0f864b5d
doc: updated doc following global renaming
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 21 Mar 2021 18:23:58 +0100 |
parents | doc/jp/pipe.rst@72583524cfd3 |
children | 4705f80b6e23 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/libervia-cli/pipe.rst Sun Mar 21 18:23:58 2021 +0100 @@ -0,0 +1,43 @@ +================================================== +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:: + + $ li 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:: + + $ li pipe out louise@example.org/sat < some_video.webm + +Send output from ``cal`` command to louise:: + + $ cal | li pipe out louise@example.org/sat