From 0cc766180e64e634bdec853571fea0a1cbe8647d Mon Sep 17 00:00:00 2001 Message-Id: <0cc766180e64e634bdec853571fea0a1cbe8647d.1715575453.git.mdw@distorted.org.uk> From: Mark Wooding Date: Mon, 19 Apr 2010 22:00:59 +0100 Subject: [PATCH] init/tripe.conf: Reformat, and make comments more useful (and truthful). Organization: Straylight/Edgeware From: Mark Wooding --- init/tripe.conf | 125 ++++++++++++++++++++++++++++-------------------- 1 file changed, 73 insertions(+), 52 deletions(-) diff --git a/init/tripe.conf b/init/tripe.conf index 19f061bf..daa42ad4 100644 --- a/init/tripe.conf +++ b/init/tripe.conf @@ -1,52 +1,73 @@ -# tripe configuration file -# -# this is sourced as a Bourne shell script by /etc/init.d/tripe - -# The directory you want tripe to work in. This is where it will search for -# keyrings, and where its admin socket and logfile are kept. -# TRIPEDIR=/etc/tripe - -# The name of the private key to use. This is usually `tripe-dh' for -# integer Diffie-Hellman keys (the default) or `tripe-ec' for elliptic -# curve keys. -# keytag=tripe-dh - -# The address you want tripe to bind to. By default, tripe will accept -# packets to any address acceptable to the host, and send packets from the -# most appropriate address for the destination; setting this means it will -# (a) only accept packets destined for the named address, and (b) send -# packets from the named address. The latter is probably more useful. -# addr=MYHOST - -# The UDP port you want tripe to use. The default is 4070, which is -# officially allocated by the IANA. If you explicitly specify port 0 -# then tripe gets the kernel to choose a port it's not using right now, -# and you have to dig it out by saying `tripectl port'. -# port=4070 - -# The tunnel device you want tripe to use. The default is to use a system- -# specific device, if there's one compiled in, or SLIP if not. -# tunnel=slip - -# The user to run as once tripe has initialized. The user (or group -- see -# `group' below) must be able to open new tunnel interfaces. -# user=tripe - -# The group to run as once tripe has initialized. See caveats for `user' -# above. -# group=tripe - -# Trace options to pass to tripe. The default is no tracing. The setting -# `A-cp' gives maxmimum possible verbosity without leaking important -# secrets. -# trace=A-cp - -# Any other options to pass on to tripectl. -# miscopts= - -# Logfile to write to. The default is `tripe.log' in the working directory. -# logfile=/var/log/tripe - -# Where to put tripectl's pidfile when it starts up. The default is -# tripectl.pid in the working directory. -# pidfile=/var/run/tripectl.pid +### -*-sh-*- +### +### This file is sourced as a Bourne shell script by tripe's startup script. +### There are vaguely sane defaults. + +## The directory you want tripe to work in. This is where it will search for +## keyrings, and where its admin socket and logfile are kept. The default is +## the CONFIGDIR established at `configure' time, via the `--with-configdir' +## option. +## +#TRIPEDIR=/etc/tripe + +## The tag or type of the private key to use. This is usually `tripe'; the +## default is to try both `tripe' or `tripe-dh', in that order. +## +#keytag=tripe + +## The address you want tripe to bind to. By default, tripe will accept +## packets to any address acceptable to the host, and send packets from the +## most appropriate address for the destination; setting this means it will +## (a) only accept packets destined for the named address, and (b) send +## packets from the named address. The latter is probably more useful. +## +#addr=MYHOST + +## The UDP port you want tripe to use. The default is 4070, which is +## officially allocated by the IANA. If you explicitly specify port 0 then +## tripe gets the kernel to choose a port it's not using right now, and you +## have to dig it out by saying `tripectl port'. +## +#port=4070 + +## The tunnel device you want tripe to use. The default is to use a system- +## specific device, if there's one compiled in, or SLIP if not. +## +#tunnel=slip + +## The user to run as once tripe has initialized. TrIPE keeps a separate +## process running as `root' specifically to open new tunnel devices, but +## this doesn't work for SLIP devices; in this case, you must ensure that the +## user (and/or group) you choose has sufficient privileges to request new +## SLIP tunnels -- or acquires sufficient tunnels at startup time. The +## default is not to change user. +## +#user=tripe + +## The group to run as once tripe has initialized. See caveats for `user' +## above. The default is not to change group. +## +#group=tripe + +## Trace options to pass to tripe. The default is no tracing. The setting +## `A-cp' gives maxmimum possible verbosity without leaking important +## secrets. +## +#trace=A-cp + +## Any other options to pass on to tripectl. (If you want to pass options on +## to the tripe server itself, you'll need to put -SARG,ARG,... in here.) +## The default is not to pass additional options. +## +#miscopts= + +## Logfile to write to. The default is determined by the `--with-logfile' +## configure option, which defaults to `./tripe.log' (relative to $TRIPEDIR). +## +#logfile=/var/log/tripe + +## Where to put tripectl's pidfile when it starts up. The default is +## determined by the `--with-pidfile' configure option, which defaults to +## `./tripectl.pid' (relative to $TRIPEDIR). +## +#pidfile=/var/run/tripectl.pid -- [mdw]