1.\" Copyright (c) 1990, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" @(#)hier.7 8.1 (Berkeley) 6/5/93
| 1.\" Copyright (c) 1990, 1993
2.\" The Regents of the University of California. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\" notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\" notice, this list of conditions and the following disclaimer in the
11.\" documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" @(#)hier.7 8.1 (Berkeley) 6/5/93
|
33.\" $FreeBSD: head/share/man/man7/hier.7 107383 2002-11-29 11:39:20Z ru $
| 33.\" $FreeBSD: head/share/man/man7/hier.7 107788 2002-12-12 17:26:04Z ru $
|
34.\"
35.Dd June 5, 1993
36.Dt HIER 7
37.Os
38.Sh NAME
39.Nm hier
| 34.\"
35.Dd June 5, 1993
36.Dt HIER 7
37.Os
38.Sh NAME
39.Nm hier
|
40.Nd layout of filesystems
| 40.Nd layout of file systems
|
41.Sh DESCRIPTION
| 41.Sh DESCRIPTION
|
42A sketch of the filesystem hierarchy.
| 42A sketch of the file system hierarchy.
|
43.Bl -tag -width "/stand/"
44.It Pa /
| 43.Bl -tag -width "/stand/"
44.It Pa /
|
45root directory of the filesystem
| 45root directory of the file system
|
46.It Pa /bin/
47user utilities fundamental to both single-user and multi-user environments
48.It Pa /boot/
49programs and configuration files used during operating system bootstrap
50.Pp
51.Bl -tag -width defaults/ -compact
52.It Pa defaults/
53default bootstrapping configuration files; see
54.Xr loader.conf 5
55.It Pa kernel/
56pure kernel executable (the operating system loaded into memory
57at boot time).
58.It Pa modules/
59third-party loadable kernel modules;
60see
61.Xr kldstat 8
62.El
63.It Pa /cdrom/
64default mount point for CD-ROM drives
65(created by
66.Xr sysinstall 8 )
67.It Pa /compat/
68normally a link to
69.Pa /usr/compat .
70If not, then the
71.Pa /usr/compat
72comments apply
73(created by
74.Xr sysinstall 8 )
75.It Pa /dev/
76block and character device files
77.Pp
78.Bl -tag -width MAKEDEV -compact
79.It Pa MAKEDEV
80script for creating device files;
81see
82.Xr MAKEDEV 8
83.It Pa fd/
84file descriptor files;
85see
86.Xr \&fd 4
87.El
88.It Pa /dist/
89mount point used by
90.Xr sysinstall 8
91.It Pa /etc/
92system configuration files and scripts
93.Pp
94.Bl -tag -width "disklabels/" -compact
95.It Pa defaults/
96default system configuration files;
97see
98.Xr rc 8
99.It Pa gnats/
100gnats configuration files;
101see
102.Xr send-pr 1
103.It Pa isdn/
104isdn4bsd configuration files;
105see
106.Xr isdnd 8
107.It Pa kerberosIV/
108configuration files for kerberos version IV;
109see
110.Xr kerberos 1
111.It Pa localtime
112local timezone information;
113see
114.Xr ctime 3
115.It Pa mail/
116Sendmail control files
117.It Pa mtree/
118mtree configuration files;
119see
120.Xr mtree 8
121.It Pa namedb/
122named configuration files;
123see
124.Xr named 8
125.It Pa pam.d/
126configuration files for the Pluggable Authentication Modules (PAM)
127library;
128see
129.Xr pam 8
130.It Pa periodic/
131scripts that are run daily, weekly, and monthly, via
132.Xr cron 8 ;
133see
134.Xr periodic 8
135.It Pa ppp/
136ppp configuration files;
137see
138.Xr ppp 8
139.It Pa ssl/
140OpenSSL configuration files
141.El
142.It Pa /mnt/
143empty directory commonly used by
144system administrators as a temporary mount point
145.It Pa /proc/
| 46.It Pa /bin/
47user utilities fundamental to both single-user and multi-user environments
48.It Pa /boot/
49programs and configuration files used during operating system bootstrap
50.Pp
51.Bl -tag -width defaults/ -compact
52.It Pa defaults/
53default bootstrapping configuration files; see
54.Xr loader.conf 5
55.It Pa kernel/
56pure kernel executable (the operating system loaded into memory
57at boot time).
58.It Pa modules/
59third-party loadable kernel modules;
60see
61.Xr kldstat 8
62.El
63.It Pa /cdrom/
64default mount point for CD-ROM drives
65(created by
66.Xr sysinstall 8 )
67.It Pa /compat/
68normally a link to
69.Pa /usr/compat .
70If not, then the
71.Pa /usr/compat
72comments apply
73(created by
74.Xr sysinstall 8 )
75.It Pa /dev/
76block and character device files
77.Pp
78.Bl -tag -width MAKEDEV -compact
79.It Pa MAKEDEV
80script for creating device files;
81see
82.Xr MAKEDEV 8
83.It Pa fd/
84file descriptor files;
85see
86.Xr \&fd 4
87.El
88.It Pa /dist/
89mount point used by
90.Xr sysinstall 8
91.It Pa /etc/
92system configuration files and scripts
93.Pp
94.Bl -tag -width "disklabels/" -compact
95.It Pa defaults/
96default system configuration files;
97see
98.Xr rc 8
99.It Pa gnats/
100gnats configuration files;
101see
102.Xr send-pr 1
103.It Pa isdn/
104isdn4bsd configuration files;
105see
106.Xr isdnd 8
107.It Pa kerberosIV/
108configuration files for kerberos version IV;
109see
110.Xr kerberos 1
111.It Pa localtime
112local timezone information;
113see
114.Xr ctime 3
115.It Pa mail/
116Sendmail control files
117.It Pa mtree/
118mtree configuration files;
119see
120.Xr mtree 8
121.It Pa namedb/
122named configuration files;
123see
124.Xr named 8
125.It Pa pam.d/
126configuration files for the Pluggable Authentication Modules (PAM)
127library;
128see
129.Xr pam 8
130.It Pa periodic/
131scripts that are run daily, weekly, and monthly, via
132.Xr cron 8 ;
133see
134.Xr periodic 8
135.It Pa ppp/
136ppp configuration files;
137see
138.Xr ppp 8
139.It Pa ssl/
140OpenSSL configuration files
141.El
142.It Pa /mnt/
143empty directory commonly used by
144system administrators as a temporary mount point
145.It Pa /proc/
|
146process filesystem;
| 146process file system;
|
147see
148.Xr procfs 5 ,
149.Xr mount_procfs 8
150.It Pa /root/
151root's HOME directory
152.It Pa /sbin/
153system programs and administration utilities
154fundamental to both single-user and multi-user environments
155.It Pa /stand/
156programs used in a standalone environment
157.It Pa /tmp/
158temporary files that are not guaranteed to persist across system reboots
159.It Pa /usr/
160contains the majority of user utilities and applications
161.Pp
162.Bl -tag -width "libdata/" -compact
163.It Pa bin/
164common utilities, programming tools, and applications
165.It Pa compat/
166files needed to support binary compatibility with other operating systems,
167such as Linux
168(created by
169.Xr sysinstall 8 )
170.It Pa games/
171useful and semi-frivolous programs
172.It Pa heimdal/
173kerberos server databases; see
174.Xr kdc 8
175.It Pa include/
176standard C include files
177.Pp
178.Bl -tag -width "kerberosIV/" -compact
179.It Pa arpa/
180C include files for Internet service protocols
181.It Pa cam/
182C include files for the Common Access Methods Layer
183.Bl -tag -width "kerberosIV/" -compact
184.It scsi/
185The SCSI device on top of CAM
186.El
187.It Pa dev/
188C include files for programming various
189.Fx
190devices
191.Bl -tag -width "kerberosIV/" -compact
192.It Pa ic/
193Various header files describing driver- and bus-independent
194hardware circuits
195.It Pa ofw/
196OpenFirmware support
197.It Pa ppbus/
198The parallel port bus;
199see
200.Xr ppbus 4
201.It Pa usb/
202The USB subsystem
203.It Pa wi/
204The
205.Xr wi 4
206WaveLAN driver
207.El
208.It Pa fs/
209.Bl -tag -width "kerberosIV/" -compact
210.It Pa fdescfs/
| 147see
148.Xr procfs 5 ,
149.Xr mount_procfs 8
150.It Pa /root/
151root's HOME directory
152.It Pa /sbin/
153system programs and administration utilities
154fundamental to both single-user and multi-user environments
155.It Pa /stand/
156programs used in a standalone environment
157.It Pa /tmp/
158temporary files that are not guaranteed to persist across system reboots
159.It Pa /usr/
160contains the majority of user utilities and applications
161.Pp
162.Bl -tag -width "libdata/" -compact
163.It Pa bin/
164common utilities, programming tools, and applications
165.It Pa compat/
166files needed to support binary compatibility with other operating systems,
167such as Linux
168(created by
169.Xr sysinstall 8 )
170.It Pa games/
171useful and semi-frivolous programs
172.It Pa heimdal/
173kerberos server databases; see
174.Xr kdc 8
175.It Pa include/
176standard C include files
177.Pp
178.Bl -tag -width "kerberosIV/" -compact
179.It Pa arpa/
180C include files for Internet service protocols
181.It Pa cam/
182C include files for the Common Access Methods Layer
183.Bl -tag -width "kerberosIV/" -compact
184.It scsi/
185The SCSI device on top of CAM
186.El
187.It Pa dev/
188C include files for programming various
189.Fx
190devices
191.Bl -tag -width "kerberosIV/" -compact
192.It Pa ic/
193Various header files describing driver- and bus-independent
194hardware circuits
195.It Pa ofw/
196OpenFirmware support
197.It Pa ppbus/
198The parallel port bus;
199see
200.Xr ppbus 4
201.It Pa usb/
202The USB subsystem
203.It Pa wi/
204The
205.Xr wi 4
206WaveLAN driver
207.El
208.It Pa fs/
209.Bl -tag -width "kerberosIV/" -compact
210.It Pa fdescfs/
|
211per-process file descriptors filesystem
| 211per-process file descriptors file system
|
212.It Pa fifofs/
213.St -p1003.1
| 212.It Pa fifofs/
213.St -p1003.1
|
214FIFOs filesystem
| 214FIFOs file system
|
215.It Pa msdosfs/
| 215.It Pa msdosfs/
|
216MS-DOS filesystem
| 216MS-DOS file system
|
217.It Pa ntfs/
| 217.It Pa ntfs/
|
218NTFS filesystem
| 218NTFS file system
|
219.It Pa nullfs/
| 219.It Pa nullfs/
|
220loopback filesystem
| 220loopback file system
|
221.It Pa nwfs/
| 221.It Pa nwfs/
|
222NetWare filesystem
| 222NetWare file system
|
223.It Pa portalfs/
| 223.It Pa portalfs/
|
224portal filesystem
| 224portal file system
|
225.It Pa procfs/
| 225.It Pa procfs/
|
226process filesystem
| 226process file system
|
227.It Pa smbfs/
| 227.It Pa smbfs/
|
228SMB/CIFS filesystem
| 228SMB/CIFS file system
|
229.It Pa umapfs/
| 229.It Pa umapfs/
|
230alternate uid/gid mappings filesystem
| 230alternate uid/gid mappings file system
|
231.It Pa unionfs
| 231.It Pa unionfs
|
232union filesystem
| 232union file system
|
233.El
234.It Pa g++/
235GNU C++ include files
236.Bl -tag -width "kerberosIV/" -compact
237.It Pa std/
238GNU C++ libstdc++ include files
239.El
240.It Pa isc/
241ISC utility library libisc include files
242.It Pa isofs/
243.Bl -tag -width "kerberosIV/" -compact
244.It Pa cd9660/
| 233.El
234.It Pa g++/
235GNU C++ include files
236.Bl -tag -width "kerberosIV/" -compact
237.It Pa std/
238GNU C++ libstdc++ include files
239.El
240.It Pa isc/
241ISC utility library libisc include files
242.It Pa isofs/
243.Bl -tag -width "kerberosIV/" -compact
244.It Pa cd9660/
|
245iso9660 filesystem
| 245iso9660 file system
|
246.El
247.It Pa kerberosIV/
248C include files for kerberos authentication package;
249see
250.Xr kerberos 1
251.It Pa libmilter/
252C include files for libmilter,
253the
254.Xr sendmail 8
255mail filter API
256.It Pa machine/
257machine-specific C include files
258.It Pa net/
259misc network C include files
260.It Pa netatalk/
261Appletalk protocol
262.It Pa netatm/
263ATM include files;
264see
265.Xr atm 8
266.It Pa netinet/
267C include files for Internet standard protocols;
268see
269.Xr inet 4
270.It Pa netinet6/
271C include files for Internet protocol version 6;
272see
273.Xr inet6 4
274.It Pa netipx/
275IPX/SPX protocol stacks
276.It Pa netkey/
277kernel key-management service
278.It Pa netns/
279Xerox NS protocols
280.It Pa netsmb/
281SMB/CIFS requester
282.It Pa netnatm/
283NATM include files;
284see
285.Xr natm 4
286.It Pa nfs/
287C include files for NFS (Network File System)
288.It Pa objc/
289Objective C include files
290.It Pa openssl/
291OpenSSL (Cryptography/SSL toolkit) headers
292.It Pa pccard/
293PC-CARD controllers
294.It Pa posix4/
295POSIX real-time extensions includes;
296see
297.Xr p1003_1b 9
298.It Pa protocols/
299C include files for Berkeley service protocols
300.It Pa readline/
301get a line from a user, with editing;
302see
303.Xr readline 3
304.It Pa rpc/
305remote procedure calls;
306see
307.Xr rpc 3
308.It Pa rpcsvc/
309definition of RPC service structures; see
310.Xr rpc 3
311.It Pa security/
312PAM; see
313.Xr pam 8
314.It Pa sys/
315system C include files (kernel data structures)
316.\" .It Pa tcl/
317.\" Tcl language;
318.\" see
319.\" .Xr Tcl n
320.\" .Bl -tag -width "kerberosIV/" -compact
321.\" .It Pa generic/
322.\" ???
323.\" .It Pa unix/
324.\" ???
325.\" .El
326.It Pa ufs/
327C include files for UFS (The U-word File System)
328.Bl -tag -width "kerberosIV/" -compact
329.It Pa ffs/
| 246.El
247.It Pa kerberosIV/
248C include files for kerberos authentication package;
249see
250.Xr kerberos 1
251.It Pa libmilter/
252C include files for libmilter,
253the
254.Xr sendmail 8
255mail filter API
256.It Pa machine/
257machine-specific C include files
258.It Pa net/
259misc network C include files
260.It Pa netatalk/
261Appletalk protocol
262.It Pa netatm/
263ATM include files;
264see
265.Xr atm 8
266.It Pa netinet/
267C include files for Internet standard protocols;
268see
269.Xr inet 4
270.It Pa netinet6/
271C include files for Internet protocol version 6;
272see
273.Xr inet6 4
274.It Pa netipx/
275IPX/SPX protocol stacks
276.It Pa netkey/
277kernel key-management service
278.It Pa netns/
279Xerox NS protocols
280.It Pa netsmb/
281SMB/CIFS requester
282.It Pa netnatm/
283NATM include files;
284see
285.Xr natm 4
286.It Pa nfs/
287C include files for NFS (Network File System)
288.It Pa objc/
289Objective C include files
290.It Pa openssl/
291OpenSSL (Cryptography/SSL toolkit) headers
292.It Pa pccard/
293PC-CARD controllers
294.It Pa posix4/
295POSIX real-time extensions includes;
296see
297.Xr p1003_1b 9
298.It Pa protocols/
299C include files for Berkeley service protocols
300.It Pa readline/
301get a line from a user, with editing;
302see
303.Xr readline 3
304.It Pa rpc/
305remote procedure calls;
306see
307.Xr rpc 3
308.It Pa rpcsvc/
309definition of RPC service structures; see
310.Xr rpc 3
311.It Pa security/
312PAM; see
313.Xr pam 8
314.It Pa sys/
315system C include files (kernel data structures)
316.\" .It Pa tcl/
317.\" Tcl language;
318.\" see
319.\" .Xr Tcl n
320.\" .Bl -tag -width "kerberosIV/" -compact
321.\" .It Pa generic/
322.\" ???
323.\" .It Pa unix/
324.\" ???
325.\" .El
326.It Pa ufs/
327C include files for UFS (The U-word File System)
328.Bl -tag -width "kerberosIV/" -compact
329.It Pa ffs/
|
330Fast filesystem
| 330Fast file system
|
331.It Pa ufs/
| 331.It Pa ufs/
|
332UFS filesystem
| 332UFS file system
|
333.El
334.It Pa vm/
335virtual memory;
336see
337.Xr vmstat 8
338.El
339.Pp
340.It Pa lib/
341archive libraries
342.Bl -tag -width Fl -compact
343.It Pa aout/
344a.out archive libraries
345.It Pa compat/
346shared libraries for compatibility
347.Bl -tag -width Fl -compact
348.It Pa aout/
349a.out backward compatibility libraries
350.El
351.El
352.Pp
353.It Pa libdata/
354misc. utility data files
355.Bl -tag -width Fl -compact
356.It Pa doscmd/
357files used by doscmd (drivers, fonts, etc.);
358see
359.Xr doscmd 1
360.Bl -tag -width 6n -compact
361.It Pa fonts/
362fonts used by doscmd
363.El
364.It Pa gcc/
365???
366.It Pa ldscripts/
367linker scripts;
368see
369.Xr ld 1
370.It Pa lint/
371various prebuilt lint libraries;
372see
373.Xr lint 1
374.It Pa msdosfs/
375Character set conversion tables
376.It Pa stallion/
377firmware images for Stallion serial controllers; see
378.Xr stl 4
379.El
380.Pp
381.It Pa libexec/
382system daemons & system utilities (executed by other programs)
383.Bl -tag -width Fl -compact
384.It Pa aout/
385utilities to manipulate a.out executables
386.It Pa elf/
387utilities to manipulate ELF executables
388.It Pa lpr/
389utilities and filters for LP print system;
390see
391.Xr lpr 1
392.It Pa sendmail/
393the
394.Xr sendmail 8
395binary;
396see
397.Xr mailwrapper 8
398.It Pa sm.bin/
399restricted shell for
400.Xr sendmail 8 ;
401see
402.Xr smrsh 8
403.El
404.Pp
405.It Pa local/
406local executables, libraries, etc.
407Also used as the default destination for the
408.Fx
409ports framework.
410Within local/, the general layout sketched out by
411.Xr hier 7
412for /usr
413should be used. Exceptions are the man directory (directly under local/
414rather than under local/share/), ports documentation (in share/doc/<port>/),
415and /usr/local/etc (mimics /etc).
416.It Pa obj/
417architecture-specific target tree produced by building the /usr/src tree
418.It Pa ports/
419The
420.Fx
421ports collection (optional).
422.It Pa sbin/
423system daemons & system utilities (executed by users)
424.It Pa share/
425architecture-independent files
426.Pp
427.Bl -tag -width "calendar/" -compact
428.It Pa calendar/
429a variety of pre-fab calendar files;
430see
431.Xr calendar 1
432.It Pa dict/
433word lists;
434see
435.Xr look 1
436.Pp
437.Bl -tag -width Fl -compact
438.It Pa freebsd
439.Fx Ns -specific
440terms, proper names, and jargon
441.It Pa words
442common words
443.It Pa web2
444words from Webster's 2nd International
445.It Pa papers/
446reference databases;
447see
448.Xr refer 1
449.El
450.Pp
451.It Pa doc/
452miscellaneous documentation;
453source for most of the printed
454.Bx
455manuals (available
456from the
457.Tn USENIX
458association)
459.Bl -tag -width Fl -compact
460.It Pa FAQ/
461Frequently Asked Questions
462.It Pa IPv6/
463implementation notes for IPv6
464.It Pa bind/
465documents pertaining to BIND (the Berkeley Internet Name Domain)
466.It Pa es/
467Spanish translations of documents in /usr/share/doc
468.It Pa handbook/
469.Fx
470Handbook
471.It Pa ja/
472Japanese translations of documents in /usr/share/doc
473.It Pa ncurses/
474HTML documents pertaining to ncurses;
475see
476.Xr ncurses 3X
477.It Pa ntp/
478HTML documents pertaining to the Network Time Protocol
479.It Pa papers/
480UNIX Papers
481.It Pa psd/
482UNIX Programmer's Supplementary Documents
483.It Pa ru/
484Russian translations of documents in /usr/share/doc
485.It Pa smm/
486UNIX System Manager's Manual
487.It Pa tutorials/
488.Fx
489tutorials
490.It Pa usd/
491UNIX User's Supplementary Documents
492.It Pa zh/
493Chinese translations of documents in /usr/share/doc
494.El
495.Pp
496.It Pa examples/
497various examples for users and programmers
498.It Pa games/
499ASCII text files used by various games
500.It Pa groff_font/
501device description file for device name
502.It Pa info/
503GNU Info hypertext system
504.It Pa isdn/
505ISDN
506.It Pa locale/
507localization files;
508see
509.Xr setlocale 3
510.It Pa man/
511manual pages
512.It Pa me/
513macros for use with the me macro package;
514see
515.Xr me 7
516.It Pa misc/
517misc system-wide ASCII text files
518.Bl -tag -width Fl -compact
519.It Pa fonts/
520???
521.It Pa pcvtfonts/
522pcvt fonts;
523see
524.Xr pcvt 4
525.It Pa termcap
526terminal characteristics database;
527see
528.Xr termcap 5
529.El
530.It Pa mk/
531templates for make;
532see
533.Xr make 1
534.It Pa nls/
535national language support files;
536see
537.Xr mklocale 1
538.It Pa pcvt/
539pcvt documentation and etc examples;
540see
541.Xr pcvt 4
542.It Pa sendmail/
543.Xr sendmail 8
544configuration files
545.It Pa skel/
546example . (dot) files for new accounts
547.It Pa syscons/
548files used by syscons;
549see
550.Xr syscons 4
551.Bl -tag -width "scrnmaps/xx" -compact
552.It Pa fonts/
553console fonts;
554see
555.Xr vidcontrol 1
556and
557.Xr vidfont 1
558.It Pa keymaps/
559console keyboard maps;
560see
561.Xr kbdcontrol 1
562and
563.Xr kbdmap 1
564.It Pa scrnmaps/
565console screen maps
566.El
567.It Pa tabset/
568tab description files for a variety of terminals; used in
569the termcap file;
570see
571.Xr termcap 5
572.It Pa tmac/
573text processing macros;
574see
575.Xr nroff 1
576and
577.Xr troff 1
578.It Pa vi/
579localization support and utilities for
580.Xr vi 1
581.It Pa zoneinfo/
582timezone configuration information;
583see
584.Xr tzfile 5
585.El
586.It Pa src/
587.Bx ,
588third-party, and/or local source files
589.Pp
590.Bl -tag -width "kerberosIV/" -compact
591.It Pa bin/
592source code for files in /bin
593.It Pa contrib/
594source code for contributed software
595.It Pa crypto/
596source code for contributed cryptography software
597.It Pa etc/
598source code for files in /etc
599.It Pa games/
600source code for files in /usr/games
601.It Pa gnu/
602Utilities covered by the GNU General Public License
603.It Pa include/
604source code for files in /usr/include
605.It Pa kerberosIV/
606source code for kerberos version IV
607.It Pa lib/
608source code for files in /usr/lib
609.It Pa libexec/
610source code for files in /usr/libexec
611.It Pa release/
612files required to produce a
613.Fx
614release
615.It Pa sbin/
616source code for files in /sbin
617.It Pa secure/
618build directory for files in /usr/src/crypto
619.It Pa share/
620source for files in /usr/share
621.It Pa sys/
622kernel source code
623.It Pa tools/
624tools used for maintenance and testing of
625.Fx
626.It Pa usr.bin/
627source code for files in /usr/bin
628.It Pa usr.sbin/
629source code for files in /usr/sbin
630.El
631.Pp
632.It Pa X11R6/
633X11R6 distribution executables, libraries, etc (optional).
634.Bl -tag -width "include/" -compact
635.It Pa bin/
636X11R6 binaries (servers, utilities, local packages/ports).
637.It Pa etc/
638X11R6 configuration files and scripts.
639.It Pa include/
640X11R6 include files.
641.It Pa lib/
642X11R6 libraries.
643.It Pa man/
644X11R6 manual pages.
645.It Pa share/
646architecture-independent files.
647.El
648.El
649.It Pa /var/
650multi-purpose log, temporary, transient, and spool files
651.Pp
652.Bl -tag -width "preserve/" -compact
653.It Pa account/
654system accounting files
655.Pp
656.Bl -tag -width Fl -compact
657.It Pa acct
658execution accounting file;
659see
660.Xr acct 5
661.El
662.Pp
663.It Pa at/
664timed command scheduling files;
665see
666.Xr \&at 1
667.Bl -tag -width "preserve/" -compact
668.It Pa jobs/
669directory containing job files
670.It Pa spool/
671directory containing output spool files
672.El
673.Pp
674.It Pa backups/
675misc. backup files
676.It Pa crash/
677default directory to store kernel crash dumps; see
678.Xr crash 8
679and
680.Xr savecore 8
681.It Pa cron/
682files used by cron;
683see
684.Xr cron 8
685.Bl -tag -width "preserve/" -compact
686.It Pa tabs/
687crontab files;
688see
689.Xr crontab 5
690.El
691.Pp
692.It Pa db/
693misc. automatically generated system-specific database files
694.It Pa empty/
695empty directory used by
696.Xr sshd 8
697for privilege separation
698.It Pa games/
699misc. game status and score files
700.It Pa log/
701misc. system log files
702.Pp
703.Bl -tag -width Fl -compact
704.It Pa wtmp
705login/logout log;
706see
707.Xr wtmp 5
708.El
709.Pp
710.It Pa mail/
711user mailbox files
712.It Pa preserve/
713temporary home of files preserved after an accidental death
714of an editor;
715see
716.Xr \&ex 1
717.It Pa msgs/
718system messages database;
719see
720.Xr msgs 1
721.It Pa quotas/
| 333.El
334.It Pa vm/
335virtual memory;
336see
337.Xr vmstat 8
338.El
339.Pp
340.It Pa lib/
341archive libraries
342.Bl -tag -width Fl -compact
343.It Pa aout/
344a.out archive libraries
345.It Pa compat/
346shared libraries for compatibility
347.Bl -tag -width Fl -compact
348.It Pa aout/
349a.out backward compatibility libraries
350.El
351.El
352.Pp
353.It Pa libdata/
354misc. utility data files
355.Bl -tag -width Fl -compact
356.It Pa doscmd/
357files used by doscmd (drivers, fonts, etc.);
358see
359.Xr doscmd 1
360.Bl -tag -width 6n -compact
361.It Pa fonts/
362fonts used by doscmd
363.El
364.It Pa gcc/
365???
366.It Pa ldscripts/
367linker scripts;
368see
369.Xr ld 1
370.It Pa lint/
371various prebuilt lint libraries;
372see
373.Xr lint 1
374.It Pa msdosfs/
375Character set conversion tables
376.It Pa stallion/
377firmware images for Stallion serial controllers; see
378.Xr stl 4
379.El
380.Pp
381.It Pa libexec/
382system daemons & system utilities (executed by other programs)
383.Bl -tag -width Fl -compact
384.It Pa aout/
385utilities to manipulate a.out executables
386.It Pa elf/
387utilities to manipulate ELF executables
388.It Pa lpr/
389utilities and filters for LP print system;
390see
391.Xr lpr 1
392.It Pa sendmail/
393the
394.Xr sendmail 8
395binary;
396see
397.Xr mailwrapper 8
398.It Pa sm.bin/
399restricted shell for
400.Xr sendmail 8 ;
401see
402.Xr smrsh 8
403.El
404.Pp
405.It Pa local/
406local executables, libraries, etc.
407Also used as the default destination for the
408.Fx
409ports framework.
410Within local/, the general layout sketched out by
411.Xr hier 7
412for /usr
413should be used. Exceptions are the man directory (directly under local/
414rather than under local/share/), ports documentation (in share/doc/<port>/),
415and /usr/local/etc (mimics /etc).
416.It Pa obj/
417architecture-specific target tree produced by building the /usr/src tree
418.It Pa ports/
419The
420.Fx
421ports collection (optional).
422.It Pa sbin/
423system daemons & system utilities (executed by users)
424.It Pa share/
425architecture-independent files
426.Pp
427.Bl -tag -width "calendar/" -compact
428.It Pa calendar/
429a variety of pre-fab calendar files;
430see
431.Xr calendar 1
432.It Pa dict/
433word lists;
434see
435.Xr look 1
436.Pp
437.Bl -tag -width Fl -compact
438.It Pa freebsd
439.Fx Ns -specific
440terms, proper names, and jargon
441.It Pa words
442common words
443.It Pa web2
444words from Webster's 2nd International
445.It Pa papers/
446reference databases;
447see
448.Xr refer 1
449.El
450.Pp
451.It Pa doc/
452miscellaneous documentation;
453source for most of the printed
454.Bx
455manuals (available
456from the
457.Tn USENIX
458association)
459.Bl -tag -width Fl -compact
460.It Pa FAQ/
461Frequently Asked Questions
462.It Pa IPv6/
463implementation notes for IPv6
464.It Pa bind/
465documents pertaining to BIND (the Berkeley Internet Name Domain)
466.It Pa es/
467Spanish translations of documents in /usr/share/doc
468.It Pa handbook/
469.Fx
470Handbook
471.It Pa ja/
472Japanese translations of documents in /usr/share/doc
473.It Pa ncurses/
474HTML documents pertaining to ncurses;
475see
476.Xr ncurses 3X
477.It Pa ntp/
478HTML documents pertaining to the Network Time Protocol
479.It Pa papers/
480UNIX Papers
481.It Pa psd/
482UNIX Programmer's Supplementary Documents
483.It Pa ru/
484Russian translations of documents in /usr/share/doc
485.It Pa smm/
486UNIX System Manager's Manual
487.It Pa tutorials/
488.Fx
489tutorials
490.It Pa usd/
491UNIX User's Supplementary Documents
492.It Pa zh/
493Chinese translations of documents in /usr/share/doc
494.El
495.Pp
496.It Pa examples/
497various examples for users and programmers
498.It Pa games/
499ASCII text files used by various games
500.It Pa groff_font/
501device description file for device name
502.It Pa info/
503GNU Info hypertext system
504.It Pa isdn/
505ISDN
506.It Pa locale/
507localization files;
508see
509.Xr setlocale 3
510.It Pa man/
511manual pages
512.It Pa me/
513macros for use with the me macro package;
514see
515.Xr me 7
516.It Pa misc/
517misc system-wide ASCII text files
518.Bl -tag -width Fl -compact
519.It Pa fonts/
520???
521.It Pa pcvtfonts/
522pcvt fonts;
523see
524.Xr pcvt 4
525.It Pa termcap
526terminal characteristics database;
527see
528.Xr termcap 5
529.El
530.It Pa mk/
531templates for make;
532see
533.Xr make 1
534.It Pa nls/
535national language support files;
536see
537.Xr mklocale 1
538.It Pa pcvt/
539pcvt documentation and etc examples;
540see
541.Xr pcvt 4
542.It Pa sendmail/
543.Xr sendmail 8
544configuration files
545.It Pa skel/
546example . (dot) files for new accounts
547.It Pa syscons/
548files used by syscons;
549see
550.Xr syscons 4
551.Bl -tag -width "scrnmaps/xx" -compact
552.It Pa fonts/
553console fonts;
554see
555.Xr vidcontrol 1
556and
557.Xr vidfont 1
558.It Pa keymaps/
559console keyboard maps;
560see
561.Xr kbdcontrol 1
562and
563.Xr kbdmap 1
564.It Pa scrnmaps/
565console screen maps
566.El
567.It Pa tabset/
568tab description files for a variety of terminals; used in
569the termcap file;
570see
571.Xr termcap 5
572.It Pa tmac/
573text processing macros;
574see
575.Xr nroff 1
576and
577.Xr troff 1
578.It Pa vi/
579localization support and utilities for
580.Xr vi 1
581.It Pa zoneinfo/
582timezone configuration information;
583see
584.Xr tzfile 5
585.El
586.It Pa src/
587.Bx ,
588third-party, and/or local source files
589.Pp
590.Bl -tag -width "kerberosIV/" -compact
591.It Pa bin/
592source code for files in /bin
593.It Pa contrib/
594source code for contributed software
595.It Pa crypto/
596source code for contributed cryptography software
597.It Pa etc/
598source code for files in /etc
599.It Pa games/
600source code for files in /usr/games
601.It Pa gnu/
602Utilities covered by the GNU General Public License
603.It Pa include/
604source code for files in /usr/include
605.It Pa kerberosIV/
606source code for kerberos version IV
607.It Pa lib/
608source code for files in /usr/lib
609.It Pa libexec/
610source code for files in /usr/libexec
611.It Pa release/
612files required to produce a
613.Fx
614release
615.It Pa sbin/
616source code for files in /sbin
617.It Pa secure/
618build directory for files in /usr/src/crypto
619.It Pa share/
620source for files in /usr/share
621.It Pa sys/
622kernel source code
623.It Pa tools/
624tools used for maintenance and testing of
625.Fx
626.It Pa usr.bin/
627source code for files in /usr/bin
628.It Pa usr.sbin/
629source code for files in /usr/sbin
630.El
631.Pp
632.It Pa X11R6/
633X11R6 distribution executables, libraries, etc (optional).
634.Bl -tag -width "include/" -compact
635.It Pa bin/
636X11R6 binaries (servers, utilities, local packages/ports).
637.It Pa etc/
638X11R6 configuration files and scripts.
639.It Pa include/
640X11R6 include files.
641.It Pa lib/
642X11R6 libraries.
643.It Pa man/
644X11R6 manual pages.
645.It Pa share/
646architecture-independent files.
647.El
648.El
649.It Pa /var/
650multi-purpose log, temporary, transient, and spool files
651.Pp
652.Bl -tag -width "preserve/" -compact
653.It Pa account/
654system accounting files
655.Pp
656.Bl -tag -width Fl -compact
657.It Pa acct
658execution accounting file;
659see
660.Xr acct 5
661.El
662.Pp
663.It Pa at/
664timed command scheduling files;
665see
666.Xr \&at 1
667.Bl -tag -width "preserve/" -compact
668.It Pa jobs/
669directory containing job files
670.It Pa spool/
671directory containing output spool files
672.El
673.Pp
674.It Pa backups/
675misc. backup files
676.It Pa crash/
677default directory to store kernel crash dumps; see
678.Xr crash 8
679and
680.Xr savecore 8
681.It Pa cron/
682files used by cron;
683see
684.Xr cron 8
685.Bl -tag -width "preserve/" -compact
686.It Pa tabs/
687crontab files;
688see
689.Xr crontab 5
690.El
691.Pp
692.It Pa db/
693misc. automatically generated system-specific database files
694.It Pa empty/
695empty directory used by
696.Xr sshd 8
697for privilege separation
698.It Pa games/
699misc. game status and score files
700.It Pa log/
701misc. system log files
702.Pp
703.Bl -tag -width Fl -compact
704.It Pa wtmp
705login/logout log;
706see
707.Xr wtmp 5
708.El
709.Pp
710.It Pa mail/
711user mailbox files
712.It Pa preserve/
713temporary home of files preserved after an accidental death
714of an editor;
715see
716.Xr \&ex 1
717.It Pa msgs/
718system messages database;
719see
720.Xr msgs 1
721.It Pa quotas/
|
722filesystem quota information files
| 722file system quota information files
|
723.It Pa run/
724system information files describing various info about
725system since it was booted
726.Pp
727.Bl -tag -width Fl -compact
728.It Pa named/
729writable by the
730.Dq bind
731user; see
732.Xr named 8
733.It Pa ppp/
734writable by the
735.Dq network
736group for command connection sockets; see
737.Xr ppp 8
738.It Pa utmp
739database of current users;
740see
741.Xr utmp 5
742.El
743.Pp
744.It Pa rwho/
745rwho data files;
746see
747.Xr rwhod 8 ,
748.Xr rwho 1 ,
749and
750.Xr ruptime 1
751.It Pa spool/
752misc. printer and mail system spooling directories
753.Pp
754.Bl -tag -width Fl -compact
755.It Pa clientmqueue/
756undelivered submission mail queue;
757see
758.Xr sendmail 8
759.It Pa ftp/
760commonly ~ftp; the anonymous ftp root directory
761.It Pa mqueue/
762undelivered mail queue;
763see
764.Xr sendmail 8
765.It Pa output/
766line printer spooling directories
767.El
768.Pp
769.It Pa tmp/
770temporary files that are kept between system reboots
771.Bl -tag -width Fl -compact
772.It Pa vi.recover/
773the directory where recovery files are stored
774.El
775.It Pa yp/
776the NIS maps
777.El
778.El
779.Sh NOTES
780This manual page documents the default
781.Fx
| 723.It Pa run/
724system information files describing various info about
725system since it was booted
726.Pp
727.Bl -tag -width Fl -compact
728.It Pa named/
729writable by the
730.Dq bind
731user; see
732.Xr named 8
733.It Pa ppp/
734writable by the
735.Dq network
736group for command connection sockets; see
737.Xr ppp 8
738.It Pa utmp
739database of current users;
740see
741.Xr utmp 5
742.El
743.Pp
744.It Pa rwho/
745rwho data files;
746see
747.Xr rwhod 8 ,
748.Xr rwho 1 ,
749and
750.Xr ruptime 1
751.It Pa spool/
752misc. printer and mail system spooling directories
753.Pp
754.Bl -tag -width Fl -compact
755.It Pa clientmqueue/
756undelivered submission mail queue;
757see
758.Xr sendmail 8
759.It Pa ftp/
760commonly ~ftp; the anonymous ftp root directory
761.It Pa mqueue/
762undelivered mail queue;
763see
764.Xr sendmail 8
765.It Pa output/
766line printer spooling directories
767.El
768.Pp
769.It Pa tmp/
770temporary files that are kept between system reboots
771.Bl -tag -width Fl -compact
772.It Pa vi.recover/
773the directory where recovery files are stored
774.El
775.It Pa yp/
776the NIS maps
777.El
778.El
779.Sh NOTES
780This manual page documents the default
781.Fx
|
782filesystem layout, but
| 782file system layout, but
|
783the actual hierarchy on a given system is defined at the system
784administrator's discretion.
785A well-maintained installation will include a customized version of
786this document.
787.Sh SEE ALSO
788.Xr apropos 1 ,
789.Xr find 1 ,
790.Xr finger 1 ,
791.Xr grep 1 ,
792.Xr ls 1 ,
793.Xr whatis 1 ,
794.Xr whereis 1 ,
795.Xr which 1 ,
796.Xr fsck 8
797.Sh HISTORY
798A
799.Nm
800manual page appeared in
801.At v7 .
| 783the actual hierarchy on a given system is defined at the system
784administrator's discretion.
785A well-maintained installation will include a customized version of
786this document.
787.Sh SEE ALSO
788.Xr apropos 1 ,
789.Xr find 1 ,
790.Xr finger 1 ,
791.Xr grep 1 ,
792.Xr ls 1 ,
793.Xr whatis 1 ,
794.Xr whereis 1 ,
795.Xr which 1 ,
796.Xr fsck 8
797.Sh HISTORY
798A
799.Nm
800manual page appeared in
801.At v7 .
|