X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/tripe/blobdiff_plain/6b6ad6702f305891ced3b9a7cf3061c75eabda86..46dde0806919904d146851bf8bd93fac9915730b:/server/tripe.8.in diff --git a/server/tripe.8.in b/server/tripe.8.in index c72a3548..edf0ea58 100644 --- a/server/tripe.8.in +++ b/server/tripe.8.in @@ -1,40 +1,44 @@ .\" -*-nroff-*- .\". -.de hP -.IP -\h'-\w'\fB\\$1\ \fP'u'\fB\\$1\ \fP\c -.. -.de VS -.sp 1 -.RS -.nf -.ft B -.. -.de VE -.ft R -.fi -.RE -.sp 1 -.. -.ie t \{\ -. ds o \(bu -. ds ss \s8\u -. ds se \d\s0 -. if \n(.g \{\ -. fam P -. \} -.\} -.el \{\ -. ds o o -. ds ss ^ -. ds se -.\} +.\" Manual for the server +.\" +.\" (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 tripe 8 "10 February 2001" "Straylight/Edgeware" "TrIPE: Trivial IP Encryption" +. +.\"-------------------------------------------------------------------------- .SH "NAME" +. tripe \- a simple VPN daemon +. +.\"-------------------------------------------------------------------------- .SH "SYNOPSIS" +. .B tripe -.RB [ \-D ] +.RB [ \-DF ] .RB [ \-d .IR dir ] .RB [ \-b @@ -61,7 +65,10 @@ tripe \- a simple VPN daemon .IR pub-keyring ] .RB [ \-t .IR key-tag ] +. +.\"-------------------------------------------------------------------------- .SH "DESCRIPTION" +. The .B tripe program is a server which can provide strong IP-level encryption and @@ -99,7 +106,7 @@ will initialize by following these steps: It sets the directory named by the .B TRIPEDIR environment variable (or -.B "@configdir@" +.B "*(/c" if the variable is unset) as the current directory. .hP 2. It acquires a UDP socket with an arbitrary kernel-selected port number. @@ -166,6 +173,13 @@ standard output. A better way to start in the background is with .BR tripectl (1). .TP +.B "\-F, \-\-foreground" +Runs the server in the `foreground'; i.e., +.B tripe +will quit if it sees end-of-file on its standard input. This is +incompatible with +.BR \-D . +.TP .BI "\-d, \-\-directory=" dir Makes .I dir @@ -173,7 +187,7 @@ the current directory. The default directory to change to is given by the environment variable .BR TRIPEDIR ; if that's not specified, a default default of -.B "@configdir@" +.B "*(/c" is used. Give a current directory of .B . if you don't want it to change directory at all. @@ -234,7 +248,7 @@ The default socket, if this option isn't specified, is given by the environment variable .BR TRIPESOCK ; if that's not set either, then a default default of -.B "@socketdir@/tripesock" +.B "*(/s/tripesock" is used instead. .TP .BI "\-T, \-\-trace=" trace-opts @@ -531,16 +545,27 @@ The program's name is all in lower-case. The name of the protocol it uses is `TrIPE', with four capital letters and one lower-case. The name stands for `Trivial IP Encryption'. +. +.\"-------------------------------------------------------------------------- .SH "BUGS" +. The code hasn't been audited. It may contain security bugs. If you find one, please inform the author .IR immediately . +. +.\"-------------------------------------------------------------------------- .SH "SEE ALSO" +. .BR key (1), .BR tripectl (1), .BR tripe\-admin (5). .PP .IR "The Trivial IP Encryption Protocol" , .IR "The Wrestlers Protocol" . +. +.\"-------------------------------------------------------------------------- .SH "AUTHOR" +. Mark Wooding, +. +.\"----- That's all, folks --------------------------------------------------