Release Notes
<<< PreviousNext >>>

Storing AFS Documents in AFS

This section explains how to create and mount a volume to house AFS documents. The recommended mount point for the volume is /afs/cellname/afsdoc. If you ran AFS 3.5, the volume possibly already exists. You can choose to overwrite its contents with the AFS 3.6 version of documents, or can create a new volume for the AFS 3.6 documents and mount it at /afs/cellname/afsdoc instead of the volume of AFS 3.5 documents. Alter the following instructions as necessary.

If you wish, you can create a link to the mount point on each client machine's local disk, called /usr/afsdoc. Alternatively, you can create a link to the mount point in each user's home directory. You can also choose to permit users to access only certain documents (most probably, the OpenAFS User Guide) by creating different mount points or setting different ACLs on different document directories.

To create a new volume for storing AFS documents:

  1. Issue the vos create command to create a volume for storing the AFS documentation. Include the -maxquota argument to set an unlimited quota on the volume.

    If you wish, you can set the volume's quota to a finite value after you complete the copying operations. At that point, use the vos examine command to determine how much space the volume is occupying. Then issue the fs setquota command to set a quota value that is slightly larger. 

       % vos create <machine name> <partition name> afsdoc -maxquota 0

  2. Issue the fs mkmount command to mount the new volume. If your root.cell volume is replicated, you must precede the cellname with a period to specify the read/write mount point, as shown. Then issue the vos release command to release a new replica of the root.cell volume, and the fs checkvolumes command to force the local Cache Manager to access them. 

       % fs mkmount -dir /afs/.cellname/afsdoc -vol afsdoc
   
   % vos release root.cell
   
   % fs checkvolumes

  3. Issue the fs setacl command to grant the rl permissions to the system:anyuser group on the new directory's ACL. 

       % cd /afs/.cellname/afsdoc 
    
   % fs setacl  .  system:anyuser rl

  4. Access the documents via one of the sources listed in Accessing the AFS Binary Distribution and Documentation. Copy the documents in one more formats from a source_format directory into subdirectories of the /afs/cellname/afsdoc directory. Repeat the commands for each format. Suggested substitutions for the format_name variable are "HTML" and "PDF". 

       # mkdir format_name
   
   # cd format_name
   
   # cp -rp /cdrom/Documentation/language_code/source_format  .
    If you copy the HTML version of the documents, note that in addition to a subdirectory for each document there are several files with a .gif extension, which enable readers to move easily between sections of a document. The file called index.htm is an introductory HTML page that has a hyperlink to the documents. For HTML viewing to work properly, these files must remain in the top-level HTML directory (the one named, for example, /afs/cellname/afsdoc/HTML).

  5. (Optional) If you believe it is helpful to your users to access AFS documents via a local disk directory, create /usr/afsdoc on the local disk as a symbolic link to the directory housing the desired format (probably HTML or PDF). 

       # ln -s /afs/cellname/afsdoc/format_name /usr/afsdoc
    An alternative is to create a link in each user's home directory to the documentation directory in AFS.

<<< PreviousHomeNext >>>
Loading AFS into the Solaris KernelUpReference Pages