termy-connect(1)

1termy-connect(1)            General Commands Manual           termy-connect(1)
2
3
4

NAME

6       termy-connect - Establish connection between TermySequence servers
7
8

SYNOPSIS

10       termy-connect [options] [--] command [arg...]
11
12

DESCRIPTION

14       termy-connect  is  used  to  establish  a  connection  between  a local
15       instance of termy-server(1) and an  instance  running  on  a  different
16       host,  as  a  different  user, or in a container.  termy-connect runs a
17       helper program, specified by command and args, which must  itself  exe‐
18       cute  an  instance  of termy-server(1) on the desired remote system and
19       make it accessible over standard input and standard output.  After  the
20       handshake from the remote server is received, termy-connect connects to
21       the local termy-server(1) instance, sets up the link  between  the  two
22       servers,  and exits. File descriptor passing is used to hand the helper
23       process over to the local server, making it unnecessary for  termy-con‐
24       nect to forward traffic.
25
26       Separate convenience scripts are provided for commonly used helper pro‐
27       grams: termy-ssh(1), termy-sudo(1), and termy-su(1).  However, any pro‐
28       gram  that  can  be used to execute an instance of termy-server(1) in a
29       remote environment can be used  with  termy-connect.   The  convenience
30       scripts  are  simple wrappers for termy-connect and are documented fur‐
31       ther in their own man pages.
32
33       Until termy-connect sees a valid TermySequence protocol handshake,  any
34       output  produced  by  the helper program is relayed to standard output,
35       and standard input is relayed to the helper program (with terminal echo
36       disabled).  This  allows passwords, pass phrases, and other input to be
37       collected from the user to establish the connection. Once  the  connec‐
38       tion  is  established  and termy-connect has exited, the helper program
39       will be detached from the terminal and running in the background.
40
41       However, a side effect of this feature is that any diagnostic  messages
42       printed  by  the helper program once the connection is established will
43       interrupt the protocol stream. Furthermore, the default "raw"  encoding
44       of  the  TermySequence  protocol  cannot  be used if the helper program
45       interferes with the data stream, such as by providing escape  sequences
46       to  interrupt the connection. Helper programs should be run with appro‐
47       priate arguments to minimize the number  of  messages  printed  and  to
48       (ideally)  make  the  data  stream  8-bit safe.  termy-connect provides
49       options to change the variant of the  TermySequence  protocol  used  as
50       necessary  to  ensure a clean connection. See OPTIONS below for further
51       details.
52
53

OPTIONS

55       -p,--pty
56              Run command in a pseudoterminal. Use this option if  the  helper
57              program expects standard input to be connected to a terminal.
58
59
60       -P,--nopty
61              Do  not  run  command  in  a pseudoterminal (a socket or pipe is
62              used). This is the default.
63
64
65       -r,--raw
66              Use the 8-bit "raw" encoding of the TermySequence protocol. This
67              encoding  offers the best performance, but cannot be used if the
68              data stream is not 8-bit safe. This is the default.
69
70
71       -R,--noraw
72              Use the 7-bit "term" encoding  of  the  TermySequence  protocol.
73              This encoding uses Base64 encoded terminal escape sequences, and
74              will function in non-8-bit-safe data streams. It is  also  some‐
75              what robust against occasional diagnostic messages being printed
76              into the data stream.
77
78
79       -k,--keepalive n
80              Enable keep-alive probes with a timeout of n seconds on the con‐
81              nection.  A timeout of 0 disables keep-alive probes. The default
82              timeout is 25 seconds and the minimum  (nonzero)  timeout  is  5
83              seconds.
84
85
86       -d,--dir dir
87              Start  command in directory dir.  Relative paths are interpreted
88              relative to $HOME.  By default $HOME is used.
89
90
91       -0,--arg0 arg
92              Use arg as the first argument vector element when  running  com‐
93              mand.
94
95
96       -n,--noosc
97              Do not issue TermySequence escape sequences if standard input is
98              a tty. Use when running in a terminal emulator other than termy-
99              server(1).
100
101
102       -t,--runtime dir
103              Look for the per-user local socket in runtime directory dir.
104
105
106       --help Print basic help
107
108
109       --version
110              Print version information
111
112
113       --man  Attempt to show this man page
114
115
116       --about
117              Print license information and disclaimer of warranty
118
119

NOTES

121       termy-connect  is  an alias for termy-server; both functions are imple‐
122       mented by the same binary.
123
124

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

NOTES

SEE ALSO