Sync usage with man page.
[netbsd-mini2440.git] / usr.sbin / mailwrapper / mailer.conf.5
blob83d996f8d55d6fa7a9452ec10ff846089abf80e1
1 .\"     $NetBSD: mailer.conf.5,v 1.12 2003/03/03 07:28:29 wiz Exp $
2 .\"
3 .\" Copyright (c) 1998
4 .\"     Perry E. Metzger.  All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\"    must display the following acknowledgment:
16 .\"     This product includes software developed for the NetBSD Project
17 .\"     by Perry E. Metzger.
18 .\" 4. The name of the author may not be used to endorse or promote products
19 .\"    derived from this software without specific prior written permission.
20 .\"
21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 .\"
32 .Dd July 17, 2004
33 .Dt MAILER.CONF 5
34 .Os
35 .Sh NAME
36 .Nm mailer.conf
37 .Nd configuration file for
38 .Xr mailwrapper 8
39 .Sh DESCRIPTION
40 The file
41 .Pa /etc/mailer.conf
42 contains a series of lines of the form
43 .Pp
44 .Pa name
45 .Pa program
46 .Op Ar arguments ...
47 .Pp
48 The first word of each line is the
49 .Pa name
50 of a program invoking
51 .Xr mailwrapper 8 .
52 (For example, on a typical system
53 .Pa /usr/sbin/sendmail
54 would be a symbolic link to
55 .Xr mailwrapper 8 ,
56 as would
57 .Xr newaliases 1
58 and
59 .Xr mailq 1 .
60 Thus,
61 .Pa name
62 might be
63 .Dq sendmail
65 .Dq newaliases
66 etc.)
67 .Pp
68 The second word of each line is the name of the
69 .Pa program
70 to actually execute when the first name is invoked.
71 .Pp
72 The further
73 .Ar arguments ,
74 if any, are passed to the
75 .Pa program ,
76 followed by the arguments
77 .Xr mailwrapper 8
78 was called with.
79 .Pp
80 The file may also contain comment lines, denoted by a
81 .Sq #
82 mark in the first column of any line.
83 .Pp
84 The default mailer is
85 .Xr sendmail 8 ,
86 which will also start by default (unless specifically disabled via an
87 .Xr rc.conf 5
88 setting) so that locally generated mail can be delivered, if the
89 .Dq sendmail
90 setting in
91 .Pa /etc/mailer.conf
92 is set to
93 .Dq /usr/libexec/sendmail/sendmail .
94 .Sh FILES
95 /etc/mailer.conf
96 .Sh EXAMPLES
97 This example shows how to set up
98 .Nm
99 to invoke the traditional
100 .Xr sendmail 8
101 program:
102 .Bd -literal -offset indent
103 # Execute the "real" sendmail program located in
104 # /usr/libexec/sendmail/sendmail
105 sendmail        /usr/libexec/sendmail/sendmail
106 send-mail       /usr/libexec/sendmail/sendmail
107 mailq           /usr/libexec/sendmail/sendmail
108 newaliases      /usr/libexec/sendmail/sendmail
109 hoststat        /usr/libexec/sendmail/sendmail
110 purgestat       /usr/libexec/sendmail/sendmail
113 This example shows how to invoke the
114 .Xr postfix 1
115 MTA suite in place of
116 .Xr sendmail 8 :
117 .Bd -literal -offset indent
118 # Emulate sendmail using postfix
119 sendmail        /usr/libexec/postfix/sendmail
120 send-mail       /usr/libexec/postfix/sendmail
121 mailq           /usr/libexec/postfix/sendmail
122 newaliases      /usr/libexec/postfix/sendmail
125 This example shows the use of the mini-sendmail package from pkgsrc
126 in place of
127 .Xr sendmail 8 :
128 Note the use of additional arguments.
129 .Bd -literal -offset indent
130 # Send outgoing mail to a smart relay using mini-sendmail
131 sendmail        /usr/pkg/sbin/mini-sendmail -srelayhost
132 send-mail       /usr/pkg/sbin/mini-sendmail -srelayhost
134 .Sh SEE ALSO
135 .Xr mail 1 ,
136 .Xr mailq 1 ,
137 .Xr newaliases 1 ,
138 .Xr postfix 1 ,
139 .Xr mailwrapper 8 ,
140 .Xr sendmail 8
142 .Pa pkgsrc/mail/mini_sendmail
143 .Sh HISTORY
145 appeared in
146 .Nx 1.4 .
147 .Sh AUTHORS
148 .An Perry E. Metzger Aq perry@piermont.com
149 .Sh BUGS
150 The entire reason this program exists is a crock.
151 Instead, a command
152 for how to submit mail should be standardized, and all the "behave
153 differently if invoked with a different name" behavior of things like
154 .Xr mailq 1
155 should go away.