Merge branch 'vendor/OPENSSL'
[dragonfly.git] / share / man / man5 / mailer.conf.5
1 .\"     $NetBSD: mailer.conf.5,v 1.2 1999/05/29 18:18:30 christos Exp $
2 .\"     $FreeBSD: src/share/man/man5/mailer.conf.5,v 1.1.1.1.2.5 2001/08/17 13:08:47 ru Exp $
3 .\"
4 .\" Copyright (c) 1998
5 .\"     Perry E. Metzger.  All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgment:
17 .\"     This product includes software developed for the NetBSD Project
18 .\"     by Perry E. Metzger.
19 .\" 4. The name of the author may not be used to endorse or promote products
20 .\"    derived from this software without specific prior written permission.
21 .\"
22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 .\"
33 .\" The following requests are required for all man pages.
34 .Dd March 9, 2015
35 .Dt MAILER.CONF 5
36 .Os
37 .Sh NAME
38 .Nm mailer.conf
39 .Nd configuration file for
40 .Xr mailwrapper 8
41 .Sh DESCRIPTION
42 The file
43 .Pa /etc/mail/mailer.conf
44 contains a series of pairs. The first member of each pair is the name
45 of a program invoking
46 .Xr mailwrapper 8
47 which is typically a symbolic link to
48 .Pa /usr/sbin/sendmail .
49 (On a typical system,
50 .Xr newaliases 1
51 and
52 .Xr mailq 1
53 would be set up this way.)
54 The second member of each pair is the name of the program to
55 actually execute when the first name is invoked. The file may also
56 contain comments, denoted by a # mark in the first column of any line.
57 .Sh FILES
58 /etc/mail/mailer.conf
59 .Sh EXAMPLES
60 The following is an example of how to set up an
61 .Nm
62 for traditional sendmail invocation behavior (installed from DPorts)
63 .Bd -literal
64 # Use sendmail as Mail Transfer Agent
65 sendmail        /usr/local/sbin/sendmail
66 mailq           /usr/local/bin/mailq
67 newaliases      /usr/local/bin/newaliases
68 hoststat        /usr/local/bin/hoststat
69 purgestat       /usr/local/bin/purgestat
70 .Ed
71 .Pp
72 This example shows how to invoke a sendmail-workalike like Postfix
73 installed from DPorts to replace
74 .Xr dma 8
75 .Bd -literal
76 # Use postfix as Mail Transfer Agent
77 sendmail        /usr/local/sbin/sendmail
78 mailq           /usr/local/bin/mailq
79 newaliases      /usr/local/bin/newaliases
80 hoststat        true
81 purgestat       true
82 .Ed
83 .Pp
84 This example shows how to invoke a sendmail-workalike like OpenSMTPd
85 installed from DPorts to replace
86 .Xr dma 8
87 .Bd -literal
88 # Use opensmtpd as Mail Transfer Agent
89 sendmail        /usr/local/sbin/smtpctl
90 mailq           /usr/local/sbin/smtpctl
91 newaliases      /usr/local/sbin/smtpctl
92 hoststat        true
93 purgestat       true
94 .Ed
95 .Pp
96 These are the default contents of the file
97 .Bd -literal
98 # Use dma as Mail Transfer Agent
99 sendmail        /usr/libexec/dma
100 mailq           /usr/libexec/dma
101 newaliases      true
102 hoststat        true
103 purgestat       true
104 .Ed
105 .Sh SEE ALSO
106 .Xr mail 1 ,
107 .Xr mailwrapper 8
108 .Sh HISTORY
109 .Nm
110 appeared in
111 .Nx 1.4 .
112 .Sh AUTHORS
113 .An Perry E. Metzger Aq Mt perry@piermont.com
114 should go away.