3 .\" Manual for the administration client
5 .\" (c) 2008 Straylight/Edgeware
8 .\"----- Licensing notice ---------------------------------------------------
10 .\" This file is part of Trivial IP Encryption (TrIPE).
12 .\" TrIPE is free software: you can redistribute it and/or modify it under
13 .\" the terms of the GNU General Public License as published by the Free
14 .\" Software Foundation; either version 3 of the License, or (at your
15 .\" option) any later version.
17 .\" TrIPE is distributed in the hope that it will be useful, but WITHOUT
18 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
19 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
22 .\" You should have received a copy of the GNU General Public License
23 .\" along with TrIPE. If not, see <https://www.gnu.org/licenses/>.
25 .\"--------------------------------------------------------------------------
26 .so ../common/defs.man \" @@@PRE@@@
28 .\"--------------------------------------------------------------------------
29 .TH tripectl 1tripe "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
31 .\"--------------------------------------------------------------------------
34 tripectl \- simple client for TrIPE
36 .\"--------------------------------------------------------------------------
72 .IB arg , arg ,\fR...]
74 .\"--------------------------------------------------------------------------
79 program is a simple client which can be used, either interactively or
80 from a script, to send commands to and read status information from a
83 server. It can also be used to start
85 passing appropriate arguments and capturing logging information.
86 .SS "Command-line options"
89 Writes a brief description of the command-line options available to
90 standard output and exits with status 0.
93 Writes tripe's version number to standard output and exits with status
97 Writes a brief usage summary to standard output and exits with status 0.
102 disassociate from the terminal and become a background process after
103 connecting to the server.
105 .BI "\-d, \-\-directory=" dir
108 the current directory, before doing anything else. Note that all the
109 other filenames (e.g., the log output file) are relative to this
110 directory. The default directory, if this option is not specified, is
111 taken from the environment variable
113 if that's not defined either, a default default of
117 .BI "\-a, \-\-admin-socket=" socket
118 If connecting to a running server, connect to the socket named
120 if running a new server, instruct it to listen for admin
123 The default socket, if this option is not specified, is taken from the
126 if that's not defined either, a default default of
130 .BI "\-P, \-\-pidfile=" pidfile
141 options are given, a default of
142 .IB dir /tripectl.pid
143 is used if you don't give a
148 Start a new server: don't connect to an existing one. Starting a
150 server in this manner is a good way to ensure that no log messages are
156 options are particularly useful in conjunction with
159 .BI "\-p, \-\-spawn\-path=" path
162 runs the program named by
164 rather than the default
168 is actually an unqualified filename, the program to run is found using
171 environment variable in the usual way.
173 .BI "\-S, \-\-spawn\-args=" arg , arg ,\fR...
176 passes the comma-separated
180 server on its command line. Arguments added using this option are added
182 any passed automatically by
187 .BI "\-U, \-\-setuid=" user
190 (either a user name or integer uid) after initialization. Also set gid
193 primary group, unless overridden by a
197 server is going to be spawned then it is also passed corresponding
203 .BI "\-G, \-\-setgid=" group
204 If the current effective uid is zero (i.e., the daemon was invoked as
206 then set gid to that of
208 (either a group name or integer gid) after initialization. If a new
210 server is going to be spawned then it is also passed a corresponding
215 Send warnings and trace messages to the
217 service. Messages are logged using the
219 facility. Warnings are logged with severity
221 trace messages are logged with severity
224 .BI "\-f, \-\-logfile=" file
225 Write warnings and trace messages to
231 to request output to stdout, or
233 to request output to stderr. If a proper filename is given (rather than
234 one of these special tokens), then on receipt of a
238 will close its log file and reopen a new one with the same name; this is
239 useful when you rotate logs.
241 .B "\-t, \-\-no-timestamp"
242 When logging to a file (with
244 don't prefix log items with a timestamp. This is useful when the log
245 output is being captured by some process which will add its own
248 .B "\-w, \-\-warnings"
249 Write warnings to standard error even when running noninteractively.
251 .BI "\-W, \-\-watch=" things
252 When running as a client, arrange to receive asynchronous messages as
255 which should be a trace list suitable for passing to the server's
259 for more details. This overrides the
261 flag in noninteractive use.
262 .SS "Interactive use"
265 will connect to a running server and await commands from its standard
266 input. The commands are submitted to the server unchanged, and the
267 results written to standard output. It will quit when it receives a
268 fatal signal or an end-of-file indication from the server.
269 .SS "Use from scripts"
270 If arguments are given to
272 they are quoted if necessary to protect spaces and other special
273 characters, concatenated with spaces between, and submitted to the
274 server after connection. Any
276 responses returned by the server are written to standard output (without
281 response causes the error message to be written to standard error, and
282 the client to exit with a nonzero return code. An
284 response causes the client to exit with a zero return code. Unless the
286 command-line option was given, any
288 responses are discarded; if
293 responses are written to standard error. In all cases,
295 responses are ignored.
296 .SS "Starting the tripe server"
297 If any of the options
306 server, rather than connecting to an existing one.
308 The command line for the new server is
319 is the concatenation of the arguments of
321 options, split at commas.
327 is most useful if you want to collect logging information from the
328 server, and want to avoid losing any. For example, the command
330 tripectl -Ds -f tripe.log
332 starts up a new server in the default directory, and captures all of its
333 logging output (i.e.,
337 messages) in the file
339 It stores its process-id in
342 It's possible to communicate interactively with a newly-started server,
343 or to give it a command and quit, but this is seldom useful.
345 .\"--------------------------------------------------------------------------
348 .BR tripe\-admin (5),
351 .IR "The Trivial IP Encryption Protocol" ,
352 .IR "The Wrestlers Protocol" .
354 .\"--------------------------------------------------------------------------
357 Mark Wooding, <mdw@distorted.org.uk>
359 .\"----- That's all, folks --------------------------------------------------