OSDN Git Service

Import translated manuals from JM CVS Repository.
[linuxjm/jm.git] / manual / GNU_uucp / original / man1 / uustat.1
1 ''' $Id: uustat.1,v 1.12 1995/06/26 20:34:30 ian Rel $
2 .TH uustat 1 "Taylor UUCP 1.06"
3 .SH NAME
4 uustat \- UUCP status inquiry and control
5 .SH SYNOPSIS
6 .B uustat \-a
7 .PP
8 .B uustat \-\-all
9 .PP
10 .B uustat
11 [
12 .B \-eKRiMNQ ] [
13 .B \-sS
14 system ] [
15 .B \-uU
16 user ] [
17 .B \-cC
18 command ] [
19 .B \-oy
20 hours ] [
21 .B \-B
22 lines ] [
23 .B \-\-executions
24 ] [
25 .B \-\-kill-all
26 ] [
27 .B \-\-rejuvenate-all
28 ] [
29 .B \-\-prompt
30 ] [
31 .B \-\-mail
32 ] [
33 .B \-\-notify
34 ] [
35 .B \-\-no-list
36 ] [
37 .B \-\-system
38 system ] [
39 .B \-\-not-system
40 system ] [
41 .B \-\-user
42 user ] [
43 .B \-\-not-user
44 user ] [
45 .B \-\-command
46 command ] [
47 .B \-\-not-command
48 command ] [
49 .B \-\-older-than
50 hours ] [
51 .B \-\-younger-than
52 hours ] [
53 .B \-\-mail-lines
54 lines ]
55 .PP
56 .B uustat
57 [
58 .B \-kr
59 jobid ] [
60 .B \-\-kill
61 jobid ] [
62 .B \-\-rejuvenate
63 jobid ]
64 .PP
65 .B uustat \-q [
66 .B \-sS
67 system ] [
68 .B \-oy
69 hours ] [
70 .B \-\-system
71 system ] [
72 .B \-\-not-system
73 system ] [
74 .B \-\-older-than
75 hours ] [
76 .B \-\-younger-than
77 hours ]
78 .PP
79 .B uustat \-\-list [
80 .B \-sS
81 system ] [
82 .B \-oy
83 hours ] [
84 .B \-\-system
85 system ] [
86 .B \-\-not-system
87 system ] [
88 .B \-\-older-than
89 hours ] [
90 .B \-\-younger-than
91 hours ]
92 .PP
93 .B uustat \-m
94 .PP
95 .B uustat \-\-status
96 .PP
97 .B uustat \-p
98 .PP
99 .B uustat \-\-ps
100 .SH DESCRIPTION
101 The
102 .I uustat
103 command can display various types of status information about the UUCP
104 system.  It can also be used to cancel or rejuvenate requests made by
105 .I uucp
106 (1) or
107 .I uux
108 (1).
109
110 By default
111 .I uustat
112 displays all jobs queued up for the invoking user, as if given the
113 .B \-\-user
114 option with the appropriate argument.
115
116 If any of the
117 .B \-a,
118 .B \-\-all,
119 .B \-e,
120 .B \-\-executions,
121 .B \-s,
122 .B \-\-system,
123 .B \-S,
124 .B \-\-not-system,
125 .B \-u,
126 .B \-\-user,
127 .B \-U,
128 .B \-\-not-user,
129 .B \-c,
130 .B \-\-command,
131 .B \-C,
132 .B \-\-not-command,
133 .B \-o,
134 .B \-\-older-than,
135 .B \-y,
136 .B \-\-younger-than
137 options are given, then all jobs which match the combined
138 specifications are displayed.
139
140 The 
141 .B \-K
142 or
143 .B \-\-kill-all
144 option may be used to kill off a selected group of jobs, such as all
145 jobs more than 7 days old.
146 .SH OPTIONS
147 The following options may be given to
148 .I uustat.
149 .TP 5
150 .B \-a, \-\-all
151 List all queued file transfer requests.
152 .TP 5
153 .B \-e, \-\-executions
154 List queued execution requests rather than queued file transfer
155 requests.  Queued execution requests are processed by
156 .I uuxqt
157 (8) rather than
158 .I uucico
159 (8).  Queued execution requests may be waiting for some file to be
160 transferred from a remote system.  They are created by an invocation
161 of
162 .I uux
163 (1).
164 .TP 5
165 .B \-s system, \-\-system system
166 List all jobs queued up for the named system.  These options may be
167 specified multiple times, in which case all jobs for all the systems
168 will be listed.  If used with
169 .B \-\-list
170 only the systems named will be listed.
171 .TP 5
172 .B \-S system, \-\-not-system system
173 List all jobs queued for systems other than the one named.  These
174 options may be specified multiple times, in which case no jobs from
175 any of the specified systems will be listed.  If used with
176 .B \-\-list
177 only the systems not named will be listed.  These options may not be
178 used with
179 .B \-s
180 or
181 .B \-\-system.
182 .TP 5
183 .B \-u user, \-\-user user
184 List all jobs queued up for the named user.  These options may be
185 specified multiple times, in which case all jobs for all the users
186 will be listed.
187 .TP 5
188 .B \-U user, \-\-not-user user
189 List all jobs queued up for users other than the one named.  These
190 options may be specified multiple times, in which case no jobs from
191 any of the specified users will be listed.  These options may not be
192 used with
193 .B \-u
194 or
195 .B \-\-user.
196 .TP 5
197 .B \-c command, \-\-command command
198 List all jobs requesting the execution of the named command.  If
199 .B command
200 is
201 .I ALL
202 this will list all jobs requesting the execution of some command (as
203 opposed to simply requesting a file transfer).  These options may be
204 specified multiple times, in which case all jobs requesting any of the
205 commands will be listed.
206 .TP 5
207 .B \-C command, \-\-not-command command
208 List all jobs requesting execution of some command other than the
209 named command, or, if
210 .B command
211 is
212 .I ALL,
213 list all jobs that simply request a file transfer (as opposed to
214 requesting the execution of some command).  These options may be
215 specified multiple times, in which case no job requesting one of the
216 specified commands will be listed.  These options may not be used with
217 .B \-c
218 or
219 .B \-\-command.
220 .TP 5
221 .B \-o hours, \-\-older-than hours
222 List all queued jobs older than the given number of hours.  If used
223 with
224 .B \-\-list
225 only systems whose oldest job is older than the given number of hours
226 will be listed.
227 .TP 5
228 .B \-y hours, \-\-younger-than hours
229 List all queued jobs younger than the given number of hours.  If used
230 with
231 .B \-\-list
232 only systems whose oldest job is younger than the given number of
233 hours will be listed.
234 .TP 5
235 .B \-k jobid, \-\-kill jobid
236 Kill the named job.  The job id is shown by the default output format,
237 as well as by the
238 .B \-j
239 or
240 .B \-\-jobid
241 option to
242 .I uucp
243 (1) or
244 .I uux
245 (1).  A job may only be killed by the user who created the job, or by
246 the UUCP administrator or the superuser.  The
247 .B \-k
248 or
249 .B \-\-kill
250 options may be used multiple times on the command line to kill several
251 jobs.
252 .TP 5
253 .B \-r jobid, \-\-rejuvenate jobid
254 Rejuvenate the named job.  This will mark it as having been invoked at
255 the current time, affecting the output of the
256 .B \-o,
257 .B \-\-older-than,
258 .B \-y,
259 or
260 .B \-\-younger-than
261 options and preserving it from any automated cleanup daemon.  The job
262 id is shown by the default output format, as well as by the
263 .B \-j
264 or
265 .B \-\-jobid
266 options to
267 .I uucp
268 (1) or
269 .I uux
270 (1).  A job may only be rejuvenated by the user who created the job,
271 or by the UUCP administrator or the superuser.  The
272 .B \-r
273 or
274 .B \-\-rejuvenate
275 options may be used multiple times on the command line to rejuvenate
276 several jobs.
277 .TP 5
278 .B \-q, \-\-list
279 Display the status of commands, executions and conversations for all
280 remote systems for which commands or executions are queued.  The
281 .B \-s,
282 .B \-\-system,
283 .B \-S,
284 .B \-\-not-system,
285 .B \-o,
286 .B \-\-older-than,
287 .B \-y,
288 and
289 .B \-\-younger-than
290 options may be used to restrict the systems which are listed.  Systems
291 for which no commands or executions are queued will never be listed.
292 .TP 5
293 .B \-m, \-\-status
294 Display the status of conversations for all remote systems.
295 .TP 5
296 .B \-p, \-\-ps
297 Display the status of all processes holding UUCP locks on systems or
298 ports.
299 .TP 5
300 .B \-i, \-\-prompt
301 For each listed job, prompt whether to kill the job or not.  If the
302 first character of the input line is
303 .I y
304 or
305 .I Y
306 the job will be killed.
307 .TP 5
308 .B \-K, \-\-kill-all
309 Automatically kill each listed job.  This can be useful for automatic
310 cleanup scripts, in conjunction with the
311 .B \-\-mail
312 and
313 .B \-\-notify
314 options.
315 .TP 5
316 .B \-R, \-\-rejuvenate-all
317 Automatically rejuvenate each listed job.  This may not be used with
318 .B \-\-kill-all.
319 .TP 5
320 .B \-M, \-\-mail
321 For each listed job, send mail to the UUCP administrator.  If the job
322 is killed (due to
323 .B \-\-kill-all
324 or
325 .B \-\-prompt
326 with an affirmative response) the mail will indicate that.  A comment
327 specified by the
328 .B \-\-comment
329 option may be included.  If the job is an execution, the initial
330 portion of its standard input will be included in the mail message;
331 the number of lines to include may be set with the
332 .B \-\-mail-lines
333 option (the default is 100).  If the standard input contains null
334 characters, it is assumed to be a binary file and is not included.
335 .TP 5
336 .B \-N, \-\-notify
337 For each listed job, send mail to the user who requested the job.  The
338 mail is identical to that sent by the
339 .B \-M
340 or
341 .B \-\-mail
342 options.
343 .TP 5
344 .B \-W comment, \-\-comment comment
345 Specify a comment to be included in mail sent with the
346 .B \-M,
347 .B \-\-mail,
348 .B \-N,
349 or
350 .B \-\-notify
351 options.
352 .TP 5
353 .B \-B lines, \-\-mail-lines lines
354 When the
355 .B \-M,
356 .B \-\-mail,
357 .B \-N,
358 or
359 .B \-\-notify
360 options are used to send mail about an execution with standard input,
361 this option controls the number of lines of standard input to include
362 in the message.  The default is 100.
363 .TP 5
364 .B \-Q, \-\-no-list
365 Do not actually list the job, but only take any actions indicated by
366 the
367 .B \-i,
368 .B \-\-prompt,
369 .B \-K,
370 .B \-\-kill-all,
371 .B \-M,
372 .B \-\-mail,
373 .B \-N
374 or
375 .B \-\-notify
376 options.
377 .TP 5
378 .B \-x type, \-\-debug type
379 Turn on particular debugging types.  The following types are
380 recognized: abnormal, chat, handshake, uucp-proto, proto, port,
381 config, spooldir, execute, incoming, outgoing.  Only abnormal, config,
382 spooldir and execute are meaningful for
383 .I uustat.
384
385 Multiple types may be given, separated by commas, and the
386 .B \-\-debug
387 option may appear multiple times.  A number may also be given, which
388 will turn on that many types from the foregoing list; for example,
389 .B \-\-debug 2
390 is equivalent to
391 .B \-\-debug abnormal,chat.
392 .TP 5
393 .B \-I file, \-\-config file
394 Set configuration file to use.  This option may not be available,
395 depending upon how
396 .I uustat
397 was compiled.
398 .TP 5
399 .B \-v, \-\-version
400 Report version information and exit.
401 .TP 5
402 .B \-\-help
403 Print a help message and exit.
404 .SH EXAMPLES
405 .br
406 .nf
407 uustat --all
408 .fi
409 Display status of all jobs.  A sample output line is as follows:
410 .br
411 .in +0.5i
412 .nf
413 bugsA027h bugs ian 04-01 13:50 Executing rmail ian@airs.com (sending 1283 bytes)
414 .fi
415 .in -0.5i
416 The format is
417 .br
418 .in +0.5i
419 .nf
420 jobid system user queue-date command (size)
421 .fi
422 .in -0.5i
423 The jobid may be passed to the
424 .B \-\-kill
425 or
426 .B \-\-rejuvenate
427 options.
428 The size indicates how much data is to be transferred to the remote
429 system, and is absent for a file receive request.
430 The
431 .B \-\-system,
432 .B \-\-not-system,
433 .B \-\-user,
434 .B \-\-not-user,
435 .B \-\-command,
436 .B \-\-not-command,
437 .B \-\-older-than,
438 and
439 .B \-\-younger-than
440 options may be used to control which jobs are listed.
441
442 .br
443 .nf
444 uustat --executions
445 .fi
446 Display status of queued up execution requests.  A sample output line
447 is as follows:
448 .br
449 .in +0.5i
450 .nf
451 bugs bugs!ian 05-20 12:51 rmail ian
452 .fi
453 .in -0.5i
454 The format is
455 .br
456 .in +0.5i
457 .nf
458 system requestor queue-date command
459 .fi
460 .in -0.5i
461 The
462 .B \-\-system,
463 .B \-\-not-system,
464 .B \-\-user,
465 .B \-\-not-user,
466 .B \-\-command,
467 .B \-\-not-command,
468 .B \-\-older-than,
469 and
470 .B \-\-younger-than
471 options may be used to control which requests are listed.
472
473 .br
474 .nf
475 uustat --list
476 .fi
477 Display status for all systems with queued up commands.  A sample
478 output line is as follows:
479 .br
480 .in +0.5i
481 .nf
482 bugs            4C (1 hour)   0X (0 secs) 04-01 14:45 Dial failed
483 .fi
484 .in -0.5i
485 This indicates the system, the number of queued commands, the age of
486 the oldest queued command, the number of queued local executions, the
487 age of the oldest queued execution, the date of the last conversation,
488 and the status of that conversation.
489
490 .br
491 .nf
492 uustat --status
493 .fi
494 Display conversation status for all remote systems.  A sample output
495 line is as follows:
496 .br
497 .in +0.5i
498 .nf
499 bugs           04-01 15:51 Conversation complete
500 .fi
501 .in -0.5i
502 This indicates the system, the date of the last conversation, and the
503 status of that conversation.  If the last conversation failed,
504 .I uustat
505 will indicate how many attempts have been made to call the system.  If
506 the retry period is currently preventing calls to that system,
507 .I uustat
508 also displays the time when the next call will be permitted.
509
510 .br
511 .nf
512 uustat --ps
513 .fi
514 Display the status of all processes holding UUCP locks.  The output
515 format is system dependent, as
516 .I uustat
517 simply invokes
518 .I ps
519 (1) on each process holding a lock.
520
521 .br
522 .in +0.5i
523 .nf
524 uustat --command rmail --older-than 168 --kill-all --no-list --mail --notify --comment "Queued for over 1 week"
525 .fi
526 .in -0.5i
527 This will kill all
528 .I rmail
529 commands that have been queued up waiting for delivery for over 1 week
530 (168 hours).  For each such command, mail will be sent both to the
531 UUCP administrator and to the user who requested the rmail execution.
532 The mail message sent will include the string given by the
533 .B \-\-comment
534 option.  The
535 .B \-\-no-list
536 option prevents any of the jobs from being listed on the terminal, so
537 any output from the program will be error messages.
538 .SH FILES
539 The file names may be changed at compilation time or by the
540 configuration file, so these are only approximations.
541
542 .br
543 /usr/lib/uucp/config - Configuration file.
544 .br
545 /usr/spool/uucp -
546 UUCP spool directory.
547 .SH SEE ALSO
548 ps(1), rmail(1), uucp(1), uux(1), uucico(8), uuxqt(8)
549 .SH AUTHOR
550 Ian Lance Taylor
551 (ian@airs.com)