X-Git-Url: https://git.distorted.org.uk/~mdw/tripe/blobdiff_plain/6b6ad6702f305891ced3b9a7cf3061c75eabda86..203e1b1f8b5ce6f7b78ed8e03b376dea2d56d0ed:/client/tripectl.1.in

diff --git a/client/tripectl.1.in b/client/tripectl.1.in
index 9c114377..4c6777e1 100644
--- a/client/tripectl.1.in
+++ b/client/tripectl.1.in
@@ -1,25 +1,42 @@
 .\" -*-nroff-*-
-.de VS
-.sp 1
-.RS
-.nf
-.ft B
-..
-.de VE
-.ft R
-.fi
-.RE
-.sp 1
-..
-.ie t \{\
-.  if \n(.g \{\
-.    fam P
-.  \}
-.\}
+.\".
+.\" Manual for the administration client
+.\"
+.\" (c) 2008 Straylight/Edgeware
+.\"
+.
+.\"----- Licensing notice ---------------------------------------------------
+.\"
+.\" This file is part of Trivial IP Encryption (TrIPE).
+.\"
+.\" TrIPE is free software; you can redistribute it and/or modify
+.\" it under the terms of the GNU General Public License as published by
+.\" the Free Software Foundation; either version 2 of the License, or
+.\" (at your option) any later version.
+.\"
+.\" TrIPE is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\"
+.\" You should have received a copy of the GNU General Public License
+.\" along with TrIPE; if not, write to the Free Software Foundation,
+.\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+.
+.\"--------------------------------------------------------------------------
+.so ../common/defs.man \" @@@PRE@@@
+.
+.\"--------------------------------------------------------------------------
 .TH tripectl 1 "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
-.SH NAME
+.
+.\"--------------------------------------------------------------------------
+.SH "NAME"
+.
 tripectl \- simple client for TrIPE
-.SH SYNOPSIS
+.
+.\"--------------------------------------------------------------------------
+.SH "SYNOPSIS"
+.
 .B tripectl
 .RB [ \-w ]
 .RB [ \-\fIoptions ]
@@ -45,10 +62,17 @@ Options:
 .br
 	\&
 .RB [ \-p
-.IR program ]
+.IR path ]
+.RB [ \-U
+.IR user ]
+.RB [ \-G
+.IR group ]
 .RB [ \-S
 .IB arg , arg ,\fR...]
-.SH DESCRIPTION
+.
+.\"--------------------------------------------------------------------------
+.SH "DESCRIPTION"
+.
 The
 .B tripectl
 program is a simple client which can be used, either interactively or
@@ -86,7 +110,7 @@ directory.  The default directory, if this option is not specified, is
 taken from the environment variable
 .BR TRIPEDIR ;
 if that's not defined either, a default default of
-.B "@configdir@"
+.B "\*(/c"
 is used.
 .TP
 .BI "\-a, \-\-admin-socket=" socket
@@ -99,7 +123,7 @@ The default socket, if this option is not specified, is taken from the
 environment variable
 .BR TRIPESOCK ;
 if that's not defined either, a default default of
-.B "@socketdir@/tripesock"
+.B "\*(/s/tripesock"
 is used.
 .TP
 .BI "\-P, \-\-pidfile=" pidfile
@@ -159,6 +183,33 @@ any passed automatically by
 (e.g.,
 .BR \-a ).
 .TP
+.BI "\-U, \-\-setuid=" user
+Set uid to that of
+.I user
+(either a user name or integer uid) after initialization.  Also set gid
+to
+.IR user 's
+primary group, unless overridden by a
+.B \-G
+option.  If a new
+.BR tripe (8)
+server is going to be spawned then it is also passed corresponding
+.B \-U
+and
+.B \-G
+options.
+.TP
+.BI "\-G, \-\-setgid=" group
+If the current effective uid is zero (i.e., the daemon was invoked as
+.BR root )
+then set gid to that of
+.I group
+(either a group name or integer gid) after initialization.  If a new
+.BR tripe (8)
+server is going to be spawned then it is also passed a corresponding
+.B \-G
+option.
+.TP
 .B "\-l, \-\-syslog"
 Send warnings and trace messages to the
 .BR syslog (8)
@@ -225,9 +276,29 @@ are given,
 .B tripectl
 will start a new
 .B tripe
-server, rather than connecting to an existing one.  This is most useful
-if you want to collect logging information from the server, and want to
-avoid losing any.  For example, the command
+server, rather than connecting to an existing one.
+.PP
+The command line for the new server is
+.IP
+.I path
+.B \-F
+.B \-d.\&
+.B \-a
+.I socket
+.I dash-S-options
+.PP
+where
+.I dash-S-options
+is the concatenation of the arguments of
+.B \-S
+options, split at commas.
+.PP
+Starting a
+.B tripe
+server through
+.B tripectl
+is most useful if you want to collect logging information from the
+server, and want to avoid losing any.  For example, the command
 .VS
 tripectl -Ds -f tripe.log
 .VE
@@ -243,11 +314,19 @@ It stores its process-id in
 .PP
 It's possible to communicate interactively with a newly-started server,
 or to give it a command and quit, but this is seldom useful.
+.
+.\"--------------------------------------------------------------------------
 .SH "SEE ALSO"
+.
 .BR tripe\-admin (5),
 .BR tripe (8).
 .PP
 .IR "The Trivial IP Encryption Protocol" ,
 .IR "The Wrestlers Protocol" .
+.
+.\"--------------------------------------------------------------------------
 .SH "AUTHOR"
+.
 Mark Wooding, <mdw@distorted.org.uk>
+.
+.\"----- That's all, folks --------------------------------------------------