Debian Codegraph @

upstream/opensuse-tumbleweed/man1/uustat.1

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