.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .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. \*(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- .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" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "SRS 1p" .TH SRS 1p "2022-11-27" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" srs \- command line interface to Mail::SRS .SH "SYNOPSIS" .IX Header "SYNOPSIS" srs \-\-alias=alias@forwarder.com \-\-secretfile=/etc/srs_secret \e sender@source.com .SH "DESCRIPTION" .IX Header "DESCRIPTION" The srs commandline interface will create an instance of Mail::SRS with parameters derived from the commandline arguments and perform forward or reverse transformations for all addresses given. .PP It is usually invoked from a sendmail envelope address transformation rule, a qmail alias, or similar. See http://www.anarres.org/projects/srs/ for examples. .PP Arguments take the form \-\-name or \-\-name=value. .SH "ARGUMENTS" .IX Header "ARGUMENTS" .SS "\-\-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. .SS "\-\-address" .IX Subsection "--address" String, may be specified multiple times, must be specified at least once. .PP Specify a sender address to transform. .SS "\-\-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. .SS "\-\-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. .SS "\-\-forward" .IX Subsection "--forward" No argument. .PP Specifies a forwards transformation. This is the default. \-\-reverse must not also be given. .SS "\-\-reverse" .IX Subsection "--reverse" No argument. .PP Specifies a reverse transformation. \-\-forward must not also be given. .SS "\-\-alias" .IX Subsection "--alias" String, must be specified exactly once if doing forwards transformation. .PP Provides the alias address to which the mail was sent. The domain-part of this address is used in the generated \s-1SRS\s0 address. The local-part and @ are optional and may be omitted. .SS "\-\-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. .SS "\-\-help" .IX Subsection "--help" Print some basic help. .SH "SEE ALSO" .IX Header "SEE ALSO" Mail::SRS, 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.