From 87e14d567e860748eabbfc7055112112d5bf4aa4 Mon Sep 17 00:00:00 2001 From: Sam Hartman Date: Sun, 22 Oct 2006 00:56:34 +0000 Subject: [PATCH] Apply upstream fix for butc crashing --- debian/changelog | 6 + doc/man-pages/man1/afs.1 | 674 ++++++++--------- doc/man-pages/man1/afsmonitor.1 | 542 ++++++------- doc/man-pages/man1/aklog.1 | 431 +++++------ doc/man-pages/man1/cmdebug.1 | 321 +++----- doc/man-pages/man1/dlog.1 | 420 ++++------- doc/man-pages/man1/dpass.1 | 322 ++++---- doc/man-pages/man1/fs.1 | 471 +++++------- doc/man-pages/man1/fs_apropos.1 | 284 +++---- doc/man-pages/man1/fs_checkservers.1 | 366 ++++----- doc/man-pages/man1/fs_checkvolumes.1 | 271 +++---- doc/man-pages/man1/fs_cleanacl.1 | 306 +++----- doc/man-pages/man1/fs_copyacl.1 | 366 ++++----- doc/man-pages/man1/fs_diskfree.1 | 328 +++----- doc/man-pages/man1/fs_examine.1 | 330 +++----- doc/man-pages/man1/fs_exportafs.1 | 419 +++++------ doc/man-pages/man1/fs_flush.1 | 297 +++----- doc/man-pages/man1/fs_flushmount.1 | 289 +++---- doc/man-pages/man1/fs_flushvolume.1 | 291 +++---- doc/man-pages/man1/fs_getcacheparms.1 | 276 +++---- doc/man-pages/man1/fs_getcellstatus.1 | 286 +++---- doc/man-pages/man1/fs_getclientaddrs.1 | 292 +++---- doc/man-pages/man1/fs_getserverprefs.1 | 348 ++++----- doc/man-pages/man1/fs_help.1 | 302 +++----- doc/man-pages/man1/fs_listacl.1 | 406 ++++------ doc/man-pages/man1/fs_listcells.1 | 289 +++---- doc/man-pages/man1/fs_listquota.1 | 329 +++----- doc/man-pages/man1/fs_lsmount.1 | 322 +++----- doc/man-pages/man1/fs_messages.1 | 311 +++----- doc/man-pages/man1/fs_mkmount.1 | 406 ++++------ doc/man-pages/man1/fs_newcell.1 | 343 ++++----- doc/man-pages/man1/fs_quota.1 | 293 +++----- doc/man-pages/man1/fs_rmmount.1 | 285 +++---- doc/man-pages/man1/fs_setacl.1 | 489 +++++------- doc/man-pages/man1/fs_setcachesize.1 | 310 +++----- doc/man-pages/man1/fs_setcell.1 | 312 +++----- doc/man-pages/man1/fs_setclientaddrs.1 | 304 +++----- doc/man-pages/man1/fs_setquota.1 | 300 +++----- doc/man-pages/man1/fs_setserverprefs.1 | 386 ++++------ doc/man-pages/man1/fs_setvol.1 | 317 +++----- doc/man-pages/man1/fs_storebehind.1 | 349 ++++----- doc/man-pages/man1/fs_sysname.1 | 317 +++----- doc/man-pages/man1/fs_whereis.1 | 290 +++---- doc/man-pages/man1/fs_whichcell.1 | 284 +++---- doc/man-pages/man1/fs_wscell.1 | 277 +++---- doc/man-pages/man1/klog.1 | 478 +++++------- doc/man-pages/man1/knfs.1 | 405 ++++------ doc/man-pages/man1/kpasswd.1 | 368 ++++----- doc/man-pages/man1/livesys.1 | 288 +++---- doc/man-pages/man1/package_test.1 | 276 +++---- doc/man-pages/man1/pagsh.1 | 337 ++++----- doc/man-pages/man1/pts.1 | 357 ++++----- doc/man-pages/man1/pts_adduser.1 | 356 ++++----- doc/man-pages/man1/pts_apropos.1 | 286 +++---- doc/man-pages/man1/pts_chown.1 | 329 ++++---- doc/man-pages/man1/pts_creategroup.1 | 407 ++++------ doc/man-pages/man1/pts_createuser.1 | 410 ++++------ doc/man-pages/man1/pts_delete.1 | 325 +++----- doc/man-pages/man1/pts_examine.1 | 459 +++++------ doc/man-pages/man1/pts_help.1 | 304 +++----- doc/man-pages/man1/pts_listentries.1 | 356 ++++----- doc/man-pages/man1/pts_listmax.1 | 316 +++----- doc/man-pages/man1/pts_listowned.1 | 330 +++----- doc/man-pages/man1/pts_membership.1 | 360 ++++----- doc/man-pages/man1/pts_removeuser.1 | 345 ++++----- doc/man-pages/man1/pts_rename.1 | 327 +++----- doc/man-pages/man1/pts_setfields.1 | 464 +++++------- doc/man-pages/man1/pts_setmax.1 | 331 ++++---- doc/man-pages/man1/rxdebug.1 | 475 +++++------- doc/man-pages/man1/rxgen.1 | 877 ++++++++++++---------- doc/man-pages/man1/scout.1 | 460 +++++------- doc/man-pages/man1/sys.1 | 288 +++---- doc/man-pages/man1/tokens.1 | 318 +++----- doc/man-pages/man1/translate_et.1 | 267 +++---- doc/man-pages/man1/udebug.1 | 430 +++++------ doc/man-pages/man1/unlog.1 | 289 +++---- doc/man-pages/man1/up.1 | 330 +++----- doc/man-pages/man1/vos.1 | 455 +++++------ doc/man-pages/man1/vos_addsite.1 | 354 ++++----- doc/man-pages/man1/vos_apropos.1 | 288 +++---- doc/man-pages/man1/vos_backup.1 | 318 +++----- doc/man-pages/man1/vos_backupsys.1 | 460 +++++------- doc/man-pages/man1/vos_changeaddr.1 | 366 ++++----- doc/man-pages/man1/vos_create.1 | 365 ++++----- doc/man-pages/man1/vos_delentry.1 | 417 ++++------ doc/man-pages/man1/vos_dump.1 | 403 ++++------ doc/man-pages/man1/vos_examine.1 | 572 ++++++-------- doc/man-pages/man1/vos_help.1 | 302 +++----- doc/man-pages/man1/vos_listaddrs.1 | 323 +++----- doc/man-pages/man1/vos_listpart.1 | 321 +++----- doc/man-pages/man1/vos_listvldb.1 | 479 +++++------- doc/man-pages/man1/vos_listvol.1 | 510 +++++-------- doc/man-pages/man1/vos_lock.1 | 326 +++----- doc/man-pages/man1/vos_move.1 | 403 ++++------ doc/man-pages/man1/vos_partinfo.1 | 340 ++++----- doc/man-pages/man1/vos_release.1 | 390 ++++------ doc/man-pages/man1/vos_remove.1 | 370 ++++----- doc/man-pages/man1/vos_remsite.1 | 358 ++++----- doc/man-pages/man1/vos_rename.1 | 329 +++----- doc/man-pages/man1/vos_restore.1 | 436 +++++------ doc/man-pages/man1/vos_status.1 | 370 ++++----- doc/man-pages/man1/vos_syncserv.1 | 344 ++++----- doc/man-pages/man1/vos_syncvldb.1 | 367 ++++----- doc/man-pages/man1/vos_unlock.1 | 332 ++++---- doc/man-pages/man1/vos_unlockvldb.1 | 379 ++++------ doc/man-pages/man1/vos_zap.1 | 388 ++++------ doc/man-pages/man1/xstat_cm_test.1 | 333 ++++---- doc/man-pages/man1/xstat_fs_test.1 | 333 ++++---- doc/man-pages/man5/AuthLog.5 | 263 +++---- doc/man-pages/man5/AuthLog.dir.5 | 262 +++---- doc/man-pages/man5/BackupLog.5 | 265 +++---- doc/man-pages/man5/BosConfig.5 | 404 ++++------ doc/man-pages/man5/BosLog.5 | 273 +++---- doc/man-pages/man5/CellServDB.5 | 357 ++++----- doc/man-pages/man5/FORCESALVAGE.5 | 265 +++---- doc/man-pages/man5/FileLog.5 | 269 +++---- doc/man-pages/man5/KeyFile.5 | 287 +++---- doc/man-pages/man5/NetInfo.5 | 285 +++---- doc/man-pages/man5/NetRestrict.5 | 287 +++---- doc/man-pages/man5/NoAuth.5 | 283 +++---- doc/man-pages/man5/SALVAGE.fs.5 | 273 +++---- doc/man-pages/man5/SalvageLog.5 | 265 +++---- doc/man-pages/man5/ThisCell.5 | 297 +++----- doc/man-pages/man5/UserList.5 | 275 +++---- doc/man-pages/man5/VLLog.5 | 287 +++---- doc/man-pages/man5/VolserLog.5 | 265 +++---- doc/man-pages/man5/afs.5 | 475 +++++------- doc/man-pages/man5/afs_cache.5 | 339 ++++----- doc/man-pages/man5/afs_volume_header.5 | 258 +++---- doc/man-pages/man5/afsmonitor.5 | 349 ++++----- doc/man-pages/man5/afszcm.cat.5 | 259 +++---- doc/man-pages/man5/bdb.DB0.5 | 261 +++---- doc/man-pages/man5/butc.5 | 719 ++++++++---------- doc/man-pages/man5/butc_logs.5 | 291 +++---- doc/man-pages/man5/cacheinfo.5 | 288 +++---- doc/man-pages/man5/fms.log.5 | 279 +++---- doc/man-pages/man5/kaserver.DB0.5 | 261 +++---- doc/man-pages/man5/kaserverauxdb.5 | 261 +++---- doc/man-pages/man5/package.5 | 855 +++++++++------------ doc/man-pages/man5/prdb.DB0.5 | 263 +++---- doc/man-pages/man5/salvage.lock.5 | 255 +++---- doc/man-pages/man5/sysid.5 | 276 +++---- doc/man-pages/man5/tapeconfig.5 | 340 ++++----- doc/man-pages/man5/uss.5 | 795 +++++++++----------- doc/man-pages/man5/uss_bulk.5 | 485 +++++------- doc/man-pages/man5/vldb.DB0.5 | 275 +++---- doc/man-pages/man8/afsd.8 | 641 ++++++---------- doc/man-pages/man8/asetkey.8 | 338 ++++----- doc/man-pages/man8/backup.8 | 457 +++++------ doc/man-pages/man8/backup_adddump.8 | 362 ++++----- doc/man-pages/man8/backup_addhost.8 | 329 +++----- doc/man-pages/man8/backup_addvolentry.8 | 408 ++++------ doc/man-pages/man8/backup_addvolset.8 | 322 +++----- doc/man-pages/man8/backup_apropos.8 | 286 +++---- doc/man-pages/man8/backup_dbverify.8 | 338 ++++----- doc/man-pages/man8/backup_deldump.8 | 305 +++----- doc/man-pages/man8/backup_deletedump.8 | 350 ++++----- doc/man-pages/man8/backup_delhost.8 | 316 +++----- doc/man-pages/man8/backup_delvolentry.8 | 321 +++----- doc/man-pages/man8/backup_delvolset.8 | 312 +++----- doc/man-pages/man8/backup_diskrestore.8 | 444 +++++------ doc/man-pages/man8/backup_dump.8 | 519 ++++++------- doc/man-pages/man8/backup_dumpinfo.8 | 536 ++++++------- doc/man-pages/man8/backup_help.8 | 304 +++----- doc/man-pages/man8/backup_interactive.8 | 330 +++----- doc/man-pages/man8/backup_jobs.8 | 410 ++++------ doc/man-pages/man8/backup_kill.8 | 335 +++------ doc/man-pages/man8/backup_labeltape.8 | 408 ++++------ doc/man-pages/man8/backup_listdumps.8 | 299 +++----- doc/man-pages/man8/backup_listhosts.8 | 311 +++----- doc/man-pages/man8/backup_listvolsets.8 | 324 +++----- doc/man-pages/man8/backup_quit.8 | 283 +++---- doc/man-pages/man8/backup_readlabel.8 | 421 +++++------ doc/man-pages/man8/backup_restoredb.8 | 330 ++++---- doc/man-pages/man8/backup_savedb.8 | 362 ++++----- doc/man-pages/man8/backup_scantape.8 | 478 +++++------- doc/man-pages/man8/backup_setexp.8 | 341 ++++----- doc/man-pages/man8/backup_status.8 | 408 ++++------ doc/man-pages/man8/backup_volinfo.8 | 350 ++++----- doc/man-pages/man8/backup_volrestore.8 | 458 +++++------ doc/man-pages/man8/backup_volsetrestore.8 | 486 +++++------- doc/man-pages/man8/bos.8 | 460 +++++------- doc/man-pages/man8/bos_addhost.8 | 356 ++++----- doc/man-pages/man8/bos_addkey.8 | 356 ++++----- doc/man-pages/man8/bos_adduser.8 | 337 ++++----- doc/man-pages/man8/bos_apropos.8 | 286 +++---- doc/man-pages/man8/bos_create.8 | 597 +++++++-------- doc/man-pages/man8/bos_delete.8 | 337 ++++----- doc/man-pages/man8/bos_exec.8 | 319 +++----- doc/man-pages/man8/bos_getdate.8 | 345 ++++----- doc/man-pages/man8/bos_getlog.8 | 371 ++++----- doc/man-pages/man8/bos_getrestart.8 | 365 ++++----- doc/man-pages/man8/bos_help.8 | 302 +++----- doc/man-pages/man8/bos_install.8 | 374 ++++----- doc/man-pages/man8/bos_listhosts.8 | 327 +++----- doc/man-pages/man8/bos_listkeys.8 | 346 ++++----- doc/man-pages/man8/bos_listusers.8 | 323 +++----- doc/man-pages/man8/bos_prune.8 | 377 ++++------ doc/man-pages/man8/bos_removehost.8 | 348 ++++----- doc/man-pages/man8/bos_removekey.8 | 336 ++++----- doc/man-pages/man8/bos_removeuser.8 | 337 ++++----- doc/man-pages/man8/bos_restart.8 | 373 ++++----- doc/man-pages/man8/bos_salvage.8 | 508 +++++-------- doc/man-pages/man8/bos_setauth.8 | 346 ++++----- doc/man-pages/man8/bos_setcellname.8 | 364 ++++----- doc/man-pages/man8/bos_setrestart.8 | 401 ++++------ doc/man-pages/man8/bos_shutdown.8 | 367 ++++----- doc/man-pages/man8/bos_start.8 | 347 ++++----- doc/man-pages/man8/bos_startup.8 | 362 ++++----- doc/man-pages/man8/bos_status.8 | 469 +++++------- doc/man-pages/man8/bos_stop.8 | 350 ++++----- doc/man-pages/man8/bos_uninstall.8 | 356 ++++----- doc/man-pages/man8/bosserver.8 | 349 ++++----- doc/man-pages/man8/buserver.8 | 359 ++++----- doc/man-pages/man8/butc.8 | 410 ++++------ doc/man-pages/man8/fileserver.8 | 558 ++++++-------- doc/man-pages/man8/fms.8 | 315 +++----- doc/man-pages/man8/fstrace.8 | 306 +++----- doc/man-pages/man8/fstrace_apropos.8 | 286 +++---- doc/man-pages/man8/fstrace_clear.8 | 300 +++----- doc/man-pages/man8/fstrace_dump.8 | 405 ++++------ doc/man-pages/man8/fstrace_help.8 | 302 +++----- doc/man-pages/man8/fstrace_lslog.8 | 336 ++++----- doc/man-pages/man8/fstrace_lsset.8 | 302 +++----- doc/man-pages/man8/fstrace_setlog.8 | 306 +++----- doc/man-pages/man8/fstrace_setset.8 | 304 +++----- doc/man-pages/man8/kadb_check.8 | 323 +++----- doc/man-pages/man8/kas.8 | 387 ++++------ doc/man-pages/man8/kas_apropos.8 | 288 +++---- doc/man-pages/man8/kas_create.8 | 351 ++++----- doc/man-pages/man8/kas_delete.8 | 340 ++++----- doc/man-pages/man8/kas_examine.8 | 521 ++++++------- doc/man-pages/man8/kas_forgetticket.8 | 279 +++---- doc/man-pages/man8/kas_help.8 | 306 +++----- doc/man-pages/man8/kas_interactive.8 | 357 ++++----- doc/man-pages/man8/kas_list.8 | 362 ++++----- doc/man-pages/man8/kas_listtickets.8 | 317 +++----- doc/man-pages/man8/kas_noauthentication.8 | 278 +++---- doc/man-pages/man8/kas_quit.8 | 274 +++---- doc/man-pages/man8/kas_setfields.8 | 577 ++++++-------- doc/man-pages/man8/kas_setpassword.8 | 395 ++++------ doc/man-pages/man8/kas_statistics.8 | 359 ++++----- doc/man-pages/man8/kas_stringtokey.8 | 306 +++----- doc/man-pages/man8/kas_unlock.8 | 344 ++++----- doc/man-pages/man8/kaserver.8 | 374 ++++----- doc/man-pages/man8/kdb.8 | 363 ++++----- doc/man-pages/man8/kpwvalid.8 | 288 +++---- doc/man-pages/man8/package.8 | 377 ++++------ doc/man-pages/man8/prdb_check.8 | 312 +++----- doc/man-pages/man8/ptserver.8 | 333 +++----- doc/man-pages/man8/salvager.8 | 482 +++++------- doc/man-pages/man8/upclient.8 | 355 ++++----- doc/man-pages/man8/upserver.8 | 325 +++----- doc/man-pages/man8/uss.8 | 326 +++----- doc/man-pages/man8/uss_add.8 | 508 ++++++------- doc/man-pages/man8/uss_apropos.8 | 286 +++---- doc/man-pages/man8/uss_bulk.8 | 364 ++++----- doc/man-pages/man8/uss_delete.8 | 368 ++++----- doc/man-pages/man8/uss_help.8 | 306 +++----- doc/man-pages/man8/vldb_check.8 | 323 +++----- doc/man-pages/man8/vlserver.8 | 332 ++++---- doc/man-pages/man8/voldump.8 | 316 +++----- doc/man-pages/man8/volinfo.8 | 352 ++++----- doc/man-pages/man8/volserver.8 | 329 ++++---- doc/man-pages/man8/xfs_size_check.8 | 284 +++---- src/util/kreltime.c | 4 +- 266 files changed, 36868 insertions(+), 57887 deletions(-) diff --git a/debian/changelog b/debian/changelog index bbee02824..fcf6770c4 100644 --- a/debian/changelog +++ b/debian/changelog @@ -1,3 +1,9 @@ +openafs (1.4.2-2) unstable; urgency=low + + * Upstream fix to prevent butc segfaulting. + + -- Sam Hartman Sat, 21 Oct 2006 20:57:09 -0400 + openafs (1.4.2-1) unstable; urgency=medium * New upstream release, fixes amd64 kernel issues diff --git a/doc/man-pages/man1/afs.1 b/doc/man-pages/man1/afs.1 index a043c0dd6..65c320adf 100644 --- a/doc/man-pages/man1/afs.1 +++ b/doc/man-pages/man1/afs.1 @@ -1,9 +1,8 @@ -.rn '' }` -''' $RCSfile$$Revision$$Date$ -''' -''' $Log$ -''' -.de Sh +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading .br .if t .Sp .ne 5 @@ -11,150 +10,98 @@ \fB\\$1\fR .PP .. -.de Sp +.de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. -.de Ip -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.de Vb +.de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. -.de Ve +.de Ve \" End verbatim text .ft R - .fi .. -''' -''' -''' Set up \*(-- to give an unbreakable dash; -''' string Tr holds user defined translation string. -''' Bell System Logo is used as a dummy character. -''' -.tr \(*W-|\(bv\*(Tr +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ -.ds -- \(*W- -.ds PI pi -.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -.ds L" "" -.ds R" "" -''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of -''' \*(L" and \*(R", except that they are used on ".xx" lines, -''' such as .IP and .SH, which do another additional levels of -''' double-quote interpretation -.ds M" """ -.ds S" """ -.ds N" """"" -.ds T" """"" -.ds L' ' -.ds R' ' -.ds M' ' -.ds S' ' -.ds N' ' -.ds T' ' +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" 'br\} .el\{\ -.ds -- \(em\| -.tr \*(Tr -.ds L" `` -.ds R" '' -.ds M" `` -.ds S" '' -.ds N" `` -.ds T" '' -.ds L' ` -.ds R' ' -.ds M' ` -.ds S' ' -.ds N' ` -.ds T' ' -.ds PI \(*p +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' 'br\} -.\" If the F register is turned on, we'll generate -.\" index entries out stderr for the following things: -.\" TH Title -.\" SH Header -.\" Sh Subsection -.\" Ip Item -.\" X<> Xref (embedded -.\" Of course, you have to process the output yourself -.\" in some meaninful fashion. -.if \nF \{ -.de IX -.tm Index:\\$1\t\\n%\t"\\$2" +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr % 0 -.rr F +. nr % 0 +. rr F .\} -.TH AFS 1 "OpenAFS" "27/Feb/2006" "AFS Command Reference" -.UC -.if n .hy 0 +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 .if n .na -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' -.de CQ \" put $1 in typewriter font -.ft CW -'if n "\c -'if t \\&\\$1\c -'if n \\&\\$1\c -'if n \&" -\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 -'.ft R -.. -.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 -. \" AM - accent mark definitions -.bd B 3 -. \" fudge factors for nroff and troff +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff .if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP .\} .if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& .\} -. \" simple accents for nroff and troff +. \" simple accents for nroff and troff .if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds ? ? -. ds ! ! -. ds / -. ds q +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / .\} .if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' -. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} -. \" troff and (daisy-wheel) nroff accents +. \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] -.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' -.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' -.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' @@ -162,74 +109,84 @@ .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E -.ds oe o\h'-(\w'o'u*4/10)'e -.ds Oe O\h'-(\w'O'u*4/10)'E -. \" corrections for vroff +. \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) +. \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ -. ds : e -. ds 8 ss -. ds v \h'-1'\o'\(aa\(ga' -. ds _ \h'-1'^ -. ds . \h'-1'. -. ds 3 3 -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -. ds oe oe -. ds Oe OE +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE .\} .rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "AFS 1" +.TH AFS 1 "2006-10-10" "OpenAFS" "AFS Command Reference" .SH "NAME" afs \- Introduction to AFS commands .SH "DESCRIPTION" -AFS provides many commands that enable users and system administrators to +.IX Header "DESCRIPTION" +\&\s-1AFS\s0 provides many commands that enable users and system administrators to use and customize its features. Many of the commands belong to the following categories, called \fIcommand suites\fR. -.Ip "backup" 4 +.IP "backup" 4 +.IX Item "backup" Interface for configuring and operating the \s-1AFS\s0 Backup System. -.Ip "bos" 4 +.IP "bos" 4 +.IX Item "bos" Interface to the Basic Overseer (\s-1BOS\s0) Server for administering server processes and configuration files. -.Ip "fs" 4 +.IP "fs" 4 +.IX Item "fs" Interface for administering access control lists (ACLs), the Cache Manager, and other miscellaneous file system functions. -.Ip "fstrace" 4 +.IP "fstrace" 4 +.IX Item "fstrace" Interface for tracing Cache Manager operations when debugging problems. -.Ip "kas" 4 +.IP "kas" 4 +.IX Item "kas" Interface to the Authentication Server for administering security and authentication information. -.Ip "pts" 4 +.IP "pts" 4 +.IX Item "pts" Interface to the Protection Server for administering \s-1AFS\s0 \s-1ID\s0 and group membership information. -.Ip "uss" 4 +.IP "uss" 4 +.IX Item "uss" Interface for automated administration of user accounts. -.Ip "vos" 4 +.IP "vos" 4 +.IX Item "vos" Interface to the Volume Server and Volume Location (\s-1VL\s0) Server for administering volumes. .PP In addition, there are several commands that do not belong to suites. .Sh "\s-1AFS\s0 Command Syntax" -\s-1AFS\s0 commands that belong to suites have the following structure: +.IX Subsection "AFS Command Syntax" +\&\s-1AFS\s0 commands that belong to suites have the following structure: +.PP +\&\fIcommand_suite\fR \fIoperation_code\fR \fB\-switch\fR <\fIvalue\fR>[+] [\fB\-flag\fR] +.PP +\fICommand Names\fR +.IX Subsection "Command Names" .PP -\fIcommand_suite\fR \fIoperation_code\fR \fB\-switch\fR <\fIvalue\fR>[+] [\fB\-flag\fR] Together, the \fIcommand_suite\fR and \fIoperation_code\fR make up the \fIcommand name\fR. .PP The \fIcommand_suite\fR specifies the group of related commands to which the command belongs, and indicates which command interpreter and server process perform the command. \s-1AFS\s0 has several command suites, including -\fBbos\fR, \fBfs\fR, \fBkas\fR, \fBpackage\fR, \fBpts\fR, \fBuss\fR and \fBvos\fR. Some of +\&\fBbos\fR, \fBfs\fR, \fBkas\fR, \fBpackage\fR, \fBpts\fR, \fBuss\fR and \fBvos\fR. Some of these suites have an interactive mode in which the issuer omits the -\fIoperation_code\fR portion of the command name. +\&\fIoperation_code\fR portion of the command name. .PP The \fIoperation_code\fR tells the command interpreter and server process which action to perform. Most command suites include several operation @@ -240,8 +197,16 @@ in the context of performing administrative tasks. Several \s-1AFS\s0 commands do not belong to a suite and so their names do not have a \fIcommand_suite\fR portion. Their structure is otherwise similar to the commands in the suites. +.PP +\fIOptions\fR +.IX Subsection "Options" +.PP The term \fIoption\fR refers to both arguments and flags, which are described in the following sections. +.PP +\fIArguments\fR +.IX Subsection "Arguments" +.PP One or more arguments can follow the command name. Arguments specify the entities on which to act while performing the command (for example, which server machine, server process, or file). To minimize the potential for @@ -249,29 +214,33 @@ error, provide a command's arguments in the order prescribed in its syntax definition. .PP Each argument has two parts, which appear in the indicated order: -.Ip "\(bu" 4 +.IP "\(bu" 4 The \fIswitch\fR specifies the argument's type and is preceded by a hyphen (\fB\-\fR). For instance, the switch \fB\-server\fR usually indicates that the argument names a server machine. Switches can often be omitted, subject to -the rules outlined in the section on \fIConditions for Omitting Switches\fR. -.Ip "\(bu" 4 +the rules outlined in \*(L"Conditions for Omitting Switches\*(R". +.IP "\(bu" 4 The \fIvalue\fR names a particular entity of the type specified by the preceding switch. For example, the proper value for a \fB\-server\fR switch is -a server machine name like \f(CWfs3.abc.com\fR. Unlike switches (which have a +a server machine name like \f(CW\*(C`fs3.abc.com\*(C'\fR. Unlike switches (which have a required form), values vary depending on what the issuer wants to -accomplish. Values appear surrounded by angle brackets (\f(CW< <\fR >>) in +accomplish. Values appear surrounded by angle brackets (\f(CW\*(C`<>\*(C'\fR) in command descriptions and the online help to show that they are user-supplied variable information. .PP Some arguments accept multiple values, as indicated by trailing plus sign -(\f(CW+\fR) in the command descriptions and online help. How many of a +(\f(CW\*(C`+\*(C'\fR) in the command descriptions and online help. How many of a command's arguments take multiple values, and their ordering with respect to other arguments, determine when it is acceptable to omit switches. See -the section on \fIConditions for Omitting Switches\fR. +\&\*(L"Conditions for Omitting Switches\*(R". .PP Some commands have optional as well as required arguments; the command descriptions and online help show optional arguments in square brackets -(\f(CW[]\fR). +(\f(CW\*(C`[]\*(C'\fR). +.PP +\fIFlags\fR +.IX Subsection "Flags" +.PP Some commands have one or more flags, which specify the manner in which the command interpreter and server process perform the command, or what kind of output it produces. Flags are preceded by hyphens like switches, @@ -280,29 +249,38 @@ generally list a command's flags after its arguments, there is no prescribed order for flags. They can appear anywhere on the command line following the operation code, except in between the parts of an argument. Flags are always optional. +.PP +\fIAn Example Command\fR +.IX Subsection "An Example Command" +.PP The following example illustrates the different parts of a command that belongs to an \s-1AFS\s0 command suite. .PP .Vb 1 -\& % bos getdate -server fs1.abc.com -file ptserver kaserver +\& % bos getdate \-server fs1.abc.com \-file ptserver kaserver .Ve +.PP where -.Ip "\(bu" 4 -\fBbos\fR is the command suite. The \s-1BOS\s0 Server executes most of the commands +.IP "\(bu" 4 +\&\fBbos\fR is the command suite. The \s-1BOS\s0 Server executes most of the commands in this suite. -.Ip "\(bu" 4 -\fBgetdate\fR is the operation code. It tells the \s-1BOS\s0 Server on the specified -server machine (in this case \f(CWfs1.abc.com\fR) to report the modification +.IP "\(bu" 4 +\&\fBgetdate\fR is the operation code. It tells the \s-1BOS\s0 Server on the specified +server machine (in this case \f(CW\*(C`fs1.abc.com\*(C'\fR) to report the modification dates of binary files in the local \fI/usr/afs/bin\fR directory. -.Ip "\(bu" 4 -\f(CW-server fs1.abc.com\fR is one argument, with \fB\-server\fR as the switch and -\f(CWfs1.abc.com\fR as the value. This argument specifies the server machine on +.IP "\(bu" 4 +\&\f(CW\*(C`\-server fs1.abc.com\*(C'\fR is one argument, with \fB\-server\fR as the switch and +\&\f(CW\*(C`fs1.abc.com\*(C'\fR as the value. This argument specifies the server machine on which \s-1BOS\s0 Server is to collect and report binary dates. -.Ip "\(bu" 4 -\f(CW-file ptserver kaserver\fR is an argument that takes multiple values. The -switch is \fB\-file\fR and the values are \f(CWptserver\fR and \f(CWkaserver\fR. This +.IP "\(bu" 4 +\&\f(CW\*(C`\-file ptserver kaserver\*(C'\fR is an argument that takes multiple values. The +switch is \fB\-file\fR and the values are \f(CW\*(C`ptserver\*(C'\fR and \f(CW\*(C`kaserver\*(C'\fR. This argument tells the \s-1BOS\s0 Server to report the modification dates on the files \fI/usr/afs/bin/kaserver\fR and \fI/usr/afs/bin/ptserver\fR. +.PP +\fIRules for Entering \s-1AFS\s0 Commands\fR +.IX Subsection "Rules for Entering AFS Commands" +.PP Enter each \s-1AFS\s0 command on a single line (press only at the end of the command). Some commands in this document appear broken across multiple lines, but that is for legibility only. @@ -313,24 +291,28 @@ argument. .PP In many cases, the issuer of a command can reduce the amount of typing necessary by using one or both of the following methods: -.Ip "\(bu" 4 +.IP "\(bu" 4 Omitting switches. -.Ip "\(bu" 4 +.IP "\(bu" 4 Using accepted abbreviations for operation codes, switches (if they are included at all), and some types of values. .PP The following sections explain the conditions for omitting or shortening parts of the command line. It is always acceptable to type a command in full, with all of its switches and no abbreviations. +.PP +Conditions for Omitting Switches +.IX Subsection "Conditions for Omitting Switches" +.PP It is always acceptable to type the switch part of an argument, but in many cases it is not necessary. Specifically, switches can be omitted if the following conditions are met. -.Ip "\(bu" 4 +.IP "\(bu" 4 All of the command's required arguments appear in the order prescribed by the syntax statement. -.Ip "\(bu" 4 +.IP "\(bu" 4 No switch is provided for any argument. -.Ip "\(bu" 4 +.IP "\(bu" 4 There is only one value for each argument (but note the important exception discussed in the following paragraph). .PP @@ -348,23 +330,28 @@ final argument. The following list describes the rules for omitting switches from the opposite perspective: an argument's switch must be provided when any of the following conditions apply. -.Ip "\(bu" 4 +.IP "\(bu" 4 The command's arguments do not appear in the prescribed order. -.Ip "\(bu" 4 +.IP "\(bu" 4 An optional argument is omitted but a subsequent optional argument is provided. -.Ip "\(bu" 4 +.IP "\(bu" 4 A switch is provided for a preceding argument. -.Ip "\(bu" 4 +.IP "\(bu" 4 More than one value is supplied for a preceding argument (which must take multiple values, of course); without a switch on the current argument, the command interpreter assumes that the current argument is another value for the preceding argument. -Consider again the example command from the section on \fIAn Example Command\fR. +.PP +An Example of Omitting Switches +.IX Subsection "An Example of Omitting Switches" +.PP +Consider again the example command from \*(L"An Example Command\*(R". .PP .Vb 1 -\& % bos getdate -server fs1.abc.com -file ptserver kaserver +\& % bos getdate \-server fs1.abc.com \-file ptserver kaserver .Ve +.PP This command has two required arguments: the server machine name (identified by the \fB\-server\fR switch) and binary file name (identified by the \fB\-file\fR switch). The second argument accepts multiple values. By @@ -373,43 +360,63 @@ complying with all three conditions, the issuer can omit the switches: .Vb 1 \& % bos getdate fs1.abc.com ptserver kaserver .Ve +.PP Because there are no switches, the bos command interpreter relies on the order of arguments. It assumes that the first element following the -operation code, \f(CWfs1.abc.com\fR, is the server machine name, and that the -next argument, \f(CWptserver\fR, is a binary file name. Then, because the +operation code, \f(CW\*(C`fs1.abc.com\*(C'\fR, is the server machine name, and that the +next argument, \f(CW\*(C`ptserver\*(C'\fR, is a binary file name. Then, because the command's second (and last) argument accepts multiple values, the command -interpreter correctly interprets \f(CWkaserver\fR as an additional value for +interpreter correctly interprets \f(CW\*(C`kaserver\*(C'\fR as an additional value for it. .PP On the other hand, the following is not acceptable because it violates the -first two conditions in the section on \fIConditions for Omitting Switches\fR: even though +first two conditions in \*(L"Conditions for Omitting Switches\*(R": even though there is only one value per argument, the arguments do not appear in the prescribed order, and a switch is provided for one argument but not the other. .PP .Vb 1 -\& % bos getdate ptserver -server fs1.abc.com +\& % bos getdate ptserver \-server fs1.abc.com .Ve +.PP +\fIRules for Using Abbreviations and Aliases\fR +.IX Subsection "Rules for Using Abbreviations and Aliases" +.PP This section explains how to abbreviate operation codes, option names, server machine names, partition names, and cell names. It is not possible to abbreviate other types of values. +.PP +Abbreviating Operation Codes +.IX Subsection "Abbreviating Operation Codes" +.PP It is acceptable to abbreviate an operation code to the shortest form that still distinguishes it from the other operation codes in its suite. .PP For example, it is acceptable to shorten \fBbos install\fR to \fBbos i\fR because there are no other operation codes in the \fBbos\fR command suite -that begin with the letter \f(CWi\fR. In contrast, there are several \fBbos\fR -operation codes that start with the letter \f(CWs\fR, so the abbreviations must +that begin with the letter \f(CW\*(C`i\*(C'\fR. In contrast, there are several \fBbos\fR +operation codes that start with the letter \f(CW\*(C`s\*(C'\fR, so the abbreviations must be longer to remain unambiguous: -.Ip "\fBbos sa\fR for bos salvage" 4 -.Ip "\fBbos seta\fR for bos setauth" 4 -.Ip "\fBbos setc\fR for bos setcellname" 4 -.Ip "\fBbos setr\fR for bos setrestart" 4 -.Ip "\fBbos sh\fR for bos shutdown" 4 -.Ip "\fBbos start\fR for bos start" 4 -.Ip "\fBbos startu\fR for bos startup" 4 -.Ip "\fBbos stat\fR for bos status" 4 -.Ip "\fBbos sto\fR for bos stop" 4 +.IP "\fBbos sa\fR for bos salvage" 4 +.IX Item "bos sa for bos salvage" +.PD 0 +.IP "\fBbos seta\fR for bos setauth" 4 +.IX Item "bos seta for bos setauth" +.IP "\fBbos setc\fR for bos setcellname" 4 +.IX Item "bos setc for bos setcellname" +.IP "\fBbos setr\fR for bos setrestart" 4 +.IX Item "bos setr for bos setrestart" +.IP "\fBbos sh\fR for bos shutdown" 4 +.IX Item "bos sh for bos shutdown" +.IP "\fBbos start\fR for bos start" 4 +.IX Item "bos start for bos start" +.IP "\fBbos startu\fR for bos startup" 4 +.IX Item "bos startu for bos startup" +.IP "\fBbos stat\fR for bos status" 4 +.IX Item "bos stat for bos status" +.IP "\fBbos sto\fR for bos stop" 4 +.IX Item "bos sto for bos stop" +.PD .PP In addition to abbreviations, some operation codes have an \fIalias\fR, a short form that is not derived by abbreviating the operation code to its @@ -418,14 +425,14 @@ command is \fBfs sa\fR, whereas the shortest unambiguous abbreviation is \fBfs seta\fR. .PP There are two usual reasons an operation code has an alias: -.Ip "\(bu" 4 +.IP "\(bu" 4 Because the command is frequently issued, it is convenient to have a form shorter than the one derived by abbreviating. The \fBfs setacl\fR command is an example. -.Ip "\(bu" 4 +.IP "\(bu" 4 Because the command's name has changed, but users of previous versions of -\s-1AFS\s0 know the former name. For example, \fBbos listhosts\fR has the alias -\fBbos getcell\fR, its former name. It is acceptable to abbreviate aliases +\&\s-1AFS\s0 know the former name. For example, \fBbos listhosts\fR has the alias +\&\fBbos getcell\fR, its former name. It is acceptable to abbreviate aliases to their shortest unambiguous form (for example, \fBbos getcell\fR to \fBbos getc\fR). .PP @@ -433,12 +440,20 @@ Even if an operation code has an alias, it is still acceptable to use the shortest unambiguous form. Thus, the \fBfs setacl\fR command has three acceptable forms: \fBfs setacl\fR (the full form), \fBfs seta\fR (the shortest abbreviation), and \fBfs sa\fR (the alias). +.PP +Abbreviating Switches and Flags +.IX Subsection "Abbreviating Switches and Flags" +.PP It is acceptable to shorten a switch or flag to the shortest form that distinguishes it from the other switches and flags for its operation code. It is often possible to omit switches entirely, subject to the -conditions listed in the section on \fIConditions for Omitting Switches\fR. -\s-1AFS\s0 server machines must have fully-qualified Internet-style host names -(for example, \f(CWfs1.abc.com\fR), but it is not always necessary to type the +conditions listed in \*(L"Conditions for Omitting Switches\*(R". +.PP +Abbreviating Server Machine Names +.IX Subsection "Abbreviating Server Machine Names" +.PP +\&\s-1AFS\s0 server machines must have fully-qualified Internet-style host names +(for example, \f(CW\*(C`fs1.abc.com\*(C'\fR), but it is not always necessary to type the full name on the command line. \s-1AFS\s0 commands accept unambiguous shortened forms, but depend on the cell's name service (such as the Domain Name Service) or a local host table to resolve a shortened name to the @@ -446,11 +461,15 @@ fully-qualified equivalent when the command is issued. .PP Most commands also accept the dotted decimal form of the machine's \s-1IP\s0 address as an identifier. +.PP +Abbreviating Partition Names +.IX Subsection "Abbreviating Partition Names" +.PP Partitions that house \s-1AFS\s0 volumes must have names of the form -\fI/vicep\fIx\fR\fR or \fI/vicep\fIxx\fR\fR, where the variable final portion is one +\&\fI/vicep\fIx\fI\fR or \fI/vicep\fIxx\fI\fR, where the variable final portion is one or two lowercase letters. By convention, the first server partition created on a file server machine is called \fI/vicepa\fR, the second -\fI/vicepb\fR, and so on. The \fI\s-1IBM\s0 \s-1AFS\s0 Quick Beginnings\fR explains how to +\&\fI/vicepb\fR, and so on. The \fI\s-1IBM\s0 \s-1AFS\s0 Quick Beginnings\fR explains how to configure and name a file server machine's partitions in preparation for storing \s-1AFS\s0 volumes on them. .PP @@ -461,34 +480,44 @@ of the following forms: \& /vicepa = vicepa = a = 0 \& /vicepb = vicepb = b = 1 .Ve +.PP After /vicepz (for which the index is 25) comes .PP .Vb 2 \& /vicepaa = vicepaa = aa = 26 \& /vicepab = vicepab = ab = 27 .Ve +.PP and so on through .PP .Vb 1 \& /vicepiv = vicepiv = iv = 255 .Ve +.PP +Abbreviating Cell Names +.IX Subsection "Abbreviating Cell Names" +.PP A cell's full name usually matches its Internet domain name (such as -\fBstateu.edu\fR for the State University or \f(CWabc.com\fR for \s-1ABC\s0 +\&\fBstateu.edu\fR for the State University or \f(CW\*(C`abc.com\*(C'\fR for \s-1ABC\s0 Corporation). Some \s-1AFS\s0 commands accept unambiguous shortened forms, usually with respect to the local \fI/usr/vice/etc/CellServDB file\fR but sometimes depending on the ability of the local name service to resolve the corresponding domain name. +.PP +\fIDisplaying Online Help for \s-1AFS\s0 Commands\fR +.IX Subsection "Displaying Online Help for AFS Commands" +.PP To display online help for \s-1AFS\s0 commands that belong to suites, use the -\fBhelp\fR and \fBapropos\fR operation codes. A \fB\-help\fR flag is also available +\&\fBhelp\fR and \fBapropos\fR operation codes. A \fB\-help\fR flag is also available on every almost every \s-1AFS\s0 command. .PP The online help entry for a command consists of two or three lines: -.Ip "\(bu" 4 +.IP "\(bu" 4 The first line names the command and briefly describes what it does. -.Ip "\(bu" 4 +.IP "\(bu" 4 If the command has aliases, they appear on the next line. -.Ip "\(bu" 4 -The final line, which begins with the string \f(CWUsage:\fR, lists the +.IP "\(bu" 4 +The final line, which begins with the string \f(CW\*(C`Usage:\*(C'\fR, lists the command's options in the prescribed order; online help entries use the same typographical symbols (brackets and so on) as this documentation. .PP @@ -498,6 +527,7 @@ first line (short description) for every operation code in the suite: .Vb 1 \& % help .Ve +.PP If the issuer specifies one or more operation codes, the \fBhelp\fR operation code displays each command's complete online entry (short description, alias if any, and syntax): @@ -505,12 +535,14 @@ alias if any, and syntax): .Vb 1 \& % help + .Ve +.PP The \fB\-help\fR flag displays a command's syntax but not the short description or alias: .PP .Vb 1 -\& % -help +\& % \-help .Ve +.PP The apropos operation code displays the short description of any command in a suite whose operation code or short description includes the specified keyword: @@ -518,6 +550,7 @@ specified keyword: .Vb 1 \& % apropos "" .Ve +.PP The following example command displays the complete online help entry for the \fBfs setacl\fR command: .PP @@ -525,16 +558,18 @@ the \fBfs setacl\fR command: \& % fs help setacl \& fs setacl: set access control list \& aliases: sa -\& Usage: fs setacl -dir + -acl + -\& [-clear] [-negative] [-id] [-if] [-help] +\& Usage: fs setacl \-dir + \-acl + +\& [\-clear] [\-negative] [\-id] [\-if] [\-help] .Ve +.PP To see only the syntax statement, use the \fB\-help\fR flag: .PP .Vb 3 -\& % fs setacl -help -\& Usage: fs setacl -dir + -acl + -\& [-clear] [-negative] [-id] [-if] [-help] +\& % fs setacl \-help +\& Usage: fs setacl \-dir + \-acl + +\& [\-clear] [\-negative] [\-id] [\-if] [\-help] .Ve +.PP In the following example, a user wants to display the quota for her home volume. She knows that the relevant command belongs to the \fBfs\fR suite, but cannot remember the operation code. She uses \fBquota\fR as the keyword: @@ -545,6 +580,7 @@ but cannot remember the operation code. She uses \fBquota\fR as the keyword: \& quota: show volume quota usage \& setquota: set volume quota .Ve +.PP The following illustrates the error message that results if no command name or short description contains the keyword: .PP @@ -553,148 +589,60 @@ name or short description contains the keyword: \& Sorry, no commands found .Ve .SH "PRIVILEGE REQUIRED" -Many AFS commands require one or more types of administrative +.IX Header "PRIVILEGE REQUIRED" +Many \s-1AFS\s0 commands require one or more types of administrative privilege. See the reference page for each command. .SH "SEE ALSO" -the \fIafsd(8)\fR manpage, -the \fIafsmonitor(1)\fR manpage, -the \fIbackup(8)\fR manpage, -the \fIbos(8)\fR manpage, -the \fIbosserver(8)\fR manpage, -the \fIbuserver(8)\fR manpage, -the \fIbutc(8)\fR manpage, -the \fIdlog(1)\fR manpage, -the \fIdpass(1)\fR manpage, -the \fIfileserver(8)\fR manpage, -the \fIfms(8)\fR manpage, -the \fIfs(1)\fR manpage, -the \fIfstrace(8)\fR manpage, -the \fIkadb_check(8)\fR manpage, -the \fIkas(8)\fR manpage, -the \fIkaserver(8)\fR manpage, -the \fIkdb(8)\fR manpage, -the \fIklog(1)\fR manpage, -the \fIknfs(1)\fR manpage, -the \fIkpasswd(1)\fR manpage, -the \fIkpwvalid(8)\fR manpage, -the \fIpackage(1)\fR manpage, -the \fIpagsh(1)\fR manpage, -the \fIprdb_check(8)\fR manpage, -the \fIpts(1)\fR manpage, -the \fIptserver(8)\fR manpage, -the \fIrxdebug(1)\fR manpage, -the \fIsalvager(8)\fR manpage, -the \fIscout(1)\fR manpage, -the \fIsys(1)\fR manpage, -the \fItokens(1)\fR manpage, -the \fItranslate_et(1)\fR manpage, -the \fIunlog(1)\fR manpage, -the \fIup(1)\fR manpage, -the \fIupclient(8)\fR manpage, -the \fIupserver(8)\fR manpage, -the \fIuss(8)\fR manpage, -the \fIvldb_check(8)\fR manpage, -the \fIvlserver(8)\fR manpage, -the \fIvolinfo(8)\fR manpage, -the \fIvolserver(8)\fR manpage, -the \fIvos(1)\fR manpage, -the \fIxfs_size_check(8)\fR manpage, -the \fIxstat_cm_test(1)\fR manpage, -the \fIxstat_fs_test(1)\fR manpage +.IX Header "SEE ALSO" +\&\fIafsd\fR\|(8), +\&\fIafsmonitor\fR\|(1), +\&\fIbackup\fR\|(8), +\&\fIbos\fR\|(8), +\&\fIbosserver\fR\|(8), +\&\fIbuserver\fR\|(8), +\&\fIbutc\fR\|(8), +\&\fIdlog\fR\|(1), +\&\fIdpass\fR\|(1), +\&\fIfileserver\fR\|(8), +\&\fIfms\fR\|(8), +\&\fIfs\fR\|(1), +\&\fIfstrace\fR\|(8), +\&\fIkadb_check\fR\|(8), +\&\fIkas\fR\|(8), +\&\fIkaserver\fR\|(8), +\&\fIkdb\fR\|(8), +\&\fIklog\fR\|(1), +\&\fIknfs\fR\|(1), +\&\fIkpasswd\fR\|(1), +\&\fIkpwvalid\fR\|(8), +\&\fIpackage\fR\|(1), +\&\fIpagsh\fR\|(1), +\&\fIprdb_check\fR\|(8), +\&\fIpts\fR\|(1), +\&\fIptserver\fR\|(8), +\&\fIrxdebug\fR\|(1), +\&\fIsalvager\fR\|(8), +\&\fIscout\fR\|(1), +\&\fIsys\fR\|(1), +\&\fItokens\fR\|(1), +\&\fItranslate_et\fR\|(1), +\&\fIunlog\fR\|(1), +\&\fIup\fR\|(1), +\&\fIupclient\fR\|(8), +\&\fIupserver\fR\|(8), +\&\fIuss\fR\|(8), +\&\fIvldb_check\fR\|(8), +\&\fIvlserver\fR\|(8), +\&\fIvolinfo\fR\|(8), +\&\fIvolserver\fR\|(8), +\&\fIvos\fR\|(1), +\&\fIxfs_size_check\fR\|(8), +\&\fIxstat_cm_test\fR\|(1), +\&\fIxstat_fs_test\fR\|(1) .SH "COPYRIGHT" -IBM Corporation 2000. All Rights Reserved. +.IX Header "COPYRIGHT" +\&\s-1IBM\s0 Corporation 2000. All Rights Reserved. .PP -This documentation is covered by the IBM Public License Version 1.0. It was -converted from HTML to POD by software written by Chas Williams and Russ +This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. It was +converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell. - -.rn }` '' -.IX Title "AFS 1" -.IX Name "afs - Introduction to AFS commands" - -.IX Header "NAME" - -.IX Header "DESCRIPTION" - -.IX Item "backup" - -.IX Item "bos" - -.IX Item "fs" - -.IX Item "fstrace" - -.IX Item "kas" - -.IX Item "pts" - -.IX Item "uss" - -.IX Item "vos" - -.IX Subsection "\s-1AFS\s0 Command Syntax" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\fBbos sa\fR for bos salvage" - -.IX Item "\fBbos seta\fR for bos setauth" - -.IX Item "\fBbos setc\fR for bos setcellname" - -.IX Item "\fBbos setr\fR for bos setrestart" - -.IX Item "\fBbos sh\fR for bos shutdown" - -.IX Item "\fBbos start\fR for bos start" - -.IX Item "\fBbos startu\fR for bos startup" - -.IX Item "\fBbos stat\fR for bos status" - -.IX Item "\fBbos sto\fR for bos stop" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Item "\(bu" - -.IX Header "PRIVILEGE REQUIRED" - -.IX Header "SEE ALSO" - -.IX Header "COPYRIGHT" - diff --git a/doc/man-pages/man1/afsmonitor.1 b/doc/man-pages/man1/afsmonitor.1 index 073956fc5..cae606096 100644 --- a/doc/man-pages/man1/afsmonitor.1 +++ b/doc/man-pages/man1/afsmonitor.1 @@ -1,9 +1,8 @@ -.rn '' }` -''' $RCSfile$$Revision$$Date$ -''' -''' $Log$ -''' -.de Sh +.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32 +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sh \" Subsection heading .br .if t .Sp .ne 5 @@ -11,150 +10,98 @@ \fB\\$1\fR .PP .. -.de Sp +.de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. -.de Ip -.br -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.de Vb +.de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. -.de Ve +.de Ve \" End verbatim text .ft R - .fi .. -''' -''' -''' Set up \*(-- to give an unbreakable dash; -''' string Tr holds user defined translation string. -''' Bell System Logo is used as a dummy character. -''' -.tr \(*W-|\(bv\*(Tr +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ -.ds -- \(*W- -.ds PI pi -.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch -.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch -.ds L" "" -.ds R" "" -''' \*(M", \*(S", \*(N" and \*(T" are the equivalent of -''' \*(L" and \*(R", except that they are used on ".xx" lines, -''' such as .IP and .SH, which do another additional levels of -''' double-quote interpretation -.ds M" """ -.ds S" """ -.ds N" """"" -.ds T" """"" -.ds L' ' -.ds R' ' -.ds M' ' -.ds S' ' -.ds N' ' -.ds T' ' +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` "" +. ds C' "" 'br\} .el\{\ -.ds -- \(em\| -.tr \*(Tr -.ds L" `` -.ds R" '' -.ds M" `` -.ds S" '' -.ds N" `` -.ds T" '' -.ds L' ` -.ds R' ' -.ds M' ` -.ds S' ' -.ds N' ` -.ds T' ' -.ds PI \(*p +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' 'br\} -.\" If the F register is turned on, we'll generate -.\" index entries out stderr for the following things: -.\" TH Title -.\" SH Header -.\" Sh Subsection -.\" Ip Item -.\" X<> Xref (embedded -.\" Of course, you have to process the output yourself -.\" in some meaninful fashion. -.if \nF \{ -.de IX -.tm Index:\\$1\t\\n%\t"\\$2" +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.nr % 0 -.rr F +. nr % 0 +. rr F .\} -.TH AFSMONITOR 1 "OpenAFS" "1/Mar/2006" "AFS Command Reference" -.UC -.if n .hy 0 +.\" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.hy 0 .if n .na -.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' -.de CQ \" put $1 in typewriter font -.ft CW -'if n "\c -'if t \\&\\$1\c -'if n \\&\\$1\c -'if n \&" -\\&\\$2 \\$3 \\$4 \\$5 \\$6 \\$7 -'.ft R -.. -.\" @(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2 -. \" AM - accent mark definitions -.bd B 3 -. \" fudge factors for nroff and troff +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff .if n \{\ -. ds #H 0 -. ds #V .8m -. ds #F .3m -. ds #[ \f1 -. ds #] \fP +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP .\} .if t \{\ -. ds #H ((1u-(\\\\n(.fu%2u))*.13m) -. ds #V .6m -. ds #F 0 -. ds #[ \& -. ds #] \& +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& .\} -. \" simple accents for nroff and troff +. \" simple accents for nroff and troff .if n \{\ -. ds ' \& -. ds ` \& -. ds ^ \& -. ds , \& -. ds ~ ~ -. ds ? ? -. ds ! ! -. ds / -. ds q +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / .\} .if t \{\ -. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" -. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' -. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' -. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' -. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' -. ds ? \s-2c\h'-\w'c'u*7/10'\u\h'\*(#H'\zi\d\s+2\h'\w'c'u*8/10' -. ds ! \s-2\(or\s+2\h'-\w'\(or'u'\v'-.8m'.\v'.8m' -. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' -. ds q o\h'-\w'o'u*8/10'\s-4\v'.4m'\z\(*i\v'-.4m'\s+4\h'\w'o'u*8/10' +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} -. \" troff and (daisy-wheel) nroff accents +. \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' -.ds v \\k:\h'-(\\n(.wu*9/10-\*(#H)'\v'-\*(#V'\*(#[\s-4v\s0\v'\*(#V'\h'|\\n:u'\*(#] -.ds _ \\k:\h'-(\\n(.wu*9/10-\*(#H+(\*(#F*2/3))'\v'-.4m'\z\(hy\v'.4m'\h'|\\n:u' -.ds . \\k:\h'-(\\n(.wu*8/10)'\v'\*(#V*4/10'\z.\v'-\*(#V*4/10'\h'|\\n:u' -.ds 3 \*(#[\v'.2m'\s-2\&3\s0\v'-.2m'\*(#] .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' @@ -162,50 +109,48 @@ .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E -.ds oe o\h'-(\w'o'u*4/10)'e -.ds Oe O\h'-(\w'O'u*4/10)'E -. \" corrections for vroff +. \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' -. \" for low resolution devices (crt and lpr) +. \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ -. ds : e -. ds 8 ss -. ds v \h'-1'\o'\(aa\(ga' -. ds _ \h'-1'^ -. ds . \h'-1'. -. ds 3 3 -. ds o a -. ds d- d\h'-1'\(ga -. ds D- D\h'-1'\(hy -. ds th \o'bp' -. ds Th \o'LP' -. ds ae ae -. ds Ae AE -. ds oe oe -. ds Oe OE +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE .\} .rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "AFSMONITOR 1" +.TH AFSMONITOR 1 "2006-10-10" "OpenAFS" "AFS Command Reference" .SH "NAME" afsmonitor \- Monitors File Servers and Cache Managers .SH "SYNOPSIS" -\fBafsmonitor\fR [\fBinitcmd\fR] [\-config <\fIconfiguration file\fR>] - <<\ [\fB\-frequency\fR\ <\fIpoll\ frequency,\ in\ seconds\fR] >>> - <<\ [\fB\-output\fR\ <\fIstorage\ file\ name\fR] >>> [\fB\-detailed\fR] - <<\ [\fB\-debug\fR\ <\fIdebug\ output\ file\fR] >>> - <<\ [\fB\-fshosts\fR\ <\fIlist\ of\ file\ servers\ to\ monitor\fR+] >>> - <<\ [\fB\-cmhosts\fR\ <\fIlist\ of\ cache\ managers\ to\ monitor\fR+] >>> - <<\ [\fB\-buffers\fR\ <\fInumber\ of\ buffer\ slots\fR] >>> [\fB\-help\fR] +.IX Header "SYNOPSIS" +\&\fBafsmonitor\fR [\fBinitcmd\fR] [\-config <\fIconfiguration file\fR>] + [\fB\-frequency\fR\ <\fIpoll\ frequency,\ in\ seconds\fR>] + [\fB\-output\fR\ <\fIstorage\ file\ name\fR>] [\fB\-detailed\fR] + [\fB\-debug\fR\ <\fIdebug\ output\ file\fR>] + [\fB\-fshosts\fR\ <\fIlist\ of\ file\ servers\ to\ monitor\fR>+] + [\fB\-cmhosts\fR\ <\fIlist\ of\ cache\ managers\ to\ monitor\fR>+] + [\fB\-buffers\fR\ <\fInumber\ of\ buffer\ slots\fR>] [\fB\-help\fR] .PP -\fBafsmonitor\fR [\fBi\fR] [\-co <\fIconfiguration file\fR>] - <<\ [\fB\-fr\fR\ <\fIpoll\ frequency,\ in\ seconds\fR] >>> - <<\ [\fB\-o\fR\ <\fIstorage\ file\ name\fR] >>> [\fB\-det\fR] - <<\ [\fB\-deb\fR\ <\fIdebug\ output\ file\fR] >>> - <<\ [\fB\-fs\fR\ <\fIlist\ of\ file\ servers\ to\ monitor\fR+] >>> - <<\ [\fB\-cm\fR\ <\fIlist\ of\ cache\ managers\ to\ monitor\fR+] >>> - <<\ [\fB\-b\fR\ <\fInumber\ of\ buffer\ slots\fR] >>> [\fB\-h\fR] +\&\fBafsmonitor\fR [\fBi\fR] [\-co <\fIconfiguration file\fR>] + [\fB\-fr\fR\ <\fIpoll\ frequency,\ in\ seconds\fR>] + [\fB\-o\fR\ <\fIstorage\ file\ name\fR>] [\fB\-det\fR] + [\fB\-deb\fR\ <\fIdebug\ output\ file\fR>] + [\fB\-fs\fR\ <\fIlist\ of\ file\ servers\ to\ monitor\fR>+] + [\fB\-cm\fR\ <\fIlist\ of\ cache\ managers\ to\ monitor\fR>+] + [\fB\-b\fR\ <\fInumber\ of\ buffer\ slots\fR>] [\fB\-h\fR] .SH "DESCRIPTION" +.IX Header "DESCRIPTION" The afsmonitor command initializes a program that gathers and displays statistics about specified File Server and Cache Manager operations. It allows the issuer to monitor, from a single location, a wide range of File @@ -214,30 +159,31 @@ local and foreign cells. .PP There are 271 available File Server statistics and 571 available Cache Manager statistics, listed in the appendix about \fBafsmonitor\fR statistics -in the \fIIBM AFS Administration Guide\fR. By default, the command displays +in the \fI\s-1IBM\s0 \s-1AFS\s0 Administration Guide\fR. By default, the command displays all of the relevant statistics for the file server machines named by the -\fB\-fshosts\fR argument and the client machines named by the \fB\-cmhosts\fR +\&\fB\-fshosts\fR argument and the client machines named by the \fB\-cmhosts\fR argument. To limit the display to only the statistics of interest, list them in the configuration file specified by the \fB\-config\fR argument. In addition, use the configuration file for the following purposes: -.Ip "\(bu" 4 +.IP "\(bu" 4 To set threshold values for any monitored statistic. When the value of a statistic exceeds the threshold, the \fBafsmonitor\fR command displays it in reverse video. There are no default threshold values. -.Ip "\(bu" 4 +.IP "\(bu" 4 To invoke a program or script automatically when a statistic exceeds its threshold. The \s-1AFS\s0 distribution does not include any such scripts. -.Ip "\(bu" 4 +.IP "\(bu" 4 To list the file server and client machines to monitor, instead of using the \fB\-fshosts\fR and \fB\-cmhosts\fR arguments. .PP -For a description of the configuration file, see the \fIafsmonitor(5)\fR manpage. +For a description of the configuration file, see \fIafsmonitor\fR\|(5). .SH "CAUTIONS" +.IX Header "CAUTIONS" The following software must be accessible to a machine where the -\fBafsmonitor\fR program is running: -.Ip "\(bu" 4 +\&\fBafsmonitor\fR program is running: +.IP "\(bu" 4 The \s-1AFS\s0 xstat libraries, which the afsmonitor program uses to gather data. -.Ip "\(bu" 4 +.IP "\(bu" 4 The curses graphics package, which most \s-1UNIX\s0 distributions provide as a standard utility. .PP @@ -257,17 +203,21 @@ single machine, as long as each instance runs in its own dedicated window or terminal. Note that it can take up to three minutes to start an additional instance. .SH "OPTIONS" -.Ip "\fBinitcmd\fR" 4 +.IX Header "OPTIONS" +.IP "\fBinitcmd\fR" 4 +.IX Item "initcmd" Accommodates the command's use of the \s-1AFS\s0 command parser, and is optional. -.Ip "\fB\-config\fR <\fIfile\fR>" 4 +.IP "\fB\-config\fR <\fIfile\fR>" 4 +.IX Item "-config " Names the configuration file which lists the machines to monitor, statistics to display, and threshold values, if any. A partial pathname is interpreted relative to the current working directory. Provide this argument if not providing the \fB\-fshosts\fR argument, \fB\-cmhosts\fR argument, or neither. For instructions on creating this file, see the preceding -\fB\s-1DESCRIPTION\s0\fR section, and the section on the \fBafsmonitor\fR program in +\&\fB\s-1DESCRIPTION\s0\fR section, and the section on the \fBafsmonitor\fR program in the \fI\s-1IBM\s0 \s-1AFS\s0 Administration Guide\fR. -.Ip "\fB\-frequency\fR <\fIpoll frequency\fR>" 4 +.IP "\fB\-frequency\fR <\fIpoll frequency\fR>" 4 +.IX Item "-frequency " Specifies in seconds how often the afsmonitor program probes the File Servers and Cache Managers. Valid values range from \f(CW1\fR to \f(CW86400\fR (which is 24 hours); the default value is \f(CW60\fR. This frequency applies to @@ -275,81 +225,92 @@ both File Servers and Cache Managers, but the \fBafsmonitor\fR program initiates the two types of probes, and processes their results, separately. The actual interval between probes to a host is the probe frequency plus the time required for all hosts to respond. -.Ip "\fB\-output\fR <\fIfile\fR>" 4 +.IP "\fB\-output\fR <\fIfile\fR>" 4 +.IX Item "-output " Names the file to which the afsmonitor program writes all of the statistics that it collects. By default, no output file is created. See the section on the \fBafsmonitor\fR command in the \fI\s-1IBM\s0 \s-1AFS\s0 Administration Guide\fR for information on this file. -.Ip "\fB\-detailed\fR" 4 +.IP "\fB\-detailed\fR" 4 +.IX Item "-detailed" Formats the information in the output file named by \fB\-output\fR argument in a maximally readable format. Provide the \fB\-output\fR argument along with this one. -.Ip "\fB\-fshosts\fR <\fIhost\fR>+" 4 +.IP "\fB\-fshosts\fR <\fIhost\fR>+" 4 +.IX Item "-fshosts +" Names one or more machines from which to gather File Server statistics. For each machine, provide either a fully qualified host name, or an unambiguous abbreviation (the ability to resolve an abbreviation depends on the state of the cell's name service at the time the command is issued). This argument can be combined with the \fB\-cmhosts\fR argument, but not with the \fB\-config\fR argument. -.Ip "\fB\-cmhosts\fR <\fIhost\fR>+" 4 +.IP "\fB\-cmhosts\fR <\fIhost\fR>+" 4 +.IX Item "-cmhosts +" Names one or more machines from which to gather Cache Manager statistics. For each machine, provide either a fully qualified host name, or an unambiguous abbreviation (the ability to resolve an abbreviation depends on the state of the cell's name service at the time the command is issued). This argument can be combined with the \fB\-fshosts\fR argument, but not with the \fB\-config\fR argument. -.Ip "\fB\-buffers\fR <\fIslots\fR>" 4 +.IP "\fB\-buffers\fR <\fIslots\fR>" 4 +.IX Item "-buffers " Is nonoperational and provided to accommodate potential future enhancements to the program. -.Ip "\fB\-help\fR" 4 +.IP "\fB\-help\fR" 4 +.IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH "OUTPUT" +.IX Header "OUTPUT" The afsmonitor program displays its data on three screens: -.Ip "System Overview" 4 +.IP "System Overview" 4 +.IX Item "System Overview" This screen appears automatically when the \fBafsmonitor\fR program initializes. It summarizes separately for File Servers and Cache Managers the number of machines being monitored and how many of them have \fIalerts\fR (statistics that have exceeded their thresholds). It then lists the hostname and number of alerts for each machine being monitored, indicating if appropriate that a process failed to respond to the last probe. -.Ip "File Server" 4 +.IP "File Server" 4 +.IX Item "File Server" This screen displays File Server statistics for each file server machine being monitored. It highlights statistics that have exceeded their thresholds, and identifies machines that failed to respond to the last probe. -.Ip "Cache Managers" 4 +.IP "Cache Managers" 4 +.IX Item "Cache Managers" This screen displays Cache Manager statistics for each client machine being monitored. It highlights statistics that have exceeded their thresholds, and identifies machines that failed to respond to the last probe. .PP Fields at the corners of every screen display the following information: -.Ip "\(bu" 4 +.IP "\(bu" 4 In the top left corner, the program name and version number. -.Ip "\(bu" 4 +.IP "\(bu" 4 In the top right corner, the screen name, current and total page numbers, -and current and total column numbers. The page number (for example, \f(CWp. 1 -of 3\fR) indicates the index of the current page and the total number of +and current and total column numbers. The page number (for example, \f(CW\*(C`p. 1 +of 3\*(C'\fR) indicates the index of the current page and the total number of (vertical) pages over which data is displayed. The column number (for -example, \f(CWc. 1 of 235\fR) indicates the index of the current leftmost +example, \f(CW\*(C`c. 1 of 235\*(C'\fR) indicates the index of the current leftmost column and the total number of columns in which data appears. (The symbol -\f(CW<<< \fR>> >>>> indicates that there is additional data to the right; the -symbol \f(CW<<< <<< \fR>>> indicates that there is additional data to the +\&\f(CW\*(C`>>>\*(C'\fR indicates that there is additional data to the right; the +symbol \f(CW\*(C`<<<\*(C'\fR indicates that there is additional data to the left.) -.Ip "\(bu" 4 +.IP "\(bu" 4 In the bottom left corner, a list of the available commands. Enter the first letter in the command name to run that command. Only the currently possible options appear; for example, if there is only one page of data, -the \f(CWnext\fR and \f(CWprev\fR commands, which scroll the screen up and down +the \f(CW\*(C`next\*(C'\fR and \f(CW\*(C`prev\*(C'\fR commands, which scroll the screen up and down respectively, do not appear. For descriptions of the commands, see the following section about navigating the display screens. -.Ip "\(bu" 4 -In the bottom right corner, the \f(CWprobes\fR field reports how many times the -program has probed File Servers (\f(CWfs\fR), Cache Managers (\f(CWcm\fR), or +.IP "\(bu" 4 +In the bottom right corner, the \f(CW\*(C`probes\*(C'\fR field reports how many times the +program has probed File Servers (\f(CW\*(C`fs\*(C'\fR), Cache Managers (\f(CW\*(C`cm\*(C'\fR), or both. The counts for File Servers and Cache Managers can differ. The -\f(CWfreq\fR field reports how often the program sends probes. +\&\f(CW\*(C`freq\*(C'\fR field reports how often the program sends probes. .Sh "Navigating the afsmonitor Display Screens" +.IX Subsection "Navigating the afsmonitor Display Screens" As noted, the lower left hand corner of every display screen displays the names of the commands currently available for moving to alternate screens, which can either be a different type or display more statistics or @@ -357,37 +318,51 @@ machines of the current type. To execute a command, press the lowercase version of the first letter in its name. Some commands also have an uppercase version that has a somewhat different effect, as indicated in the following list. -.Ip "\f(CWcm\fR" 4 -Switches to the \f(CWCache Managers\fR screen. Available only on the \f(CWSystem -Overview\fR and \f(CWFile Servers\fR screens. -.Ip "\f(CWfs\fR" 4 -Switches to the \f(CWFile Servers\fR screen. Available only on the \f(CWSystem -Overview\fR and the \f(CWCache Managers\fR screens. -.Ip "\f(CWleft\fR" 4 +.ie n .IP """cm""" 4 +.el .IP "\f(CWcm\fR" 4 +.IX Item "cm" +Switches to the \f(CW\*(C`Cache Managers\*(C'\fR screen. Available only on the \f(CW\*(C`System +Overview\*(C'\fR and \f(CW\*(C`File Servers\*(C'\fR screens. +.ie n .IP """fs""" 4 +.el .IP "\f(CWfs\fR" 4 +.IX Item "fs" +Switches to the \f(CW\*(C`File Servers\*(C'\fR screen. Available only on the \f(CW\*(C`System +Overview\*(C'\fR and the \f(CW\*(C`Cache Managers\*(C'\fR screens. +.ie n .IP """left""" 4 +.el .IP "\f(CWleft\fR" 4 +.IX Item "left" Scrolls horizontally to the left, to access the data columns situated to -the left of the current set. Available when the \f(CW<<< <<< \fR>>> symbol -appears at the top left of the screen. Press uppercase \f(CWL\fR to scroll +the left of the current set. Available when the \f(CW\*(C`<<<\*(C'\fR symbol +appears at the top left of the screen. Press uppercase \f(CW\*(C`L\*(C'\fR to scroll horizontally all the way to the left (to display the first set of data columns). -.Ip "\f(CWnext\fR" 4 +.ie n .IP """next""" 4 +.el .IP "\f(CWnext\fR" 4 +.IX Item "next" Scrolls down vertically to the next page of machine names. Available when there are two or more pages of machines and the final page is not -currently displayed. Press uppercase \f(CWN\fR to scroll to the final page. -.Ip "\f(CWoview\fR" 4 -Switches to the \f(CWSystem Overview\fR screen. Available only on the \f(CWCache -Managers\fR and \f(CWFile Servers\fR screens. -.Ip "\f(CWprev\fR" 4 +currently displayed. Press uppercase \f(CW\*(C`N\*(C'\fR to scroll to the final page. +.ie n .IP """oview""" 4 +.el .IP "\f(CWoview\fR" 4 +.IX Item "oview" +Switches to the \f(CW\*(C`System Overview\*(C'\fR screen. Available only on the \f(CW\*(C`Cache +Managers\*(C'\fR and \f(CW\*(C`File Servers\*(C'\fR screens. +.ie n .IP """prev""" 4 +.el .IP "\f(CWprev\fR" 4 +.IX Item "prev" Scrolls up vertically to the previous page of machine names. Available when there are two or more pages of machines and the first page is not -currently displayed. Press uppercase \f(CWN\fR to scroll to the first page. -.Ip "\f(CWright\fR" 4 +currently displayed. Press uppercase \f(CW\*(C`N\*(C'\fR to scroll to the first page. +.ie n .IP """right""" 4 +.el .IP "\f(CWright\fR" 4 +.IX Item "right" Scrolls horizontally to the right, to access the data columns situated to -the right of the current set. This command is available when the \f(CW<<< \fR>> ->>>> symbol appears at the upper right of the screen. Press uppercase \f(CWR\fR +the right of the current set. This command is available when the \f(CW\*(C`>>>\*(C'\fR symbol appears at the upper right of the screen. Press uppercase \f(CW\*(C`R\*(C'\fR to scroll horizontally all the way to the right (to display the final set of data columns). .Sh "The System Overview Screen" -The \f(CWSystem Overview\fR screen appears automatically as the \fBafsmonitor\fR +.IX Subsection "The System Overview Screen" +The \f(CW\*(C`System Overview\*(C'\fR screen appears automatically as the \fBafsmonitor\fR program initializes. This screen displays the status of as many File Server and Cache Manager processes as can fit in the current window; scroll down to access additional information. @@ -395,21 +370,22 @@ scroll down to access additional information. The information on this screen is split into File Server information on the left and Cache Manager information on the right. The header for each grouping reports two pieces of information: -.Ip "\(bu" 4 +.IP "\(bu" 4 The number of machines on which the program is monitoring the indicated process. -.Ip "\(bu" 4 +.IP "\(bu" 4 The number of alerts and the number of machines affected by them (an -\fIalert\fR means that a statistic has exceeded its threshold or a process +\&\fIalert\fR means that a statistic has exceeded its threshold or a process failed to respond to the last probe). .PP A list of the machines being monitored follows. If there are any alerts on a machine, the number of them appears in square brackets to the left of the hostname. If a process failed to respond to the last probe, the -letters \f(CWPF\fR (probe failure) appear in square brackets to the left of the +letters \f(CW\*(C`PF\*(C'\fR (probe failure) appear in square brackets to the left of the hostname. .Sh "The File Servers Screen" -The \f(CWFile Servers\fR screen displays the values collected at the most +.IX Subsection "The File Servers Screen" +The \f(CW\*(C`File Servers\*(C'\fR screen displays the values collected at the most recent probe for File Server statistics. .PP A summary line at the top of the screen (just below the standard program @@ -424,12 +400,13 @@ To the right of the hostname column appear as many columns of statistics as can fit within the current width of the display screen or window; each column requires space for 10 characters. The name of the statistic appears at the top of each column. If the File Server on a machine did not respond -to the most recent probe, a pair of dashes (\f(CW--\fR) appears in each +to the most recent probe, a pair of dashes (\f(CW\*(C`\-\-\*(C'\fR) appears in each column. If a value exceeds its configured threshold, it is highlighted in reverse video. If a value is too large to fit into the allotted column width, it overflows into the next row in the same column. .Sh "The Cache Managers Screen" -The \f(CWCache Managers\fR screen displays the values collected at the most +.IX Subsection "The Cache Managers Screen" +The \f(CW\*(C`Cache Managers\*(C'\fR screen displays the values collected at the most recent probe for Cache Manager statistics. .PP A summary line at the top of the screen (just below the standard program @@ -444,140 +421,51 @@ To the right of the hostname column appear as many columns of statistics as can fit within the current width of the display screen or window; each column requires space for 10 characters. The name of the statistic appears at the top of each column. If the Cache Manager on a machine did not -respond to the most recent probe, a pair of dashes (\f(CW--\fR) appears in each +respond to the most recent probe, a pair of dashes (\f(CW\*(C`\-\-\*(C'\fR) appears in each column. If a value exceeds its configured threshold, it is highlighted in reverse video. If a value is too large to fit into the allotted column width, it overflows into the next row in the same column. .Sh "Writing to an Output File" +.IX Subsection "Writing to an Output File" Include the \fB\-output\fR argument to name the file into which the -\fBafsmonitor\fR program writes all of the statistics it collects. The +\&\fBafsmonitor\fR program writes all of the statistics it collects. The output file can be useful for tracking performance over long periods of time, and enables the administrator to apply post-processing techniques that reveal system trends. The \s-1AFS\s0 distribution does not include any post-processing programs. .PP The output file is in \s-1ASCII\s0 format and records the same information as the -\f(CWFile Server\fR and \f(CWCache Manager\fR display screens. Each line in the +\&\f(CW\*(C`File Server\*(C'\fR and \f(CW\*(C`Cache Manager\*(C'\fR display screens. Each line in the file uses the following format to record the time at which the -\fBafsmonitor\fR program gathered the indicated statistic from the Cache -Manager (\f(CWCM\fR) or File Server (\f(CWFS\fR) running on the machine called -\fIhost_name\fR. If a probe failed, the error code \f(CW-1\fR appears in the -\fIstatistic\fR field. +\&\fBafsmonitor\fR program gathered the indicated statistic from the Cache +Manager (\f(CW\*(C`CM\*(C'\fR) or File Server (\f(CW\*(C`FS\*(C'\fR) running on the machine called +\&\fIhost_name\fR. If a probe failed, the error code \f(CW\*(C`\-1\*(C'\fR appears in the +\&\fIstatistic\fR field. .PP .Vb 1 \&