| blob | 84a5694ffe379dfd531a4a57c430a6f35e2c9066 |
1 '\" te
2 .\" Copyright 1989 AT&T Copyright (c) 1995, Sun Microsystems, Inc. All Rights Reserved Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\" This notice shall appear on any product containing this material.
7 .\" 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.
8 .\" 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.
9 .\" 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]
10 .TH UUSTAT 1C "Mar 28, 1995"
11 .SH NAME
12 uustat \- uucp status inquiry and job control
13 .SH SYNOPSIS
14 .LP
15 .nf
16 \fBuustat\fR
17 [ [\fB-m\fR] | [\fB-p\fR] | [\fB-q\fR] | [\fB-k\fR \fIjobid\fR [\fB-n\fR]] | [\fB-r\fR \fIjobid\fR [\fB-n\fR]]]
18 .fi
20 .LP
21 .nf
22 \fBuustat\fR [\fB-a\fR] [\fB-s\fR \fIsystem\fR [\fB-j\fR]] [\fB-u\fR \fIuser\fR] [\fB-S\fR \fIqric\fR]
23 .fi
25 .LP
26 .nf
27 \fBuustat\fR \fB-t\fR \fIsystem\fR [\fB-c\fR] [\fB-d\fR \fInumber\fR]
28 .fi
30 .SH DESCRIPTION
31 .sp
32 .LP
33 The \fBuustat\fR utility functions in the following three areas:
34 .RS +4
35 .TP
36 1.
37 Displays the general status of, or cancels, previously specified \fBuucp\fR
38 commands.
39 .RE
40 .RS +4
41 .TP
42 2.
43 Provides remote system performance information, in terms of average transfer
44 rates or average queue times.
45 .RE
46 .RS +4
47 .TP
48 3.
49 Provides general remote system-specific and user-specific status of
50 \fBuucp\fR connections to other systems.
51 .RE
52 .SH OPTIONS
53 .sp
54 .LP
55 The following options are supported:
56 .SS "General Status"
57 .sp
58 .LP
59 These options obtain general status of, or cancel, previously specified
60 \fBuucp\fR commands:
61 .sp
62 .ne 2
63 .na
64 \fB\fB-a\fR\fR
65 .ad
66 .RS 11n
67 Lists all jobs in queue.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fB-j\fR\fR
74 .ad
75 .RS 11n
76 Lists the total number of jobs displayed. The \fB-j\fR option can be used in
77 conjunction with the \fB-a\fR or the \fB-s\fR option.
78 .RE
80 .sp
81 .ne 2
82 .na
83 \fB\fB-k\fR\fIjobid\fR\fR
84 .ad
85 .RS 11n
86 Kills the \fBuucp\fR request whose job identification is \fIjobid\fR. The
87 killed \fBuucp\fR request must belong to the user issuing the \fBuustat\fR
88 command unless the user is the super-user or uucp administrator. If the job is
89 killed by the super-user or uucp administrator, electronic mail is sent to the
90 user.
91 .RE
93 .sp
94 .ne 2
95 .na
96 \fB\fB-m\fR\fR
97 .ad
98 .RS 11n
99 Reports the status of accessibility of all machines.
100 .RE
102 .sp
103 .ne 2
104 .na
105 \fB\fB-n\fR\fR
106 .ad
107 .RS 11n
108 Suppresses all standard output, but not standard error. The \fB-n\fR option is
109 used in conjunction with the \fB-k\fR and \fB-r\fR options.
110 .RE
112 .sp
113 .ne 2
114 .na
115 \fB\fB-p\fR\fR
116 .ad
117 .RS 11n
118 Executes the command \fBps\fR \fB-flp\fR for all the process-ids that are in
119 the lock files.
120 .RE
122 .sp
123 .ne 2
124 .na
125 \fB\fB-q\fR\fR
126 .ad
127 .RS 11n
128 Lists the jobs queued for each machine. If a status file exists for the
129 machine, its date, time and status information are reported. In addition, if a
130 number appears in parentheses next to the number of \fBC\fR or \fBX\fR files,
131 it is the age in days of the oldest \fBC.\fR/\fBX.\fR file for that system. The
132 \fBRetry\fR field represents the number of hours until the next possible call.
133 The \fBCount\fR is the number of failure attempts. \fBNote:\fR For systems with
134 a moderate number of outstanding jobs, this could take 30 seconds or more of
135 real-time to execute. An example of the output produced by the \fB-q\fR option
136 is:
137 .sp
138 .in +2
139 .nf
140 eagle 3C 04/07-11:07 NO DEVICES AVAILABLE
141 mh3bs3 2C 07/07-10:42 SUCCESSFUL
142 .fi
143 .in -2
144 .sp
146 This indicates the number of command files that are waiting for each system.
147 Each command file may have zero or more files to be sent (zero means to call
148 the system and see if work is to be done). The date and time refer to the
149 previous interaction with the system followed by the status of the interaction.
150 .RE
152 .sp
153 .ne 2
154 .na
155 \fB\fB-r\fR\fIjobid\fR\fR
156 .ad
157 .RS 11n
158 Rejuvenates \fIjobid\fR. The files associated with \fIjobid\fR are touched so
159 that their modification time is set to the current time. This prevents the
160 cleanup daemon from deleting the job until the jobs' modification time reaches
161 the limit imposed by the daemon.
162 .RE
164 .SS "Remote System Status"
165 .sp
166 .LP
167 These options provide remote system performance information, in terms of
168 average transfer rates or average queue times. The \fB-c\fR and \fB-d\fR
169 options can only be used in conjunction with the \fB-t\fR option:
170 .sp
171 .ne 2
172 .na
173 \fB\fB-t\fR\fIsystem\fR\fR
174 .ad
175 .RS 12n
176 Reports the average transfer rate or average queue time for the past 60 minutes
177 for the remote \fIsystem\fR. The following parameters can only be used with
178 this option:
179 .RE
181 .sp
182 .ne 2
183 .na
184 \fB\fB-c\fR\fR
185 .ad
186 .RS 12n
187 Average queue time is calculated when the \fB-c\fR parameter is specified and
188 average transfer rate when \fB-c\fR is not specified. For example, the command:
189 .sp
190 .in +2
191 .nf
192 example% \fBuustat -teagle -d50 -c\fR
193 .fi
194 .in -2
195 .sp
197 produces output in the following format:
198 .sp
199 .in +2
200 .nf
201 average queue time to eagle for last 50 minutes:
202 5 seconds
203 .fi
204 .in -2
205 .sp
207 The same command without the \fB-c\fR parameter produces output in the
208 following format:
209 .sp
210 .in +2
211 .nf
212 average transfer rate with eagle for last 50 minutes:
213 2000.88 bytes/sec
214 .fi
215 .in -2
216 .sp
218 .RE
220 .sp
221 .ne 2
222 .na
223 \fB\fB-d\fR\fInumber\fR\fR
224 .ad
225 .RS 12n
226 \fInumber\fR is specified in minutes. Used to override the 60 minute default
227 used for calculations. These calculations are based on information contained in
228 the optional performance log and therefore may not be available. Calculations
229 can only be made from the time that the performance log was last cleaned up.
230 .RE
232 .SS "User- or System-Specific Status"
233 .sp
234 .LP
235 These options provide general remote system-specific and user-specific status
236 of \fBuucp\fR connections to other systems. Either or both of the following
237 options can be specified with \fBuustat\fR. The \fB-j\fR option can be used in
238 conjunction with the \fB-s\fR option to list the total number of jobs
239 displayed:
240 .sp
241 .ne 2
242 .na
243 \fB\fB-s\fR\fIsystem\fR\fR
244 .ad
245 .RS 12n
246 Reports the status of all \fBuucp\fR requests for remote system \fIsystem.\fR
247 .RE
249 .sp
250 .ne 2
251 .na
252 \fB\fB-u\fR\fIuser\fR\fR
253 .ad
254 .RS 12n
255 Reports the status of all \fBuucp\fR requests issued by \fIuser\fR.
256 .RE
258 .sp
259 .LP
260 Output for both the \fB-s\fR and \fB-u\fR options has the following format:
261 .sp
262 .in +2
263 .nf
264 eagleN1bd7 4/07-11:07 S eagle dan 522 /home/dan/A
265 eagleC1bd8 4/07-11:07 S eagle dan 59 D.3b2al2ce4924
266 4/07-11:07 S eagle dan rmail mike
267 .fi
268 .in -2
269 .sp
271 .sp
272 .LP
273 With the above two options, the first field is the \fIjobid\fR of the job. This
274 is followed by the date/time. The next field is an \fBS\fR if the job is
275 sending a file or an \fBR\fR if the job is requesting a file. The next field is
276 the machine where the file is to be transferred. This is followed by the
277 user-id of the user who queued the job. The next field contains the size of the
278 file, or in the case of a remote execution (\fBrmail\fR is the command used for
279 remote mail), the name of the command. When the size appears in this field, the
280 file name is also given. This can either be the name given by the user or an
281 internal name (for example, \fBD.3b2alce4924\fR) that is created for data files
282 associated with remote executions (\fBrmail\fR in this example).
283 .sp
284 .ne 2
285 .na
286 \fB\fB-S\fR\fIqric\fR\fR
287 .ad
288 .RS 10n
289 Reports the job state:
290 .sp
291 .ne 2
292 .na
293 \fB\fBq\fR\fR
294 .ad
295 .RS 5n
296 for queued jobs
297 .RE
299 .sp
300 .ne 2
301 .na
302 \fB\fBr\fR\fR
303 .ad
304 .RS 5n
305 for running jobs
306 .RE
308 .sp
309 .ne 2
310 .na
311 \fB\fBi\fR\fR
312 .ad
313 .RS 5n
314 for interrupted jobs
315 .RE
317 .sp
318 .ne 2
319 .na
320 \fB\fBc\fR\fR
321 .ad
322 .RS 5n
323 for completed jobs
324 .RE
326 A job is queued if the transfer has not started. A job is running when the
327 transfer has begun. A job is interrupted if the transfer began but was
328 terminated before the file was completely transferred. A completed job is a
329 job that successfully transferred. The completed state information is
330 maintained in the accounting log, which is optional and therefore may be
331 unavailable. The parameters can be used in any combination, but at least one
332 parameter must be specified. The \fB-S\fR option can also be used with \fB-s\fR
333 and \fB-u\fR options. The output for this option is exactly like the output for
334 \fB-s\fR and \fB-u\fR except that the job states are appended as the last
335 output word. Output for a completed job has the following format:
336 .sp
337 .in +2
338 .nf
339 eagleC1bd3 completed
340 .fi
341 .in -2
342 .sp
344 .RE
346 .sp
347 .LP
348 When no options are given, \fBuustat\fR writes to standard output the status of
349 all \fBuucp\fR requests issued by the current user.
350 .SH ENVIRONMENT VARIABLES
351 .sp
352 .LP
353 See \fBenviron\fR(5) for descriptions of the following environment variables
354 that affect the execution of \fBuustat\fR: \fBLANG\fR, \fBLC_ALL\fR,
355 \fBLC_COLLATE\fR\fBLC_CTYPE\fR, \fBLC_MESSAGES\fR, \fBLC_TIME\fR,
356 \fBNLSPATH\fR, and \fBTZ\fR.
357 .SH EXIT STATUS
358 .sp
359 .LP
360 The following exit values are returned:
361 .sp
362 .ne 2
363 .na
364 \fB\fB0\fR\fR
365 .ad
366 .RS 6n
367 Successful completion.
368 .RE
370 .sp
371 .ne 2
372 .na
373 \fB\fB>0\fR\fR
374 .ad
375 .RS 6n
376 An error occurred.
377 .RE
379 .SH FILES
380 .sp
381 .ne 2
382 .na
383 \fB\fB/var/spool/uucp/\fR*\fR
384 .ad
385 .RS 28n
386 spool directories
387 .RE
389 .sp
390 .ne 2
391 .na
392 \fB\fB/var/uucp/.Admin/account\fR\fR
393 .ad
394 .RS 28n
395 accounting log
396 .RE
398 .sp
399 .ne 2
400 .na
401 \fB\fB/var/uucp/.Admin/perflog\fR\fR
402 .ad
403 .RS 28n
404 performance log
405 .RE
407 .SH ATTRIBUTES
408 .sp
409 .LP
410 See \fBattributes\fR(5) for descriptions of the following attributes:
411 .sp
413 .sp
414 .TS
415 box;
416 c | c
417 l | l .
418 ATTRIBUTE TYPE ATTRIBUTE VALUE
419 _
420 Interface Stability Standard
421 .TE
423 .SH SEE ALSO
424 .sp
425 .LP
426 \fBuucp\fR(1C), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
427 .SH DIAGNOSTICS
428 .sp
429 .LP
430 The \fB-t\fR option produces no message when the data needed for the
431 calculations is not being recorded.
432 .SH NOTES
433 .sp
434 .LP
435 After the user has issued the \fBuucp\fR request, if the file to be transferred
436 is moved, deleted or was not copied to the spool directory (\fB-C\fR option)
437 when the \fBuucp\fR request was made, \fBuustat\fR reports a file size of
438 \fB\(mi99999\fR\&. This job will eventually fail because the file(s) to be
439 transferred can not be found.