~ubuntu-branches/ubuntu/trusty/postfix/trusty-proposed

« back to all changes in this revision

Viewing changes to man/man1/postqueue.1

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-02-27 09:33:07 UTC
  • Revision ID: james.westby@ubuntu.com-20050227093307-cn789t27ibnlh6tf
Tags: upstream-2.1.5
ImportĀ upstreamĀ versionĀ 2.1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH POSTQUEUE 1 
 
2
.ad
 
3
.fi
 
4
.SH NAME
 
5
postqueue
 
6
\-
 
7
Postfix queue control
 
8
.SH "SYNOPSIS"
 
9
.na
 
10
.nf
 
11
\fBpostqueue\fR [\fB-c \fIconfig_dir\fR] \fB-f\fR
 
12
.br
 
13
\fBpostqueue\fR [\fB-c \fIconfig_dir\fR] \fB-p\fR
 
14
.br
 
15
\fBpostqueue\fR [\fB-c \fIconfig_dir\fR] \fB-s \fIsite\fR
 
16
.SH DESCRIPTION
 
17
.ad
 
18
.fi
 
19
The \fBpostqueue\fR program implements the Postfix user interface
 
20
for queue management. It implements operations that are
 
21
traditionally available via the \fBsendmail\fR(1) command.
 
22
See the \fBpostsuper\fR(1) command for queue operations
 
23
that require super-user privileges such as deleting a message
 
24
from the queue or changing the status of a message.
 
25
 
 
26
The following options are recognized:
 
27
.IP "\fB-c \fIconfig_dir\fR"
 
28
The \fBmain.cf\fR configuration file is in the named directory
 
29
instead of the default configuration directory. See also the
 
30
MAIL_CONFIG environment setting below.
 
31
.IP \fB-f\fR
 
32
Flush the queue: attempt to deliver all queued mail.
 
33
 
 
34
This option implements the traditional \fBsendmail -q\fR command,
 
35
by contacting the Postfix \fBqmgr\fR(8) daemon.
 
36
 
 
37
Warning: flushing undeliverable mail frequently will result in
 
38
poor delivery performance of all other mail.
 
39
.IP \fB-p\fR
 
40
Produce a traditional sendmail-style queue listing.
 
41
This option implements the traditional \fBmailq\fR command,
 
42
by contacting the Postfix \fBshowq\fR(8) daemon.
 
43
 
 
44
Each queue entry shows the queue file ID, message
 
45
size, arrival time, sender, and the recipients that still need to
 
46
be delivered.  If mail could not be delivered upon the last attempt,
 
47
the reason for failure is shown. This mode of operation is implemented
 
48
by executing the \fBpostqueue\fR(1) command. The queue ID string
 
49
is followed by an optional status character:
 
50
.RS
 
51
.IP \fB*\fR
 
52
The message is in the \fBactive\fR queue, i.e. the message is
 
53
selected for delivery.
 
54
.IP \fB!\fR
 
55
The message is in the \fBhold\fR queue, i.e. no further delivery
 
56
attempt will be made until the mail is taken off hold.
 
57
.RE
 
58
.IP "\fB-s \fIsite\fR"
 
59
Schedule immediate delivery of all mail that is queued for the named
 
60
\fIsite\fR. The site must be eligible for the "fast flush" service.
 
61
See \fBflush\fR(8) for more information about the "fast flush"
 
62
service.
 
63
 
 
64
This option implements the traditional \fBsendmail -qR\fIsite\fR
 
65
command, by contacting the Postfix \fBflush\fR(8) daemon.
 
66
.IP \fB-v\fR
 
67
Enable verbose logging for debugging purposes. Multiple \fB-v\fR
 
68
options make the software increasingly verbose.
 
69
.SH "SECURITY"
 
70
.na
 
71
.nf
 
72
.ad
 
73
.fi
 
74
This program is designed to run with set-group ID privileges, so
 
75
that it can connect to Postfix daemon processes.
 
76
.SH DIAGNOSTICS
 
77
.ad
 
