White space
[dragonfly.git] / contrib / sendmail-8.14 / sendmail / mailq.1
blob62f123c7ddfcfc7f94b6100349a2f3f3838e4b71
1 .\" Copyright (c) 1998-2000, 2002, 2007 Sendmail, Inc. and its suppliers.
2 .\"      All rights reserved.
3 .\" Copyright (c) 1983, 1997 Eric P. Allman.  All rights reserved.
4 .\" Copyright (c) 1985, 1990, 1993
5 .\"     The Regents of the University of California.  All rights reserved.
6 .\"
7 .\" By using this file, you agree to the terms and conditions set
8 .\" forth in the LICENSE file which can be found at the top level of
9 .\" the sendmail distribution.
10 .\"
11 .\"
12 .\"     $Id: mailq.1,v 8.21 2007/03/22 18:21:27 ca Exp $
13 .\"
14 .TH MAILQ 1 "$Date: 2007/03/22 18:21:27 $"
15 .SH NAME
16 mailq
17 \- print the mail queue
18 .SH SYNOPSIS
19 .B mailq
20 .RB [ \-Ac ]
21 .RB [ \-q... ]
22 .RB [ \-v ]
23 .SH DESCRIPTION
24 .B Mailq
25 prints a summary of the mail messages queued for future delivery.
26 .PP
27 The first line printed for each message 
28 shows the internal identifier used on this host 
29 for the message with a possible status character, 
30 the size of the message in bytes,
31 the date and time the message was accepted into the queue, 
32 and the envelope sender of the message.  
33 The second line shows the error message that caused this message 
34 to be retained in the queue; 
35 it will not be present if the message is being processed 
36 for the first time.  
37 The status characters are either
38 .B *
39 to indicate the job is being processed;
40 .B X
41 to indicate that the load is too high to process the job; and
42 .B -
43 to indicate that the job is too young to process.
44 The following lines show message recipients, 
45 one per line.
46 .PP
47 .B Mailq
48 is identical to ``sendmail -bp''.
49 .PP
50 The relevant options are as follows:
51 .TP
52 .B \-Ac
53 Show the mail submission queue specified in
54 .I /etc/mail/submit.cf
55 instead of the MTA queue specified in
56 .IR /etc/mail/sendmail.cf .
57 .TP
58 .B \-qL
59 Show the "lost" items in the mail queue instead of the normal queue items.
60 .TP
61 .B \-qQ
62 Show the quarantined items in the mail queue instead of the normal queue
63 items.
64 .TP
65 \fB\-q\fR[\fI!\fR]I substr
66 Limit processed jobs to those containing
67 .I substr
68 as a substring of the queue id or not when
69 .I !
70 is specified.
71 .TP
72 \fB\-q\fR[\fI!\fR]Q substr
73 Limit processed jobs to quarantined jobs containing
74 .I substr
75 as a substring of the quarantine reason or not when
76 .I !
77 is specified.
78 .TP
79 \fB\-q\fR[\fI!\fR]R substr
80 Limit processed jobs to those containing
81 .I substr
82 as a substring of one of the recipients or not when
83 .I !
84 is specified.
85 .TP
86 \fB\-q\fR[\fI!\fR]S substr
87 Limit processed jobs to those containing
88 .I substr
89 as a substring of the sender or not when
90 .I !
91 is specified.
92 .TP
93 .B \-v
94 Print verbose information.  
95 This adds the priority of the message and 
96 a single character indicator (``+'' or blank) 
97 indicating whether a warning message has been sent 
98 on the first line of the message.
99 Additionally, extra lines may be intermixed with the recipients
100 indicating the ``controlling user'' information; 
101 this shows who will own any programs that are executed 
102 on behalf of this message 
103 and the name of the alias this command expanded from, if any.
104 Moreover, status messages for each recipient are printed
105 if available.
107 Several sendmail.cf options influence the behavior of the
108 .B mailq
109 utility:
110 The number of items printed per queue group is restricted by
111 .B MaxQueueRunSize
112 if that value is set.
113 The status character
114 .B *
115 is not printed for some values of
116 .B QueueSortOrder,
117 e.g.,
118 filename,
119 random,
120 modification, and
121 none,
122 unless a
123 .B -q
124 option is used to limit the processed jobs.
127 .B mailq
128 utility exits 0 on success, and >0 if an error occurs.
129 .SH SEE ALSO
130 sendmail(8)
131 .SH HISTORY
133 .B mailq
134 command appeared in 
135 4.0BSD.