commands/vdeliver.1
changeset 2 b3afb9f1e801
parent 0 6f7a81934006
equal deleted inserted replaced
1:30113bfbe723 2:b3afb9f1e801
     1 .rn '' }`
     1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
     2 ''' $RCSfile$$Revision$$Date$
     2 .\"
     3 '''
     3 .\" Standard preamble:
     4 ''' $Log$
     4 .\" ========================================================================
     5 '''
     5 .de Sh \" Subsection heading
     6 .de Sh
       
     7 .br
     6 .br
     8 .if t .Sp
     7 .if t .Sp
     9 .ne 5
     8 .ne 5
    10 .PP
     9 .PP
    11 \fB\\$1\fR
    10 \fB\\$1\fR
    12 .PP
    11 .PP
    13 ..
    12 ..
    14 .de Sp
    13 .de Sp \" Vertical space (when we can't use .PP)
    15 .if t .sp .5v
    14 .if t .sp .5v
    16 .if n .sp
    15 .if n .sp
    17 ..
    16 ..
    18 .de Ip
    17 .de Vb \" Begin verbatim text
    19 .br
       
    20 .ie \\n(.$>=3 .ne \\$3
       
    21 .el .ne 3
       
    22 .IP "\\$1" \\$2
       
    23 ..
       
    24 .de Vb
       
    25 .ft CW
    18 .ft CW
    26 .nf
    19 .nf
    27 .ne \\$1
    20 .ne \\$1
    28 ..
    21 ..
    29 .de Ve
    22 .de Ve \" End verbatim text
    30 .ft R
    23 .ft R
    31 
       
    32 .fi
    24 .fi
    33 ..
    25 ..
    34 '''
    26 .\" Set up some character translations and predefined strings.  \*(-- will
    35 '''
    27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
    36 '''     Set up \*(-- to give an unbreakable dash;
    28 .\" double quote, and \*(R" will give a right double quote.  | will give a
    37 '''     string Tr holds user defined translation string.
    29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
    38 '''     Bell System Logo is used as a dummy character.
    30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
    39 '''
    31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
    40 .tr \(*W-|\(bv\*(Tr
    32 .tr \(*W-|\(bv\*(Tr
       
    33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
    41 .ie n \{\
    34 .ie n \{\
    42 .ds -- \(*W-
    35 .    ds -- \(*W-
    43 .ds PI pi
    36 .    ds PI pi
    44 .if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
    37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
    45 .if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
    38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
    46 .ds L" ""
    39 .    ds L" ""
    47 .ds R" ""
    40 .    ds R" ""
    48 '''   \*(M", \*(S", \*(N" and \*(T" are the equivalent of
    41 .    ds C` ""
    49 '''   \*(L" and \*(R", except that they are used on ".xx" lines,
    42 .    ds C' ""
    50 '''   such as .IP and .SH, which do another additional levels of
       
    51 '''   double-quote interpretation
       
    52 .ds M" """
       
    53 .ds S" """
       
    54 .ds N" """""
       
    55 .ds T" """""
       
    56 .ds L' '
       
    57 .ds R' '
       
    58 .ds M' '
       
    59 .ds S' '
       
    60 .ds N' '
       
    61 .ds T' '
       
    62 'br\}
    43 'br\}
    63 .el\{\
    44 .el\{\
    64 .ds -- \(em\|
    45 .    ds -- \|\(em\|
    65 .tr \*(Tr
    46 .    ds PI \(*p
    66 .ds L" ``
    47 .    ds L" ``
    67 .ds R" ''
    48 .    ds R" ''
    68 .ds M" ``
       
    69 .ds S" ''
       
    70 .ds N" ``
       
    71 .ds T" ''
       
    72 .ds L' `
       
    73 .ds R' '
       
    74 .ds M' `
       
    75 .ds S' '
       
    76 .ds N' `
       
    77 .ds T' '
       
    78 .ds PI \(*p
       
    79 'br\}
    49 'br\}
    80 .\"	If the F register is turned on, we'll generate
    50 .\"
    81 .\"	index entries out stderr for the following things:
    51 .\" If the F register is turned on, we'll generate index entries on stderr for
    82 .\"		TH	Title 
    52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
    83 .\"		SH	Header
    53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
    84 .\"		Sh	Subsection 
    54 .\" output yourself in some meaningful fashion.
    85 .\"		Ip	Item
    55 .if \nF \{\
    86 .\"		X<>	Xref  (embedded
    56 .    de IX
    87 .\"	Of course, you have to process the output yourself
    57 .    tm Index:\\$1\t\\n%\t"\\$2"
    88 .\"	in some meaninful fashion.
    58 ..
    89 .if \nF \{
    59 .    nr % 0
    90 .de IX
    60 .    rr F
    91 .tm Index:\\$1\t\\n%\t"\\$2"
    61 .\}
    92 ..
    62 .\"
    93 .nr % 0
    63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
    94 .rr F
    64 .\" way too many mistakes in technical documents.
    95 .\}
    65 .hy 0
    96 .TH VDELIVER 1 "vmailmgr 0.96.9" "2000-09-30" "VMailMgr Tools Documentation"
       
    97 .UC
       
    98 .if n .hy 0
       
    99 .if n .na
    66 .if n .na
   100 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
    67 .\"
   101 .de CQ          \" put $1 in typewriter font
    68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
   102 .ft CW
    69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
   103 'if n "\c
    70 .    \" fudge factors for nroff and troff
   104 'if t \\&\\$1\c
       
   105 'if n \\&\\$1\c
       
   106 'if n \&"
       
   107 \\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7
       
   108 '.ft R
       
   109 ..
       
   110 .\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2
       
   111 .	\" AM - accent mark definitions
       
   112 .bd B 3
       
   113 .	\" fudge factors for nroff and troff
       
   114 .if n \{\
    71 .if n \{\
   115 .	ds #H 0
    72 .    ds #H 0
   116 .	ds #V .8m
    73 .    ds #V .8m
   117 .	ds #F .3m
    74 .    ds #F .3m
   118 .	ds #[ \f1
    75 .    ds #[ \f1
   119 .	ds #] \fP
    76 .    ds #] \fP
   120 .\}
    77 .\}
   121 .if t \{\
    78 .if t \{\
   122 .	ds #H ((1u-(\\\\n(.fu%2u))*.13m)
    79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
   123 .	ds #V .6m
    80 .    ds #V .6m
   124 .	ds #F 0
    81 .    ds #F 0
   125 .	ds #[ \&
    82 .    ds #[ \&
   126 .	ds #] \&
    83 .    ds #] \&
   127 .\}
    84 .\}
   128 .	\" simple accents for nroff and troff
    85 .    \" simple accents for nroff and troff
   129 .if n \{\
    86 .if n \{\
   130 .	ds ' \&
    87 .    ds ' \&
   131 .	ds ` \&
    88 .    ds ` \&
   132 .	ds ^ \&
    89 .    ds ^ \&
   133 .	ds , \&
    90 .    ds , \&
   134 .	ds ~ ~
    91 .    ds ~ ~
   135 .	ds ? ?
    92 .    ds /
   136 .	ds ! !
       
   137 .	ds /
       
   138 .	ds q
       
   139 .\}
    93 .\}
   140 .if t \{\
    94 .if t \{\
   141 .	ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
    95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
   142 .	ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
    96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
   143 .	ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
    97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
   144 .	ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
    98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
   145 .	ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
    99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
   146 .	ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10'
   100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
   147 .	ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m'
   101 .\}
   148 .	ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
   102 .    \" troff and (daisy-wheel) nroff accents
   149 .	ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10'
       
   150 .\}
       
   151 .	\" troff and (daisy-wheel) nroff accents
       
   152 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
   103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
   153 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
   104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
   154 .ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#]
       
   155 .ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u'
       
   156 .ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u'
       
   157 .ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#]
       
   158 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
   105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
   159 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
   106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
   160 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
   107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
   161 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
   108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
   162 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
   109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
   163 .ds ae a\h'-(\w'a'u*4/10)'e
   110 .ds ae a\h'-(\w'a'u*4/10)'e
   164 .ds Ae A\h'-(\w'A'u*4/10)'E
   111 .ds Ae A\h'-(\w'A'u*4/10)'E
   165 .ds oe o\h'-(\w'o'u*4/10)'e
   112 .    \" corrections for vroff
   166 .ds Oe O\h'-(\w'O'u*4/10)'E
       
   167 .	\" corrections for vroff
       
   168 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
   113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
   169 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
   114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
   170 .	\" for low resolution devices (crt and lpr)
   115 .    \" for low resolution devices (crt and lpr)
   171 .if \n(.H>23 .if \n(.V>19 \
   116 .if \n(.H>23 .if \n(.V>19 \
   172 \{\
   117 \{\
   173 .	ds : e
   118 .    ds : e
   174 .	ds 8 ss
   119 .    ds 8 ss
   175 .	ds v \h'-1'\o'\(aa\(ga'
   120 .    ds o a
   176 .	ds _ \h'-1'^
   121 .    ds d- d\h'-1'\(ga
   177 .	ds . \h'-1'.
   122 .    ds D- D\h'-1'\(hy
   178 .	ds 3 3
   123 .    ds th \o'bp'
   179 .	ds o a
   124 .    ds Th \o'LP'
   180 .	ds d- d\h'-1'\(ga
   125 .    ds ae ae
   181 .	ds D- D\h'-1'\(hy
   126 .    ds Ae AE
   182 .	ds th \o'bp'
       
   183 .	ds Th \o'LP'
       
   184 .	ds ae ae
       
   185 .	ds Ae AE
       
   186 .	ds oe oe
       
   187 .	ds Oe OE
       
   188 .\}
   127 .\}
   189 .rm #[ #] #H #V #F C
   128 .rm #[ #] #H #V #F C
       
   129 .\" ========================================================================
       
   130 .\"
       
   131 .IX Title "VDELIVER 1"
       
   132 .TH VDELIVER 1 "2005-09-03" "vmailmgr 0.97" "VMailMgr Tools Documentation"
   190 .SH "NAME"
   133 .SH "NAME"
   191 vdeliver \- VMailMgr delivery agent
   134 vdeliver \- VMailMgr delivery agent
   192 .SH "SYNOPSIS"
   135 .SH "SYNOPSIS"
   193 \fBvdeliver\fR
   136 .IX Header "SYNOPSIS"
       
   137 \&\fBvdeliver\fR
   194 [\fB\-D\fR]
   138 [\fB\-D\fR]
   195 [\fB\-F\fR]
   139 [\fB\-F\fR]
   196 [\fB\-R\fR]
   140 [\fB\-R\fR]
   197 [\fB\-d\fR]
   141 [\fB\-d\fR]
   198 [\fB\-f\fR]
   142 [\fB\-f\fR]
   199 [\fB--quiet\fR]
   143 [\fB\-\-no\-predeliver\fR]
       
   144 [\fB\-\-no\-postdeliver\fR]
       
   145 [\fB\-\-quiet\fR]
   200 [\fB\-r\fR]
   146 [\fB\-r\fR]
   201 .SH "DESCRIPTION"
   147 .SH "DESCRIPTION"
   202 vdeliver is the unified e-mail message delivery agent for virtual
   148 .IX Header "DESCRIPTION"
       
   149 vdeliver is the unified e\-mail message delivery agent for virtual
   203 domains managed by vmailmgr.
   150 domains managed by vmailmgr.
   204 It is run from the \fI.qmail-default\fR file, and automatically handles
   151 It is run from the \fI.qmail\-default\fR file, and automatically handles
   205 delivery to any user within a virtual domain.
   152 delivery to any user within a virtual domain.
   206 .SH "OPTIONS"
   153 .SH "OPTIONS"
   207 .Ip "\fB\-D\fR" 8
   154 .IX Header "OPTIONS"
   208 Add the \f(CWReturn-Path:\fR line to the top of the message. (default)
   155 .IP "\fB\-D\fR" 8
   209 .Ip "\fB\-F\fR" 8
   156 .IX Item "-D"
   210 Add a \*(L"\f(CWFrom \fR\*(R" mailbox line.
   157 Add the \f(CW\*(C`Return\-Path:\*(C'\fR line to the top of the message. (default)
   211 .Ip "\fB\-R\fR" 8
   158 .IP "\fB\-F\fR" 8
   212 Add a \*(L"\f(CWReturn-Path:\fR\*(R" line (default).
   159 .IX Item "-F"
   213 .Ip "\fB\-d\fR" 8
   160 Add a "\f(CW\*(C`From \*(C'\fR" mailbox line.
   214 Do not add the \f(CWDelivered-To:\fR line to the top of the message.
   161 .IP "\fB\-R\fR" 8
   215 .Ip "\fB\-f\fR" 8
   162 .IX Item "-R"
   216 Do not add the \f(CWFrom\fR mailbox line to the top of the message. Note that this line is never added when the message is being re-injected into the mail stream. (default)
   163 Add a "\f(CW\*(C`Return\-Path:\*(C'\fR" line (default).
   217 .Ip "\fB--quiet\fR" 8
   164 .IP "\fB\-d\fR" 8
       
   165 .IX Item "-d"
       
   166 Do not add the \f(CW\*(C`Delivered\-To:\*(C'\fR line to the top of the message.
       
   167 .IP "\fB\-f\fR" 8
       
   168 .IX Item "-f"
       
   169 Do not add the \f(CW\*(C`From\*(C'\fR mailbox line to the top of the message. Note that this line is never added when the message is being re-injected into the mail stream. (default)
       
   170 .IP "\fB\-\-no\-predeliver\fR" 8
       
   171 .IX Item "--no-predeliver"
       
   172 Do not run vdeliver-predeliver scripts.
       
   173 .IP "\fB\-\-no\-postdeliver\fR" 8
       
   174 .IX Item "--no-postdeliver"
       
   175 Do not run vdeliver-postdeliver scripts.
       
   176 .IP "\fB\-\-quiet\fR" 8
       
   177 .IX Item "--quiet"
   218 Suppress all status messages.
   178 Suppress all status messages.
   219 .Ip "\fB\-r\fR" 8
   179 .IP "\fB\-r\fR" 8
   220 Do not add the \f(CWReturn-Path:\fR line to the top of the message.
   180 .IX Item "-r"
       
   181 Do not add the \f(CW\*(C`Return\-Path:\*(C'\fR line to the top of the message.
   221 .SH "RETURN VALUE"
   182 .SH "RETURN VALUE"
       
   183 .IX Header "RETURN VALUE"
   222 Returns 0 if delivery was successful,
   184 Returns 0 if delivery was successful,
   223 100 if a fatal error occurred,
   185 100 if a fatal error occurred,
   224 or 111 if a temporary error occurred.
   186 or 111 if a temporary error occurred.
   225 .SH "ENVIRONMENT"
   187 .SH "ENVIRONMENT"
   226 \fIvdeliver\fR expects to be run by \fIqmail-local\fR as it requires several
   188 .IX Header "ENVIRONMENT"
       
   189 \&\fIvdeliver\fR expects to be run by \fIqmail-local\fR as it requires several
   227 of the environment variables that it sets.
   190 of the environment variables that it sets.
   228 See the \fIqmail-command\fR(8) manual page for full details on these
   191 See the \fIqmail-command\fR(8) manual page for full details on these
   229 variables.
   192 variables.
   230 In particular, it requires \f(CWDTLINE\fR, \f(CWEXT\fR, \f(CWHOST\fR, \f(CWRPLINE\fR,
   193 In particular, it requires \f(CW\*(C`DTLINE\*(C'\fR, \f(CW\*(C`EXT\*(C'\fR, \f(CW\*(C`HOST\*(C'\fR, \f(CW\*(C`RPLINE\*(C'\fR,
   231 \f(CWSENDER\fR, \f(CWUFLINE\fR, and \f(CWUSER\fR.
   194 \&\f(CW\*(C`SENDER\*(C'\fR, \f(CW\*(C`UFLINE\*(C'\fR, and \f(CW\*(C`USER\*(C'\fR.
   232 .SH "SEE ALSO"
   195 .SH "SEE ALSO"
   233 \fIcheckvpw\fR\|(1), \fIqmail-command\fR(8)
   196 .IX Header "SEE ALSO"
       
   197 \&\fIcheckvpw\fR\|(1), \fIqmail-command\fR(8)
   234 .SH "AUTHORS"
   198 .SH "AUTHORS"
       
   199 .IX Header "AUTHORS"
   235 Bruce Guenter <bruceg@em.ca>
   200 Bruce Guenter <bruceg@em.ca>
   236 
       
   237 .rn }` ''
       
   238 .IX Title "VDELIVER 1"
       
   239 .IX Name "vdeliver - VMailMgr delivery agent"
       
   240 
       
   241 .IX Header "NAME"
       
   242 
       
   243 .IX Header "SYNOPSIS"
       
   244 
       
   245 .IX Header "DESCRIPTION"
       
   246 
       
   247 .IX Header "OPTIONS"
       
   248 
       
   249 .IX Item "\fB\-D\fR"
       
   250 
       
   251 .IX Item "\fB\-F\fR"
       
   252 
       
   253 .IX Item "\fB\-R\fR"
       
   254 
       
   255 .IX Item "\fB\-d\fR"
       
   256 
       
   257 .IX Item "\fB\-f\fR"
       
   258 
       
   259 .IX Item "\fB--quiet\fR"
       
   260 
       
   261 .IX Item "\fB\-r\fR"
       
   262 
       
   263 .IX Header "RETURN VALUE"
       
   264 
       
   265 .IX Header "ENVIRONMENT"
       
   266 
       
   267 .IX Header "SEE ALSO"
       
   268 
       
   269 .IX Header "AUTHORS"
       
   270