pfix-srsd: add a -I option
[apps/pfixtools.git] / pfix-srsd / pfix-srsd.txt
1 pfix-srsd(8)
2 ============
3
4 NAME
5 ----
6
7 pfix-srsd - Postfix tcp_table(5) srsd lookup service
8
9
10 SYNOPSIS
11 --------
12
13 pfix-srsd [options] domain secrets
14
15
16 DESCRIPTION
17 -----------
18
19 pfix-srsd is designed to provide as a Postfix tcp_table(5), a way to rewrite
20 addresses using the SRS (http://www.libsrs2.org/docs/index.html) scheme. It
21 supports both encoding and decoding of such addresses.
22
23
24 OPTIONS
25 -------
26
27 Mandatory arguments
28 ~~~~~~~~~~~~~~~~~~~
29
30 domain::
31     The domain is the FQDN on which you want to use SRS.
32
33 secrets::
34     The secrets argument is a path to the secrets used for SRS, one per line.
35     There is no comment possible in that file, every line is used, including
36     empty ones. The first line is used for encoding purposes, other lines as
37     possible fallbacks for decoding, which is useful when you want to change
38     your encoding secret.
39
40 Command line switches
41 ~~~~~~~~~~~~~~~~~~~~~
42
43 -h::
44     Show the help
45
46 -d <port>::
47     Change the port `pfix-srsd` is listening to for SRS 'decoding' purposes
48     (default is 10002).
49
50 -e <port>::
51     Change the port `pfix-srsd` is listening to for SRS 'encoding' purposes
52     (default is 10001).
53
54 -f::
55     Do not daemonize `pfix-srsd` on startup.
56
57 -p <path>::
58     Path to the pidfile where `pfix-srsd` will maintain its pid. Default is to
59     not use any pidfile.
60
61 -u::
62     Work in unsafe mode: don't drop privileges when running as root.
63
64
65 COPYRIGHT
66 ---------
67
68 Copyright 2009 the Postfix Tools Suite Authors. License BSD.
69
70
71 PFIXTOOLS
72 ---------
73
74 pfix-srsd is part of the linkgit:pfixtools[7] suite.
75
76 // vim:filetype=asciidoc:tw=78