X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/tripe/blobdiff_plain/6b6ad6702f305891ced3b9a7cf3061c75eabda86..c4e05a1a9831c923f2a4a68a0178116f55d5ddf0:/client/tripectl.1.in diff --git a/client/tripectl.1.in b/client/tripectl.1.in index 9c114377..e01df128 100644 --- a/client/tripectl.1.in +++ b/client/tripectl.1.in @@ -1,33 +1,52 @@ .\" -*-nroff-*- -.de VS -.sp 1 -.RS -.nf -.ft B -.. -.de VE -.ft R -.fi -.RE -.sp 1 -.. -.ie t \{\ -. if \n(.g \{\ -. fam P -. \} -.\} -.TH tripectl 1 "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" -.SH NAME +.\". +.\" 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 1tripe "19 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" +. +.\"-------------------------------------------------------------------------- +.SH "NAME" +. tripectl \- simple client for TrIPE -.SH SYNOPSIS +. +.\"-------------------------------------------------------------------------- +.SH "SYNOPSIS" +. .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 ] @@ -45,10 +64,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 +112,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 +125,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 +185,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) @@ -172,15 +225,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 @@ -225,9 +304,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 +342,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, +. +.\"----- That's all, folks --------------------------------------------------