build, debian: Add a suffix to the main TrIPE-specific manpages.

[tripe] / client / tripectl.1.in

diff --git a/client/tripectl.1.in b/client/tripectl.1.in
index edf93a901c806af387e8590d2ae4f1fdf8e0dc3d..523b1f054c523caaea7599437315b84e022174ad 100644 (file)
--- a/client/tripectl.1.in
+++ b/client/tripectl.1.in
@@ -24,10 +24,10 @@
 .\" Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 .
 .\"--------------------------------------------------------------------------
-.so ../defs.man.in \" @@@PRE@@@
+.so ../common/defs.man \" @@@PRE@@@
 .
 .\"--------------------------------------------------------------------------
-.TH tripectl 1 "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
+.TH tripectl 1tripe "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption"
 .
 .\"--------------------------------------------------------------------------
 .SH "NAME"
@@ -44,7 +44,7 @@ tripectl \- simple client for TrIPE
 .RI [ args ]...]
 .br
 .B tripectl
-.RB [ \-Dl ]
+.RB [ \-Dlt ]
 .RB [ \-f
 .IR file ]
 .RB [ \-\fIoptions ]
@@ -62,7 +62,11 @@ Options:
 .br
        \&
 .RB [ \-p
-.IR program ]
+.IR path ]
+.RB [ \-U
+.IR user ]
+.RB [ \-G
+.IR group ]
 .RB [ \-S
 .IB arg , arg ,\fR...]
 .
@@ -106,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 "*(/c"
+.B "\*(/c"
 is used.
 .TP
 .BI "\-a, \-\-admin-socket=" socket
@@ -119,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 "*(/s/tripesock"
+.B "\*(/s/tripesock"
 is used.
 .TP
 .BI "\-P, \-\-pidfile=" pidfile
@@ -179,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)
@@ -192,12 +223,26 @@ trace messages are logged with severity
 .BI "\-f, \-\-logfile=" file
 Write warnings and trace messages to
 .IR file .
-On receipt of a
+The
+.I file
+may be
+.RB ` \- '
+to request output to stdout, or
+.RB ` ! '
+to request output to stderr.  If a proper filename is given (rather than
+one of these special tokens), then on receipt of a
 .B SIGHUP
 signal,
 .B tripectl
-will close its log file and reopen a new one with the same name.  This
-is useful when you rotate logs.
+will close its log file and reopen a new one with the same name; this is
+useful when you rotate logs.
+.TP
+.B "\-t, \-\-no-timestamp"
+When logging to a file (with
+.BR \-f ),
+don't prefix log items with a timestamp.  This is useful when the log
+output is being captured by some process which will add its own
+timestamps anyway.
 .TP
 .B "\-w, \-\-warnings"
 Write warnings to standard error even when running noninteractively.
@@ -245,9 +290,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