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 ../defs.man.in \" @@@PRE@@@
29 .\"--------------------------------------------------------------------------
30 .TH tripectl 1 "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 tripectl \- simple client for TrIPE
37 .\"--------------------------------------------------------------------------
67 .IB arg , arg ,\fR...]
69 .\"--------------------------------------------------------------------------
74 program is a simple client which can be used, either interactively or
75 from a script, to send commands to and read status information from a
78 server. It can also be used to start
80 passing appropriate arguments and capturing logging information.
81 .SS "Command-line options"
84 Writes a brief description of the command-line options available to
85 standard output and exits with status 0.
88 Writes tripe's version number to standard output and exits with status
92 Writes a brief usage summary to standard output and exits with status 0.
97 disassociate from the terminal and become a background process after
98 connecting to the server.
100 .BI "\-d, \-\-directory=" dir
103 the current directory, before doing anything else. Note that all the
104 other filenames (e.g., the log output file) are relative to this
105 directory. The default directory, if this option is not specified, is
106 taken from the environment variable
108 if that's not defined either, a default default of
112 .BI "\-a, \-\-admin-socket=" socket
113 If connecting to a running server, connect to the socket named
115 if running a new server, instruct it to listen for admin
118 The default socket, if this option is not specified, is taken from the
121 if that's not defined either, a default default of
125 .BI "\-P, \-\-pidfile=" pidfile
136 options are given, a default of
137 .IB dir /tripectl.pid
138 is used if you don't give a
143 Start a new server: don't connect to an existing one. Starting a
145 server in this manner is a good way to ensure that no log messages are
151 options are particularly useful in conjunction with
154 .BI "\-p, \-\-spawn\-path=" path
157 runs the program named by
159 rather than the default
163 is actually an unqualified filename, the program to run is found using
166 environment variable in the usual way.
168 .BI "\-S, \-\-spawn\-args=" arg , arg ,\fR...
171 passes the comma-separated
175 server on its command line. Arguments added using this option are added
177 any passed automatically by
183 Send warnings and trace messages to the
185 service. Messages are logged using the
187 facility. Warnings are logged with severity
189 trace messages are logged with severity
192 .BI "\-f, \-\-logfile=" file
193 Write warnings and trace messages to
199 will close its log file and reopen a new one with the same name. This
200 is useful when you rotate logs.
202 .B "\-w, \-\-warnings"
203 Write warnings to standard error even when running noninteractively.
204 .SS "Interactive use"
207 will connect to a running server and await commands from its standard
208 input. The commands are submitted to the server unchanged, and the
209 results written to standard output. It will quit when it receives a
210 fatal signal or an end-of-file indication from the server.
211 .SS "Use from scripts"
212 If arguments are given to
214 they are quoted if necessary to protect spaces and other special
215 characters, concatenated with spaces between, and submitted to the
216 server after connection. Any
218 responses returned by the server are written to standard output (without
223 response causes the error message to be written to standard error, and
224 the client to exit with a nonzero return code. An
226 response causes the client to exit with a zero return code. Unless the
228 command-line option was given, any
230 responses are discarded; if
235 responses are written to standard error. In all cases,
237 responses are ignored.
238 .SS "Starting the tripe server"
239 If any of the options
248 server, rather than connecting to an existing one. This is most useful
249 if you want to collect logging information from the server, and want to
250 avoid losing any. For example, the command
252 tripectl -Ds -f tripe.log
254 starts up a new server in the default directory, and captures all of its
255 logging output (i.e.,
259 messages) in the file
261 It stores its process-id in
264 It's possible to communicate interactively with a newly-started server,
265 or to give it a command and quit, but this is seldom useful.
267 .\"--------------------------------------------------------------------------
270 .BR tripe\-admin (5),
273 .IR "The Trivial IP Encryption Protocol" ,
274 .IR "The Wrestlers Protocol" .
276 .\"--------------------------------------------------------------------------
279 Mark Wooding, <mdw@distorted.org.uk>
281 .\"----- That's all, folks --------------------------------------------------