X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/tripe/blobdiff_plain/6b6ad6702f305891ced3b9a7cf3061c75eabda86..92e57abc8b98e5c28b6d6b4e9e3bf8735c0746c4:/client/tripectl.1.in diff --git a/client/tripectl.1.in b/client/tripectl.1.in index 9c114377..11fa6c94 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 ../defs.man.in \" @@@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,13 @@ Options: .br \& .RB [ \-p -.IR program ] +.IR path ] .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 +106,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 +119,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 @@ -225,9 +245,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 +283,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 --------------------------------------------------