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 1 "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 tripectl \- simple client for TrIPE
37 .\"--------------------------------------------------------------------------
71 .IB arg , arg ,\fR...]
73 .\"--------------------------------------------------------------------------
78 program is a simple client which can be used, either interactively or
79 from a script, to send commands to and read status information from a
82 server. It can also be used to start
84 passing appropriate arguments and capturing logging information.
85 .SS "Command-line options"
88 Writes a brief description of the command-line options available to
89 standard output and exits with status 0.
92 Writes tripe's version number to standard output and exits with status
96 Writes a brief usage summary to standard output and exits with status 0.
101 disassociate from the terminal and become a background process after
102 connecting to the server.
104 .BI "\-d, \-\-directory=" dir
107 the current directory, before doing anything else. Note that all the
108 other filenames (e.g., the log output file) are relative to this
109 directory. The default directory, if this option is not specified, is
110 taken from the environment variable
112 if that's not defined either, a default default of
116 .BI "\-a, \-\-admin-socket=" socket
117 If connecting to a running server, connect to the socket named
119 if running a new server, instruct it to listen for admin
122 The default socket, if this option is not specified, is taken from the
125 if that's not defined either, a default default of
129 .BI "\-P, \-\-pidfile=" pidfile
140 options are given, a default of
141 .IB dir /tripectl.pid
142 is used if you don't give a
147 Start a new server: don't connect to an existing one. Starting a
149 server in this manner is a good way to ensure that no log messages are
155 options are particularly useful in conjunction with
158 .BI "\-p, \-\-spawn\-path=" path
161 runs the program named by
163 rather than the default
167 is actually an unqualified filename, the program to run is found using
170 environment variable in the usual way.
172 .BI "\-S, \-\-spawn\-args=" arg , arg ,\fR...
175 passes the comma-separated
179 server on its command line. Arguments added using this option are added
181 any passed automatically by
186 .BI "\-U, \-\-setuid=" user
189 (either a user name or integer uid) after initialization. Also set gid
192 primary group, unless overridden by a
196 server is going to be spawned then it is also passed corresponding
202 .BI "\-G, \-\-setgid=" group
203 If the current effective uid is zero (i.e., the daemon was invoked as
205 then set gid to that of
207 (either a group name or integer gid) after initialization. If a new
209 server is going to be spawned then it is also passed a corresponding
214 Send warnings and trace messages to the
216 service. Messages are logged using the
218 facility. Warnings are logged with severity
220 trace messages are logged with severity
223 .BI "\-f, \-\-logfile=" file
224 Write warnings and trace messages to
230 to request output to stdout, or
232 to request output to stderr. If a proper filename is given (rather than
233 one of these special tokens), then on receipt of a
237 will close its log file and reopen a new one with the same name; this is
238 useful when you rotate logs.
240 .B "\-t, \-\-no-timestamp"
241 When logging to a file (with
243 don't prefix log items with a timestamp. This is useful when the log
244 output is being captured by some process which will add its own
247 .B "\-w, \-\-warnings"
248 Write warnings to standard error even when running noninteractively.
249 .SS "Interactive use"
252 will connect to a running server and await commands from its standard
253 input. The commands are submitted to the server unchanged, and the
254 results written to standard output. It will quit when it receives a
255 fatal signal or an end-of-file indication from the server.
256 .SS "Use from scripts"
257 If arguments are given to
259 they are quoted if necessary to protect spaces and other special
260 characters, concatenated with spaces between, and submitted to the
261 server after connection. Any
263 responses returned by the server are written to standard output (without
268 response causes the error message to be written to standard error, and
269 the client to exit with a nonzero return code. An
271 response causes the client to exit with a zero return code. Unless the
273 command-line option was given, any
275 responses are discarded; if
280 responses are written to standard error. In all cases,
282 responses are ignored.
283 .SS "Starting the tripe server"
284 If any of the options
293 server, rather than connecting to an existing one.
295 The command line for the new server is
306 is the concatenation of the arguments of
308 options, split at commas.
314 is most useful if you want to collect logging information from the
315 server, and want to avoid losing any. For example, the command
317 tripectl -Ds -f tripe.log
319 starts up a new server in the default directory, and captures all of its
320 logging output (i.e.,
324 messages) in the file
326 It stores its process-id in
329 It's possible to communicate interactively with a newly-started server,
330 or to give it a command and quit, but this is seldom useful.
332 .\"--------------------------------------------------------------------------
335 .BR tripe\-admin (5),
338 .IR "The Trivial IP Encryption Protocol" ,
339 .IR "The Wrestlers Protocol" .
341 .\"--------------------------------------------------------------------------
344 Mark Wooding, <mdw@distorted.org.uk>
346 .\"----- That's all, folks --------------------------------------------------