From: Pierre Habouzit Date: Sun, 11 Jan 2009 18:46:10 +0000 (+0100) Subject: Add a man page for pfix-srsd(8). X-Git-Url: http://git.madism.org/?a=commitdiff_plain;h=380e4e0ee92811b2edd87f06ad7f0d13e92882d4;p=apps%2Fpfixtools.git Add a man page for pfix-srsd(8). Signed-off-by: Pierre Habouzit --- diff --git a/.gitignore b/.gitignore index ee4c91a..28cea19 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,10 @@ /pfix-srsd/pfix-srsd /postlicyd/data/*.db +*.xml +*.html +*.[1-9] + *.[ao] .tags .*.dep diff --git a/pfix-srsd/Makefile b/pfix-srsd/Makefile index 321d75b..90ae21e 100644 --- a/pfix-srsd/Makefile +++ b/pfix-srsd/Makefile @@ -33,6 +33,7 @@ ############################################################################## PROGRAMS = pfix-srsd +DOCS = pfix-srsd.8 pfix-srsd_SOURCES = main-srsd.c ../common/lib.a pfix-srsd_LIBADD = -lsrs2 -lev diff --git a/pfix-srsd/pfix-srsd.txt b/pfix-srsd/pfix-srsd.txt new file mode 100644 index 0000000..42e047e --- /dev/null +++ b/pfix-srsd/pfix-srsd.txt @@ -0,0 +1,76 @@ +pfix-srsd(8) +============ + +NAME +---- + +pfix-srsd - Postfix tcp_table(5) srsd lookup service + + +SYNOPSIS +-------- + +pfix-srsd [options] domain secrets + + +DESCRIPTION +----------- + +pfix-srsd is designed to provide as a Postfix tcp_table(5), a way to rewrite +addresses using the SRS (http://www.libsrs2.org/docs/index.html) scheme. It +supports both encoding and decoding of such addresses. + + +OPTIONS +------- + +Mandatory arguments +~~~~~~~~~~~~~~~~~~~ + +domain:: + The domain is the FQDN on which you want to use SRS. + +secrets:: + The secrets argument is a path to the secrets used for SRS, one per line. + There is no comment possible in that file, every line is used, including + empty ones. The first line is used for encoding purposes, other lines as + possible fallbacks for decoding, which is useful when you want to change + your encoding secret. + +Command line switches +~~~~~~~~~~~~~~~~~~~~~ + +-h:: + Show the help + +-d :: + Change the port `pfix-srsd` is listening to for SRS 'decoding' purposes + (default is 10002). + +-e :: + Change the port `pfix-srsd` is listening to for SRS 'encoding' purposes + (default is 10001). + +-f:: + Do not daemonize `pfix-srsd` on startup. + +-p :: + Path to the pidfile where `pfix-srsd` will maintain its pid. Default is to + not use any pidfile. + +-u:: + Work in unsafe mode: don't drop privileges when running as root. + + +COPYRIGHT +--------- + +Copyright 2009 the Postfix Tools Suite Authors. License BSD. + + +PFIXTOOLS +--------- + +pfix-srsd is part of the linkgit:pfixtools[7] suite. + +// vim:filetype=asciidoc:tw=78