initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf204.htm
diff --git a/doc/html/AdminReference/auarf204.htm b/doc/html/AdminReference/auarf204.htm
new file mode 100644 (file)
index 0000000..c6e14b2
--- /dev/null
@@ -0,0 +1,155 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
+<HTML><HEAD>
+<TITLE>Administration Reference</TITLE>
+<!-- Begin Header Records  ========================================== -->
+<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
+<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
+<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
+<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
+<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
+</HEAD><BODY>
+<!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
+<BODY bgcolor="ffffff"> 
+<!-- End Header Records  ============================================ -->
+<A NAME="Top_Of_Page"></A>
+<H1>Administration Reference</H1>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf203.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf205.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<P>
+<H2><A NAME="HDRPACKAGE" HREF="auarf002.htm#ToC_218">package</A></H2>
+<A NAME="IDX5197"></A>
+<A NAME="IDX5198"></A>
+<A NAME="IDX5199"></A>
+<A NAME="IDX5200"></A>
+<A NAME="IDX5201"></A>
+<A NAME="IDX5202"></A>
+<A NAME="IDX5203"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Configures files and directories on the local disk
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>package</B> [<B>initcmd</B>]  [<B>-config</B> &lt;<VAR>base&nbsp;name&nbsp;of&nbsp;configuration file</VAR>>]
+   [<B>-fullconfig</B> &lt;<VAR>full&nbsp;name&nbsp;of&nbsp;configuration&nbsp;file,&nbsp;or&nbsp;stdin&nbsp;for&nbsp;standard&nbsp;input</VAR>>]
+   [<B>-overwrite</B>]  [<B>-noaction</B>]  [<B>-verbose</B>]  [<B>-silent</B>]  [<B>-rebootfiles</B>]  
+   [<B>-debug</B>]  [<B>-help</B>]
+    
+<B>package</B> [<B>i</B>]  [<B>-c</B> &lt;<VAR>base&nbsp;name&nbsp;of&nbsp;configuration file</VAR>>]
+        [<B>-f</B> &lt;<VAR>full&nbsp;name&nbsp;of&nbsp;configuration&nbsp;file,&nbsp;or&nbsp;stdin&nbsp;for&nbsp;standard&nbsp;input</VAR>>]
+        [<B>-o</B>]  [<B>-n</B>]  [<B>-v</B>]  [<B>-s</B>]  [<B>-r</B>]  [<B>-d</B>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>package</B> command configures the machine's local disk to
+comply with the instructions in the configuration file named by the
+<B>-config</B> or <B>-fullconfig</B> argument.
+<P>By default, the <B>package</B> command alters any existing local disk
+element whose contents or configuration does not match the element defined in
+the configuration file. For example, if a configuration file
+<B>D</B> instruction defines a directory that has the same name as a
+symbolic link on the local disk, the <B>package</B> command replaces the
+symbolic link with the directory. The <B>F</B> and <B>L</B>
+instructions include an optional <VAR>update_code</VAR> field that alters this
+behavior.
+<P>Also by default, the <B>package</B> command takes no action on elements
+on the local disk that are not mentioned in the configuration file. Use
+the <B>D</B> instruction's <B>R</B> update code to remove files
+from the disk directory that are not mentioned in the configuration
+file.
+<P>Before running the <B>package</B> command, the administrator must
+create the template file and other files on the local disk. For
+instructions, see the <I>IBM AFS Administration Guide</I>.
+<P>It is not possible to configure a remote client machine's disk using
+this command.
+<P><STRONG>Cautions</STRONG>
+<P>The <B>package</B> command interpreter exits without executing any
+instruction if there are any syntax errors or incorrect values in the
+configuration file.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B>initcmd
+</B><DD>Accommodates the command's use of the AFS command parser, and is
+optional.
+<P><DT><B>-config
+</B><DD>Specifies the pathname of the configuration file to use, ending in the
+file's base name, which omits the suffix that indicates the machine
+type. The <B>package</B> command determines the machine's
+system type name and automatically appends it to the base name. An
+example of the proper value for this argument is <B>staff</B> rather than
+<B>staff.rs_aix42</B>. Partial pathnames are interpreted
+relative to the current working directory.
+<P>Provide this argument or the <B>-fullconfig</B> argument.
+<P><DT><B>-fullconfig
+</B><DD>Specifies the configuration file to use. Two types of values are
+acceptable: 
+<UL>
+<P><LI>The full pathname of the configuration file to use, complete with an
+extension indicating the machine type (examples:
+<B>staff.rs_aix42</B>, <B>admin.sun4x_56</B>).
+<P><LI>The string <B>stdin</B> to indicate that the issuer is providing
+configuration information via the standard input stream, either by piping in
+the contents of a file, or by typing configuration lines at the shell.
+In the latter case, type <B>&lt;Ctrl-d></B> to conclude the input.
+</UL>
+<P>Provide this argument or the <B>-config</B> argument.
+<P><DT><B>-overwrite
+</B><DD>Overwrites elements on the local disk with the source version indicated in
+the configuration file, even if the owner <B>write</B> (<B>w</B>) mode
+bit is turned on the disk element. Files protected by the <B>I</B>
+update code on an <B>F</B> line in the configuration file are not
+overwritten.
+<P><DT><B>-noaction
+</B><DD>Checks the sequence of operations to be performed when the command
+actually runs and reports any problems that the <B>package</B> command
+interpreter expects to encounter. No elements on the local disk or in
+AFS are changed. If the <B>-verbose</B> flag is also provided, the
+trace includes all actions to be performed as well as anticipated
+errors.
+<P><DT><B>-silent
+</B><DD>Suppresses some of the trace messages sent to the standard output stream
+by default. The output still reports major problems.
+<P><DT><B>-verbose
+</B><DD>Produces on the standard output stream a detailed trace of the
+command's execution. If this argument is omitted, only warnings
+and error messages appear.
+<P><DT><B>-rebootfiles
+</B><DD>Prevents overwriting of any file marked with the <B>Q</B> update code
+on an <B>F</B> line in the configuration file. This effectively
+prevents the machine from rebooting automatically again when the
+<B>package</B> command is invoked in the machine's AFS initialization
+file.
+<P><DT><B>-debug
+</B><DD>Enables debugging output, which is directed to the standard output stream
+by default. By default, no debugging output is produced.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Examples</STRONG>
+<P>This command is usually invoked in a client machine's AFS
+initialization file (<B>/etc/rc</B> or equivalent), rather than issued at
+the command shell prompt.
+<P>The following command invokes the version of the <B>staff</B>
+configuration file appropriate for this machine's system type, and
+produces verbose output.
+<PRE>   # <B>/etc/package -c staff -v</B>
+   
+</PRE>
+<P>The following example uses the configuration file whose basename is defined
+in the <B>/.package</B> file on the local machine. This
+method enables the administrator to use the same <B>package</B> command in
+every machine's AFS initialization file but still customize configuration
+by putting the appropriate basename in the <B>/.package</B>
+file.
+<PRE>   # <B>/etc/package -c `cat /.package` -v</B>
+   
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer must be logged in as the local superuser <B>root</B>.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf053.htm#HDRPACKAGECONFIG">package Configuration File</A>
+<P>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf203.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf205.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<!-- Begin Footer Records  ========================================== -->
+<P><HR><B> 
+<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
+</B> 
+<!-- End Footer Records  ============================================ -->
+<A NAME="Bot_Of_Page"></A>
+</BODY></HTML>