scout: Tidy header includes
[openafs.git] / doc / man-pages / pod5 / afs.pod
1 =head1 NAME
2
3 afs - Introduction to AFS files
4
5 =head1 DESCRIPTION
6
7 A number of files must reside on the local disk of AFS server and client
8 machines. They belong to the following general categories:
9
10 =over 4
11
12 =item *
13
14 I<Configuration files> define configuration parameters for specific server
15 and kernel processes such as the Backup System Tape Coordinator or the
16 Cache Manager.
17
18 =item *
19
20 I<Administrative files> list information used in administration of server
21 machines, such as a list of privileged users or server encryption keys.
22
23 =item *
24
25 I<Cache-related files> contain cached data or information about cached
26 data, on client machines.
27
28 =item *
29
30 I<Log files> contain tracing messages about the operation of a specific
31 process.
32
33 =item *
34
35 I<Database files> contain database records used to administer the AFS
36 cell.
37
38 =item *
39
40 I<Controller files> control the behavior of a process.
41
42 =item *
43
44 I<Volume header files> represent AFS volumes on server partitions.
45
46 =back
47
48 For a description of the format and contents of each file, see its
49 reference page.
50
51 Note for Windows users: Some files described in this document possibly do
52 not exist on machines that run a Windows operating system. Also, Windows
53 uses a backslash (C<\>) rather than a forward slash (C</>) to separate the
54 elements in a pathname.
55
56 =head1 SEE ALSO
57
58 Configuration files:
59
60 =over 4
61
62 =item L<BosConfig(5)>
63
64 =item L<CellServDB(5)>
65
66 =item L<NetInfo(5)>
67
68 =item L<NetRestrict(5)>
69
70 =item L<ThisCell(5)>
71
72 =item L<butc(5)>
73
74 =item L<cacheinfo(5)>
75
76 =item L<krb.conf(5)>
77
78 =item L<package(5)>
79
80 =item L<sysid(5)>
81
82 =item L<tapeconfig(5)>
83
84 =item L<uss(5)>
85
86 =item L<uss_bulk(5)>
87
88 =back
89
90 Administrative files:
91
92 =over 4
93
94 =item L<KeyFile(5)>
95
96 =item L<UserList(5)>
97
98 =back
99
100 Cache-related files:
101
102 =over 4
103
104 =item L<afs_cache(5)>
105
106 =back
107
108 Log files:
109
110 =over 4
111
112 =item L<AuthLog(5)>
113
114 =item L<BackupLog(5)>
115
116 =item L<BosLog(5)>
117
118 =item L<FileLog(5)>
119
120 =item L<SalvageLog(5)>
121
122 =item L<VLLog(5)>
123
124 =item L<VolserLog(5)>
125
126 =item L<butc(5)>
127
128 =item L<fms.log(5)>
129
130 =back
131
132 Database files:
133
134 =over 4
135
136 =item L<bdb.DB0(5)>
137
138 =item L<kaserver.DB0(5)>
139
140 =item L<kaserverauxdb(5)>
141
142 =item L<prdb.DB0(5)>
143
144 =item L<vldb.DB0(5)>
145
146 =back
147
148 Controller files:
149
150 =over 4
151
152 =item L<FORCESALVAGE(5)>
153
154 =item L<NoAuth(5)>
155
156 =item L<SALVAGE.fs(5)>
157
158 =item L<salvage.lock(5)>
159
160 =back
161
162 Volume header files:
163
164 =over 4
165
166 =item L<afs_volume_header(5)>
167
168 =back
169
170 =head1 COPYRIGHT
171
172 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
173
174 This documentation is covered by the IBM Public License Version 1.0.  It was
175 converted from HTML to POD by software written by Chas Williams and Russ
176 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.