xref: /openbsd-src/usr.sbin/smtpd/smtpd.8 (revision f2da64fbbbf1b03f09f390ab01267c93dfd77c4c)
1.\"	$OpenBSD: smtpd.8,v 1.30 2016/04/18 21:06:42 jmc Exp $
2.\"
3.\" Copyright (c) 2012, Eric Faurot <eric@openbsd.org>
4.\" Copyright (c) 2008, Gilles Chehade <gilles@poolp.org>
5.\" Copyright (c) 2008, Pierre-Yves Ritschard <pyr@openbsd.org>
6.\"
7.\" Permission to use, copy, modify, and distribute this software for any
8.\" purpose with or without fee is hereby granted, provided that the above
9.\" copyright notice and this permission notice appear in all copies.
10.\"
11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18.\"
19.Dd $Mdocdate: April 18 2016 $
20.Dt SMTPD 8
21.Os
22.Sh NAME
23.Nm smtpd
24.Nd Simple Mail Transfer Protocol daemon
25.Sh SYNOPSIS
26.Nm
27.Op Fl dhnv
28.Op Fl D Ar macro Ns = Ns Ar value
29.Op Fl f Ar file
30.Op Fl P Ar system
31.Op Fl T Ar trace
32.Sh DESCRIPTION
33.Nm
34is a Simple Mail Transfer Protocol
35.Pq SMTP
36daemon which can be used as a machine's primary mail system.
37.Nm
38can listen on a network interface and handle SMTP
39transactions; it can also be fed messages through the standard
40.Xr sendmail 8
41interface.
42It can relay messages through remote mail transfer agents or store them
43locally using either the mbox or maildir format.
44This implementation supports SMTP as defined by RFC 5321 as well as several
45extensions.
46A running
47.Nm
48can be controlled through
49.Xr smtpctl 8 .
50.Pp
51The options are as follows:
52.Bl -tag -width Ds
53.It Fl D Ar macro Ns = Ns Ar value
54Define
55.Ar macro
56to be set to
57.Ar value
58on the command line.
59Overrides the definition of
60.Ar macro
61in the configuration file.
62.It Fl d
63Do not daemonize.
64If this option is specified,
65.Nm
66will run in the foreground and log to
67.Em stderr .
68.It Fl f Ar file
69Specify an alternative configuration file.
70.It Fl h
71Display version and usage.
72.It Fl n
73Configtest mode.
74Only check the configuration file for validity.
75.It Fl P Ar system
76Pause a specific subsystem at startup.
77Normal operation can be resumed using
78.Xr smtpctl 8 .
79This option can be used multiple times.
80The accepted values are:
81.Pp
82.Bl -tag -width "smtpXXX" -compact
83.It mda
84Do not schedule local deliveries.
85.It mta
86Do not schedule remote transfers.
87.It smtp
88Do not listen on SMTP sockets.
89.El
90.It Fl T Ar trace
91Enables real-time tracing at startup.
92Normal operation can be resumed using
93.Xr smtpctl 8 .
94This option can be used multiple times.
95The accepted values are:
96.Pp
97.Bl -bullet -compact
98.It
99imsg
100.It
101io
102.It
103smtp (incoming sessions)
104.It
105filters
106.It
107transfer (outgoing sessions)
108.It
109bounce
110.It
111scheduler
112.It
113expand (aliases/virtual/forward expansion)
114.It
115lookup (user/credentials lookups)
116.It
117stat
118.It
119rules (matched by incoming sessions)
120.It
121mproc
122.It
123all
124.El
125.It Fl v
126Produce more verbose output.
127.El
128.Sh FILES
129.Bl -tag -width "/etc/mail/smtpd.confXXX" -compact
130.It Pa /etc/mail/mailname
131Alternate server name to use.
132.It Pa /etc/mail/smtpd.conf
133Default
134.Nm
135configuration file.
136.It Pa /var/run/smtpd.sock
137.Ux Ns -domain
138socket used for communication with
139.Xr smtpctl 8 .
140.It Pa /var/spool/smtpd/
141Spool directories for mail during processing.
142.El
143.Sh SEE ALSO
144.Xr smtpd.conf 5 ,
145.Xr mailwrapper 8 ,
146.Xr smtpctl 8
147.Sh STANDARDS
148.Rs
149.%A J. Klensin
150.%D October 2008
151.%R RFC 5321
152.%T Simple Mail Transfer Protocol
153.Re
154.Sh HISTORY
155The
156.Nm
157program first appeared in
158.Ox 4.6 .
159