quickstart-obsolete-appendices-20070423
[openafs.git] / doc / xml / QuickStartUnix / auqbg007.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <chapter id="HDRWQ133">
3   <title>Installing Additional Client Machines</title>
4
5   <indexterm>
6     <primary>instructions</primary>
7
8     <secondary>client machine</secondary>
9   </indexterm>
10
11   <indexterm>
12     <primary>installing</primary>
13
14     <secondary>client functionality</secondary>
15
16     <tertiary>client machine</tertiary>
17   </indexterm>
18
19   <para>This chapter describes how to install AFS client machines after you have installed the first AFS machine. Some parts of the
20   installation differ depending on whether or not the new client is of the same AFS system type (uses the same AFS binaries) as a
21   previously installed client machine. <indexterm>
22       <primary>overview</primary>
23
24       <secondary>installing client machine</secondary>
25     </indexterm></para>
26
27   <sect1 id="Header_116">
28     <title>Summary of Procedures</title>
29
30     <orderedlist>
31       <listitem>
32         <para>Incorporate AFS into the machine's kernel</para>
33       </listitem>
34
35       <listitem>
36         <para>Define the machine's cell membership</para>
37       </listitem>
38
39       <listitem>
40         <para>Define cache location and size</para>
41       </listitem>
42
43       <listitem>
44         <para>Create the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file, which determines which foreign cells the
45         client can access in addition to the local cell</para>
46       </listitem>
47
48       <listitem>
49         <para>Create the <emphasis role="bold">/afs</emphasis> directory and start the Cache Manager</para>
50       </listitem>
51
52       <listitem>
53         <para>Create and mount volumes for housing AFS client binaries (necessary only for clients of a new system type)</para>
54       </listitem>
55
56       <listitem>
57         <para>Create a link from the local <emphasis role="bold">/usr/afsws</emphasis> directory to the AFS directory housing the
58         AFS client binaries</para>
59       </listitem>
60
61       <listitem>
62         <para>Modify the machine's authentication system to enable AFS users to obtain tokens at login</para>
63       </listitem>
64     </orderedlist>
65
66     <indexterm>
67       <primary>Binary Distribution</primary>
68
69       <secondary>creating /tmp/afsdist directory</secondary>
70
71       <tertiary>client machine</tertiary>
72     </indexterm>
73
74     <indexterm>
75       <primary>afsdist directory</primary>
76
77       <secondary>client machine</secondary>
78     </indexterm>
79
80     <indexterm>
81       <primary>client machine</primary>
82
83       <secondary>/tmp/afsdist directory</secondary>
84     </indexterm>
85
86     <indexterm>
87       <primary>creating</primary>
88
89       <secondary>/tmp/afsdist directory</secondary>
90
91       <tertiary>client machine</tertiary>
92     </indexterm>
93
94     <indexterm>
95       <primary>usr/vice/etc directory</primary>
96
97       <secondary>client machine</secondary>
98     </indexterm>
99
100     <indexterm>
101       <primary>client machine</primary>
102
103       <secondary>/usr/vice/etc directory</secondary>
104     </indexterm>
105
106     <indexterm>
107       <primary>creating</primary>
108
109       <secondary>/usr/vice/etc directory</secondary>
110
111       <tertiary>client machine</tertiary>
112     </indexterm>
113   </sect1>
114
115   <sect1 id="HDRWQ134">
116     <title>Creating AFS Directories on the Local Disk</title>
117
118     <para>If you are not installing from a packaged distribution, create the <emphasis role="bold">/usr/vice/etc</emphasis> directory on the local disk, to house client binaries and
119     configuration files. Subsequent instructions copy files from the OpenAFS binary distribution into them. Create the <emphasis
120     role="bold">/tmp/afsdist</emphasis> directory as a location to uncompress this distribution, if it does not already exist.</para>
121
122     <programlisting>
123    # <emphasis role="bold">mkdir /usr/vice</emphasis>
124    # <emphasis role="bold">mkdir /usr/vice/etc</emphasis>
125    # <emphasis role="bold">mkdir /tmp/afsdist</emphasis>
126 </programlisting>
127   </sect1>
128
129   <sect1 id="HDRWQ135">
130     <title>Performing Platform-Specific Procedures</title>
131
132     <para>Every AFS client machine's kernel must incorporate AFS modifications. Some system types use a dynamic kernel loader
133     program, whereas on other system types you build AFS modifications into a static kernel. Some system types support both
134     methods.</para>
135
136     <para>Also modify the machine's authentication system so that users obtain an AFS token as they log into the local file system.
137     Using AFS is simpler and more convenient for your users if you make the modifications on all client machines. Otherwise, users
138     must perform a two or three step login procedure (login to the local system, obtain Kerberos credentials, and then issue the <emphasis role="bold">klog</emphasis>
139     command). For further discussion of AFS authentication, see the chapter in the <emphasis>OpenAFS Administration Guide</emphasis>
140     about cell configuration and administration issues.</para>
141
142     <para>For convenience, the following sections group the two procedures by system type. Proceed to the appropriate section.
143     <itemizedlist>
144         <listitem>
145           <para><link linkend="HDRWQ136">Getting Started on AIX Systems</link></para>
146         </listitem>
147
148         <listitem>
149           <para><link linkend="HDRWQ138">Getting Started on HP-UX Systems</link></para>
150         </listitem>
151
152         <listitem>
153           <para><link linkend="HDRWQ139">Getting Started on IRIX Systems</link></para>
154         </listitem>
155
156         <listitem>
157           <para><link linkend="HDRWQ143">Getting Started on Linux Systems</link></para>
158         </listitem>
159
160         <listitem>
161           <para><link linkend="HDRWQ144">Getting Started on Solaris Systems</link></para>
162         </listitem>
163       </itemizedlist></para>
164
165     <indexterm>
166       <primary>incorporating AFS kernel extensions</primary>
167
168       <secondary>client machine</secondary>
169
170       <tertiary>AIX</tertiary>
171     </indexterm>
172
173     <indexterm>
174       <primary>AFS kernel extensions</primary>
175
176       <secondary>on client machine</secondary>
177
178       <tertiary>AIX</tertiary>
179     </indexterm>
180
181     <indexterm>
182       <primary>client machine</primary>
183
184       <secondary>AFS kernel extensions</secondary>
185
186       <tertiary>on AIX</tertiary>
187     </indexterm>
188
189     <indexterm>
190       <primary>AIX</primary>
191
192       <secondary>AFS kernel extensions</secondary>
193
194       <tertiary>on client machine</tertiary>
195     </indexterm>
196
197     <indexterm>
198       <primary>enabling AFS login</primary>
199
200       <secondary>client machine</secondary>
201
202       <tertiary>AIX</tertiary>
203     </indexterm>
204
205     <indexterm>
206       <primary>AFS login</primary>
207
208       <secondary>on client machine</secondary>
209
210       <tertiary>AIX</tertiary>
211     </indexterm>
212
213     <indexterm>
214       <primary>client machine</primary>
215
216       <secondary>AFS login</secondary>
217
218       <tertiary>on AIX</tertiary>
219     </indexterm>
220
221     <indexterm>
222       <primary>AIX</primary>
223
224       <secondary>AFS login</secondary>
225
226       <tertiary>on client machine</tertiary>
227     </indexterm>
228
229     <indexterm>
230       <primary>secondary authentication system (AIX)</primary>
231
232       <secondary>client machine</secondary>
233     </indexterm>
234   </sect1>
235
236   <sect1 id="HDRWQ136">
237     <title>Getting Started on AIX Systems</title>
238
239     <para>In this section you load AFS into the AIX kernel. Then incorporate AFS modifications into the machine's secondary
240     authentication system, if you wish to enable AFS login.</para>
241
242     <sect2 id="Header_120">
243       <title>Loading AFS into the AIX Kernel</title>
244
245       <para>The AIX kernel extension facility is the dynamic kernel loader provided by IBM Corporation. AIX does not support
246       incorporation of AFS modifications during a kernel build.</para>
247
248       <para>For AFS to function correctly, the kernel extension facility must run each time the machine reboots, so the AFS
249       initialization script (included in the AFS distribution) invokes it automatically. In this section you copy the script to the
250       conventional location and edit it to select the appropriate options depending on whether NFS is also to run.</para>
251
252       <para>After editing the script, you run it to incorporate AFS into the kernel. In a later section you verify that the script
253       correctly initializes the Cache Manager, then configure the AIX <emphasis role="bold">inittab</emphasis> file so that the
254       script runs automatically at reboot. <orderedlist>
255           <listitem>
256             <para>Unpack the distribution tarball. The examples below assume 
257             that you have unpacked the files into the 
258             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
259             pick a different location, substitute this in all of the following 
260             examples. Once you have unpacked the distribution, 
261             change directory as indicated.
262 <programlisting>
263    # <emphasis role="bold">cd /tmp/afsdist/rs_aix42/root.client/usr/vice/etc</emphasis>
264 </programlisting></para>
265           </listitem>
266           <listitem>
267             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/dkload</emphasis> directory,
268             and the AFS initialization script to the <emphasis role="bold">/etc</emphasis> directory. <programlisting>
269    # <emphasis role="bold">cp -rp  dkload  /usr/vice/etc</emphasis>
270    # <emphasis role="bold">cp -p  rc.afs  /etc/rc.afs</emphasis>
271 </programlisting></para>
272           </listitem>
273
274           <listitem>
275             <para>Edit the <emphasis role="bold">/etc/rc.afs</emphasis> script, setting the <computeroutput>NFS</computeroutput>
276             variable as indicated.</para>
277
278             <para>If the machine is not to function as an NFS/AFS Translator, set the <computeroutput>NFS</computeroutput> variable
279             as follows.</para>
280
281             <programlisting>
282    NFS=$NFS_NONE
283 </programlisting>
284
285             <para>If the machine is to function as an NFS/AFS Translator and is running AIX 4.2.1 or higher, set the
286             <computeroutput>NFS</computeroutput> variable as follows. Note that NFS must already be loaded into the kernel, which
287             happens automatically on systems running AIX 4.1.1 and later, as long as the file <emphasis
288             role="bold">/etc/exports</emphasis> exists.</para>
289
290             <programlisting>
291    NFS=$NFS_IAUTH
292 </programlisting>
293           </listitem>
294
295           <listitem>
296             <para>Invoke the <emphasis role="bold">/etc/rc.afs</emphasis> script to load AFS modifications into the kernel. You can
297             ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS client.
298             <programlisting>
299    # <emphasis role="bold">/etc/rc.afs</emphasis>
300 </programlisting></para>
301           </listitem>
302         </orderedlist></para>
303     </sect2>
304
305     <sect2 id="Header_121">
306       <title>Enabling AFS Login on AIX Systems</title>
307
308       <para>In modern AFS installations, you should be using Kerberos v5
309       for user login, and obtaining AFS tokens following this authentication
310       step.</para>
311       
312       <para>There are currently no instructions available on configuring AIX to
313       automatically obtain AFS tokens at login. Following login, users can 
314       obtain tokens by running the <emphasis role="bold">aklog</emphasis> 
315       command</para>
316
317       <para>Sites which still require <emphasis role="bold">kaserver</emphasis>
318       or external Kerberos v4 authentication should consult 
319       <link linkend="KAS012">Enabling kaserver based AFS Login on AIX Systems</link>
320       for details of how to enable AIX login.</para>
321
322       <para><orderedlist>
323           <listitem>
324             <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
325           </listitem>
326         </orderedlist></para>
327
328       <indexterm>
329         <primary>incorporating AFS kernel extensions</primary>
330
331         <secondary>client machine</secondary>
332
333         <tertiary>HP-UX</tertiary>
334       </indexterm>
335
336       <indexterm>
337         <primary>AFS kernel extensions</primary>
338
339         <secondary>on client machine</secondary>
340
341         <tertiary>HP-UX</tertiary>
342       </indexterm>
343
344       <indexterm>
345         <primary>client machine</primary>
346
347         <secondary>AFS kernel extensions</secondary>
348
349         <tertiary>on HP-UX</tertiary>
350       </indexterm>
351
352       <indexterm>
353         <primary>HP-UX</primary>
354
355         <secondary>AFS-modified kernel</secondary>
356
357         <tertiary>on client machine</tertiary>
358       </indexterm>
359
360       <indexterm>
361         <primary>enabling AFS login</primary>
362
363         <secondary>client machine</secondary>
364
365         <tertiary>HP-UX</tertiary>
366       </indexterm>
367
368       <indexterm>
369         <primary>AFS login</primary>
370
371         <secondary>on client machine</secondary>
372
373         <tertiary>HP-UX</tertiary>
374       </indexterm>
375
376       <indexterm>
377         <primary>client machine</primary>
378
379         <secondary>AFS login</secondary>
380
381         <tertiary>on HP-UX</tertiary>
382       </indexterm>
383
384       <indexterm>
385         <primary>HP-UX</primary>
386
387         <secondary>AFS login</secondary>
388
389         <tertiary>on client machine</tertiary>
390       </indexterm>
391
392       <indexterm>
393         <primary>PAM</primary>
394
395         <secondary>on HP-UX</secondary>
396
397         <tertiary>client machine</tertiary>
398       </indexterm>
399     </sect2>
400   </sect1>
401
402   <sect1 id="HDRWQ138">
403     <title>Getting Started on HP-UX Systems</title>
404
405     <para>In this section you build AFS into the HP-UX kernel. Then incorporate AFS modifications into the machine's Pluggable
406     Authentication Module (PAM) system, if you wish to enable AFS login.</para>
407
408     <sect2 id="Header_126">
409       <title>Building AFS into the HP-UX Kernel</title>
410
411       <para>On HP-UX systems, you must build AFS modifications into a new static kernel; HP-UX does not support dynamic loading. If
412       the machine's hardware and software configuration exactly matches another HP-UX machine on which AFS is already built into the
413       kernel, you can choose to copy the kernel from that machine to this one. In general, however, it is better to build AFS
414       modifications into the kernel on each machine according to the following instructions. <orderedlist>
415           <listitem>
416             <para>Move the existing kernel-related files to a safe location. <programlisting>
417    # <emphasis role="bold">cp /stand/vmunix /stand/vmunix.noafs</emphasis>
418    # <emphasis role="bold">cp /stand/system /stand/system.noafs</emphasis>
419 </programlisting></para>
420           </listitem>
421
422           <listitem>
423             <para>Unpack the OpenAFS HP-UX distribution tarball. The examples 
424             below assume that you have unpacked the files into the 
425             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
426             pick a different location, substitute this in all of the following 
427             examples. Once you have unpacked the distribution, change directory 
428             as indicated.
429             <programlisting>
430    # <emphasis role="bold">cd /tmp/afsdist/hp_ux110/root.client</emphasis>
431 </programlisting></para>
432           </listitem>
433
434           <listitem>
435             <para>Copy the AFS initialization file to the local directory for initialization files (by convention, <emphasis
436             role="bold">/sbin/init.d</emphasis> on HP-UX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
437             extension as you copy the file. <programlisting>
438    # <emphasis role="bold">cp usr/vice/etc/afs.rc  /sbin/init.d/afs</emphasis>
439 </programlisting></para>
440           </listitem>
441
442           <listitem>
443             <para>Copy the file <emphasis role="bold">afs.driver</emphasis> to the local <emphasis
444             role="bold">/usr/conf/master.d</emphasis> directory, changing its name to <emphasis role="bold">afs</emphasis> as you
445             do. <programlisting>
446    # <emphasis role="bold">cp  usr/vice/etc/afs.driver  /usr/conf/master.d/afs</emphasis>
447 </programlisting></para>
448           </listitem>
449
450           <listitem>
451             <para>Copy the AFS kernel module to the local <emphasis role="bold">/usr/conf/lib</emphasis> directory.</para>
452
453             <para>If the machine's kernel supports NFS server functionality:</para>
454
455             <programlisting>
456    # <emphasis role="bold">cp bin/libafs.a /usr/conf/lib</emphasis>   
457 </programlisting>
458
459             <para>If the machine's kernel does not support NFS server functionality, change the file's name as you copy it:</para>
460
461             <programlisting>
462    # <emphasis role="bold">cp bin/libafs.nonfs.a /usr/conf/lib/libafs.a</emphasis>
463 </programlisting>
464           </listitem>
465
466           <listitem>
467             <para>Incorporate the AFS driver into the kernel, either using the <emphasis role="bold">SAM</emphasis> program or a
468             series of individual commands. <itemizedlist>
469                 <listitem>
470                   <para>To use the <emphasis role="bold">SAM</emphasis> program: <orderedlist>
471                       <listitem>
472                         <para>Invoke the <emphasis role="bold">SAM</emphasis> program, specifying the hostname of the local machine
473                         as <replaceable>local_hostname</replaceable>. The <emphasis role="bold">SAM</emphasis> graphical user
474                         interface pops up. <programlisting>
475    # <emphasis role="bold">sam -display</emphasis> <replaceable>local_hostname</replaceable><emphasis role="bold">:0</emphasis> 
476 </programlisting></para>
477                       </listitem>
478
479                       <listitem>
480                         <para>Choose the <emphasis role="bold">Kernel Configuration</emphasis> icon, then the <emphasis
481                         role="bold">Drivers</emphasis> icon. From the list of drivers, select <emphasis
482                         role="bold">afs</emphasis>.</para>
483                       </listitem>
484
485                       <listitem>
486                         <para>Open the pull-down <emphasis role="bold">Actions</emphasis> menu and choose the <emphasis
487                         role="bold">Add Driver to Kernel</emphasis> option.</para>
488                       </listitem>
489
490                       <listitem>
491                         <para>Open the <emphasis role="bold">Actions</emphasis> menu again and choose the <emphasis
492                         role="bold">Create a New Kernel</emphasis> option.</para>
493                       </listitem>
494
495                       <listitem>
496                         <para>Confirm your choices by choosing <emphasis role="bold">Yes</emphasis> and <emphasis
497                         role="bold">OK</emphasis> when prompted by subsequent pop-up windows. The <emphasis
498                         role="bold">SAM</emphasis> program builds the kernel and reboots the system.</para>
499                       </listitem>
500
501                       <listitem>
502                         <para>Login again as the superuser <emphasis role="bold">root</emphasis>. <programlisting>
503    login: <emphasis role="bold">root</emphasis>
504    Password: <replaceable>root_password</replaceable>
505 </programlisting></para>
506                       </listitem>
507                     </orderedlist></para>
508                 </listitem>
509
510                 <listitem>
511                   <para>To use individual commands: <orderedlist>
512                       <listitem>
513                         <para>Edit the file <emphasis role="bold">/stand/system</emphasis>, adding an entry for <emphasis
514                         role="bold">afs</emphasis> to the <computeroutput>Subsystems</computeroutput> section.</para>
515                       </listitem>
516
517                       <listitem>
518                         <para>Change to the <emphasis role="bold">/stand/build</emphasis> directory and issue the <emphasis
519                         role="bold">mk_kernel</emphasis> command to build the kernel. <programlisting>
520    # <emphasis role="bold">cd /stand/build</emphasis>
521    # <emphasis role="bold">mk_kernel</emphasis>
522 </programlisting></para>
523                       </listitem>
524
525                       <listitem>
526                         <para>Move the new kernel to the standard location (<emphasis role="bold">/stand/vmunix</emphasis>), reboot
527                         the machine to start using it, and login again as the superuser <emphasis role="bold">root</emphasis>.
528                         <programlisting>
529    # <emphasis role="bold">mv /stand/build/vmunix_test /stand/vmunix</emphasis>
530    # <emphasis role="bold">cd /</emphasis>
531    # <emphasis role="bold">shutdown -r now</emphasis>             
532    login: <emphasis role="bold">root</emphasis>
533    Password: <replaceable>root_password</replaceable>
534 </programlisting></para>
535                       </listitem>
536                     </orderedlist></para>
537                 </listitem>
538               </itemizedlist></para>
539           </listitem>
540         </orderedlist></para>
541     </sect2>
542
543     <sect2 id="Header_127">
544       <title>Enabling AFS Login on HP-UX Systems</title>
545
546       <para>At this point you incorporate AFS into the operating system's Pluggable Authentication Module (PAM) scheme. PAM
547       integrates all authentication mechanisms on the machine, including login, to provide the security infrastructure for
548       authenticated access to and from the machine.</para>
549
550       <para>In modern AFS installations, you should be using Kerberos v5
551       for user login, and obtaining AFS tokens subsequent to this authentication
552       step. OpenAFS does not currently distribute a PAM module allowing AFS 
553       tokens to be automatically gained at login. Whilst there are a number of
554       third party modules providing this functionality, it is not know if these 
555       have been tested with HP/UX.</para>
556       
557       <para>Following login, users can 
558       obtain tokens by running the <emphasis role="bold">aklog</emphasis> 
559       command</para>
560
561       <para>If you are at a site which still requires 
562       <emphasis role="bold">kaserver</emphasis> or external Kerberos v4 based 
563       authentication, please consult
564       <link linkend="KAS014">Enabling kaserver based AFS Login on HP-UX systems</link>
565       for further installation instructions.
566         <orderedlist>
567           <listitem>
568             <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
569           </listitem>
570         </orderedlist>
571       </para>
572
573       <indexterm>
574         <primary>incorporating AFS kernel extensions</primary>
575
576         <secondary>client machine</secondary>
577
578         <tertiary>IRIX</tertiary>
579       </indexterm>
580
581       <indexterm>
582         <primary>AFS kernel extensions</primary>
583
584         <secondary>on client machine</secondary>
585
586         <tertiary>IRIX</tertiary>
587       </indexterm>
588
589       <indexterm>
590         <primary>client machine</primary>
591
592         <secondary>AFS kernel extensions</secondary>
593
594         <tertiary>on IRIX</tertiary>
595       </indexterm>
596     </sect2>
597   </sect1>
598
599   <sect1 id="HDRWQ139">
600     <title>Getting Started on IRIX Systems</title>
601
602     <para>In this section you incorporate AFS into the IRIX kernel, choosing one of two methods: <itemizedlist>
603         <listitem>
604           <para>Dynamic loading using the <emphasis role="bold">ml</emphasis> program distributed by Silicon Graphics, Incorporated
605           (SGI).</para>
606         </listitem>
607
608         <listitem>
609           <para>Building a new static kernel.</para>
610         </listitem>
611       </itemizedlist></para>
612
613     <para>Then see <link linkend="HDRWQ142">Enabling AFS Login on IRIX Systems</link> to read about integrated AFS login on IRIX
614     systems.</para>
615
616     <para>In preparation for either dynamic loading or kernel building, perform the following procedures: <orderedlist>
617         <listitem>
618           <para>Unpack the OpenAFS IRIX distribution tarball. The examples
619           below assume that you have unpacked the files into the 
620           <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you
621           pick a different location, substitue this in all of the following
622           examples. Once you have unpacked the distribution, change directory
623           as indicated.
624 <programlisting>
625    # <emphasis role="bold">cd  /tmp/afsdist/sgi_65/root.client</emphasis>
626 </programlisting></para>
627         </listitem>
628         <listitem>
629           <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
630           role="bold">/etc/init.d</emphasis> on IRIX machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
631           extension as you copy the script. <programlisting>
632    # <emphasis role="bold">cp -p   usr/vice/etc/afs.rc  /etc/init.d/afs</emphasis>
633 </programlisting></para>
634         </listitem>
635
636         <listitem>
637           <para>Issue the <emphasis role="bold">uname -m</emphasis> command to determine the machine's CPU board type. The <emphasis
638           role="bold">IP</emphasis><replaceable>xx</replaceable> value in the output must match one of the supported CPU board types
639           listed in the <emphasis>OpenAFS Release Notes</emphasis> for the current version of AFS. <programlisting>
640    # <emphasis role="bold">uname -m</emphasis>
641 </programlisting></para>
642         </listitem>
643
644         <listitem>
645           <para>Proceed to either <link linkend="HDRWQ140">Loading AFS into the IRIX Kernel</link> or <link
646           linkend="HDRWQ141">Building AFS into the IRIX Kernel</link>.</para>
647         </listitem>
648       </orderedlist></para>
649
650     <indexterm>
651       <primary>IRIX</primary>
652
653       <secondary>AFS kernel extensions</secondary>
654
655       <tertiary>on client machine</tertiary>
656     </indexterm>
657
658     <indexterm>
659       <primary>afsml variable (IRIX)</primary>
660
661       <secondary>client machine</secondary>
662     </indexterm>
663
664     <indexterm>
665       <primary>variables</primary>
666
667       <secondary>afsml (IRIX)</secondary>
668
669       <tertiary>client machine</tertiary>
670     </indexterm>
671
672     <indexterm>
673       <primary>IRIX</primary>
674
675       <secondary>afsml variable</secondary>
676
677       <tertiary>client machine</tertiary>
678     </indexterm>
679
680     <indexterm>
681       <primary>afsxnfs variable (IRIX)</primary>
682
683       <secondary>client machine</secondary>
684     </indexterm>
685
686     <indexterm>
687       <primary>variables</primary>
688
689       <secondary>afsxnfs (IRIX)</secondary>
690
691       <tertiary>client machine</tertiary>
692     </indexterm>
693
694     <indexterm>
695       <primary>IRIX</primary>
696
697       <secondary>afsxnfs variable</secondary>
698
699       <tertiary>client machine</tertiary>
700     </indexterm>
701
702     <sect2 id="HDRWQ140">
703       <title>Loading AFS into the IRIX Kernel</title>
704
705       <para>The <emphasis role="bold">ml</emphasis> program is the dynamic kernel loader provided by SGI for IRIX systems. If you
706       use it rather than building AFS modifications into a static kernel, then for AFS to function correctly the <emphasis
707       role="bold">ml</emphasis> program must run each time the machine reboots. Therefore, the AFS initialization script (included
708       in the OpenAFS Binary Distribution) invokes it automatically when the <emphasis role="bold">afsml</emphasis> configuration variable is
709       activated. In this section you activate the variable and run the script.</para>
710
711       <para>In a later section you verify that the script correctly initializes the Cache Manager, then create the links that
712       incorporate AFS into the IRIX startup and shutdown sequence. <orderedlist>
713           <listitem>
714             <para>Create the local <emphasis role="bold">/usr/vice/etc/sgiload</emphasis> directory to house the AFS kernel library
715             file. <programlisting>
716    # <emphasis role="bold">mkdir /usr/vice/etc/sgiload</emphasis>
717 </programlisting></para>
718           </listitem>
719
720           <listitem>
721             <para>Copy the appropriate AFS kernel library file to the <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
722             directory. The <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable> portion of the library file name must
723             match the value previously returned by the <emphasis role="bold">uname -m</emphasis> command. Also choose the file
724             appropriate to whether the machine's kernel supports NFS server functionality (NFS must be supported for the machine to
725             act as an NFS/AFS Translator). Single- and multiprocessor machines use the same library file.</para>
726
727             <para>(You can choose to copy all of the kernel library files into the <emphasis
728             role="bold">/usr/vice/etc/sgiload</emphasis> directory, but they require a significant amount of space.)</para>
729
730             <para>If the machine's kernel supports NFS server functionality:</para>
731
732             <programlisting>
733    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.o  /usr/vice/etc/sgiload</emphasis>   
734 </programlisting>
735
736             <para>If the machine's kernel does not support NFS server functionality:</para>
737
738             <programlisting>
739    # <emphasis role="bold">cp -p  usr/vice/etc/sgiload/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.o</emphasis>   \
740                    <emphasis role="bold">/usr/vice/etc/sgiload</emphasis>
741 </programlisting>
742           </listitem>
743
744           <listitem>
745             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
746             role="bold">afsml</emphasis> configuration variable. <programlisting>
747    # <emphasis role="bold">/etc/chkconfig -f afsml on</emphasis>   
748 </programlisting></para>
749
750             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
751             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
752
753             <programlisting>
754    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
755 </programlisting>
756           </listitem>
757
758           <listitem>
759             <para>Run the <emphasis role="bold">/etc/init.d/afs</emphasis> script to load AFS extensions into the kernel. The script
760             invokes the <emphasis role="bold">ml</emphasis> command, automatically determining which kernel library file to use
761             based on this machine's CPU type and the activation state of the <emphasis role="bold">afsxnfs</emphasis>
762             variable.</para>
763
764             <para>You can ignore any error messages about the inability to start the BOS Server or the Cache Manager or AFS
765             client.</para>
766
767             <programlisting>
768    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
769 </programlisting>
770           </listitem>
771
772           <listitem>
773             <para>Proceed to <link linkend="HDRWQ142">Enabling AFS Login on IRIX Systems</link>.</para>
774           </listitem>
775         </orderedlist></para>
776
777       <indexterm>
778         <primary>IRIX</primary>
779
780         <secondary>AFS-modified kernel</secondary>
781
782         <tertiary>on client machine</tertiary>
783       </indexterm>
784     </sect2>
785
786     <sect2 id="HDRWQ141">
787       <title>Building AFS into the IRIX Kernel</title>
788
789       <para>If you prefer to build a kernel, and the machine's hardware and software configuration exactly matches another IRIX
790       machine on which AFS is already built into the kernel, you can choose to copy the kernel from that machine to this one. In
791       general, however, it is better to build AFS modifications into the kernel on each machine according to the following
792       instructions. <orderedlist>
793           <listitem>
794             <para>Copy the kernel initialization file <emphasis role="bold">afs.sm</emphasis> to the local <emphasis
795             role="bold">/var/sysgen/system</emphasis> directory, and the kernel master file <emphasis role="bold">afs</emphasis> to
796             the local <emphasis role="bold">/var/sysgen/master.d</emphasis> directory. <programlisting>
797    # <emphasis role="bold">cp -p  bin/afs.sm  /var/sysgen/system</emphasis>
798    # <emphasis role="bold">cp -p  bin/afs  /var/sysgen/master.d</emphasis>
799 </programlisting></para>
800           </listitem>
801
802           <listitem>
803             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
804             role="bold">/var/sysgen/boot/afs.a</emphasis>; the <emphasis role="bold">IP</emphasis><replaceable>xx</replaceable>
805             portion of the library file name must match the value previously returned by the <emphasis role="bold">uname
806             -m</emphasis> command. Also choose the file appropriate to whether the machine's kernel supports NFS server
807             functionality (NFS must be supported for the machine to act as an NFS/AFS Translator). Single- and multiprocessor
808             machines use the same library file.</para>
809
810             <para>If the machine's kernel supports NFS server functionality:</para>
811
812             <programlisting>
813    # <emphasis role="bold">cp -p   bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.a   /var/sysgen/boot/afs.a</emphasis>   
814 </programlisting>
815
816             <para>If the machine's kernel does not support NFS server functionality:</para>
817
818             <programlisting>
819    # <emphasis role="bold">cp -p  bin/libafs.IP</emphasis><replaceable>xx</replaceable><emphasis role="bold">.nonfs.a  /var/sysgen/boot/afs.a</emphasis>
820 </programlisting>
821           </listitem>
822
823           <listitem>
824             <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to deactivate the <emphasis
825             role="bold">afsml</emphasis> configuration variable. <programlisting>
826    # <emphasis role="bold">/etc/chkconfig -f afsml off</emphasis>   
827 </programlisting></para>
828
829             <para>If the machine is to function as an NFS/AFS Translator and the kernel supports NFS server functionality, activate
830             the <emphasis role="bold">afsxnfs</emphasis> variable.</para>
831
832             <programlisting>
833    # <emphasis role="bold">/etc/chkconfig -f afsxnfs on</emphasis>
834 </programlisting>
835           </listitem>
836
837           <listitem>
838             <para>Copy the existing kernel file, <emphasis role="bold">/unix</emphasis>, to a safe location. Compile the new kernel,
839             which is created in the file <emphasis role="bold">/unix.install</emphasis>. It overwrites the existing <emphasis
840             role="bold">/unix</emphasis> file when the machine reboots in the next step. <programlisting>
841    # <emphasis role="bold">cp /unix /unix_noafs</emphasis>
842    # <emphasis role="bold">autoconfig</emphasis>
843 </programlisting></para>
844           </listitem>
845
846           <listitem>
847             <para>Reboot the machine to start using the new kernel, and login again as the superuser <emphasis
848             role="bold">root</emphasis>. <programlisting>
849    # <emphasis role="bold">cd /</emphasis>
850    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
851    login: <emphasis role="bold">root</emphasis>
852    Password: <replaceable>root_password</replaceable>
853 </programlisting></para>
854           </listitem>
855
856           <listitem>
857             <para>Proceed to <link linkend="HDRWQ142">Enabling AFS Login on IRIX Systems</link>.</para>
858           </listitem>
859         </orderedlist></para>
860
861       <indexterm>
862         <primary>enabling AFS login</primary>
863
864         <secondary>client machine</secondary>
865
866         <tertiary>IRIX</tertiary>
867       </indexterm>
868
869       <indexterm>
870         <primary>AFS login</primary>
871
872         <secondary>on client machine</secondary>
873
874         <tertiary>IRIX</tertiary>
875       </indexterm>
876
877       <indexterm>
878         <primary>client machine</primary>
879
880         <secondary>AFS login</secondary>
881
882         <tertiary>on IRIX</tertiary>
883       </indexterm>
884     </sect2>
885
886     <sect2 id="HDRWQ142">
887       <title>Enabling AFS Login on IRIX Systems</title>
888
889       <para>Whilst the standard IRIX command-line 
890       <emphasis role="bold">login</emphasis> program and the 
891       graphical <emphasis role="bold">xdm</emphasis> login program both have
892       the ability to grant AFS tokens, this ability relies upon the deprecated
893       kaserver authentication system. As this system is not recommended for
894       new installations, this is not documented here.</para>
895         
896       <para>Users who have been successfully authenticated via Kerberos 5
897       authentication may obtain AFS tokens following login by running the
898       <emphasis role="bold">aklog</emphasis> command.</para>
899
900       <para>If you are at a site which still requires 
901       <emphasis role="bold">kaserver</emphasis> or external Kerberos v4 based 
902       authentication, please consult 
903       <link linkend="KAS014">Enabling kaserver based AFS Login on Linux Systems</link>
904       for further installation instructions.</para>
905       
906       <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.
907       <indexterm>
908           <primary>incorporating AFS kernel extensions</primary>
909
910           <secondary>client machine</secondary>
911
912           <tertiary>Linux</tertiary>
913         </indexterm> <indexterm>
914           <primary>AFS kernel extensions</primary>
915
916           <secondary>on client machine</secondary>
917
918           <tertiary>Linux</tertiary>
919         </indexterm> <indexterm>
920           <primary>client machine</primary>
921
922           <secondary>AFS kernel extensions</secondary>
923
924           <tertiary>on Linux</tertiary>
925         </indexterm> <indexterm>
926           <primary>Linux</primary>
927
928           <secondary>AFS kernel extensions</secondary>
929
930           <tertiary>on client machine</tertiary>
931         </indexterm> <indexterm>
932           <primary>enabling AFS login</primary>
933
934           <secondary>client machine</secondary>
935
936           <tertiary>Linux</tertiary>
937         </indexterm> <indexterm>
938           <primary>AFS login</primary>
939
940           <secondary>on client machine</secondary>
941
942           <tertiary>Linux</tertiary>
943         </indexterm> <indexterm>
944           <primary>client machine</primary>
945
946           <secondary>AFS login</secondary>
947
948           <tertiary>on Linux</tertiary>
949         </indexterm> <indexterm>
950           <primary>Linux</primary>
951
952           <secondary>AFS login</secondary>
953
954           <tertiary>on client machine</tertiary>
955         </indexterm> <indexterm>
956           <primary>PAM</primary>
957
958           <secondary>on Linux</secondary>
959
960           <tertiary>client machine</tertiary>
961         </indexterm></para>
962     </sect2>
963   </sect1>
964
965   <sect1 id="HDRWQ143">
966     <title>Getting Started on Linux Systems</title>
967
968     <para>In this section you load AFS into the Linux kernel. Then incorporate AFS modifications into the machine's Pluggable
969     Authentication Module (PAM) system, if you wish to enable AFS login.</para>
970
971     <sect2 id="Header_133">
972       <title>Loading AFS into the Linux Kernel</title>
973
974       <para>The <emphasis role="bold">modprobe</emphasis> program is the dynamic kernel loader for Linux. Linux does not support
975       incorporation of AFS modifications during a kernel build.</para>
976
977       <para>For AFS to function correctly, the <emphasis role="bold">modprobe</emphasis> program must run each time the machine
978       reboots, so your distributions's AFS initialization script invokes it automatically. The script also includes
979       commands that select the appropriate AFS library file automatically. In this section you run the script.</para>
980
981       <para>In a later section you also verify that the script correctly initializes the Cache Manager, then activate a
982       configuration variable, which results in the script being incorporated into the Linux startup and shutdown sequence.</para>
983       
984       <para>The procedure for starting up OpenAFS depends upon your distribution</para>
985       <sect3>
986         <title>Fedora and RedHat Enterprise Linux</title>
987         <para>OpenAFS ships RPMS for all current Fedora and RHEL releases.
988         <orderedlist>
989           <listitem>
990             <para>Download and install the RPM set for your operating system.
991             RPMs are available from the OpenAFS web site. You will need the
992             <emphasis role="bold">openafs</emphasis> and
993             <emphasis role="bold">openfs-client</emphasis> packages, along
994             with an <emphasis role="bold">openafs-kernel</emphasis> package
995             matching your current, running ,kernel.</para>
996
997             <para>You can find the version of your current kernel by running
998 <programlisting>
999   # uname -r
1000 <replaceable>2.6.20-1.2933.fc6</replaceable>
1001 </programlisting></para>
1002
1003             <para>Once downloaded, the packages may be installed with the
1004             <emphasis role="bold">rpm</emphasis> command
1005 <programlisting>
1006   # rpm -U openafs-* openafs-client-* openafs-server-* openafs-kernel-*
1007 </programlisting></para>
1008           </listitem>
1009         </orderedlist>
1010       </para>
1011       </sect3>
1012       <sect3>
1013         <title>Systems packaged as tar files</title>
1014         <para>If you are running a system where the OpenAFS Binary Distribution
1015         is provided as a tar file, or where you have built the system from
1016         source yourself, you need to install the relevant components by hand
1017         </para>
1018         <orderedlist>
1019           <listitem>
1020             <para>Unpack the distribution tarball. The examples below assume
1021             that you have unpacked the files into the
1022             <emphasis role="bold">/tmp/afsdist</emphasis>directory. If you
1023             pick a different location, substitute this in all of the following
1024             examples. Once you have unpacked the distribution,
1025             change directory as indicated.
1026 <programlisting>
1027   # <emphasis role="bold">cd /tmp/afsdist/linux/root.client/usr/vice/etc</emphasis>
1028 </programlisting></para>
1029           </listitem>
1030
1031           <listitem>
1032             <para>Copy the AFS kernel library files to the local <emphasis role="bold">/usr/vice/etc/modload</emphasis> directory.
1033             The filenames for the libraries have the format <emphasis
1034             role="bold">libafs-</emphasis><replaceable>version</replaceable><emphasis role="bold">.o</emphasis>, where
1035             <replaceable>version</replaceable> indicates the kernel build level. The string <emphasis role="bold">.mp</emphasis> in
1036             the <replaceable>version</replaceable> indicates that the file is appropriate for machines running a multiprocessor
1037             kernel. <programlisting>
1038    # <emphasis role="bold">cp -rp  modload  /usr/vice/etc</emphasis>
1039 </programlisting></para>
1040           </listitem>
1041
1042           <listitem>
1043             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1044             role="bold">/etc/rc.d/init.d</emphasis> on Linux machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1045             extension as you copy the script. <programlisting>
1046    # <emphasis role="bold">cp -p   afs.rc  /etc/rc.d/init.d/afs</emphasis> 
1047 </programlisting></para>
1048           </listitem>
1049
1050 <!--
1051           <listitem>
1052             <para>Run the AFS initialization script to load AFS extensions into the kernel. You can ignore any error messages about
1053             the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
1054    # <emphasis role="bold">/etc/rc.d/init.d/afs  start</emphasis>
1055 </programlisting></para>
1056           </listitem>
1057 -->
1058         </orderedlist>
1059       </sect3>
1060     </sect2>
1061
1062     <sect2 id="Header_134">
1063       <title>Enabling AFS Login on Linux Systems</title>
1064
1065       <para>At this point you incorporate AFS into the operating system's Pluggable Authentication Module (PAM) scheme. PAM
1066       integrates all authentication mechanisms on the machine, including login, to provide the security infrastructure for
1067       authenticated access to and from the machine.</para>
1068
1069       <para>At this time, we recommend that new sites requiring AFS credentials
1070       to be gained as part of PAM authentication use Russ Alberry's 
1071       pam_afs_session, rather than utilising the bundled pam_afs2 module. 
1072       A typical PAM stack should authenticate the user using an external 
1073       Kerberos V service, and then use the AFS PAM module to obtain AFS 
1074       credentials in the <computeroutput>session</computeroutput> section</para>
1075
1076       <para>If you are at a site which still requires 
1077       <emphasis role="bold">kaserver</emphasis> or external Kerberos v4 based 
1078       authentication, please consult 
1079       <link linkend="KAS015">Enabling kaserver based AFS Login on Linux Systems</link>
1080       for further installation instructions.</para>
1081       
1082       <para>Proceed to 
1083       <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
1084
1085       <indexterm>
1086         <primary>incorporating AFS kernel extensions</primary>
1087
1088         <secondary>client machine</secondary>
1089
1090         <tertiary>Solaris</tertiary>
1091       </indexterm>
1092
1093       <indexterm>
1094         <primary>AFS kernel extensions</primary>
1095
1096         <secondary>on client machine</secondary>
1097
1098         <tertiary>Solaris</tertiary>
1099       </indexterm>
1100
1101       <indexterm>
1102         <primary>client machine</primary>
1103
1104         <secondary>AFS kernel extensions</secondary>
1105
1106         <tertiary>on Solaris</tertiary>
1107       </indexterm>
1108
1109       <indexterm>
1110         <primary>Solaris</primary>
1111
1112         <secondary>AFS kernel extensions</secondary>
1113
1114         <tertiary>on client machine</tertiary>
1115       </indexterm>
1116
1117       <indexterm>
1118         <primary>enabling AFS login</primary>
1119
1120         <secondary>client machine</secondary>
1121
1122         <tertiary>Solaris</tertiary>
1123       </indexterm>
1124
1125       <indexterm>
1126         <primary>AFS login</primary>
1127
1128         <secondary>on client machine</secondary>
1129
1130         <tertiary>Solaris</tertiary>
1131       </indexterm>
1132
1133       <indexterm>
1134         <primary>client machine</primary>
1135
1136         <secondary>AFS login</secondary>
1137
1138         <tertiary>on Solaris</tertiary>
1139       </indexterm>
1140
1141       <indexterm>
1142         <primary>Solaris</primary>
1143
1144         <secondary>AFS login</secondary>
1145
1146         <tertiary>on client machine</tertiary>
1147       </indexterm>
1148
1149       <indexterm>
1150         <primary>PAM</primary>
1151
1152         <secondary>on Solaris</secondary>
1153
1154         <tertiary>client machine</tertiary>
1155       </indexterm>
1156
1157       <indexterm>
1158         <primary>Solaris</primary>
1159
1160         <secondary>file systems clean-up script</secondary>
1161
1162         <tertiary>on client machine</tertiary>
1163       </indexterm>
1164
1165       <indexterm>
1166         <primary>file systems clean-up script (Solaris)</primary>
1167
1168         <secondary>client machine</secondary>
1169       </indexterm>
1170
1171       <indexterm>
1172         <primary>scripts</primary>
1173
1174         <secondary>file systems clean-up (Solaris)</secondary>
1175
1176         <tertiary>client machine</tertiary>
1177       </indexterm>
1178     </sect2>
1179   </sect1>
1180
1181   <sect1 id="HDRWQ144">
1182     <title>Getting Started on Solaris Systems</title>
1183
1184     <para>In this section you load AFS into the Solaris kernel. Then incorporate AFS modifications into the machine's Pluggable
1185     Authentication Module (PAM) system, if you wish to enable AFS login.</para>
1186
1187     <sect2 id="Header_136">
1188       <title>Loading AFS into the Solaris Kernel</title>
1189
1190       <para>The <emphasis role="bold">modload</emphasis> program is the dynamic kernel loader provided by Sun Microsystems for
1191       Solaris systems. Solaris does not support incorporation of AFS modifications during a kernel build.</para>
1192
1193       <para>For AFS to function correctly, the <emphasis role="bold">modload</emphasis> program must run each time the machine
1194       reboots, so the AFS initialization script (included on the AFS CD-ROM) invokes it automatically. In this section you copy the
1195       appropriate AFS library file to the location where the <emphasis role="bold">modload</emphasis> program accesses it and then
1196       run the script.</para>
1197
1198       <para>In a later section you verify that the script correctly initializes the Cache Manager, then create the links that
1199       incorporate AFS into the Solaris startup and shutdown sequence. <orderedlist>
1200           <listitem>
1201             <para>Unpack the OpenAFS Solaris distribution tarball. The examples
1202             below assume that you have unpacked the files into the 
1203             <emphasis role="bold">/tmp/afsdist</emphasis> directory. If you 
1204             pick a diferent location, substitute this in all of the following
1205             exmaples. Once you have unpacked the distribution, change directory
1206             as indicated. 
1207 <programlisting>
1208    # <emphasis role="bold">cd  /tmp/afsdist/sun4x_56/root.client/usr/vice/etc</emphasis>
1209 </programlisting></para>
1210           </listitem>          
1211
1212           <listitem>
1213             <para>Copy the AFS initialization script to the local directory for initialization files (by convention, <emphasis
1214             role="bold">/etc/init.d</emphasis> on Solaris machines). Note the removal of the <emphasis role="bold">.rc</emphasis>
1215             extension as you copy the script. <programlisting>
1216    # <emphasis role="bold">cp -p  afs.rc  /etc/init.d/afs</emphasis>
1217 </programlisting></para>
1218           </listitem>
1219
1220           <listitem>
1221             <para>Copy the appropriate AFS kernel library file to the local file <emphasis
1222             role="bold">/kernel/fs/afs</emphasis>.</para>
1223
1224             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, its kernel supports NFS server
1225             functionality, and the <emphasis role="bold">nfsd</emphasis> process is running:</para>
1226
1227             <programlisting>
1228    # <emphasis role="bold">cp -p modload/libafs.o /kernel/fs/afs</emphasis>   
1229 </programlisting>
1230
1231             <para>If the machine is running Solaris 2.6 or the 32-bit version of Solaris 7, and its kernel does not support NFS
1232             server functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
1233
1234             <programlisting>
1235    # <emphasis role="bold">cp -p modload/libafs.nonfs.o /kernel/fs/afs</emphasis>   
1236 </programlisting>
1237
1238             <para>If the machine is running the 64-bit version of Solaris 7, its kernel supports NFS server functionality, and the
1239             <emphasis role="bold">nfsd</emphasis> process is running:</para>
1240
1241             <programlisting>
1242    # <emphasis role="bold">cp -p modload/libafs64.o /kernel/fs/sparcv9/afs</emphasis>   
1243 </programlisting>
1244
1245             <para>If the machine is running the 64-bit version of Solaris 7, and its kernel does not support NFS server
1246             functionality or the <emphasis role="bold">nfsd</emphasis> process is not running:</para>
1247
1248             <programlisting>
1249    # <emphasis role="bold">cp -p modload/libafs64.nonfs.o /kernel/fs/sparcv9/afs</emphasis>
1250 </programlisting>
1251           </listitem>
1252
1253           <listitem>
1254             <para>Run the AFS initialization script to load AFS modifications into the kernel. You can ignore any error messages
1255             about the inability to start the BOS Server or the Cache Manager or AFS client. <programlisting>
1256    # <emphasis role="bold">/etc/init.d/afs start</emphasis>   
1257 </programlisting></para>
1258
1259             <para>When an entry called <computeroutput>afs</computeroutput> does not already exist in the local <emphasis
1260             role="bold">/etc/name_to_sysnum</emphasis> file, the script automatically creates it and reboots the machine to start
1261             using the new version of the file. If this happens, log in again as the superuser <emphasis role="bold">root</emphasis>
1262             after the reboot and run the initialization script again. This time the required entry exists in the <emphasis
1263             role="bold">/etc/name_to_sysnum</emphasis> file, and the <emphasis role="bold">modload</emphasis> program runs.</para>
1264
1265             <programlisting>
1266    login: <emphasis role="bold">root</emphasis>
1267    Password: <replaceable>root_password</replaceable>
1268    # <emphasis role="bold">/etc/init.d/afs start</emphasis>
1269 </programlisting>
1270           </listitem>
1271         </orderedlist></para>
1272     </sect2>
1273
1274     <sect2 id="Header_137">
1275       <title>Enabling AFS Login on Solaris Systems</title>
1276
1277       <para>At this point you incorporate AFS into the operating system's Pluggable Authentication Module (PAM) scheme. PAM
1278       integrates all authentication mechanisms on the machine, including login, to provide the security infrastructure for
1279       authenticated access to and from the machine.</para>
1280
1281       <para>In modern AFS installations, you should be using Kerberos v5
1282       for user login, and obtaining AFS tokens subsequent to this authentication
1283       step. OpenAFS does not currently distribute a PAM module allowing AFS 
1284       tokens to be automatically gained at login. Whilst there are a number of
1285       third party modules providing this functionality, it is not know if these 
1286       have been tested with Solaris.</para>
1287
1288       <para>If you are at a site which still requires 
1289       <emphasis role="bold">kaserver</emphasis> or external Kerberos v4 based 
1290       authentication, please consult 
1291       <link linkend="KAS016">Enabling kaserver based AFS Login on Solaris Systems</link>
1292       for further installation instructions.</para>
1293     </sect2>
1294     <sect2 id="Header_137a">
1295       <title>Editing the File Systems Clean-up Script on Solaris Systems</title>
1296       <para>
1297         <orderedlist>
1298           <listitem>
1299             <para>Some Solaris distributions include a script that locates 
1300             and removes unneeded files from various file systems. Its
1301             conventional location is 
1302             <emphasis role="bold">/usr/lib/fs/nfs/nfsfind</emphasis>. The 
1303             script generally uses an argument to the 
1304             <emphasis role="bold">find</emphasis> command to define which file 
1305             systems to search. In this step you modify the
1306             command to exclude the <emphasis role="bold">/afs</emphasis> 
1307             directory. Otherwise, the command traverses the AFS
1308             filespace of every cell that is accessible from the machine, which can take many hours. The following alterations are
1309             possibilities, but you must verify that they are appropriate for your cell.</para>
1310
1311             <para>The first possible alteration is to add the <emphasis role="bold">-local</emphasis> flag to the existing command,
1312             so that it looks like the following:</para>
1313
1314             <programlisting>
1315    find $dir -local -name .nfs\* -mtime +7 -mount -exec rm -f {} \;   
1316 </programlisting>
1317
1318             <para>Another alternative is to exclude any directories whose names begin with the lowercase letter <emphasis
1319             role="bold">a</emphasis> or a non-alphabetic character.</para>
1320
1321             <programlisting>
1322    find /[A-Zb-z]*  <replaceable>remainder of existing command</replaceable>   
1323 </programlisting>
1324
1325             <para>Do not use the following command, which still searches under the <emphasis role="bold">/afs</emphasis> directory,
1326             looking for a subdirectory of type <emphasis role="bold">4.2</emphasis>.</para>
1327
1328             <programlisting>
1329    find / -fstype 4.2     /* <replaceable>do not use</replaceable> */
1330 </programlisting>
1331           </listitem>
1332
1333           <listitem>
1334             <para>Proceed to <link linkend="HDRWQ145">Loading and Creating Client Files</link>.</para>
1335           </listitem>
1336         </orderedlist></para>
1337
1338       <indexterm>
1339         <primary>Binary Distribution</primary>
1340
1341         <secondary>copying client files from</secondary>
1342
1343         <tertiary>client machine</tertiary>
1344       </indexterm>
1345
1346       <indexterm>
1347         <primary>client machine</primary>
1348
1349         <secondary>copying client files to local disk</secondary>
1350       </indexterm>
1351
1352       <indexterm>
1353         <primary>copying</primary>
1354
1355         <secondary>client files to local disk</secondary>
1356
1357         <tertiary>client machine</tertiary>
1358       </indexterm>
1359
1360       <indexterm>
1361         <primary>cell name</primary>
1362
1363         <secondary>setting in client ThisCell file</secondary>
1364
1365         <tertiary>client machine</tertiary>
1366       </indexterm>
1367
1368       <indexterm>
1369         <primary>setting</primary>
1370
1371         <secondary>cell name in client ThisCell file</secondary>
1372
1373         <tertiary>client machine</tertiary>
1374       </indexterm>
1375
1376       <indexterm>
1377         <primary>client machine</primary>
1378
1379         <secondary>cell membership</secondary>
1380       </indexterm>
1381
1382       <indexterm>
1383         <primary>client machine</primary>
1384
1385         <secondary>ThisCell file</secondary>
1386       </indexterm>
1387
1388       <indexterm>
1389         <primary>ThisCell file (client)</primary>
1390
1391         <secondary>client machine</secondary>
1392       </indexterm>
1393
1394       <indexterm>
1395         <primary>CellServDB file (client)</primary>
1396
1397         <secondary>creating</secondary>
1398
1399         <tertiary>on client machine</tertiary>
1400       </indexterm>
1401
1402       <indexterm>
1403         <primary>database server machine</primary>
1404
1405         <secondary>entry in client CellServDB file</secondary>
1406
1407         <tertiary>on client machine</tertiary>
1408       </indexterm>
1409
1410       <indexterm>
1411         <primary>creating</primary>
1412
1413         <secondary>CellServDB file (client)</secondary>
1414
1415         <tertiary>client machine</tertiary>
1416       </indexterm>
1417
1418       <indexterm>
1419         <primary>client machine</primary>
1420
1421         <secondary>CellServDB file</secondary>
1422
1423         <tertiary>creating during initial installation</tertiary>
1424       </indexterm>
1425     </sect2>
1426   </sect1>
1427
1428   <sect1 id="HDRWQ145">
1429     <title>Loading and Creating Client Files</title>
1430
1431     <para>If you are using a non-packaged distribution (that is, one provided as
1432     a tarball) you should now copy files from the istribution to the 
1433     <emphasis role="bold">/usr/vice/etc</emphasis> directory. On some platforms 
1434     that use a dynamic loader program to incorporate AFS modifications into the 
1435     kernel, you have already copied over some the files.
1436     Copying them again does no harm.</para>
1437
1438     <para>Every AFS client machine has a copy of the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file on its local disk
1439     to define the machine's cell membership for the AFS client programs that run on it. Among other functions, this file determines
1440     the following: <itemizedlist>
1441         <listitem>
1442           <para>The cell in which users authenticate when they log onto the machine, assuming it is using an AFS-modified login
1443           utility</para>
1444         </listitem>
1445
1446         <listitem>
1447           <para>The cell in which users authenticate by default when they issue the <emphasis role="bold">aklog</emphasis>
1448           command</para>
1449         </listitem>
1450
1451         <listitem>
1452           <para>The cell membership of the AFS server processes that the AFS command interpreters on this machine contact by
1453           default</para>
1454         </listitem>
1455       </itemizedlist></para>
1456
1457     <para>Similarly, the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file on a client machine's local disk lists the
1458     database server machines in each cell that the local Cache Manager can contact. If there is no entry in the file for a cell, or
1459     the list of database server machines is wrong, then users working on this machine cannot access the cell. The chapter in the
1460     <emphasis>OpenAFS Administration Guide</emphasis> about administering client machines explains how to maintain the file after
1461     creating it. A version of the client <emphasis role="bold">CellServDB</emphasis> file was created during the installation of
1462     your cell's first machine (in <link linkend="HDRWQ66">Creating the Client CellServDB File</link>). It is probably also
1463     appropriate for use on this machine.</para>
1464
1465     <para>Remember that the Cache Manager consults the <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file only at
1466     reboot, when it copies the information into the kernel. For the Cache Manager to perform properly, the <emphasis
1467     role="bold">CellServDB</emphasis> file must be accurate at all times. Refer to the chapter in the <emphasis>OpenAFS
1468     Administration Guide</emphasis> about administering client machines for instructions on updating this file, with or without
1469     rebooting. <orderedlist>
1470         <listitem>
1471           <para>If you have not already done so, unpack the distribution 
1472           tarball for this machine's system type into a suitable location on 
1473           the filesystem, such as <emphasis role="bold">/tmp/afsdist</emphasis>.
1474           If you use a different location, substitue that in the examples that 
1475           follow.</para>
1476         </listitem>
1477
1478         <listitem>
1479           <para>Copy files to the local <emphasis role="bold">/usr/vice/etc</emphasis> directory.</para>
1480
1481           <para>This step places a copy of the AFS initialization script (and related files, if applicable) into the <emphasis
1482           role="bold">/usr/vice/etc</emphasis> directory. In the preceding instructions for incorporating AFS into the kernel, you
1483           copied the script directly to the operating system's conventional location for initialization files. When you incorporate
1484           AFS into the machine's startup sequence in a later step, you can choose to link the two files.</para>
1485
1486           <para>On some system types that use a dynamic kernel loader program, you previously copied AFS library files into a
1487           subdirectory of the <emphasis role="bold">/usr/vice/etc</emphasis> directory. On other system types, you copied the
1488           appropriate AFS library file directly to the directory where the operating system accesses it. The following commands do
1489           not copy or recopy the AFS library files into the <emphasis role="bold">/usr/vice/etc</emphasis> directory, because on
1490           some system types the library files consume a large amount of space. If you want to copy them, add the <emphasis
1491           role="bold">-r</emphasis> flag to the first <emphasis role="bold">cp</emphasis> command and skip the second <emphasis
1492           role="bold">cp</emphasis> command.</para>
1493
1494           <programlisting>
1495    # <emphasis role="bold">cd /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis>
1496    # <emphasis role="bold">cp -p  *  /usr/vice/etc</emphasis>
1497    # <emphasis role="bold">cp -rp  C  /usr/vice/etc</emphasis>
1498 </programlisting>
1499         </listitem>
1500
1501         <listitem>
1502           <para>Create the <emphasis role="bold">/usr/vice/etc/ThisCell</emphasis> file. <programlisting>
1503    # <emphasis role="bold">echo "</emphasis><replaceable>cellname</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/ThisCell</emphasis>
1504 </programlisting></para>
1505         </listitem>
1506
1507         <listitem>
1508           <para>Create the 
1509           <emphasis role="bold">/usr/vice/etc/CellServDB</emphasis> file. Use a 
1510           network file transfer program such as 
1511           <emphasis role="bold">sftp</emphasis> or 
1512           <emphasis role="bold">scp</emphasis> to copy it from one of the 
1513           following sources, which are listed in decreasing order of 
1514           preference: <itemizedlist>
1515               <listitem>
1516                 <para>Your cell's central <emphasis role="bold">CellServDB</emphasis> source file (the conventional location is
1517                 <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
1518                 role="bold">/common/etc/CellServDB</emphasis>)</para>
1519               </listitem>
1520
1521               <listitem>
1522                 <para>The global <emphasis role="bold">CellServDB</emphasis> 
1523                 file maintained at grand.central.org</para>
1524               </listitem>
1525
1526               <listitem>
1527                 <para>An existing client machine in your cell</para>
1528               </listitem>
1529
1530               <listitem>
1531                 <para>The <emphasis role="bold">CellServDB.sample</emphasis> 
1532                 file included in the
1533                 <replaceable>sysname</replaceable><emphasis role="bold">/root.client/usr/vice/etc</emphasis> 
1534                 directory of each OpenAFS distribution; add an entry for the 
1535                 local cell by following the instructions in 
1536                 <link linkend="HDRWQ66">Creating the Client CellServDB File</link>
1537                 </para>
1538               </listitem>
1539             </itemizedlist></para>
1540         </listitem>
1541       </orderedlist></para>
1542
1543     <indexterm>
1544       <primary>client cache</primary>
1545
1546       <see>cache</see>
1547     </indexterm>
1548
1549     <indexterm>
1550       <primary>AFS cache</primary>
1551
1552       <see>cache</see>
1553     </indexterm>
1554
1555     <indexterm>
1556       <primary>disk cache</primary>
1557
1558       <see>cache</see>
1559     </indexterm>
1560
1561     <indexterm>
1562       <primary>memory cache</primary>
1563
1564       <see>cache</see>
1565     </indexterm>
1566
1567     <indexterm>
1568       <primary>cache</primary>
1569
1570       <secondary>requirements</secondary>
1571     </indexterm>
1572
1573     <indexterm>
1574       <primary>cache</primary>
1575
1576       <secondary>choosing size</secondary>
1577     </indexterm>
1578
1579     <indexterm>
1580       <primary>requirements</primary>
1581
1582       <secondary>cache</secondary>
1583     </indexterm>
1584
1585     <indexterm>
1586       <primary>usr/vice/etc/cacheinfo</primary>
1587
1588       <see>cacheinfo file</see>
1589     </indexterm>
1590
1591     <indexterm>
1592       <primary>cacheinfo file</primary>
1593     </indexterm>
1594
1595     <indexterm>
1596       <primary>files</primary>
1597
1598       <secondary>cacheinfo</secondary>
1599     </indexterm>
1600
1601     <indexterm>
1602       <primary>usr/vice/cache directory</primary>
1603     </indexterm>
1604
1605     <indexterm>
1606       <primary>directories</primary>
1607
1608       <secondary>/usr/vice/cache</secondary>
1609     </indexterm>
1610
1611     <indexterm>
1612       <primary>cache</primary>
1613
1614       <secondary>configuring</secondary>
1615
1616       <tertiary>client machine</tertiary>
1617     </indexterm>
1618
1619     <indexterm>
1620       <primary>configuring</primary>
1621
1622       <secondary>cache</secondary>
1623
1624       <tertiary>client machine</tertiary>
1625     </indexterm>
1626
1627     <indexterm>
1628       <primary>setting</primary>
1629
1630       <secondary>cache size and location</secondary>
1631
1632       <tertiary>client machine</tertiary>
1633     </indexterm>
1634
1635     <indexterm>
1636       <primary>client machine</primary>
1637
1638       <secondary>cache size and location</secondary>
1639     </indexterm>
1640   </sect1>
1641
1642   <sect1 id="HDRWQ146">
1643     <title>Configuring the Cache</title>
1644
1645     <para>The Cache Manager uses a cache on the local disk or in machine memory to store local copies of files fetched from file
1646     server machines. As the <emphasis role="bold">afsd</emphasis> program initializes the Cache Manager, it sets basic cache
1647     configuration parameters according to definitions in the local <emphasis role="bold">/usr/vice/etc/cacheinfo</emphasis> file.
1648     The file has three fields: <orderedlist>
1649         <listitem>
1650           <para>The first field names the local directory on which to mount the AFS filespace. The conventional location is the
1651           <emphasis role="bold">/afs</emphasis> directory.</para>
1652         </listitem>
1653
1654         <listitem>
1655           <para>The second field defines the local disk directory to use for the disk cache. The conventional location is the
1656           <emphasis role="bold">/usr/vice/cache</emphasis> directory, but you can specify an alternate directory if another
1657           partition has more space available. There must always be a value in this field, but the Cache Manager ignores it if the
1658           machine uses a memory cache.</para>
1659         </listitem>
1660
1661         <listitem>
1662           <para>The third field specifies the number of kilobyte (1024 byte) blocks to allocate for the cache.</para>
1663         </listitem>
1664       </orderedlist></para>
1665
1666     <para>The values you define must meet the following requirements. <itemizedlist>
1667         <listitem>
1668           <para>On a machine using a disk cache, the Cache Manager expects always to be able to use the amount of space specified in
1669           the third field. Failure to meet this requirement can cause serious problems, some of which can be repaired only by
1670           rebooting. You must prevent non-AFS processes from filling up the cache partition. The simplest way is to devote a
1671           partition to the cache exclusively.</para>
1672         </listitem>
1673
1674         <listitem>
1675           <para>The amount of space available in memory or on the partition housing the disk cache directory imposes an absolute
1676           limit on cache size.</para>
1677         </listitem>
1678
1679         <listitem>
1680           <para>The maximum supported cache size can vary in each AFS release; see the <emphasis>OpenAFS Release Notes</emphasis>
1681           for the current version.</para>
1682         </listitem>
1683
1684         <listitem>
1685           <para>For a disk cache, you cannot specify a value in the third field that exceeds 95% of the space available on the
1686           partition mounted at the directory named in the second field. If you violate this restriction, the <emphasis
1687           role="bold">afsd</emphasis> program exits without starting the Cache Manager and prints an appropriate message on the
1688           standard output stream. A value of 90% is more appropriate on most machines. Some operating systems (such as AIX) do not
1689           automatically reserve some space to prevent the partition from filling completely; for them, a smaller value (say, 80% to
1690           85% of the space available) is more appropriate.</para>
1691         </listitem>
1692
1693         <listitem>
1694           <para>For a memory cache, you must leave enough memory for other processes and applications to run. If you try to allocate
1695           more memory than is actually available, the <emphasis role="bold">afsd</emphasis> program exits without initializing the
1696           Cache Manager and produces the following message on the standard output stream. <programlisting>
1697    afsd: memCache allocation failure at <replaceable>number</replaceable> KB
1698 </programlisting></para>
1699
1700           <para>The <replaceable>number</replaceable> value is how many kilobytes were allocated just before the failure, and so
1701           indicates the approximate amount of memory available.</para>
1702         </listitem>
1703       </itemizedlist></para>
1704
1705     <para>Within these hard limits, the factors that determine appropriate cache size include the number of users working on the
1706     machine, the size of the files with which they work, and (for a memory cache) the number of processes that run on the machine.
1707     The higher the demand from these factors, the larger the cache needs to be to maintain good performance.</para>
1708
1709     <para>Disk caches smaller than 10 MB do not generally perform well. Machines serving multiple users usually perform better with
1710     a cache of at least 60 to 70 MB. The point at which enlarging the cache further does not really improve performance depends on
1711     the factors mentioned previously and is difficult to predict.</para>
1712
1713     <para>Memory caches smaller than 1 MB are nonfunctional, and the performance of caches smaller than 5 MB is usually
1714     unsatisfactory. Suitable upper limits are similar to those for disk caches but are probably determined more by the demands on
1715     memory from other sources on the machine (number of users and processes). Machines running only a few processes possibly can use
1716     a smaller memory cache.</para>
1717
1718     <sect2 id="HDRWQ147">
1719       <title>Configuring a Disk Cache</title>
1720
1721       <note>
1722         <para>Not all file system types that an operating system supports are necessarily supported for use as the cache partition.
1723         For possible restrictions, see the <emphasis>OpenAFS Release Notes</emphasis>.</para>
1724       </note>
1725
1726       <para>To configure the disk cache, perform the following procedures: <orderedlist>
1727           <listitem>
1728             <para>Create the local directory to use for caching. The following instruction shows the conventional location,
1729             <emphasis role="bold">/usr/vice/cache</emphasis>. If you are devoting a partition exclusively to caching, as
1730             recommended, you must also configure it, make a file system on it, and mount it at the directory created in this step.
1731             <programlisting>
1732    # <emphasis role="bold">mkdir /usr/vice/cache</emphasis>
1733 </programlisting></para>
1734           </listitem>
1735
1736           <listitem>
1737             <para>Create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration parameters discussed
1738             previously. The following instruction shows the standard mount location, <emphasis role="bold">/afs</emphasis>, and the
1739             standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis>. <programlisting>
1740    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
1741 </programlisting></para>
1742
1743             <para>The following example defines the disk cache size as 50,000 KB:</para>
1744
1745             <programlisting>
1746    # <emphasis role="bold">echo "/afs:/usr/vice/cache:50000" &gt; /usr/vice/etc/cacheinfo</emphasis>
1747 </programlisting>
1748           </listitem>
1749         </orderedlist></para>
1750     </sect2>
1751
1752     <sect2 id="HDRWQ148">
1753       <title>Configuring a Memory Cache</title>
1754
1755       <para>To configure a memory cache, create the <emphasis role="bold">cacheinfo</emphasis> file to define the configuration
1756       parameters discussed previously. The following instruction shows the standard mount location, <emphasis
1757       role="bold">/afs</emphasis>, and the standard cache location, <emphasis role="bold">/usr/vice/cache</emphasis> (though the
1758       exact value of the latter is irrelevant for a memory cache).</para>
1759
1760       <programlisting>
1761    # <emphasis role="bold">echo "/afs:/usr/vice/cache:</emphasis><replaceable>#blocks</replaceable><emphasis role="bold">" &gt; /usr/vice/etc/cacheinfo</emphasis>
1762 </programlisting>
1763
1764       <para>The following example allocates 25,000 KB of memory for the cache.</para>
1765
1766       <programlisting>
1767    # <emphasis role="bold">echo "/afs:/usr/vice/cache:25000" &gt; /usr/vice/etc/cacheinfo</emphasis>
1768 </programlisting>
1769
1770       <indexterm>
1771         <primary>afs (/afs) directory</primary>
1772
1773         <secondary>creating</secondary>
1774
1775         <tertiary>client machine</tertiary>
1776       </indexterm>
1777
1778       <indexterm>
1779         <primary>afs (/afs) directory</primary>
1780
1781         <secondary>as root of AFS filespace</secondary>
1782       </indexterm>
1783
1784       <indexterm>
1785         <primary>AFS filespace</primary>
1786
1787         <secondary>root at /afs directory</secondary>
1788       </indexterm>
1789
1790       <indexterm>
1791         <primary>directories</primary>
1792
1793         <secondary>/afs</secondary>
1794       </indexterm>
1795
1796       <indexterm>
1797         <primary>afsd</primary>
1798
1799         <secondary>options file (Linux)</secondary>
1800       </indexterm>
1801
1802       <indexterm>
1803         <primary>files</primary>
1804
1805         <secondary>afsd options file (Linux)</secondary>
1806       </indexterm>
1807
1808       <indexterm>
1809         <primary>files</primary>
1810
1811         <secondary>afs</secondary>
1812
1813         <tertiary>afsd options file (Linux)</tertiary>
1814       </indexterm>
1815
1816       <indexterm>
1817         <primary>afs file</primary>
1818
1819         <secondary>afsd options file (Linux)</secondary>
1820       </indexterm>
1821
1822       <indexterm>
1823         <primary>etc/sysconfig/afs</primary>
1824
1825         <see>afs file</see>
1826       </indexterm>
1827
1828       <indexterm>
1829         <primary>Linux</primary>
1830
1831         <secondary>afsd options file</secondary>
1832       </indexterm>
1833
1834       <indexterm>
1835         <primary>client machine</primary>
1836
1837         <secondary>afsd options file (Linux)</secondary>
1838       </indexterm>
1839
1840       <indexterm>
1841         <primary>afsd</primary>
1842
1843         <secondary>command in AFS init. script</secondary>
1844       </indexterm>
1845
1846       <indexterm>
1847         <primary>commands</primary>
1848
1849         <secondary>afsd</secondary>
1850       </indexterm>
1851
1852       <indexterm>
1853         <primary>OPTIONS variable in AFS initialization file</primary>
1854       </indexterm>
1855
1856       <indexterm>
1857         <primary>files</primary>
1858
1859         <secondary>AFS initialization</secondary>
1860
1861         <see>AFS initialization script</see>
1862       </indexterm>
1863
1864       <indexterm>
1865         <primary>scripts</primary>
1866
1867         <secondary>AFS initialization</secondary>
1868
1869         <see>AFS initialization script</see>
1870       </indexterm>
1871
1872       <indexterm>
1873         <primary>AFS initialization script</primary>
1874
1875         <secondary>setting afsd parameters</secondary>
1876
1877         <tertiary>client machine</tertiary>
1878       </indexterm>
1879
1880       <indexterm>
1881         <primary>client machine</primary>
1882
1883         <secondary>afsd command parameters</secondary>
1884       </indexterm>
1885
1886       <indexterm>
1887         <primary>variables</primary>
1888
1889         <secondary>OPTIONS (in AFS initialization file)</secondary>
1890       </indexterm>
1891
1892       <indexterm>
1893         <primary>environment variables</primary>
1894
1895         <see>variables</see>
1896       </indexterm>
1897
1898       <indexterm>
1899         <primary>Cache Manager</primary>
1900
1901         <secondary>client machine</secondary>
1902       </indexterm>
1903
1904       <indexterm>
1905         <primary>configuring</primary>
1906
1907         <secondary>Cache Manager</secondary>
1908
1909         <tertiary>client machine</tertiary>
1910       </indexterm>
1911
1912       <indexterm>
1913         <primary>client machine</primary>
1914
1915         <secondary>Cache Manager</secondary>
1916       </indexterm>
1917
1918       <indexterm>
1919         <primary>files</primary>
1920
1921         <secondary>vfs (AIX)</secondary>
1922       </indexterm>
1923
1924       <indexterm>
1925         <primary>vfs file</primary>
1926       </indexterm>
1927
1928       <indexterm>
1929         <primary>etc/vfs file</primary>
1930       </indexterm>
1931
1932       <indexterm>
1933         <primary>AIX</primary>
1934
1935         <secondary>editing /etc/vfs file</secondary>
1936       </indexterm>
1937
1938       <indexterm>
1939         <primary>client machine</primary>
1940
1941         <secondary>vfs file (AIX)</secondary>
1942       </indexterm>
1943     </sect2>
1944   </sect1>
1945
1946   <sect1 id="HDRWQ149">
1947     <title>Configuring the Cache Manager</title>
1948
1949     <para>By convention, the Cache Manager mounts the AFS filespace on the local <emphasis role="bold">/afs</emphasis> directory. In
1950     this section you create that directory.</para>
1951
1952     <para>The <emphasis role="bold">afsd</emphasis> program sets several cache configuration parameters as it initializes the Cache
1953     Manager, and starts daemons that improve performance. You can use the <emphasis role="bold">afsd</emphasis> command's arguments
1954     to override the parameters' default values and to change the number of some of the daemons. Depending on the machine's cache
1955     size, its amount of RAM, and how many people work on it, you can sometimes improve Cache Manager performance by overriding the
1956     default values. For a discussion of all of the <emphasis role="bold">afsd</emphasis> command's arguments, see its reference page
1957     in the <emphasis>OpenAFS Administration Reference</emphasis>.</para>
1958
1959     <para>On platforms using the standard 'afs' initialisation script (this does
1960     not apply to Fedora or RHEL based distributions), the 
1961     <emphasis role="bold">afsd</emphasis> command line in the AFS 
1962     initialization script on each system type includes an
1963     <computeroutput>OPTIONS</computeroutput> variable. You can use it to set 
1964     nondefault values for the command's arguments, in one
1965     of the following ways: <itemizedlist>
1966         <listitem>
1967           <para>You can create an <emphasis role="bold">afsd</emphasis> <emphasis>options file</emphasis> that sets values for
1968           arguments to the <emphasis role="bold">afsd</emphasis> command. If the file exists, its contents are automatically
1969           substituted for the <computeroutput>OPTIONS</computeroutput> variable in the AFS initialization script. The AFS
1970           distribution for some system types includes an options file; on other system types, you must create it.</para>
1971
1972           <para>You use two variables in the AFS initialization script to specify the path to the options file:
1973           <computeroutput>CONFIG</computeroutput> and <computeroutput>AFSDOPT</computeroutput>. On system types that define a
1974           conventional directory for configuration files, the <computeroutput>CONFIG</computeroutput> variable indicates it by
1975           default; otherwise, the variable indicates an appropriate location.</para>
1976
1977           <para>List the desired <emphasis role="bold">afsd</emphasis> options on a single line in the options file, separating each
1978           option with one or more spaces. The following example sets the <emphasis role="bold">-stat</emphasis> argument to 2500,
1979           the <emphasis role="bold">-daemons</emphasis> argument to 4, and the <emphasis role="bold">-volumes</emphasis> argument to
1980           100.</para>
1981
1982           <programlisting>
1983    -stat 2500 -daemons 4 -volumes 100   
1984 </programlisting>
1985         </listitem>
1986
1987         <listitem>
1988           <para>On a machine that uses a disk cache, you can set the <computeroutput>OPTIONS</computeroutput> variable in the AFS
1989           initialization script to one of <computeroutput>$SMALL</computeroutput>, <computeroutput>$MEDIUM</computeroutput>, or
1990           <computeroutput>$LARGE</computeroutput>. The AFS initialization script uses one of these settings if the <emphasis
1991           role="bold">afsd</emphasis> options file named by the <computeroutput>AFSDOPT</computeroutput> variable does not exist. In
1992           the script as distributed, the <computeroutput>OPTIONS</computeroutput> variable is set to the value
1993           <computeroutput>$MEDIUM</computeroutput>.</para>
1994
1995           <note>
1996             <para>Do not set the <computeroutput>OPTIONS</computeroutput> variable to <computeroutput>$SMALL</computeroutput>,
1997             <computeroutput>$MEDIUM</computeroutput>, or <computeroutput>$LARGE</computeroutput> on a machine that uses a memory
1998             cache. The arguments it sets are appropriate only on a machine that uses a disk cache.</para>
1999           </note>
2000
2001           <para>The script (or on some system types the <emphasis role="bold">afsd</emphasis> options file named by the
2002           <computeroutput>AFSDOPT</computeroutput> variable) defines a value for each of <computeroutput>SMALL</computeroutput>,
2003           <computeroutput>MEDIUM</computeroutput>, and <computeroutput>LARGE</computeroutput> that sets <emphasis
2004           role="bold">afsd</emphasis> command arguments appropriately for client machines of different sizes: <itemizedlist>
2005               <listitem>
2006                 <para><computeroutput>SMALL</computeroutput> is suitable for a small machine that serves one or two users and has
2007                 approximately 8 MB of RAM and a 20-MB cache</para>
2008               </listitem>
2009
2010               <listitem>
2011                 <para><computeroutput>MEDIUM</computeroutput> is suitable for a medium-sized machine that serves two to six users
2012                 and has 16 MB of RAM and a 40-MB cache</para>
2013               </listitem>
2014
2015               <listitem>
2016                 <para><computeroutput>LARGE</computeroutput> is suitable for a large machine that serves five to ten users and has
2017                 32 MB of RAM and a 100-MB cache</para>
2018               </listitem>
2019             </itemizedlist></para>
2020         </listitem>
2021
2022         <listitem>
2023           <para>You can choose not to create an <emphasis role="bold">afsd</emphasis> options file and to set the
2024           <computeroutput>OPTIONS</computeroutput> variable in the initialization script to a null value rather than to the default
2025           <computeroutput>$MEDIUM</computeroutput> value. You can then either set arguments directly on the <emphasis
2026           role="bold">afsd</emphasis> command line in the script, or set no arguments (and so accept default values for all Cache
2027           Manager parameters).</para>
2028         </listitem>
2029       </itemizedlist>
2030       
2031       <note>
2032         <para>If you are running on a Fedora or RHEL based system, the 
2033         openafs-client initialization script behaves differently from that
2034         described above. It sources 
2035         <emphasis role="bold">/etc/sysconfig/openafs</emphasis>, in which the
2036         AFSD_ARGS variable may be set to contain any, or all, of the afsd 
2037         options detailed above. Note that this script does not support setting
2038         an <computeroutput>OPTIONS</computeroutput> variable, or the 
2039         <computeroutput>SMALL</computeroutput>,
2040         <computeroutput>MEDIUM</computeroutput> and
2041         <computeroutput>LARGE</computeroutput> methods of defining cache size.
2042         </para>
2043       </note>
2044       
2045       <orderedlist>
2046         <listitem>
2047           <para>Create the local directory on which to mount the AFS filespace, by convention <emphasis role="bold">/afs</emphasis>.
2048           If the directory already exists, verify that it is empty. <programlisting>
2049    # <emphasis role="bold">mkdir /afs</emphasis>
2050 </programlisting></para>
2051         </listitem>
2052
2053         <listitem>
2054           <para>On AIX systems, add the following line to the <emphasis role="bold">/etc/vfs</emphasis> file. It enables AIX to
2055           unmount AFS correctly during shutdown. <programlisting>
2056    afs     4     none     none
2057 </programlisting></para>
2058         </listitem>
2059
2060         <listitem>
2061           <para>On non-package based Linux systems, copy the <emphasis role="bold">afsd</emphasis> options file from the <emphasis
2062           role="bold">/usr/vice/etc</emphasis> directory to the <emphasis role="bold">/etc/sysconfig</emphasis> directory, removing
2063           the <emphasis role="bold">.conf</emphasis> extension as you do so. <programlisting>
2064    # <emphasis role="bold">cp /usr/vice/etc/afs.conf /etc/sysconfig/afs</emphasis>
2065 </programlisting></para>
2066         </listitem>
2067
2068         <listitem>
2069           <para>Edit the machine's AFS initialization script or <emphasis role="bold">afsd</emphasis> options file to set
2070           appropriate values for <emphasis role="bold">afsd</emphasis> command parameters. The appropriate file for each system type
2071           is as follows: <itemizedlist>
2072               <listitem>
2073                 <para>On AIX systems, <emphasis role="bold">/etc/rc.afs</emphasis></para>
2074               </listitem>
2075
2076               <listitem>
2077                 <para>On HP-UX systems, <emphasis role="bold">/sbin/init.d/afs</emphasis></para>
2078               </listitem>
2079
2080               <listitem>
2081                 <para>On IRIX systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
2082               </listitem>
2083
2084               <listitem>
2085                 <para>On Fedora and RHEL systems, <emphasis role="bold">/etc/sysconfig/openafs</emphasis></para>
2086               </listitem>
2087               
2088               <listitem>
2089                 <para>On Linux systems, <emphasis role="bold">/etc/sysconfig/afs</emphasis> (the <emphasis
2090                 role="bold">afsd</emphasis> options file)</para>
2091               </listitem>
2092
2093               <listitem>
2094                 <para>On Solaris systems, <emphasis role="bold">/etc/init.d/afs</emphasis></para>
2095               </listitem>
2096             </itemizedlist></para>
2097
2098           <para>Use one of the methods described in the introduction to this section to add the following flags to the <emphasis
2099           role="bold">afsd</emphasis> command line. Also set any performance-related arguments you wish. <itemizedlist>
2100               <listitem>
2101                 <para>Add the <emphasis role="bold">-memcache</emphasis> flag if the machine is to use a memory cache.</para>
2102               </listitem>
2103
2104               <listitem>
2105                 <para>Add the <emphasis role="bold">-verbose</emphasis> flag to display a trace of the Cache Manager's
2106                 initialization on the standard output stream.</para>
2107               </listitem>
2108             </itemizedlist></para>
2109         </listitem>
2110       </orderedlist></para>
2111
2112     <indexterm>
2113       <primary>AFS initialization script</primary>
2114
2115       <secondary>running</secondary>
2116
2117       <tertiary>client machine</tertiary>
2118     </indexterm>
2119
2120     <indexterm>
2121       <primary>client machine</primary>
2122
2123       <secondary>AFS initialization script</secondary>
2124     </indexterm>
2125
2126     <indexterm>
2127       <primary>running AFS init. script</primary>
2128
2129       <secondary>client machine</secondary>
2130     </indexterm>
2131
2132     <indexterm>
2133       <primary>installing</primary>
2134
2135       <secondary>AFS initialization script</secondary>
2136
2137       <tertiary>client machine</tertiary>
2138     </indexterm>
2139
2140     <indexterm>
2141       <primary>AFS initialization script</primary>
2142
2143       <secondary>adding to machine startup sequence</secondary>
2144
2145       <tertiary>client machine</tertiary>
2146     </indexterm>
2147   </sect1>
2148
2149   <sect1 id="HDRWQ150">
2150     <title>Starting the Cache Manager and Installing the AFS Initialization Script</title>
2151
2152     <para>In this section you run the AFS initialization script to start the Cache Manager. If the script works correctly, perform
2153     the steps that incorporate it into the machine's startup and shutdown sequence. If there are problems during the initialization,
2154     attempt to resolve them. The AFS Product Support group can provide assistance if necessary.</para>
2155
2156     <para>On machines that use a disk cache, it can take a while for the <emphasis role="bold">afsd</emphasis> program to run the
2157     first time on a machine, because it must create all of the <emphasis role="bold">V</emphasis><replaceable>n</replaceable> files
2158     in the cache directory. Subsequent Cache Manager initializations do not take nearly as long, because the <emphasis
2159     role="bold">V</emphasis><replaceable>n</replaceable> files already exist.</para>
2160
2161     <para>On system types that use a dynamic loader program, you must reboot the machine before running the initialization script,
2162     so that it can freshly load AFS modifications into the kernel.</para>
2163
2164     <para>Proceed to the instructions for your system type:</para>
2165
2166     <itemizedlist>
2167       <listitem>
2168         <para><link linkend="HDRWQ151">Running the Script on AIX Systems</link></para>
2169       </listitem>
2170
2171       <listitem>
2172         <para><link linkend="HDRWQ153">Running the Script on HP-UX Systems</link></para>
2173       </listitem>
2174
2175       <listitem>
2176         <para><link linkend="HDRWQ154">Running the Script on IRIX Systems</link></para>
2177       </listitem>
2178
2179       <listitem>
2180         <para><link linkend="HDRWQ155">Running the Script on Linux Systems</link></para>
2181       </listitem>
2182
2183       <listitem>
2184         <para><link linkend="HDRWQ156">Running the Script on Solaris Systems</link></para>
2185       </listitem>
2186     </itemizedlist>
2187
2188     <indexterm>
2189       <primary>AIX</primary>
2190
2191       <secondary>AFS initialization script</secondary>
2192
2193       <tertiary>on client machine</tertiary>
2194     </indexterm>
2195
2196     <indexterm>
2197       <primary>rc.afs file (AFS init. file for AIX)</primary>
2198     </indexterm>
2199
2200     <indexterm>
2201       <primary>files</primary>
2202
2203       <secondary>rc.afs</secondary>
2204     </indexterm>
2205
2206     <indexterm>
2207       <primary>etc/rc.afs</primary>
2208
2209       <see>rc.afs file</see>
2210     </indexterm>
2211
2212     <sect2 id="HDRWQ151">
2213       <title>Running the Script on AIX Systems</title>
2214
2215       <orderedlist>
2216         <listitem>
2217           <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
2218    # <emphasis role="bold">cd /</emphasis>
2219    # <emphasis role="bold">shutdown -r now</emphasis>
2220    login: <emphasis role="bold">root</emphasis>
2221    Password: <replaceable>root_password</replaceable>
2222 </programlisting></para>
2223         </listitem>
2224
2225         <listitem>
2226           <para>Run the AFS initialization script. <programlisting>
2227    # <emphasis role="bold">/etc/rc.afs</emphasis>
2228 </programlisting></para>
2229         </listitem>
2230
2231         <listitem>
2232           <para>Edit the AIX initialization file, <emphasis role="bold">/etc/inittab</emphasis>, adding the following line to invoke
2233           the AFS initialization script. Place it just after the line that starts NFS daemons. <programlisting>
2234    rcafs:2:wait:/etc/rc.afs &gt; /dev/console 2&gt;&amp;1 # Start AFS services
2235 </programlisting></para>
2236         </listitem>
2237
2238         <listitem>
2239           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2240           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc</emphasis> directories. If you want to avoid
2241           potential confusion by guaranteeing that they are always the same, create a link between them. You can always retrieve the
2242           original script from the AFS CD-ROM if necessary. <programlisting>
2243    # <emphasis role="bold">cd  /usr/vice/etc</emphasis>
2244    # <emphasis role="bold">rm  rc.afs</emphasis>
2245    # <emphasis role="bold">ln -s  /etc/rc.afs</emphasis>
2246 </programlisting></para>
2247         </listitem>
2248
2249         <listitem>
2250           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2251           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2252           complete.</para>
2253         </listitem>
2254       </orderedlist>
2255
2256       <indexterm>
2257         <primary>afs file</primary>
2258
2259         <secondary>AFS initialization file</secondary>
2260       </indexterm>
2261
2262       <indexterm>
2263         <primary>files</primary>
2264
2265         <secondary>afs</secondary>
2266
2267         <tertiary>AFS initialization file</tertiary>
2268       </indexterm>
2269
2270       <indexterm>
2271         <primary>HP-UX</primary>
2272
2273         <secondary>AFS initialization script</secondary>
2274
2275         <tertiary>on client machine</tertiary>
2276       </indexterm>
2277     </sect2>
2278
2279     <sect2 id="HDRWQ153">
2280       <title>Running the Script on HP-UX Systems</title>
2281
2282       <orderedlist>
2283         <listitem>
2284           <para>Run the AFS initialization script. <programlisting>
2285    # <emphasis role="bold">/sbin/init.d/afs  start</emphasis>
2286 </programlisting></para>
2287         </listitem>
2288
2289         <listitem>
2290           <para>Change to the <emphasis role="bold">/sbin/init.d</emphasis> directory and issue the <emphasis role="bold">ln
2291           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the HP-UX startup and
2292           shutdown sequence. <programlisting>
2293    # <emphasis role="bold">cd /sbin/init.d</emphasis>
2294    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/S460afs</emphasis>
2295    # <emphasis role="bold">ln -s ../init.d/afs /sbin/rc2.d/K800afs</emphasis>
2296 </programlisting></para>
2297         </listitem>
2298
2299         <listitem>
2300           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2301           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/sbin/init.d</emphasis> directories. If you want
2302           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
2303           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
2304    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2305    # <emphasis role="bold">rm afs.rc</emphasis>
2306    # <emphasis role="bold">ln -s  /sbin/init.d/afs  afs.rc</emphasis>
2307 </programlisting></para>
2308         </listitem>
2309
2310         <listitem>
2311           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2312           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2313           complete.</para>
2314         </listitem>
2315       </orderedlist>
2316
2317       <indexterm>
2318         <primary>afs file</primary>
2319
2320         <secondary>AFS initialization file</secondary>
2321       </indexterm>
2322
2323       <indexterm>
2324         <primary>files</primary>
2325
2326         <secondary>afs</secondary>
2327
2328         <tertiary>AFS initialization file</tertiary>
2329       </indexterm>
2330
2331       <indexterm>
2332         <primary>IRIX</primary>
2333
2334         <secondary>AFS initialization script</secondary>
2335
2336         <tertiary>on client machine</tertiary>
2337       </indexterm>
2338
2339       <indexterm>
2340         <primary>etc/init.d/afs</primary>
2341
2342         <see>afs file</see>
2343       </indexterm>
2344
2345       <indexterm>
2346         <primary>afsclient variable (IRIX)</primary>
2347
2348         <secondary>client machine</secondary>
2349       </indexterm>
2350
2351       <indexterm>
2352         <primary>variables</primary>
2353
2354         <secondary>afsclient (IRIX)</secondary>
2355
2356         <tertiary>client machine</tertiary>
2357       </indexterm>
2358
2359       <indexterm>
2360         <primary>IRIX</primary>
2361
2362         <secondary>afsclient variable</secondary>
2363
2364         <tertiary>client machine</tertiary>
2365       </indexterm>
2366     </sect2>
2367
2368     <sect2 id="HDRWQ154">
2369       <title>Running the Script on IRIX Systems</title>
2370
2371       <orderedlist>
2372         <listitem>
2373           <para>If you have configured the machine to use the <emphasis role="bold">ml</emphasis> dynamic loader program, reboot the
2374           machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
2375    # <emphasis role="bold">cd /</emphasis>
2376    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
2377    login: <emphasis role="bold">root</emphasis>
2378    Password: <replaceable>root_password</replaceable>
2379 </programlisting></para>
2380         </listitem>
2381
2382         <listitem>
2383           <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis
2384           role="bold">afsclient</emphasis> configuration variable. <programlisting>
2385    # <emphasis role="bold">/etc/chkconfig -f afsclient on</emphasis> 
2386 </programlisting></para>
2387         </listitem>
2388
2389         <listitem>
2390           <para>Run the AFS initialization script. <programlisting>
2391    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
2392 </programlisting></para>
2393         </listitem>
2394
2395         <listitem>
2396           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
2397           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the IRIX startup and
2398           shutdown sequence. <programlisting>
2399    # <emphasis role="bold">cd /etc/init.d</emphasis>
2400    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc2.d/S35afs</emphasis>
2401    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K35afs</emphasis>
2402 </programlisting></para>
2403         </listitem>
2404
2405         <listitem>
2406           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2407           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
2408           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
2409           retrieve the original script from the AFS CD-ROM if necessary. <programlisting>
2410    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2411    # <emphasis role="bold">rm afs.rc</emphasis>
2412    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
2413 </programlisting></para>
2414         </listitem>
2415
2416         <listitem>
2417           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2418           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2419           complete.</para>
2420         </listitem>
2421       </orderedlist>
2422
2423       <indexterm>
2424         <primary>afs file</primary>
2425
2426         <secondary>AFS initialization file</secondary>
2427       </indexterm>
2428
2429       <indexterm>
2430         <primary>files</primary>
2431
2432         <secondary>afs</secondary>
2433
2434         <tertiary>AFS initialization file</tertiary>
2435       </indexterm>
2436
2437       <indexterm>
2438         <primary>etc/rc.d/init.d/afs</primary>
2439
2440         <see>afs file</see>
2441       </indexterm>
2442
2443       <indexterm>
2444         <primary>Linux</primary>
2445
2446         <secondary>AFS initialization script</secondary>
2447
2448         <tertiary>on client machine</tertiary>
2449       </indexterm>
2450     </sect2>
2451
2452     <sect2>
2453       <title>Running the Script on Fedora / RHEL Systems</title>
2454
2455       <orderedlist>
2456         <listitem>
2457           <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
2458    # <emphasis role="bold">cd /</emphasis>
2459    # <emphasis role="bold">shutdown -r now</emphasis>
2460    login: <emphasis role="bold">root</emphasis>
2461    Password: <replaceable>root_password</replaceable>
2462 </programlisting></para>
2463         </listitem>
2464
2465         <listitem>
2466           <para>Run the AFS initialization script. 
2467 <programlisting>
2468    # <emphasis role="bold">/etc/rc.d/init.d/openafs-client  start</emphasis>
2469 </programlisting></para>
2470         </listitem>
2471
2472         <listitem>
2473           <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis role="bold">openafs-client</emphasis>
2474           configuration variable. Based on the instruction in the AFS initialization file that begins with the string
2475           <computeroutput>#chkconfig</computeroutput>, the command automatically creates the symbolic links that incorporate the
2476           script into the Linux startup and shutdown sequence. <programlisting>
2477    # <emphasis role="bold">/sbin/chkconfig  --add openafs-client</emphasis>
2478 </programlisting></para>
2479         </listitem>
2480       </orderedlist>
2481     </sect2>
2482       
2483     <sect2 id="HDRWQ155">
2484       <title>Running the Script on other Linux Systems</title>
2485
2486       <orderedlist>
2487         <listitem>
2488           <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
2489    # <emphasis role="bold">cd /</emphasis>
2490    # <emphasis role="bold">shutdown -r now</emphasis>
2491    login: <emphasis role="bold">root</emphasis>
2492    Password: <replaceable>root_password</replaceable>
2493 </programlisting></para>
2494         </listitem>
2495
2496         <listitem>
2497           <para>Run the AFS initialization script. <programlisting>
2498    # <emphasis role="bold">/etc/rc.d/init.d/afs  start</emphasis>
2499 </programlisting></para>
2500         </listitem>
2501
2502         <listitem>
2503           <para>Issue the <emphasis role="bold">chkconfig</emphasis> command to activate the <emphasis role="bold">afs</emphasis>
2504           configuration variable. Based on the instruction in the AFS initialization file that begins with the string
2505           <computeroutput>#chkconfig</computeroutput>, the command automatically creates the symbolic links that incorporate the
2506           script into the Linux startup and shutdown sequence. <programlisting>
2507    # <emphasis role="bold">/sbin/chkconfig  --add afs</emphasis>
2508 </programlisting></para>
2509         </listitem>
2510
2511         <listitem>
2512           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2513           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/rc.d/init.d</emphasis> directories, and
2514           copies of the <emphasis role="bold">afsd</emphasis> options file in both the <emphasis
2515           role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/sysconfig</emphasis> directories. If you want to avoid
2516           potential confusion by guaranteeing that the two copies of each file are always the same, create a link between them. You
2517           can always retrieve the original script or options file from the AFS CD-ROM if necessary. <programlisting>
2518    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2519    # <emphasis role="bold">rm afs.rc afs.conf</emphasis>
2520    # <emphasis role="bold">ln -s  /etc/rc.d/init.d/afs  afs.rc</emphasis>
2521    # <emphasis role="bold">ln -s  /etc/sysconfig/afs  afs.conf</emphasis>
2522 </programlisting></para>
2523         </listitem>
2524
2525         <listitem>
2526           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2527           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2528           complete.</para>
2529         </listitem>
2530       </orderedlist>
2531
2532       <indexterm>
2533         <primary>afs file</primary>
2534
2535         <secondary>AFS initialization file</secondary>
2536       </indexterm>
2537
2538       <indexterm>
2539         <primary>files</primary>
2540
2541         <secondary>afs</secondary>
2542
2543         <tertiary>AFS initialization file</tertiary>
2544       </indexterm>
2545
2546       <indexterm>
2547         <primary>Solaris</primary>
2548
2549         <secondary>AFS initialization script</secondary>
2550
2551         <tertiary>on client machine</tertiary>
2552       </indexterm>
2553     </sect2>
2554
2555     <sect2 id="HDRWQ156">
2556       <title>Running the Script on Solaris Systems</title>
2557
2558       <orderedlist>
2559         <listitem>
2560           <para>Reboot the machine and log in again as the local superuser <emphasis role="bold">root</emphasis>. <programlisting>
2561    # <emphasis role="bold">cd /</emphasis>
2562    # <emphasis role="bold">shutdown -i6 -g0 -y</emphasis>
2563    login: <emphasis role="bold">root</emphasis>
2564    Password: <replaceable>root_password</replaceable>
2565 </programlisting></para>
2566         </listitem>
2567
2568         <listitem>
2569           <para>Run the AFS initialization script. <programlisting>
2570    # <emphasis role="bold">/etc/init.d/afs  start</emphasis>
2571 </programlisting></para>
2572         </listitem>
2573
2574         <listitem>
2575           <para>Change to the <emphasis role="bold">/etc/init.d</emphasis> directory and issue the <emphasis role="bold">ln
2576           -s</emphasis> command to create symbolic links that incorporate the AFS initialization script into the Solaris startup and
2577           shutdown sequence. <programlisting>
2578    # <emphasis role="bold">cd /etc/init.d</emphasis>
2579    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc3.d/S99afs</emphasis>
2580    # <emphasis role="bold">ln -s ../init.d/afs /etc/rc0.d/K66afs</emphasis>
2581 </programlisting></para>
2582         </listitem>
2583
2584         <listitem>
2585           <para><emphasis role="bold">(Optional)</emphasis> There are now copies of the AFS initialization file in both the
2586           <emphasis role="bold">/usr/vice/etc</emphasis> and <emphasis role="bold">/etc/init.d</emphasis> directories. If you want
2587           to avoid potential confusion by guaranteeing that they are always the same, create a link between them. You can always
2588           retrieve the original script from the OpenAFS Binary Distribution if necessary. <programlisting>
2589    # <emphasis role="bold">cd /usr/vice/etc</emphasis>
2590    # <emphasis role="bold">rm afs.rc</emphasis>
2591    # <emphasis role="bold">ln -s  /etc/init.d/afs  afs.rc</emphasis>
2592 </programlisting></para>
2593         </listitem>
2594
2595         <listitem>
2596           <para>If a volume for housing AFS binaries for this machine's system type does not already exist, proceed to <link
2597           linkend="HDRWQ157">Setting Up Volumes and Loading Binaries into AFS</link>. Otherwise, the installation is
2598           complete.</para>
2599         </listitem>
2600       </orderedlist>
2601
2602       <indexterm>
2603         <primary>storing</primary>
2604
2605         <secondary>AFS binaries in volumes</secondary>
2606       </indexterm>
2607
2608       <indexterm>
2609         <primary>creating</primary>
2610
2611         <secondary>volume</secondary>
2612
2613         <tertiary>for AFS binaries</tertiary>
2614       </indexterm>
2615
2616       <indexterm>
2617         <primary>volume</primary>
2618
2619         <secondary>for AFS binaries</secondary>
2620       </indexterm>
2621
2622       <indexterm>
2623         <primary>binaries</primary>
2624
2625         <secondary>storing AFS in volume</secondary>
2626       </indexterm>
2627
2628       <indexterm>
2629         <primary>usr/afsws directory</primary>
2630       </indexterm>
2631
2632       <indexterm>
2633         <primary>directories</primary>
2634
2635         <secondary>/usr/afsws</secondary>
2636       </indexterm>
2637     </sect2>
2638   </sect1>
2639
2640   <sect1 id="HDRWQ157">
2641     <title>Setting Up Volumes and Loading Binaries into AFS</title>
2642
2643     <note><para>If you are using an operating system which uses packaged
2644     binaries, such as .rpms or .debs, you should allow these package management
2645     systems to maintain your AFS binaries, rather than following the 
2646     instructions in this section.</para></note>
2647     
2648     <para>In this section, you link <emphasis role="bold">/usr/afsws</emphasis> on the local disk to the directory in AFS that
2649     houses AFS binaries for this system type. The conventional name for the AFS directory is <emphasis
2650     role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2651     role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis>.</para>
2652
2653     <para>If this machine is an existing system type, the AFS directory presumably already exists. You can simply create a link from
2654     the local <emphasis role="bold">/usr/afsws</emphasis> directory to it. Follow the instructions in <link
2655     linkend="HDRWQ158">Linking /usr/afsws on an Existing System Type</link>.</para>
2656
2657     <para>If this machine is a new system type (there are no AFS machines of this type in your cell), you must first create and
2658     mount volumes to store its AFS binaries, and then create the link from <emphasis role="bold">/usr/afsws</emphasis> to the new
2659     directory. See <link linkend="HDRWQ159">Creating Binary Volumes for a New System Type</link>.</para>
2660
2661     <para>You can also store UNIX system binaries (the files normally stored in local disk directories such as <emphasis
2662     role="bold">/bin</emphasis>, <emphasis role="bold">/etc</emphasis>, and <emphasis role="bold">/lib</emphasis>) in volumes
2663     mounted under <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2664     role="bold">/</emphasis><replaceable>sysname</replaceable>. See <link linkend="HDRWQ88">Storing System Binaries in AFS</link>
2665     .</para>
2666
2667     <sect2 id="HDRWQ158">
2668       <title>Linking /usr/afsws on an Existing System Type</title>
2669
2670       <para>If this client machine is an existing system type, there is already a volume mounted in the AFS filespace that houses
2671       AFS client binaries for it. <orderedlist>
2672           <listitem>
2673             <para>Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the directory <emphasis
2674             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws</emphasis>. You can
2675             specify the actual system name instead of <emphasis role="bold">@sys</emphasis> if you wish, but the advantage of using
2676             <emphasis role="bold">@sys</emphasis> is that it remains valid if you upgrade this machine to a different system type.
2677             <programlisting>
2678    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
2679 </programlisting></para>
2680           </listitem>
2681
2682           <listitem>
2683             <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
2684             in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as
2685             a symbolic link to the documentation directory in AFS (<emphasis
2686             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2687             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
2688    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
2689                   role="bold">/usr/afsdoc</emphasis>
2690 </programlisting></para>
2691
2692             <para>An alternative is to create a link in each user's home directory to the <emphasis
2693             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2694             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
2695           </listitem>
2696         </orderedlist></para>
2697     </sect2>
2698
2699     <sect2 id="HDRWQ159">
2700       <title>Creating Binary Volumes for a New System Type</title>
2701
2702       <para>If this client machine is a new system type, you must create and mount volumes for its binaries before you can link the
2703       local <emphasis role="bold">/usr/afsws</emphasis> directory to an AFS directory.</para>
2704
2705       <para>To create and mount the volumes, you use the 
2706       <emphasis role="bold">kinit</emphasis> command to authenticate as an
2707       administrator, followed by the <emphasis role="bold">aklog</emphasis> 
2708       command to gain tokens, and then issue commands from the 
2709       <emphasis role="bold">vos</emphasis> and 
2710       <emphasis role="bold">fs</emphasis> command suites. However, the 
2711       command binaries are not yet available on this machine (by convention, 
2712       they are accessible via the <emphasis role="bold">/usr/afsws</emphasis> 
2713       link that you are about to create). You have two choices: 
2714       <itemizedlist>
2715           <listitem>
2716             <para>Perform all steps except the last one (Step <link linkend="LIWQ162">10</link>) on an existing AFS machine. On a
2717             file server machine, the <emphasis role="bold">aklog</emphasis>, <emphasis role="bold">fs</emphasis> and <emphasis
2718             role="bold">vos</emphasis> binaries reside in the <emphasis role="bold">/usr/afs/bin</emphasis> directory. On client
2719             machines, the <emphasis role="bold">aklog</emphasis> and <emphasis role="bold">fs</emphasis> binaries reside in the
2720             <emphasis role="bold">/usr/afsws/bin</emphasis> directory and the <emphasis role="bold">vos</emphasis> binary in the
2721             <emphasis role="bold">/usr/afsws/etc</emphasis> directory. Depending on how your PATH environment variable is set, you
2722             possibly need to precede the command names with a pathname.</para>
2723
2724             <para>If you work on another AFS machine, be sure to substitute the new system type name for the
2725             <replaceable>sysname</replaceable> argument in the following commands, not the system type of the machine on which you
2726             are issuing the commands.</para>
2727           </listitem>
2728
2729           <listitem>
2730             <para>Copy the necessary command binaries to a temporary location on the local disk, which enables you to perform the
2731             steps on the local machine. The following procedure installs them in the <emphasis role="bold">/tmp</emphasis> directory
2732             and removes them at the end. Depending on how your PATH environment variable is set, you possibly need to precede the
2733             command names with a pathname.</para>
2734           </listitem>
2735         </itemizedlist></para>
2736
2737       <para>Perform the following steps to create a volume for housing AFS binaries. <orderedlist>
2738           <listitem>
2739             <para>Working either on the local machine or another AFS machine, 
2740             extract the Open AFS distribtion tarball onto a directory on that 
2741             machine. The following instructions assume that you are using the
2742             <emphasis role="bold">/tmp/afsdist</emphasis> directory.</para>
2743           </listitem>
2744
2745           <listitem>
2746             <para>If working on the local machine, copy the necessary binaries to a temporary location on the local disk. Substitute
2747             a different directory name for <emphasis role="bold">/tmp</emphasis> if you wish. <programlisting>
2748    # <emphasis role="bold">cd  /tmp/afsdist/</emphasis><replaceable>new_sysname</replaceable><emphasis role="bold">/root.server/usr/afs/bin</emphasis>
2749    # <emphasis role="bold">cp -p  aklog  /tmp</emphasis>
2750    # <emphasis role="bold">cp -p  fs  /tmp</emphasis>
2751    # <emphasis role="bold">cp -p  vos  /tmp</emphasis>
2752 </programlisting></para>
2753           </listitem>
2754
2755           <listitem>
2756             <para>Authenticate as the user <emphasis role="bold">admin</emphasis>. 
2757 <programlisting>
2758    # <emphasis role="bold">kinit admin</emphasis>
2759    Password: <replaceable>admin_password</replaceable>
2760    # <emphasis role="bold">aklog</emphasis>
2761 </programlisting></para>
2762           </listitem>
2763
2764           <listitem>
2765             <para><anchor id="LIWQ160" />Issue the <emphasis role="bold">vos create</emphasis> command to create volumes for storing
2766             the AFS client binaries for this system type. The following example instruction creates volumes called
2767             <replaceable>sysname</replaceable>, <replaceable>sysname</replaceable>.<emphasis role="bold">usr</emphasis>, and
2768             <replaceable>sysname</replaceable>.<emphasis role="bold">usr.afsws</emphasis>. Refer to the <emphasis>OpenAFS Release
2769             Notes</emphasis> to learn the proper value of <replaceable>sysname</replaceable> for this system type. <programlisting>
2770    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable>
2771    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
2772                   role="bold">.usr</emphasis>
2773    # <emphasis role="bold">vos create</emphasis> &lt;<replaceable>machine name</replaceable>&gt; &lt;<replaceable>partition name</replaceable>&gt; <replaceable>sysname</replaceable><emphasis
2774                   role="bold">.usr.afsws</emphasis>
2775 </programlisting></para>
2776           </listitem>
2777
2778           <listitem>
2779             <para>Issue the <emphasis role="bold">fs mkmount</emphasis> command to mount the newly created volumes. Because the
2780             <emphasis role="bold">root.cell</emphasis> volume is replicated, you must precede the <emphasis>cellname</emphasis> part
2781             of the pathname with a period to specify the read/write mount point, as shown. Then issue the <emphasis role="bold">vos
2782             release</emphasis> command to release a new replica of the <emphasis role="bold">root.cell</emphasis> volume, and the
2783             <emphasis role="bold">fs checkvolumes</emphasis> command to force the local Cache Manager to access them.
2784             <programlisting>
2785    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable> <emphasis
2786                   role="bold">-vol</emphasis> <replaceable>sysname</replaceable>
2787    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
2788                   role="bold">/usr</emphasis>  <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
2789                   role="bold">.usr</emphasis>
2790    # <emphasis role="bold">fs mkmount -dir /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
2791                   role="bold">/usr/afsws</emphasis> <emphasis role="bold">-vol</emphasis> <replaceable>sysname</replaceable><emphasis
2792                   role="bold">.usr.afsws</emphasis>
2793    # <emphasis role="bold">vos release root.cell</emphasis>
2794    # <emphasis role="bold">fs checkvolumes</emphasis>
2795 </programlisting></para>
2796           </listitem>
2797
2798           <listitem>
2799             <para>Issue the <emphasis role="bold">fs setacl</emphasis> command to grant the <emphasis role="bold">l</emphasis>
2800             (<emphasis role="bold">lookup</emphasis>) and <emphasis role="bold">r</emphasis> (<emphasis role="bold">read</emphasis>)
2801             permissions to the <emphasis role="bold">system:anyuser</emphasis> group on each new directory's ACL. <programlisting>
2802    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable>
2803    # <emphasis role="bold">fs setacl  -dir  .  usr  usr/afsws  -acl  system:anyuser rl</emphasis> 
2804 </programlisting></para>
2805           </listitem>
2806
2807           <listitem>
2808             <para>Issue the <emphasis role="bold">fs setquota</emphasis> command to set an unlimited quota on the volume mounted at
2809             the <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2810             role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory. This
2811             enables you to copy all of the appropriate files from the CD-ROM into the volume without exceeding the volume's
2812             quota.</para>
2813
2814             <para>If you wish, you can set the volume's quota to a finite value after you complete the copying operation. At that
2815             point, use the <emphasis role="bold">vos examine</emphasis> command to determine how much space the volume is occupying.
2816             Then issue the <emphasis role="bold">fs setquota</emphasis> command to set a quota that is slightly larger.</para>
2817
2818             <programlisting>
2819    # <emphasis role="bold">fs setquota /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
2820                 role="bold">/usr/afsws  0</emphasis>
2821 </programlisting>
2822           </listitem>
2823
2824           <listitem>
2825             <para><anchor id="LIWQ161" />Copy the contents of the indicated 
2826             directories from the OpenAFS binary distribution into the 
2827             <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2828             role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/usr/afsws</emphasis> directory.
2829             <programlisting>
2830    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
2831                   role="bold">/usr/afsws</emphasis>
2832    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/bin  .</emphasis>
2833    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/etc  .</emphasis>
2834    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/include  .</emphasis>
2835    # <emphasis role="bold">cp -rp /cdrom/</emphasis><replaceable>sysname</replaceable><emphasis role="bold">/lib  .</emphasis>
2836 </programlisting></para>
2837           </listitem>
2838
2839           <listitem>
2840             <para>Issue the <emphasis role="bold">fs setacl</emphasis> command 
2841             to set the ACL on each directory appropriately. If you wish to 
2842             enable access to the software for locally authenticated users only, 
2843             set the ACL on the <emphasis role="bold">etc</emphasis>, 
2844             <emphasis role="bold">include</emphasis>, and 
2845             <emphasis role="bold">lib</emphasis> subdirectories to grant the 
2846             <emphasis role="bold">l</emphasis> and 
2847             <emphasis role="bold">r</emphasis> permissions to the 
2848             <emphasis role="bold">system:authuser</emphasis> group rather than 
2849             the <emphasis role="bold">system:anyuser</emphasis> group. The
2850             <emphasis role="bold">system:anyuser</emphasis> group must retain 
2851             the <emphasis role="bold">l</emphasis> and 
2852             <emphasis role="bold">r</emphasis> permissions on the 
2853             <emphasis role="bold">bin</emphasis> subdirectory to enable 
2854             unauthenticated users to access the 
2855             <emphasis role="bold">aklog</emphasis> binary. 
2856 <programlisting>
2857    # <emphasis role="bold">cd /afs/.</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/</emphasis><replaceable>sysname</replaceable><emphasis
2858                   role="bold">/usr/afsws</emphasis>
2859    # <emphasis role="bold">fs setacl  -dir etc include lib  -acl  system:authuser rl</emphasis>  \
2860               <emphasis role="bold">system:anyuser none</emphasis>
2861 </programlisting></para>
2862           </listitem>
2863
2864           <listitem>
2865             <para><anchor id="LIWQ162" />Perform this step on the new client machine even if you have performed the previous steps
2866             on another machine. Create <emphasis role="bold">/usr/afsws</emphasis> on the local disk as a symbolic link to the
2867             directory <emphasis role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2868             role="bold">/@sys/usr/afsws</emphasis>. You can specify the actual system name instead of <emphasis
2869             role="bold">@sys</emphasis> if you wish, but the advantage of using <emphasis role="bold">@sys</emphasis> is that it
2870             remains valid if you upgrade this machine to a different system type. <programlisting>
2871    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/@sys/usr/afsws  /usr/afsws</emphasis>
2872 </programlisting></para>
2873           </listitem>
2874
2875           <listitem>
2876             <para><emphasis role="bold">(Optional)</emphasis> To enable users to issue commands from the AFS suites (such as
2877             <emphasis role="bold">fs</emphasis>) without having to specify a pathname to their binaries, include the <emphasis
2878             role="bold">/usr/afsws/bin</emphasis> and <emphasis role="bold">/usr/afsws/etc</emphasis> directories in the PATH
2879             environment variable you define in each user's shell initialization file (such as <emphasis
2880             role="bold">.cshrc</emphasis>).</para>
2881           </listitem>
2882
2883           <listitem>
2884             <para><emphasis role="bold">(Optional)</emphasis> If you believe it is helpful to your users to access the AFS documents
2885             in a certain format via a local disk directory, create <emphasis role="bold">/usr/afsdoc</emphasis> on the local disk as
2886             a symbolic link to the documentation directory in AFS (<emphasis
2887             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2888             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable>). <programlisting>
2889    # <emphasis role="bold">ln -s /afs/</emphasis><replaceable>cellname</replaceable><emphasis role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> <emphasis
2890                   role="bold">/usr/afsdoc</emphasis>
2891 </programlisting></para>
2892
2893             <para>An alternative is to create a link in each user's home directory to the <emphasis
2894             role="bold">/afs/</emphasis><replaceable>cellname</replaceable><emphasis
2895             role="bold">/afsdoc/</emphasis><replaceable>format_name</replaceable> directory.</para>
2896           </listitem>
2897
2898           <listitem>
2899             <para><emphasis role="bold">(Optional)</emphasis> If working on the local machine, remove the AFS binaries from the
2900             temporary location. They are now accessible in the <emphasis role="bold">/usr/afsws</emphasis> directory.
2901             <programlisting>
2902    # <emphasis role="bold">cd  /tmp</emphasis>
2903    # <emphasis role="bold">rm  klog  fs  vos</emphasis>
2904 </programlisting></para>
2905           </listitem>
2906         </orderedlist></para>
2907     </sect2>
2908   </sect1>
2909 </chapter>