8322 nl: misleading-indentation
[unleashed/tickless.git] / usr / src / man / man1 / sendmail-mailq.1
blobe750117ec6d787bb3ce87c2b7d93c6ff444017f7
1 '\" te
2 .\"  Copyright (c) 2002 Sun Microsystems, Inc.  All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH MAILQ 1 "Jul 10, 2002"
7 .SH NAME
8 mailq \- print the mail queue
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/bin/mailq\fR [\fB-Ac\fR] [\fB-q\fR \fIsubarg\fR] [\fB-v\fR]
13 .fi
15 .SH DESCRIPTION
16 .sp
17 .LP
18 The \fBmailq\fR utility displays a summary of the mail messages queued for
19 future delivery.
20 .sp
21 .LP
22 The first line displayed for each mail message shows the internal identifier
23 used on this host for the message, the size of the message in bytes, the date
24 and time the message was accepted into the queue, and the envelope sender of
25 the message. The second line of the display shows the error message that caused
26 this message to be retained in the queue. This line will not be displayed if
27 the message is being processed for the first time.
28 .sp
29 .LP
30 The \fBmailq\fR utility used to be identical to \fBsendmail\fR \fB-bp\fR. Now
31 it checks for the authorization attribute, \fBsolaris.mail.mailq\fR. If the
32 check for the invoking user succeeds, \fBsendmail\fR \fB-bp\fR is executed with
33 the remaining argument vector. Otherwise, an error message is printed. This
34 authorization attribute is by default enabled for all users. It can be disabled
35 by modifying the Basic Solaris User entry in \fBprof_attr\fR(4).
36 .SH OPTIONS
37 .sp
38 .LP
39 The following options are supported:
40 .sp
41 .ne 2
42 .na
43 \fB\fB-Ac\fR\fR
44 .ad
45 .RS 17n
46 Like \fBsendmail\fR(1M), this flag tells \fBmailq\fR to use \fBsubmit.cf\fR
47 rather than \fBsendmail.cf\fR even  if  the  operation  mode  does  not
48 indicate an initial mail submission. This will result in the client queue
49 \fB/var/spool/clientmqueue\fR being displayed rather than the default server
50 queue \fB/var/spool/mqueue\fR.
51 .RE
53 .sp
54 .ne 2
55 .na
56 \fB\fB-q\fR\fBp\fR[\fItime\fR] \fR
57 .ad
58 .RS 17n
59 Similar to \fB-q\fR\fItime\fR, except that instead of periodically forking a
60 child to process the queue, \fBsendmail\fR forks a single persistent child for
61 each queue that alternates between processing the queue and sleeping. The sleep
62 time is given as the argument. The sleep time default is \fB1\fR second. The
63 process will always sleep at least 5 seconds if the queue was empty in the
64 previous queue run.
65 .RE
67 .sp
68 .ne 2
69 .na
70 \fB\fB-q\fR\fBf\fR\fR
71 .ad
72 .RS 17n
73 Processes saved  messages in the queue once and does not \fBfork()\fR, but runs
74 in the foreground.
75 .RE
77 .sp
78 .ne 2
79 .na
80 \fB\fB-q\fR\fBG\fR \fIname\fR\fR
81 .ad
82 .RS 17n
83 Processes jobs in the queue group called \fIname\fR only.
84 .RE
86 .sp
87 .ne 2
88 .na
89 \fB\fB-q\fR[\fB!\fR]\fBI\fR \fIsubstr\fR\fR
90 .ad
91 .RS 17n
92 Limits processed jobs to those containing \fIsubstr\fR as a substring of the
93 queue id, or not when \fB!\fR is specified.
94 .RE
96 .sp
97 .ne 2
98 .na
99 \fB\fB-q\fR[\fB!\fR]\fBR\fR \fIsubstr\fR\fR
101 .RS 17n
102 Limits processed jobs to those containing \fIsubstr\fR as a substring of one of
103 the recipients, or not when \fB!\fR is specified.
107 .ne 2
109 \fB\fB-q\fR[\fB!\fR]\fBS\fR \fIsubstr\fR\fR
111 .RS 17n
112 Limits processed jobs to those containing \fIsubstr\fR as a substring of the
113 sender, or not when \fB!\fR is specified.
117 .ne 2
119 \fB\fB-v\fR \fR
121 .RS 17n
122 Prints verbose information. This adds the priority of the message and a single
123 character indicator (\fB+\fR or blank) indicating  whether a warning message
124 has been sent on the first line of the message. Additionally, extra lines may
125 be intermixed with the recipients that indicate the "controlling user"
126 information. This shows who will own any programs that are executed on behalf
127 of this message and the name of the alias this command is expanded from, if
128 any.
131 .SH EXIT STATUS
133 .ne 2
135 \fB\fB0\fR \fR
137 .RS 7n
138 Successful completion.
142 .ne 2
144 \fB\fB>0\fR \fR
146 .RS 7n
147 An error occurred.
150 .SH FILES
152 .ne 2
154 \fB\fB/etc/security/prof_attr\fR\fR
156 .RS 27n
157 local source for execution profile attributes
161 .ne 2
163 \fB\fB/var/spool/mqueue\fR\fR
165 .RS 27n
166 default server queue
170 .ne 2
172 \fB\fB/var/spool/clientmqueue\fR\fR
174 .RS 27n
175 client queue
178 .SH SEE ALSO
181 \fBsendmail\fR(1M), \fBprof_attr\fR(4), \fBattributes\fR(5)