qtermy-pipe

Name

qtermy-pipe - send commands and pipe requests to a running qtermy instance

Synopsis

qtermy-pipe [command] [arg...]

Description

qtermy-pipe is a command-line interface to certain features of the qtermy(1) graphical multiplexing terminal emulator client. The primary use of qtermy-pipe is to pipe input or output from a remote server, sending the data stream over the TermySequence protocol. A secondary use of qtermy-pipe is performing application actions programmatically. See Examples below.

For comprehensive documentation of the many features offered by qtermy, refer to the support pages at https://termysequence.io/doc/

Commands

to user@host
Pipe standard input to a named pipe on the remote server, which must be connected within qtermy. The termy-server(1) instance on the remote server will create a named pipe (fifo) which may be used as standard input to a remote command. The path to the fifo will be printed on standard error (keep in mind that this path is on the remote server). A "Pipe To" task will be created within qtermy which may be used to track the status of the upload.
from user@host
Pipe standard output from a named pipe on the remote server. Analogous to the to command, except with data flowing in the opposite direction. A "Pipe From" task will be created within qtermy which may be used to track the status of the download.
list-servers
List the currently connected servers.
invoke action...
Run the given application action within the qtermy instance. The format is identical to the "Perform action" key binding, including arguments separated by vertical bar (|) characters if needed. Quote the action string if necessary. More than one action string may be given; multiple actions will be run sequentially.

Options

--help
Print basic help
--version
Print version information
--man
Attempt to show this man page

Files

$XDG_RUNTIME_DIR/termy-server/

Location where termy-server creates named pipes.

$XDG_RUNTIME_DIR/qtermy/

Location of the socket file used by qtermy to accept connections from qtermy-pipe (see Notes below).

Examples

Pipe Example

To compute a local md5sum(1) of the contents of a file on the connected remote server user@example.com: first, execute the local pipe command:

$ qtermy-pipe from user@example.com | md5sum
Reading from /run/user/1000/termy-server/p1 on server user@example.com

Second, on the remote server, redirect the desired file into the named pipe:

$ cat foo.dat | /run/user/1000/termy-server/p1
Invoke Example

To create a new terminal programmatically, use:

$ qtermy-pipe invoke NewTerminal

Or, to create two new terminals using settings profiles Foo and Bar, use:

$ qtermy-pipe invoke 'NewTerminal|Foo' 'NewTerminal|Bar'

Notes

If more than one instance of qtermy(1) is run by the user, it is unspecified which instance qtermy-pipe will connect to.

See Also

qtermy(1), termy-server(1), termy-connect(1), termy-ssh(1), termyctl(1)