3 .\" Manual for TrIPE services
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 tripe-service 7tripe "8 January 2007" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
32 .\"--------------------------------------------------------------------------
35 tripe-service \- common information about tripe service providers
37 .\"--------------------------------------------------------------------------
53 .\"--------------------------------------------------------------------------
58 server allows external programs to provide useful services through its
59 administration interface, as described in
61 This manual page describes standard conventions for such service
64 Service providers are programs; they are usually invoked automatically
69 Service providers may accept non-option command-line arguments, but it
70 should always be possible to start the provider without any.
72 All service providers recognize the following options.
75 Print a help message describing the service provider's command line
76 usage and suchlike to standard output, and exit with status 0.
79 Print the service provider's version number to standard output, and exit
82 .BI "\-a, \-\-admin-socket=" socket
83 Connect to the named administration
85 The default socket is given by the environment variable
87 if that's not defined either, a default default of
88 .B $socketdir/tripesock
91 .BI "\-d, \-\-directory=" dir
94 the current directory, before doing anything else. Note that all the
95 other filenames (e.g., the log output file) are relative to this
96 directory. The default directory, if this option is not specified, is
97 taken from the environment variable
99 if that's not defined either, a default default of
104 Run the service provider in the background, as a daemon, after starting
108 Inform the service provider that it is being run as part of
110 startup process, and that it should therefore do any special things
111 which are appropriate.
121 pkg-config --variable=socketdir tripe
126 services are in section 7 of the manual, for want of somewhere better to
127 put them. The manual pages are divided into sections, as usual:
130 The name of the service provider, and any services it provides, with a
131 one-line description.
134 A very brief summary of the command-line syntax of the service provider,
135 a blank line, and one-line summaries of the commands provided by each
139 A general description of the service(s) provided, and any unusual
140 command-line options recognized by the service provider, followed by a
141 description of the commands provided by each service.
143 All services must provide the following simple commands (available by
156 line for each command recognized by the service, in the format used by
163 Send a warning of the form
174 command) and terminate the service-provider program.
176 .\"--------------------------------------------------------------------------
180 .BR tripe\-admin (5).
182 .\"--------------------------------------------------------------------------
185 Mark Wooding, <mdw@distorted.org.uk>
187 .\"----- That's all, folks --------------------------------------------------