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
13 .\" it under the terms of the GNU General Public License as published by
14 .\" the Free Software Foundation; either version 2 of the License, or
15 .\" (at your option) any later version.
17 .\" TrIPE is distributed in the hope that it will be useful,
18 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
19 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 .\" GNU General Public License for more details.
22 .\" You should have received a copy of the GNU General Public License
23 .\" along with TrIPE; if not, write to the Free Software Foundation,
24 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
26 .\"--------------------------------------------------------------------------
27 .so ../common/defs.man \" @@@PRE@@@
29 .\"--------------------------------------------------------------------------
30 .TH tripectl 1tripe "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 tripectl \- simple client for TrIPE
37 .\"--------------------------------------------------------------------------
73 .IB arg , arg ,\fR...]
75 .\"--------------------------------------------------------------------------
80 program is a simple client which can be used, either interactively or
81 from a script, to send commands to and read status information from a
84 server. It can also be used to start
86 passing appropriate arguments and capturing logging information.
87 .SS "Command-line options"
90 Writes a brief description of the command-line options available to
91 standard output and exits with status 0.
94 Writes tripe's version number to standard output and exits with status
98 Writes a brief usage summary to standard output and exits with status 0.
103 disassociate from the terminal and become a background process after
104 connecting to the server.
106 .BI "\-d, \-\-directory=" dir
109 the current directory, before doing anything else. Note that all the
110 other filenames (e.g., the log output file) are relative to this
111 directory. The default directory, if this option is not specified, is
112 taken from the environment variable
114 if that's not defined either, a default default of
118 .BI "\-a, \-\-admin-socket=" socket
119 If connecting to a running server, connect to the socket named
121 if running a new server, instruct it to listen for admin
124 The default socket, if this option is not specified, is taken from the
127 if that's not defined either, a default default of
131 .BI "\-P, \-\-pidfile=" pidfile
142 options are given, a default of
143 .IB dir /tripectl.pid
144 is used if you don't give a
149 Start a new server: don't connect to an existing one. Starting a
151 server in this manner is a good way to ensure that no log messages are
157 options are particularly useful in conjunction with
160 .BI "\-p, \-\-spawn\-path=" path
163 runs the program named by
165 rather than the default
169 is actually an unqualified filename, the program to run is found using
172 environment variable in the usual way.
174 .BI "\-S, \-\-spawn\-args=" arg , arg ,\fR...
177 passes the comma-separated
181 server on its command line. Arguments added using this option are added
183 any passed automatically by
188 .BI "\-U, \-\-setuid=" user
191 (either a user name or integer uid) after initialization. Also set gid
194 primary group, unless overridden by a
198 server is going to be spawned then it is also passed corresponding
204 .BI "\-G, \-\-setgid=" group
205 If the current effective uid is zero (i.e., the daemon was invoked as
207 then set gid to that of
209 (either a group name or integer gid) after initialization. If a new
211 server is going to be spawned then it is also passed a corresponding
216 Send warnings and trace messages to the
218 service. Messages are logged using the
220 facility. Warnings are logged with severity
222 trace messages are logged with severity
225 .BI "\-f, \-\-logfile=" file
226 Write warnings and trace messages to
232 to request output to stdout, or
234 to request output to stderr. If a proper filename is given (rather than
235 one of these special tokens), then on receipt of a
239 will close its log file and reopen a new one with the same name; this is
240 useful when you rotate logs.
242 .B "\-t, \-\-no-timestamp"
243 When logging to a file (with
245 don't prefix log items with a timestamp. This is useful when the log
246 output is being captured by some process which will add its own
249 .B "\-w, \-\-warnings"
250 Write warnings to standard error even when running noninteractively.
252 .BI "\-W, \-\-watch=" things
253 When running as a client, arrange to receive asynchronous messages as
256 which should be a trace list suitable for passing to the server's
260 for more details. This overrides the
262 flag in noninteractive use.
263 .SS "Interactive use"
266 will connect to a running server and await commands from its standard
267 input. The commands are submitted to the server unchanged, and the
268 results written to standard output. It will quit when it receives a
269 fatal signal or an end-of-file indication from the server.
270 .SS "Use from scripts"
271 If arguments are given to
273 they are quoted if necessary to protect spaces and other special
274 characters, concatenated with spaces between, and submitted to the
275 server after connection. Any
277 responses returned by the server are written to standard output (without
282 response causes the error message to be written to standard error, and
283 the client to exit with a nonzero return code. An
285 response causes the client to exit with a zero return code. Unless the
287 command-line option was given, any
289 responses are discarded; if
294 responses are written to standard error. In all cases,
296 responses are ignored.
297 .SS "Starting the tripe server"
298 If any of the options
307 server, rather than connecting to an existing one.
309 The command line for the new server is
320 is the concatenation of the arguments of
322 options, split at commas.
328 is most useful if you want to collect logging information from the
329 server, and want to avoid losing any. For example, the command
331 tripectl -Ds -f tripe.log
333 starts up a new server in the default directory, and captures all of its
334 logging output (i.e.,
338 messages) in the file
340 It stores its process-id in
343 It's possible to communicate interactively with a newly-started server,
344 or to give it a command and quit, but this is seldom useful.
346 .\"--------------------------------------------------------------------------
349 .BR tripe\-admin (5),
352 .IR "The Trivial IP Encryption Protocol" ,
353 .IR "The Wrestlers Protocol" .
355 .\"--------------------------------------------------------------------------
358 Mark Wooding, <mdw@distorted.org.uk>
360 .\"----- That's all, folks --------------------------------------------------