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
205 (either a group name or integer gid) after initialization. If a new
207 server is going to be spawned then it is also passed a corresponding
212 Send warnings and trace messages to the
214 service. Messages are logged using the
216 facility. Warnings are logged with severity
218 trace messages are logged with severity
221 .BI "\-f, \-\-logfile=" file
222 Write warnings and trace messages to
228 will close its log file and reopen a new one with the same name. This
229 is useful when you rotate logs.
231 .B "\-w, \-\-warnings"
232 Write warnings to standard error even when running noninteractively.
233 .SS "Interactive use"
236 will connect to a running server and await commands from its standard
237 input. The commands are submitted to the server unchanged, and the
238 results written to standard output. It will quit when it receives a
239 fatal signal or an end-of-file indication from the server.
240 .SS "Use from scripts"
241 If arguments are given to
243 they are quoted if necessary to protect spaces and other special
244 characters, concatenated with spaces between, and submitted to the
245 server after connection. Any
247 responses returned by the server are written to standard output (without
252 response causes the error message to be written to standard error, and
253 the client to exit with a nonzero return code. An
255 response causes the client to exit with a zero return code. Unless the
257 command-line option was given, any
259 responses are discarded; if
264 responses are written to standard error. In all cases,
266 responses are ignored.
267 .SS "Starting the tripe server"
268 If any of the options
277 server, rather than connecting to an existing one.
279 The command line for the new server is
290 is the concatenation of the arguments of
292 options, split at commas.
298 is most useful if you want to collect logging information from the
299 server, and want to avoid losing any. For example, the command
301 tripectl -Ds -f tripe.log
303 starts up a new server in the default directory, and captures all of its
304 logging output (i.e.,
308 messages) in the file
310 It stores its process-id in
313 It's possible to communicate interactively with a newly-started server,
314 or to give it a command and quit, but this is seldom useful.
316 .\"--------------------------------------------------------------------------
319 .BR tripe\-admin (5),
322 .IR "The Trivial IP Encryption Protocol" ,
323 .IR "The Wrestlers Protocol" .
325 .\"--------------------------------------------------------------------------
328 Mark Wooding, <mdw@distorted.org.uk>
330 .\"----- That's all, folks --------------------------------------------------