doc/man-pages/pod1/package.pod

   1 =head1 NAME
   2
   3 package - Configures files and directories on the local disk
   4
   5 =head1 SYNOPSIS
   6
   7 B<package> [B<initcmd>]  [-config <I<base name of configuration file>>]
   8 [B<-fullconfig> <I<full name of configuration file, or stdin for standard input>>]
   9    [B<-overwrite>]  [B<-noaction>]  [B<-verbose>]  [B<-silent>]  [-rebootfiles]
  10    [B<-debug>]  [-help]
  11
  12 B<package> [B<i>]  [-c <I<base name of configuration file>>]
  13 [B<-f> <I<full name of configuration file, or stdin for standard input>>]
  14         [B<-o>]  [B<-n>]  [B<-v>]  [B<-s>]  [B<-r>]  [B<-d>]  [-h]
  15
  16 =head1 DESCRIPTION
  17
  18 The package command configures the machine's local disk to
  19 comply with the instructions in the configuration file named by the
  20 B<-config> or B<-fullconfig> argument.
  21
  22 By default, the package command alters any existing local disk
  23 element whose contents or configuration does not match the element defined in
  24 the configuration file. For example, if a configuration file
  25 B<D> instruction defines a directory that has the same name as a
  26 symbolic link on the local disk, the B<package> command replaces the
  27 symbolic link with the directory. The B<F> and B<L>
  28 instructions include an optional I<update_code> field that alters this
  29 behavior.
  30
  31 Also by default, the package command takes no action on elements
  32 on the local disk that are not mentioned in the configuration file. Use
  33 the B<D> instruction's B<R> update code to remove files
  34 from the disk directory that are not mentioned in the configuration
  35 file.
  36
  37 Before running the package command, the administrator must
  38 create the template file and other files on the local disk. For
  39 instructions, see the I<IBM AFS Administration Guide>.
  40
  41 It is not possible to configure a remote client machine's disk using
  42 this command.
  43
  44 =head1 CAVEATS
  45
  46 The package command interpreter exits without executing any
  47 instruction if there are any syntax errors or incorrect values in the
  48 configuration file.
  49
  50 =head1 OPTIONS
  51
  52 =over 4
  53
  54 =item initcmd
  55
  56 Accommodates the command's use of the AFS command parser, and is
  57 optional.
  58
  59 =item -config
  60
  61 Specifies the pathname of the configuration file to use, ending in the
  62 file's base name, which omits the suffix that indicates the machine
  63 type. The B<package> command determines the machine's
  64 system type name and automatically appends it to the base name. An
  65 example of the proper value for this argument is B<staff> rather than
  66 B<staff.rs_aix42>. Partial pathnames are interpreted
  67 relative to the current working directory.
  68
  69 Provide this argument or the -fullconfig argument.
  70
  71 =item -fullconfig
  72
  73 Specifies the configuration file to use. Two types of values are
  74 acceptable:
  75
  76 =over 4
  77
  78 =item *
  79
  80 The full pathname of the configuration file to use, complete with an
  81 extension indicating the machine type (examples:
  82 B<staff.rs_aix42>, B<admin.sun4x_56>).
  83
  84
  85 =item *
  86
  87 The string stdin to indicate that the issuer is providing
  88 configuration information via the standard input stream, either by piping in
  89 the contents of a file, or by typing configuration lines at the shell.
  90 In the latter case, type B<<Ctrl-d>> to conclude the input.
  91
  92
  93 =back
  94
  95 Provide this argument or the -config argument.
  96
  97 =item -overwrite
  98
  99 Overwrites elements on the local disk with the source version indicated in
 100 the configuration file, even if the owner B<write> (B<w>) mode
 101 bit is turned on the disk element. Files protected by the B<I>
 102 update code on an B<F> line in the configuration file are not
 103 overwritten.
 104
 105 =item -noaction
 106
 107 Checks the sequence of operations to be performed when the command
 108 actually runs and reports any problems that the B<package> command
 109 interpreter expects to encounter. No elements on the local disk or in
 110 AFS are changed. If the B<-verbose> flag is also provided, the
 111 trace includes all actions to be performed as well as anticipated
 112 errors.
 113
 114 =item -silent
 115
 116 Suppresses some of the trace messages sent to the standard output stream
 117 by default. The output still reports major problems.
 118
 119 =item -verbose
 120
 121 Produces on the standard output stream a detailed trace of the
 122 command's execution. If this argument is omitted, only warnings
 123 and error messages appear.
 124
 125 =item -rebootfiles
 126
 127 Prevents overwriting of any file marked with the Q update code
 128 on an B<F> line in the configuration file. This effectively
 129 prevents the machine from rebooting automatically again when the
 130 B<package> command is invoked in the machine's AFS initialization
 131 file.
 132
 133 =item -debug
 134
 135 Enables debugging output, which is directed to the standard output stream
 136 by default. By default, no debugging output is produced.
 137
 138 =item -help
 139
 140 Prints the online help for this command. All other valid options
 141 are ignored.
 142
 143 =back
 144
 145 =head1 EXAMPLES
 146
 147 This command is usually invoked in a client machine's AFS
 148 initialization file (B</etc/rc> or equivalent), rather than issued at
 149 the command shell prompt.
 150
 151 The following command invokes the version of the staff
 152 configuration file appropriate for this machine's system type, and
 153 produces verbose output.
 154
 155    # /etc/package -c staff -v
 156
 157 The following example uses the configuration file whose basename is defined
 158 in the B</.package> file on the local machine. This
 159 method enables the administrator to use the same B<package> command in
 160 every machine's AFS initialization file but still customize configuration
 161 by putting the appropriate basename in the B</.package>
 162 file.
 163
 164    # /etc/package -c `cat /.package` -v
 165
 166 =head1 PRIVILEGE REQUIRED
 167
 168 The issuer must be logged in as the local superuser root.
 169
 170 =head1 SEE ALSO
 171
 172 L<package Configuration File(1)>
 173
 174 =head1 COPYRIGHT
 175
 176 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 177
 178 This documentation is covered by the IBM Public License Version 1.0.  It was
 179 converted from HTML to POD by software written by Chas Williams and Russ
 180 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.