File: //usr/local/share/man/man1/srsd.1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SRSD 1"
.TH SRSD 1 "2004-06-23" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
srsd \- daemon interface to Mail::SRS
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
srsd \-\-secretfile=/etc/srs_secret
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The srsd daemon listens on a socket for \s-1SRS\s0 address transformation
requests. It transforms the addresses and returns the new addresses
on the socket.
.PP
It may be used from exim using ${readsocket ...}, from sendmail via
a \s-1TCP\s0 socket in a rule, and probably from other MTAs as well. See
http://www.anarres.org/projects/srs/ for examples.
.PP
Arguments take the form \-\-name or \-\-name=value.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
.Sh "\-\-separator"
.IX Subsection "--separator"
String, specified at most once. Defaults to \f(CW$SRSSEP\fR (\f(CW\*(C`=\*(C'\fR).
.PP
Specify the initial separator for the \s-1SRS\s0 address. See Mail::SRS for
details.
.Sh "\-\-secret"
.IX Subsection "--secret"
String, may be specified multiple times, at least one of \-\-secret or
\&\-\-secretfile must be specified.
.PP
Specify an \s-1SRS\s0 secret. The first specified secret is used for
encoding. All secrets are used for decoding.
.Sh "\-\-secretfile"
.IX Subsection "--secretfile"
String, specified at most once, at least one of \-\-secret or
\&\-\-secretfile must be specified.
.PP
A file to read for secrets. Secrets are specified once per line. The
first specified secret is used for encoding. Secrets are written
one per line. Blank lines and lines starting with a # are ignored.
If \-\-secret is not given, then the secret file must be nonempty.
.PP
\&\-\-secret will specify a primary secret and override \-\-secretfile
if both are specified. However, secrets read from \-\-secretfile will
still be used for decoding if both are specified.
.Sh "\-\-hashlength"
.IX Subsection "--hashlength"
Integer, may be specified at most once, defaults to 4.
.PP
Specify the number of base64 characters to use for the cryptographic
authentication code.
.Sh "\-\-help"
.IX Subsection "--help"
Print some basic help.
.SH "PROTOCOL"
.IX Header "PROTOCOL"
A forward request:
.PP
.Vb 1
\& FORWARD sender@source.com alias@forwarder.com
.Ve
.PP
A reverse request:
.PP
.Vb 1
\& REVERSE srs0+HHH=TT=domain=local-part@forwarder.com
.Ve
.PP
A client called srsc has been included in this distribution for
testing purposes.
.SH "TODO"
.IX Header "TODO"
Add more daemon-related options. Path to socket. Document protocol.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mail::SRS, Mail::SRS::Daemon, srsc,
http://www.anarres.org/projects/srs/
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 4
\& Shevek
\& CPAN ID: SHEVEK
\& cpan@anarres.org
\& http://www.anarres.org/projects/
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2004 Shevek. All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.