qtermy-pipe(1)

1qtermy-pipe(1)              General Commands Manual             qtermy-pipe(1)
2
3
4

NAME

6       qtermy-pipe  -  send  commands  and  pipe  requests to a running qtermy
7       instance
8
9

SYNOPSIS

11       qtermy-pipe [command] [arg...]
12
13

DESCRIPTION

15       qtermy-pipe is a command-line interface  to  certain  features  of  the
16       qtermy(1) graphical multiplexing terminal emulator client.  The primary
17       use of qtermy-pipe is to pipe input or output  from  a  remote  server,
18       sending  the  data stream over the TermySequence protocol.  A secondary
19       use of qtermy-pipe is performing application actions  programmatically.
20       See EXAMPLES below.
21
22       For comprehensive documentation of the many features offered by qtermy,
23       refer to the support pages at https://termysequence.io/doc/
24
25

COMMANDS

27       to user@host
28              Pipe standard input to a named pipe on the remote server,  which
29              must  be  connected within qtermy.  The termy-server(1) instance
30              on the remote server will create a named pipe (fifo)  which  may
31              be  used  as standard input to a remote command. The path to the
32              fifo will be printed on standard error (keep in mind  that  this
33              path  is on the remote server). A "Pipe To" task will be created
34              within qtermy which may be used  to  track  the  status  of  the
35              upload.
36
37
38       from user@host
39              Pipe  standard  output  from  a named pipe on the remote server.
40              Analogous to the to command, except with  data  flowing  in  the
41              opposite  direction.  A  "Pipe From" task will be created within
42              qtermy which may be used to track the status of the download.
43
44
45       list-servers
46              List the currently connected servers.
47
48
49       invoke action...
50              Run the given application action within the qtermy instance. The
51              format is identical to the "Perform action" key binding, includ‐
52              ing arguments  separated  by  vertical  bar  (|)  characters  if
53              needed.  Quote  the  action  string  if necessary. More than one
54              action string may be given; multiple actions will be run sequen‐
55              tially.
56
57

OPTIONS

59       --help Print basic help
60
61
62       --version
63              Print version information
64
65
66       --man  Attempt to show this man page
67
68

FILES

70       $XDG_RUNTIME_DIR/termy-server/
71
72       Location where termy-server creates named pipes.
73
74       $XDG_RUNTIME_DIR/qtermy/
75
76       Location  of  the socket file used by qtermy to accept connections from
77       qtermy-pipe (see NOTES below).
78
79

EXAMPLES

81       Pipe Example
82              To compute a local md5sum(1) of the contents of a  file  on  the
83              connected  remote  server  user@example.com:  first, execute the
84              local pipe command:
85
86                 $ qtermy-pipe from user@example.com | md5sum
87                 Reading from /run/user/1000/termy-server/p1     on     server
88              user@example.com
89
90              Second, on the remote server, redirect the desired file into the
91              named pipe:
92
93                 $ cat foo.dat | /run/user/1000/termy-server/p1
94
95
96       Invoke Example
97              To create a new terminal programmatically, use:
98
99                 $ qtermy-pipe invoke NewTerminal
100
101              Or, to create two new terminals using settings profiles Foo  and
102              Bar, use:
103
104                 $ qtermy-pipe invoke 'NewTerminal|Foo' 'NewTerminal|Bar'
105
106

NOTES

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