xref: /openbsd/usr.sbin/smtpd/smtpctl.8 (revision 404b540a)
1.\" $OpenBSD: smtpctl.8,v 1.8 2009/03/23 21:48:40 jmc Exp $
2.\"
3.\" Copyright (c) 2006 Pierre-Yves Ritschard <pyr@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: March 23 2009 $
18.Dt SMTPCTL 8
19.Os
20.Sh NAME
21.Nm smtpctl
22.Nd control the Simple Mail Transfer Protocol daemon
23.Sh SYNOPSIS
24.Nm
25.Ar command
26.Op Ar argument ...
27.Sh DESCRIPTION
28The
29.Nm
30program controls
31.Xr smtpd 8 .
32.Pp
33The following commands are available:
34.Bl -tag -width Ds
35.It Cm pause incoming
36Temporarily stop accepting incoming sessions.
37.It Cm pause local
38Temporarily stop deliveries to local users.
39.It Cm pause outgoing
40Temporarily stop relaying and deliveries to
41remote users.
42.It Cm resume incoming
43Resume accepting incoming sessions.
44.It Cm resume local
45Resume deliveries to local users.
46.It Cm resume outgoing
47Resume relaying and deliveries to remote users.
48.It Cm schedule message-id
49Marks all messages with same message ID as ready
50for immediate delivery.
51.It Cm schedule message-uid
52Marks a message as ready for immediate delivery.
53.It Cm show queue
54Displays information concerning envelopes
55that are currently in a queue.
56.It Cm show runqueue
57Displays information concerning envelopes
58that are scheduled for delivery.
59.It Cm show stats
60Displays runtime statistics concerning
61.Xr smtpd 8 .
62.El
63.Sh FILES
64.Bl -tag -width "/var/run/smtpd.sockXX" -compact
65.It /var/run/smtpd.sock
66Unix-domain socket used for communication with
67.Xr smtpd 8 .
68.El
69.Sh SEE ALSO
70.Xr smtpd 8
71.Sh HISTORY
72The
73.Nm
74program first appeared in
75.Ox 4.6 .
76