server/admin.c: Remove spurious `ping' in usage message.

[tripe] / client / tripectl.1.in

diff --git a/client/tripectl.1.in b/client/tripectl.1.in
index 11fa6c94a5743411ef35c42707263d0939188abe..7de21be16d624f0cb03f54e2b6159d0384839308 100644 (file)
--- a/client/tripectl.1.in
+++ b/client/tripectl.1.in
@@ -9,25 +9,24 @@
 .\"
 .\" 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 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 3 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.
+.\" 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.
+.\" along with TrIPE.  If not, see <https://www.gnu.org/licenses/>.
 .
 .\"--------------------------------------------------------------------------
-.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"
@@ -39,12 +38,14 @@ tripectl \- simple client for TrIPE
 .
 .B tripectl
 .RB [ \-w ]
+.RB [ \-W
+.IR things ]
 .RB [ \-\fIoptions ]
 .RI [ command
 .RI [ args ]...]
 .br
 .B tripectl
-.RB [ \-Dl ]
+.RB [ \-Dlt ]
 .RB [ \-f
 .IR file ]
 .RB [ \-\fIoptions ]
@@ -63,6 +64,10 @@ Options:
        \&
 .RB [ \-p
 .IR path ]
+.RB [ \-U
+.IR user ]
+.RB [ \-G
+.IR group ]
 .RB [ \-S
 .IB arg , arg ,\fR...]
 .
@@ -106,7 +111,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 +124,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 +184,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,15 +224,41 @@ 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.
+.TP
+.BI "\-W, \-\-watch=" things
+When running as a client, arrange to receive asynchronous messages as
+described by
+.IR things ,
+which should be a trace list suitable for passing to the server's
+.B WATCH
+command: see
+.BR tripe-admin (5)
+for more details.  This overrides the
+.B \-w
+flag in noninteractive use.
 .SS "Interactive use"
 With no arguments,
 .B tripectl