19 .TH tripectl 1 "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
21 tripectl \- simple client for TrIPE
50 .IB arg , arg ,\fR...]
54 program is a simple client which can be used, either interactively or
55 from a script, to send commands to and read status information from a
58 server. It can also be used to start
60 passing appropriate arguments and capturing logging information.
61 .SS "Command-line options"
64 Writes a brief description of the command-line options available to
65 standard output and exits with status 0.
68 Writes tripe's version number to standard output and exits with status
72 Writes a brief usage summary to standard output and exits with status 0.
77 disassociate from the terminal and become a background process after
78 connecting to the server.
80 .BI "\-d, \-\-directory=" dir
83 the current directory, before doing anything else. Note that all the
84 other filenames (e.g., the log output file) are relative to this
85 directory. The default directory, if this option is not specified, is
86 taken from the environment variable
88 if that's not defined either, a default default of
92 .BI "\-a, \-\-admin=" socket
93 If connecting to a running server, connect to the socket named
95 if running a new server, instruct it to listen for admin
99 .BI "\-P, \-\-pidfile=" pidfile
110 options are given, a default of
111 .IB dir /tripectl.pid
112 is used if you don't give a
117 Start a new server: don't connect to an existing one. Starting a
119 server in this manner is a good way to ensure that no log messages are
125 options are particularly useful in conjunction with
128 .BI "\-p, \-\-spawn\-path=" path
131 runs the program named by
133 rather than the default
137 is actually an unqualified filename, the program to run is found using
140 environment variable in the usual way.
142 .BI "\-S, \-\-spawn\-args=" arg , arg ,\fR...
145 passes the comma-separated
149 server on its command line. Arguments added using this option are added
151 any passed automatically by
157 Send warnings and trace messages to the
159 service. Messages are logged using the
161 facility. Warnings are logged with severity
163 trace messages are logged with severity
166 .BI "\-f, \-\-logfile=" file
167 Write warnings and trace messages to
173 will close its log file and reopen a new one with the same name. This
174 is useful when you rotate logs.
176 .B "\-w, \-\-warnings"
177 Write warnings to standard error even when running noninteractively.
178 .SS "Interactive use"
181 will connect to a running server and await commands from its standard
182 input. The commands are submitted to the server unchanged, and the
183 results written to standard output. It will quit when it receives a
184 fatal signal or an end-of-file indication from the server.
185 .SS "Use from scripts"
186 If arguments are given to
188 they are quoted if necessary to protect spaces and other special
189 characters, concatenated with spaces between, and submitted to the
190 server after connection. Any
192 responses returned by the server are written to standard output (without
197 response causes the error message to be written to standard error, and
198 the client to exit with a nonzero return code. An
200 response causes the client to exit with a zero return code. Unless the
202 command-line option was given, any
204 responses are discarded; if
209 responses are written to standard error. In all cases,
211 responses are ignored.
212 .SS "Starting the tripe server"
213 If any of the options
222 server, rather than connecting to an existing one. This is most useful
223 if you want to collect logging information from the server, and want to
224 avoid losing any. For example, the command
226 tripectl -Ds -f tripe.log
228 starts up a new server in the default directory, and captures all of its
229 logging output (i.e.,
233 messages) in the file
235 It stores its process-id in
238 It's possible to communicate interactively with a newly-started server,
239 or to give it a command and quit, but this is seldom useful.
241 .BR tripe\-admin (5),
244 .IR "The Trivial IP Encryption Protocol" ,
245 .IR "The Wrestlers Protocol" .
247 Mark Wooding, <mdw@distorted.org.uk>