doc/xml/UserGuide/a3812.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <HTML
   3 ><HEAD
   4 ><TITLE
   5 >AFS Command Syntax and Online Help</TITLE
   6 ><META
   7 NAME="GENERATOR"
   8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
   9 REL="HOME"
  10 TITLE="AFS User Guide"
  11 HREF="book1.html"><LINK
  12 REL="PREVIOUS"
  13 TITLE="Using the NFS/AFS Translator"
  14 HREF="a3632.html"><LINK
  15 REL="NEXT"
  16 TITLE="Glossary"
  17 HREF="g4153.html"></HEAD
  18 ><BODY
  19 CLASS="appendix"
  20 BGCOLOR="#FFFFFF"
  21 TEXT="#000000"
  22 LINK="#0000FF"
  23 VLINK="#840084"
  24 ALINK="#0000FF"
  25 ><DIV
  26 CLASS="NAVHEADER"
  27 ><TABLE
  28 SUMMARY="Header navigation table"
  29 WIDTH="100%"
  30 BORDER="0"
  31 CELLPADDING="0"
  32 CELLSPACING="0"
  33 ><TR
  34 ><TH
  35 COLSPAN="3"
  36 ALIGN="center"
  37 >AFS User Guide: Version 3.6</TH
  38 ></TR
  39 ><TR
  40 ><TD
  41 WIDTH="10%"
  42 ALIGN="left"
  43 VALIGN="bottom"
  44 ><A
  45 HREF="a3632.html"
  46 ACCESSKEY="P"
  47 >Prev</A
  48 ></TD
  49 ><TD
  50 WIDTH="80%"
  51 ALIGN="center"
  52 VALIGN="bottom"
  53 ></TD
  54 ><TD
  55 WIDTH="10%"
  56 ALIGN="right"
  57 VALIGN="bottom"
  58 ><A
  59 HREF="g4153.html"
  60 ACCESSKEY="N"
  61 >Next</A
  62 ></TD
  63 ></TR
  64 ></TABLE
  65 ><HR
  66 ALIGN="LEFT"
  67 WIDTH="100%"></DIV
  68 ><DIV
  69 CLASS="appendix"
  70 ><H1
  71 ><A
  72 NAME="HDRWQ86"
  73 ></A
  74 >Appendix B. AFS Command Syntax and Online Help</H1
  75 ><P
  76 >The AFS commands available to you are used to authenticate, list AFS information, protect directories, create
  77     and manage groups, and create and manage ACLs. There are three general types of commands available to all AFS
  78     users: file server commands, protection server commands, and miscellaneous commands. This chapter discusses the
  79     syntax of these AFS commands, the rules that must be followed when issuing them, and ways of accessing help
  80     relevant to them.</P
  81 ><DIV
  82 CLASS="sect1"
  83 ><H1
  84 CLASS="sect1"
  85 ><A
  86 NAME="HDRWQ87"
  87 >AFS Command Syntax</A
  88 ></H1
  89 ><P
  90 >&#13;
  91  Most AFS commands use the following syntax:</P
  92 ><PRE
  93 CLASS="programlisting"
  94 >&#13;   <SPAN
  95 CLASS="bold"
  96 ><B
  97 CLASS="emphasis"
  98 >command_suite operation_code -switch</B
  99 ></SPAN
 100 > &#60;<VAR
 101 CLASS="replaceable"
 102 >value</VAR
 103 >&#62;<SUP
 104 >[+]</SUP
 105 >  <SPAN
 106 CLASS="bold"
 107 ><B
 108 CLASS="emphasis"
 109 >-flag</B
 110 ></SPAN
 111 >
 112 </PRE
 113 ><P
 114 >The <SPAN
 115 CLASS="emphasis"
 116 ><I
 117 CLASS="emphasis"
 118 >command suite</I
 119 ></SPAN
 120 > indicates the general type of command and the server process that
 121     performs the command. Regular AFS users have access to two main command suites and a miscellaneous set of commands:
 122
 123
 124
 125
 126 </P
 127 ><UL
 128 ><LI
 129 ><P
 130 >The <SPAN
 131 CLASS="bold"
 132 ><B
 133 CLASS="emphasis"
 134 >fs</B
 135 ></SPAN
 136 > command suite is used to issue file server commands that
 137       interact with the File Server process.</P
 138 ></LI
 139 ><LI
 140 ><P
 141 >The <SPAN
 142 CLASS="bold"
 143 ><B
 144 CLASS="emphasis"
 145 >pts</B
 146 ></SPAN
 147 > command suite is used to issue protection-related
 148       commands.</P
 149 ></LI
 150 ><LI
 151 ><P
 152 >The miscellaneous commands are not associated with any command suite.</P
 153 ></LI
 154 ></UL
 155 ><P
 156 >The <SPAN
 157 CLASS="emphasis"
 158 ><I
 159 CLASS="emphasis"
 160 >operation code</I
 161 ></SPAN
 162 > indicates the action that the command performs. Miscellaneous
 163     commands have operation codes only.
 164
 165 </P
 166 ><P
 167 >A command can have multiple <SPAN
 168 CLASS="emphasis"
 169 ><I
 170 CLASS="emphasis"
 171 >options</I
 172 ></SPAN
 173 >, which can be <SPAN
 174 CLASS="emphasis"
 175 ><I
 176 CLASS="emphasis"
 177 >arguments</I
 178 ></SPAN
 179 > or
 180     <SPAN
 181 CLASS="emphasis"
 182 ><I
 183 CLASS="emphasis"
 184 >flags</I
 185 ></SPAN
 186 >:</P
 187 ><UL
 188 ><LI
 189 ><P
 190 >Arguments are used to supply additional information for use by the command.
 191
 192
 193  They consist of a paired <SPAN
 194 CLASS="emphasis"
 195 ><I
 196 CLASS="emphasis"
 197 >switch</I
 198 ></SPAN
 199 > and <SPAN
 200 CLASS="emphasis"
 201 ><I
 202 CLASS="emphasis"
 203 >instance</I
 204 ></SPAN
 205 >.
 206
 207
 208
 209
 210  A switch defines the type of argument and is always preceded
 211       by a hyphen; arguments can take multiple instances if a plus sign (+) appears after the instance. An instance
 212       represents some variable piece of information that is used by the command. Arguments can be optional or
 213       required.</P
 214 ></LI
 215 ><LI
 216 ><P
 217 >Flags are used to direct a command to perform in a specific way (for example, to generate a
 218       specific type of output).
 219
 220  Flags are always preceded by a hyphen and are always
 221       optional.</P
 222 ></LI
 223 ></UL
 224 ><DIV
 225 CLASS="sect2"
 226 ><H2
 227 CLASS="sect2"
 228 ><A
 229 NAME="Header_169"
 230 >Command Syntax Example</A
 231 ></H2
 232 ><P
 233 >In the following AFS command</P
 234 ><PRE
 235 CLASS="programlisting"
 236 >&#13;   % <SPAN
 237 CLASS="bold"
 238 ><B
 239 CLASS="emphasis"
 240 >fs setacl -dir $HOME -acl pat all terry none -negative</B
 241 ></SPAN
 242 >
 243 </PRE
 244 ><UL
 245 ><LI
 246 ><P
 247 ><SPAN
 248 CLASS="bold"
 249 ><B
 250 CLASS="emphasis"
 251 >fs</B
 252 ></SPAN
 253 > is the command suite.</P
 254 ></LI
 255 ><LI
 256 ><P
 257 ><SPAN
 258 CLASS="bold"
 259 ><B
 260 CLASS="emphasis"
 261 >setacl</B
 262 ></SPAN
 263 > is the <SPAN
 264 CLASS="emphasis"
 265 ><I
 266 CLASS="emphasis"
 267 >operation code</I
 268 ></SPAN
 269 >, which directs
 270       the File Server process to set an access control list.</P
 271 ></LI
 272 ><LI
 273 ><P
 274 >&#13;        <SPAN
 275 CLASS="bold"
 276 ><B
 277 CLASS="emphasis"
 278 >-dir $HOME</B
 279 ></SPAN
 280 > and <SPAN
 281 CLASS="bold"
 282 ><B
 283 CLASS="emphasis"
 284 >-acl pat all terry none</B
 285 ></SPAN
 286 > are
 287         <SPAN
 288 CLASS="emphasis"
 289 ><I
 290 CLASS="emphasis"
 291 >arguments</I
 292 ></SPAN
 293 >.
 294         </P
 295 ><UL
 296 ><LI
 297 ><P
 298 ><SPAN
 299 CLASS="bold"
 300 ><B
 301 CLASS="emphasis"
 302 >-dir</B
 303 ></SPAN
 304 > and <SPAN
 305 CLASS="bold"
 306 ><B
 307 CLASS="emphasis"
 308 >-acl</B
 309 ></SPAN
 310 > are switches;
 311           <SPAN
 312 CLASS="bold"
 313 ><B
 314 CLASS="emphasis"
 315 >-dir</B
 316 ></SPAN
 317 > indicates the name of the directory on which to set the ACL, and
 318           <SPAN
 319 CLASS="bold"
 320 ><B
 321 CLASS="emphasis"
 322 >-acl</B
 323 ></SPAN
 324 > defines the entries to set on it.</P
 325 ></LI
 326 ><LI
 327 ><P
 328 ><SPAN
 329 CLASS="bold"
 330 ><B
 331 CLASS="emphasis"
 332 >$HOME</B
 333 ></SPAN
 334 > and <SPAN
 335 CLASS="bold"
 336 ><B
 337 CLASS="emphasis"
 338 >pat all terry
 339           none</B
 340 ></SPAN
 341 > are <SPAN
 342 CLASS="emphasis"
 343 ><I
 344 CLASS="emphasis"
 345 >instances</I
 346 ></SPAN
 347 > of the arguments. <SPAN
 348 CLASS="bold"
 349 ><B
 350 CLASS="emphasis"
 351 >$HOME</B
 352 ></SPAN
 353 >
 354           defines a specific directory for the directory argument. The <SPAN
 355 CLASS="bold"
 356 ><B
 357 CLASS="emphasis"
 358 >-acl</B
 359 ></SPAN
 360 > argument
 361           has two instances specifying two ACL entries: <SPAN
 362 CLASS="bold"
 363 ><B
 364 CLASS="emphasis"
 365 >pat all</B
 366 ></SPAN
 367 > and
 368           <SPAN
 369 CLASS="bold"
 370 ><B
 371 CLASS="emphasis"
 372 >terry none</B
 373 ></SPAN
 374 >.</P
 375 ></LI
 376 ></UL
 377 ></LI
 378 ><LI
 379 ><P
 380 ><SPAN
 381 CLASS="bold"
 382 ><B
 383 CLASS="emphasis"
 384 >-negative</B
 385 ></SPAN
 386 > is a flag; it directs the command to put the access
 387       list entries on the negative rather than the normal permissions list.</P
 388 ></LI
 389 ></UL
 390 ></DIV
 391 ></DIV
 392 ><DIV
 393 CLASS="sect1"
 394 ><H1
 395 CLASS="sect1"
 396 ><A
 397 NAME="HDRWQ88"
 398 >Rules for Using AFS Commands</A
 399 ></H1
 400 ><P
 401 >This section describes the rules to follow when using AFS commands.</P
 402 ><DIV
 403 CLASS="sect2"
 404 ><H2
 405 CLASS="sect2"
 406 ><A
 407 NAME="Header_171"
 408 >Spaces and Lines</A
 409 ></H2
 410 ><P
 411 >Separate each command element (command suite, operation code, switches, instances, and flags) with a space.
 412     Multiple instances of an argument are also separated by a space.</P
 413 ><P
 414 >Type all AFS commands on one line, followed by a carriage return. Some commands in this document appear on
 415     more than one line, but that is for legibility only.</P
 416 ></DIV
 417 ><DIV
 418 CLASS="sect2"
 419 ><H2
 420 CLASS="sect2"
 421 ><A
 422 NAME="Header_172"
 423 >Abbreviations and Aliases for Operation Codes</A
 424 ></H2
 425 ><P
 426 >You can type operation codes in one of three ways:</P
 427 ><UL
 428 ><LI
 429 ><P
 430 >You can type the operation code in full.</P
 431 ></LI
 432 ><LI
 433 ><P
 434 >You can abbreviate the operation code to the shortest form that distinguishes it from the other
 435       operation codes in its command suite.</P
 436 ></LI
 437 ><LI
 438 ><P
 439 >You can use the alias for the operation code, if one exists.</P
 440 ></LI
 441 ></UL
 442 ><P
 443 >For example, the <SPAN
 444 CLASS="bold"
 445 ><B
 446 CLASS="emphasis"
 447 >fs listacl</B
 448 ></SPAN
 449 > command can be issued as follows:</P
 450 ><UL
 451 ><LI
 452 ><P
 453 ><SPAN
 454 CLASS="bold"
 455 ><B
 456 CLASS="emphasis"
 457 >fs listacl</B
 458 ></SPAN
 459 > (full command)</P
 460 ></LI
 461 ><LI
 462 ><P
 463 ><SPAN
 464 CLASS="bold"
 465 ><B
 466 CLASS="emphasis"
 467 >fs lista</B
 468 ></SPAN
 469 > (abbreviation)</P
 470 ></LI
 471 ><LI
 472 ><P
 473 ><SPAN
 474 CLASS="bold"
 475 ><B
 476 CLASS="emphasis"
 477 >fs la</B
 478 ></SPAN
 479 > (alias)</P
 480 ></LI
 481 ></UL
 482 ><P
 483 >The <SPAN
 484 CLASS="emphasis"
 485 ><I
 486 CLASS="emphasis"
 487 >IBM AFS Administration Reference</I
 488 ></SPAN
 489 > provides information on the full and abbreviated
 490     command syntax as well as any aliases for all of the commands discussed in this guide.</P
 491 ></DIV
 492 ><DIV
 493 CLASS="sect2"
 494 ><H2
 495 CLASS="sect2"
 496 ><A
 497 NAME="Header_173"
 498 >Omitting Argument Switches</A
 499 ></H2
 500 ><P
 501 >You can omit an argument's switch if the command takes only one argument, or if the following conditions are
 502     met.</P
 503 ><UL
 504 ><LI
 505 ><P
 506 >All of the command's required arguments appear in the order prescribed by the syntax
 507       statement.</P
 508 ></LI
 509 ><LI
 510 ><P
 511 >No switches are used on any arguments, even if they are in the correct order.</P
 512 ></LI
 513 ><LI
 514 ><P
 515 >There is only one value for each argument. The important exception to this condition is if the
 516       final required argument accepts multiple values; in this case, it is acceptable to provide multiple values
 517       without providing the switch.</P
 518 ></LI
 519 ></UL
 520 ><P
 521 >For example, the following two commands are equivalent:</P
 522 ><PRE
 523 CLASS="programlisting"
 524 >&#13;   % <SPAN
 525 CLASS="bold"
 526 ><B
 527 CLASS="emphasis"
 528 >fs setacl -dir /afs/abc.com/usr/terry/private -acl pat rl</B
 529 ></SPAN
 530 >
 531    % <SPAN
 532 CLASS="bold"
 533 ><B
 534 CLASS="emphasis"
 535 >fs setacl /afs/abc.com/usr/terry/private pat rl</B
 536 ></SPAN
 537 >
 538 </PRE
 539 ><P
 540 >However, the following is not an acceptable short form because the arguments are not in the prescribed
 541     order:</P
 542 ><PRE
 543 CLASS="programlisting"
 544 >&#13;   % <SPAN
 545 CLASS="bold"
 546 ><B
 547 CLASS="emphasis"
 548 >fs setacl -acl pat rl /afs/abc.com/usr/terry/private</B
 549 ></SPAN
 550 >
 551 </PRE
 552 ></DIV
 553 ><DIV
 554 CLASS="sect2"
 555 ><H2
 556 CLASS="sect2"
 557 ><A
 558 NAME="Header_174"
 559 >Shortening Switches and Flags</A
 560 ></H2
 561 ><P
 562 >&#13;
 563  If you are required to use a switch, or if you decide to use a flag, you can often
 564     shorten the name of that switch or flag provided that the shortened form still distinguishes it from the command's
 565     other flags and switches.</P
 566 ><P
 567 >For example, when you issue the <SPAN
 568 CLASS="bold"
 569 ><B
 570 CLASS="emphasis"
 571 >fs setacl</B
 572 ></SPAN
 573 > command, you can abbreviate all of
 574     the switches and flags of the command to their initial letter because they all begin with a different letter.
 575     However, when you issue the <SPAN
 576 CLASS="bold"
 577 ><B
 578 CLASS="emphasis"
 579 >knfs</B
 580 ></SPAN
 581 > command, the
 582     <SPAN
 583 CLASS="bold"
 584 ><B
 585 CLASS="emphasis"
 586 >-host</B
 587 ></SPAN
 588 > argument and <SPAN
 589 CLASS="bold"
 590 ><B
 591 CLASS="emphasis"
 592 >-help</B
 593 ></SPAN
 594 > flag both begin with the
 595     letter <SPAN
 596 CLASS="bold"
 597 ><B
 598 CLASS="emphasis"
 599 >h</B
 600 ></SPAN
 601 >, so the shortest unambiguous abbreviations are
 602     <SPAN
 603 CLASS="bold"
 604 ><B
 605 CLASS="emphasis"
 606 >-ho</B
 607 ></SPAN
 608 > and <SPAN
 609 CLASS="bold"
 610 ><B
 611 CLASS="emphasis"
 612 >-he</B
 613 ></SPAN
 614 > respectively.</P
 615 ></DIV
 616 ><DIV
 617 CLASS="sect2"
 618 ><H2
 619 CLASS="sect2"
 620 ><A
 621 NAME="Header_175"
 622 >Shortening Directory References</A
 623 ></H2
 624 ><P
 625 >&#13;
 626  Most AFS command arguments that require directory or pathnames instances accept one
 627     or more of the following short forms:</P
 628 ><UL
 629 ><LI
 630 ><P
 631 >A single period (<SPAN
 632 CLASS="bold"
 633 ><B
 634 CLASS="emphasis"
 635 >.</B
 636 ></SPAN
 637 >) indicates the current working
 638       directory.</P
 639 ></LI
 640 ><LI
 641 ><P
 642 >Two periods (<SPAN
 643 CLASS="bold"
 644 ><B
 645 CLASS="emphasis"
 646 >..</B
 647 ></SPAN
 648 >) indicate the parent directory of the current
 649       working directory.</P
 650 ></LI
 651 ><LI
 652 ><P
 653 >The $HOME environment variable indicates the issuer's home directory.</P
 654 ></LI
 655 ></UL
 656 ><P
 657 >For example, if the user <SPAN
 658 CLASS="bold"
 659 ><B
 660 CLASS="emphasis"
 661 >terry</B
 662 ></SPAN
 663 > wants to grant
 664     <SPAN
 665 CLASS="bold"
 666 ><B
 667 CLASS="emphasis"
 668 >r</B
 669 ></SPAN
 670 > (<SPAN
 671 CLASS="bold"
 672 ><B
 673 CLASS="emphasis"
 674 >read</B
 675 ></SPAN
 676 >) and <SPAN
 677 CLASS="bold"
 678 ><B
 679 CLASS="emphasis"
 680 >l</B
 681 ></SPAN
 682 >
 683     (<SPAN
 684 CLASS="bold"
 685 ><B
 686 CLASS="emphasis"
 687 >lookup</B
 688 ></SPAN
 689 >) permissions on his home directory to his manager
 690     <SPAN
 691 CLASS="bold"
 692 ><B
 693 CLASS="emphasis"
 694 >pat</B
 695 ></SPAN
 696 >, <SPAN
 697 CLASS="bold"
 698 ><B
 699 CLASS="emphasis"
 700 >terry</B
 701 ></SPAN
 702 > can issue the following
 703     command.</P
 704 ><PRE
 705 CLASS="programlisting"
 706 >&#13;   % <SPAN
 707 CLASS="bold"
 708 ><B
 709 CLASS="emphasis"
 710 >fs setacl -dir $HOME -acl pat rl</B
 711 ></SPAN
 712 >
 713 </PRE
 714 ><P
 715 >If the current working directory is <SPAN
 716 CLASS="bold"
 717 ><B
 718 CLASS="emphasis"
 719 >terry</B
 720 ></SPAN
 721 >'s home directory, he can issue the
 722     following command.</P
 723 ><PRE
 724 CLASS="programlisting"
 725 >&#13;   % <SPAN
 726 CLASS="bold"
 727 ><B
 728 CLASS="emphasis"
 729 >fs setacl -dir  .  -acl pat rl</B
 730 ></SPAN
 731 >
 732 </PRE
 733 ><P
 734 >Both of the previous examples are acceptable short forms for the following command:</P
 735 ><PRE
 736 CLASS="programlisting"
 737 >&#13;   % <SPAN
 738 CLASS="bold"
 739 ><B
 740 CLASS="emphasis"
 741 >fs setacl -dir /afs/abc.com/usr/terry -acl pat rl</B
 742 ></SPAN
 743 >
 744 </PRE
 745 ></DIV
 746 ></DIV
 747 ><DIV
 748 CLASS="sect1"
 749 ><H1
 750 CLASS="sect1"
 751 ><A
 752 NAME="Header_176"
 753 >Commonly Used fs and pts Commands</A
 754 ></H1
 755 ><P
 756 >This section provides additional information on the commonly used AFS <SPAN
 757 CLASS="bold"
 758 ><B
 759 CLASS="emphasis"
 760 >fs</B
 761 ></SPAN
 762 > and
 763     <SPAN
 764 CLASS="bold"
 765 ><B
 766 CLASS="emphasis"
 767 >pts</B
 768 ></SPAN
 769 > commands. For more detailed information, see the <SPAN
 770 CLASS="emphasis"
 771 ><I
 772 CLASS="emphasis"
 773 >IBM AFS
 774     Administration Reference</I
 775 ></SPAN
 776 >.</P
 777 ><DIV
 778 CLASS="sect2"
 779 ><H2
 780 CLASS="sect2"
 781 ><A
 782 NAME="Header_177"
 783 >About the fs Commands</A
 784 ></H2
 785 ><P
 786 >Some <SPAN
 787 CLASS="bold"
 788 ><B
 789 CLASS="emphasis"
 790 >fs</B
 791 ></SPAN
 792 > commands extend UNIX file system semantics by invoking file-related
 793     functions that UNIX does not provide (setting access control lists, for example). Other
 794     <SPAN
 795 CLASS="bold"
 796 ><B
 797 CLASS="emphasis"
 798 >fs</B
 799 ></SPAN
 800 > commands help you control the performance of the Cache Manager running on your
 801     local client machine.
 802
 803
 804
 805 </P
 806 ><P
 807 >All <SPAN
 808 CLASS="bold"
 809 ><B
 810 CLASS="emphasis"
 811 >fs</B
 812 ></SPAN
 813 > commands accept the optional <SPAN
 814 CLASS="bold"
 815 ><B
 816 CLASS="emphasis"
 817 >-help</B
 818 ></SPAN
 819 >
 820     flag. It has the same function as the <SPAN
 821 CLASS="bold"
 822 ><B
 823 CLASS="emphasis"
 824 >fs help</B
 825 ></SPAN
 826 > command: it prints a command's
 827     online help message on the screen. Do not provide other options at the same time as this flag. It overrides them,
 828     and the only effect of issuing the command is to display the help message.
 829
 830 </P
 831 ><P
 832 >The privilege required for issuing <SPAN
 833 CLASS="bold"
 834 ><B
 835 CLASS="emphasis"
 836 >fs</B
 837 ></SPAN
 838 > commands varies. The necessary
 839     privileges for the <SPAN
 840 CLASS="bold"
 841 ><B
 842 CLASS="emphasis"
 843 >fs</B
 844 ></SPAN
 845 > commands described in this guide include the
 846     following:</P
 847 ><UL
 848 ><LI
 849 ><P
 850 >Having certain permissions on a directory's access control list. For example, creating and
 851       removing mount points requires <SPAN
 852 CLASS="bold"
 853 ><B
 854 CLASS="emphasis"
 855 >a</B
 856 ></SPAN
 857 > (<SPAN
 858 CLASS="bold"
 859 ><B
 860 CLASS="emphasis"
 861 >administer</B
 862 ></SPAN
 863 >),
 864       <SPAN
 865 CLASS="bold"
 866 ><B
 867 CLASS="emphasis"
 868 >i</B
 869 ></SPAN
 870 > (<SPAN
 871 CLASS="bold"
 872 ><B
 873 CLASS="emphasis"
 874 >insert</B
 875 ></SPAN
 876 >), and
 877       <SPAN
 878 CLASS="bold"
 879 ><B
 880 CLASS="emphasis"
 881 >d</B
 882 ></SPAN
 883 > (<SPAN
 884 CLASS="bold"
 885 ><B
 886 CLASS="emphasis"
 887 >delete</B
 888 ></SPAN
 889 >) permissions for the directory in
 890       which the mount point resides.</P
 891 ></LI
 892 ><LI
 893 ><P
 894 >Belonging to the <SPAN
 895 CLASS="bold"
 896 ><B
 897 CLASS="emphasis"
 898 >system:administrators</B
 899 ></SPAN
 900 > group (see
 901       <A
 902 HREF="c1444.html#HDRWQ50"
 903 >Using the System Groups on ACLs</A
 904 >).</P
 905 ></LI
 906 ><LI
 907 ><P
 908 >No privilege. Many <SPAN
 909 CLASS="bold"
 910 ><B
 911 CLASS="emphasis"
 912 >fs</B
 913 ></SPAN
 914 > commands simply list information and so do
 915       not require any special privilege.</P
 916 ></LI
 917 ></UL
 918 ></DIV
 919 ><DIV
 920 CLASS="sect2"
 921 ><H2
 922 CLASS="sect2"
 923 ><A
 924 NAME="Header_178"
 925 >About the pts Commands</A
 926 ></H2
 927 ><P
 928 >The <SPAN
 929 CLASS="bold"
 930 ><B
 931 CLASS="emphasis"
 932 >pts</B
 933 ></SPAN
 934 > command suite is the interface through which you can create
 935     protection groups and add members to them. System administrators who belong to a special system group called
 936     <SPAN
 937 CLASS="bold"
 938 ><B
 939 CLASS="emphasis"
 940 >system:administrators</B
 941 ></SPAN
 942 > group can manipulate any group, and also create the user and
 943     machine entries that can belong to groups. Users who do not belong to the
 944     <SPAN
 945 CLASS="bold"
 946 ><B
 947 CLASS="emphasis"
 948 >system:administrators</B
 949 ></SPAN
 950 > group can always list the information associated with the
 951     group entries they own, as well as their own user entries. Depending on the setting of an entry's privacy flags,
 952     regular users can sometimes access and manipulate group entries in certain ways.</P
 953 ><P
 954 >All <SPAN
 955 CLASS="bold"
 956 ><B
 957 CLASS="emphasis"
 958 >pts</B
 959 ></SPAN
 960 > commands accept optional arguments and flags. They are listed in the
 961     command descriptions in the <SPAN
 962 CLASS="emphasis"
 963 ><I
 964 CLASS="emphasis"
 965 >IBM AFS Administration Reference</I
 966 ></SPAN
 967 > and are described here in
 968     detail:</P
 969 ><DIV
 970 CLASS="variablelist"
 971 ><DL
 972 ><DT
 973 ><SPAN
 974 CLASS="bold"
 975 ><B
 976 CLASS="emphasis"
 977 >[-cell &#60;<VAR
 978 CLASS="replaceable"
 979 >cell name</VAR
 980 >&#62;]</B
 981 ></SPAN
 982 ></DT
 983 ><DD
 984 ><P
 985 >&#13;        This argument indicates that the command runs in the indicated cell. The issuer can abbreviate the
 986         <VAR
 987 CLASS="replaceable"
 988 >cell name</VAR
 989 > value to the shortest form that distinguishes it from the other cells
 990         listed in the <SPAN
 991 CLASS="bold"
 992 ><B
 993 CLASS="emphasis"
 994 >/usr/vice/etc/CellServDB</B
 995 ></SPAN
 996 > file on the client machine on which the
 997         command is issued. By default, commands are executed in the local cell as defined
 998         </P
 999 ><UL
1000 ><LI
1001 ><P
1002 >First, by the value of the environment variable AFSCELL. (This variable is normally not
1003           defined by default. If you are working in another, nonlocal cell for an extended period of time, you can set
1004           the variable to the name of that cell.)</P
1005 ></LI
1006 ><LI
1007 ><P
1008 >Second, in the <SPAN
1009 CLASS="bold"
1010 ><B
1011 CLASS="emphasis"
1012 >/usr/vice/etc/ThisCell</B
1013 ></SPAN
1014 > file on the client
1015           machine on which the command is issued.</P
1016 ></LI
1017 ></UL
1018 ></DD
1019 ></DL
1020 ></DIV
1021 ><DIV
1022 CLASS="variablelist"
1023 ><DL
1024 ><DT
1025 ><SPAN
1026 CLASS="bold"
1027 ><B
1028 CLASS="emphasis"
1029 >[-force]</B
1030 ></SPAN
1031 ></DT
1032 ><DD
1033 ><P
1034 >This flag directs the <SPAN
1035 CLASS="bold"
1036 ><B
1037 CLASS="emphasis"
1038 >pts</B
1039 ></SPAN
1040 > command interpreter to continue
1041       executing the command, if possible, even if it encounters problems during the command's execution.
1042
1043
1044  The command interpreter performs as much of the requested operation as possible, rather
1045       than halting if it encounters a problem. The command interpreter reports any errors it encounters during the
1046       command's execution. This flag is especially useful if you provide many instances for an argument; if one of the
1047       instances is invalid, the command reports the error and proceeds with the remaining
1048       arguments.</P
1049 ></DD
1050 ></DL
1051 ></DIV
1052 ><DIV
1053 CLASS="variablelist"
1054 ><DL
1055 ><DT
1056 ><SPAN
1057 CLASS="bold"
1058 ><B
1059 CLASS="emphasis"
1060 >[-help]
1061
1062
1063
1064
1065 </B
1066 ></SPAN
1067 ></DT
1068 ><DD
1069 ><P
1070 >This flag has the same function as the <SPAN
1071 CLASS="bold"
1072 ><B
1073 CLASS="emphasis"
1074 >pts help</B
1075 ></SPAN
1076 > command: it
1077       prints the command's online help message on the screen. Do not provide other options at the same time as this
1078       flag. It overrides them, and the only effect of issuing the command is to display the help
1079       message.</P
1080 ></DD
1081 ></DL
1082 ></DIV
1083 ></DIV
1084 ></DIV
1085 ><DIV
1086 CLASS="sect1"
1087 ><H1
1088 CLASS="sect1"
1089 ><A
1090 NAME="HDRWQ89"
1091 >Getting Help in AFS</A
1092 ></H1
1093 ><P
1094 >AFS online help consists of basic syntax messages. The AFS distribution also includes help in HTML format
1095     which your system administrator can make available to you.</P
1096 ><DIV
1097 CLASS="sect2"
1098 ><H2
1099 CLASS="sect2"
1100 ><A
1101 NAME="Header_180"
1102 >Displaying Command Syntax and Aliases</A
1103 ></H2
1104 ><P
1105 >To display a brief description of a command, its syntax statement, and alias if any, use the
1106     <SPAN
1107 CLASS="bold"
1108 ><B
1109 CLASS="emphasis"
1110 >help</B
1111 ></SPAN
1112 > operation code. For example, to display the online help entry for the
1113     <SPAN
1114 CLASS="bold"
1115 ><B
1116 CLASS="emphasis"
1117 >fs listacl</B
1118 ></SPAN
1119 > command, enter the following command:</P
1120 ><PRE
1121 CLASS="programlisting"
1122 >&#13;   % <SPAN
1123 CLASS="bold"
1124 ><B
1125 CLASS="emphasis"
1126 >fs help listacl</B
1127 ></SPAN
1128 >
1129    fs listacl: list access control list
1130    aliases: la
1131    Usage: fs listacl  [-path &#60;dir/file path&#62;+]  [-id] [-if] [-help]
1132 </PRE
1133 ><P
1134 >To display the syntax statement only, use the <SPAN
1135 CLASS="bold"
1136 ><B
1137 CLASS="emphasis"
1138 >-help</B
1139 ></SPAN
1140 > flag, which is available
1141     on most AFS commands. For example, to display the syntax statement for the <SPAN
1142 CLASS="bold"
1143 ><B
1144 CLASS="emphasis"
1145 >fs
1146     setacl</B
1147 ></SPAN
1148 > command, enter the following command:</P
1149 ><PRE
1150 CLASS="programlisting"
1151 >&#13;   % <SPAN
1152 CLASS="bold"
1153 ><B
1154 CLASS="emphasis"
1155 >fs setacl -help</B
1156 ></SPAN
1157 >
1158    Usage: fs setacl -dir &#60;directory&#62;+ -acl &#60;access list entries&#62;+ [-clear] [-negative]
1159    [-id] [-if] [-help]
1160 </PRE
1161 ></DIV
1162 ><DIV
1163 CLASS="sect2"
1164 ><H2
1165 CLASS="sect2"
1166 ><A
1167 NAME="Header_181"
1168 >Displaying Operation Code Descriptions</A
1169 ></H2
1170 ><P
1171 >To display a short description of all of a command suite's operation codes, issue the
1172     <SPAN
1173 CLASS="bold"
1174 ><B
1175 CLASS="emphasis"
1176 >help</B
1177 ></SPAN
1178 > operation code without any other arguments. For example, the
1179     <SPAN
1180 CLASS="bold"
1181 ><B
1182 CLASS="emphasis"
1183 >fs help</B
1184 ></SPAN
1185 > command displays a short description of every operation code in the
1186     <SPAN
1187 CLASS="bold"
1188 ><B
1189 CLASS="emphasis"
1190 >fs</B
1191 ></SPAN
1192 > command suite.
1193
1194 </P
1195 ><P
1196 >To display a list of the commands in a command suite that concern a certain type of object, provide a
1197     relevant keyword argument to the <SPAN
1198 CLASS="bold"
1199 ><B
1200 CLASS="emphasis"
1201 >apropos</B
1202 ></SPAN
1203 > operation code. For example, if you want
1204     to set an ACL but cannot remember which <SPAN
1205 CLASS="bold"
1206 ><B
1207 CLASS="emphasis"
1208 >fs</B
1209 ></SPAN
1210 > command to use, issue the following
1211     command:</P
1212 ><PRE
1213 CLASS="programlisting"
1214 >&#13;   % <SPAN
1215 CLASS="bold"
1216 ><B
1217 CLASS="emphasis"
1218 >fs apropos set</B
1219 ></SPAN
1220 >
1221    setacl: set access control list
1222    setcachesize: set cache size
1223    setcell: set cell status
1224    setclientaddrs: set client network interface addresses
1225    setquota: set volume quota
1226    setserverprefs: set file server ranks
1227    setvol: set volume status
1228    sysname: get/set sysname (i.e. @sys) value
1229 </PRE
1230 ><P
1231 >The following message indicates that there are no commands whose names or descriptions include the keyword
1232     string you have provided:</P
1233 ><PRE
1234 CLASS="programlisting"
1235 >&#13;   Sorry, no commands found
1236 </PRE
1237 ><DIV
1238 CLASS="note"
1239 ><BLOCKQUOTE
1240 CLASS="note"
1241 ><P
1242 ><B
1243 >Note: </B
1244 >If the keyword you provide has spaces in it, enclose it in double quotes (<SPAN
1245 CLASS="bold"
1246 ><B
1247 CLASS="emphasis"
1248 >"
1249         "</B
1250 ></SPAN
1251 >).</P
1252 ></BLOCKQUOTE
1253 ></DIV
1254 ></DIV
1255 ></DIV
1256 ></DIV
1257 ><DIV
1258 CLASS="NAVFOOTER"
1259 ><HR
1260 ALIGN="LEFT"
1261 WIDTH="100%"><TABLE
1262 SUMMARY="Footer navigation table"
1263 WIDTH="100%"
1264 BORDER="0"
1265 CELLPADDING="0"
1266 CELLSPACING="0"
1267 ><TR
1268 ><TD
1269 WIDTH="33%"
1270 ALIGN="left"
1271 VALIGN="top"
1272 ><A
1273 HREF="a3632.html"
1274 ACCESSKEY="P"
1275 >Prev</A
1276 ></TD
1277 ><TD
1278 WIDTH="34%"
1279 ALIGN="center"
1280 VALIGN="top"
1281 ><A
1282 HREF="book1.html"
1283 ACCESSKEY="H"
1284 >Home</A
1285 ></TD
1286 ><TD
1287 WIDTH="33%"
1288 ALIGN="right"
1289 VALIGN="top"
1290 ><A
1291 HREF="g4153.html"
1292 ACCESSKEY="N"
1293 >Next</A
1294 ></TD
1295 ></TR
1296 ><TR
1297 ><TD
1298 WIDTH="33%"
1299 ALIGN="left"
1300 VALIGN="top"
1301 >Using the NFS/AFS Translator</TD
1302 ><TD
1303 WIDTH="34%"
1304 ALIGN="center"
1305 VALIGN="top"
1306 >&nbsp;</TD
1307 ><TD
1308 WIDTH="33%"
1309 ALIGN="right"
1310 VALIGN="top"
1311 >Glossary</TD
1312 ></TR
1313 ></TABLE
1314 ></DIV
1315 ></BODY
1316 ></HTML
1317 >