78
.fi
 
79
Problems are logged to \fBsyslogd\fR(8) and to the standard error
 
80
stream.
 
81
.SH "ENVIRONMENT"
 
82
.na
 
83
.nf
 
84
.ad
 
85
.fi
 
86
.IP MAIL_CONFIG
 
87
Directory with the \fBmain.cf\fR file. In order to avoid exploitation
 
88
of set-group ID privileges, a non-standard directory is allowed only
 
89
if:
 
90
.RS
 
91
.IP \(bu
 
92
The name is listed in the standard \fBmain.cf\fR file with the
 
93
\fBalternate_config_directories\fR configuration parameter.
 
94
.IP \(bu
 
95
The command is invoked by the super-user.
 
96
.RE
 
97
.SH "CONFIGURATION PARAMETERS"
 
98
.na
 
99
.nf
 
100
.ad
 
101
.fi
 
102
The following \fBmain.cf\fR parameters are especially relevant to
 
103
this program.
 
104
The text below provides only a parameter summary. See
 
105
postconf(5) for more details including examples.
 
106
.IP "\fBalternate_config_directories (empty)\fR"
 
107
A list of non-default Postfix configuration directories that may
 
108
be specified with "-c config_directory" on the command line, or
 
109
via the MAIL_CONFIG environment parameter.
 
110
.IP "\fBconfig_directory (see 'postconf -d' output)\fR"
 
111
The default location of the Postfix main.cf and master.cf
 
112
configuration files.
 
113
.IP "\fBcommand_directory (see 'postconf -d' output)\fR"
 
114
The location of all postfix administrative commands.
 
115
.IP "\fBfast_flush_domains ($relay_domains)\fR"
 
116
Optional list of destinations that are eligible for per-destination
 
117
logfiles with mail that is queued to those destinations.
 
118
.IP "\fBimport_environment (see 'postconf -d' output)\fR"
 
119
The list of environment parameters that a Postfix process will
 
120
import from a non-Postfix parent process.
 
121
.IP "\fBqueue_directory (see 'postconf -d' output)\fR"
 
122
The location of the Postfix top-level queue directory.
 
123
.IP "\fBsyslog_facility (mail)\fR"
 
124
The syslog facility of Postfix logging.
 
125
.IP "\fBsyslog_name (postfix)\fR"
 
126
The mail system name that is prepended to the process name in syslog
 
127
records, so that "smtpd" becomes, for example, "postfix/smtpd".
 
128
.IP "\fBtrigger_timeout (10s)\fR"
 
129
The time limit for sending a trigger to a Postfix daemon (for
 
130
example, the pickup(8) or qmgr(8) daemon).
 
131
.SH "FILES"
 
132
.na
 
133
.nf
 
134
/var/spool/postfix, mail queue
 
135
.SH "SEE ALSO"
 
136
.na
 
137
.nf
 
138
qmgr(8), queue manager
 
139
showq(8), list mail queue
 
140
flush(8), fast flush service
 
141
sendmail(1), Sendmail-compatible user interface
 
142
postsuper(1), privileged queue operations
 
143
.SH "README FILES"
 
144
.na
 
145
.nf
 
146
.ad
 
147
.fi
 
148
Use "\fBpostconf readme_directory\fR" or
 
149
"\fBpostconf html_directory\fR" to locate this information.
 
150
.na
 
151
.nf
 
152
ETRN_README, Postfix ETRN howto
 
153
.SH "LICENSE"
 
154
.na
 
155
.nf
 
156
.ad
 
157
.fi
 
158
The Secure Mailer license must be distributed with this software.
 
159
.SH "HISTORY"
 
160
.na
 
161
.nf
 
162
.ad
 
163
.fi
 
164
The postqueue command was introduced with Postfix version 1.1.
 
165
.SH "AUTHOR(S)"
 
166
.na
 
167
.nf
 
168
Wietse Venema
 
169
IBM T.J. Watson Research
 
170
P.O. Box 704
 
171
Yorktown Heights, NY 10598, USA