xref: /freebsd/share/man/man7/hier.7 (revision 4b2eaea43fec8e8792be611dea204071a10b655a)
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$
34.\"
35.Dd June 5, 1993
36.Dt HIER 7
37.Os
38.Sh NAME
39.Nm hier
40.Nd layout of file systems
41.Sh DESCRIPTION
42A sketch of the file system hierarchy.
43.Bl -tag -width "/stand/"
44.It Pa /
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/
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 include/
173standard C include files
174.Pp
175.Bl -tag -width "kerberosIV/" -compact
176.It Pa arpa/
177C include files for Internet service protocols
178.It Pa cam/
179C include files for the Common Access Methods Layer
180.Bl -tag -width "kerberosIV/" -compact
181.It Pa scsi/
182The SCSI device on top of CAM
183.El
184.It Pa dev/
185C include files for programming various
186.Fx
187devices
188.Bl -tag -width "kerberosIV/" -compact
189.It Pa ic/
190Various header files describing driver- and bus-independent
191hardware circuits
192.It Pa ofw/
193OpenFirmware support
194.It Pa ppbus/
195The parallel port bus;
196see
197.Xr ppbus 4
198.It Pa usb/
199The USB subsystem
200.It Pa wi/
201The
202.Xr wi 4
203WaveLAN driver
204.El
205.It Pa fs/
206.Bl -tag -width "kerberosIV/" -compact
207.It Pa fdescfs/
208per-process file descriptors file system
209.It Pa fifofs/
210.St -p1003.1
211FIFOs file system
212.It Pa msdosfs/
213MS-DOS file system
214.It Pa ntfs/
215NTFS file system
216.It Pa nullfs/
217loopback file system
218.It Pa nwfs/
219NetWare file system
220.It Pa portalfs/
221portal file system
222.It Pa procfs/
223process file system
224.It Pa smbfs/
225SMB/CIFS file system
226.It Pa umapfs/
227alternate uid/gid mappings file system
228.It Pa unionfs
229union file system
230.El
231.It Pa g++/
232GNU C++ include files
233.Bl -tag -width "kerberosIV/" -compact
234.It Pa std/
235GNU C++ libstdc++ include files
236.El
237.It Pa isc/
238ISC utility library libisc include files
239.It Pa isofs/
240.Bl -tag -width "kerberosIV/" -compact
241.It Pa cd9660/
242iso9660 file system
243.El
244.It Pa kerberosIV/
245C include files for kerberos authentication package;
246see
247.Xr kerberos 1
248.It Pa libmilter/
249C include files for libmilter,
250the
251.Xr sendmail 8
252mail filter API
253.It Pa machine/
254machine-specific C include files
255.It Pa net/
256misc network C include files
257.It Pa netatalk/
258Appletalk protocol
259.It Pa netatm/
260ATM include files;
261see
262.Xr atm 8
263.It Pa netinet/
264C include files for Internet standard protocols;
265see
266.Xr inet 4
267.It Pa netinet6/
268C include files for Internet protocol version 6;
269see
270.Xr inet6 4
271.It Pa netipx/
272IPX/SPX protocol stacks
273.It Pa netkey/
274kernel key-management service
275.It Pa netnatm/
276NATM include files;
277see
278.Xr natm 4
279.It Pa netns/
280Xerox NS protocols
281.It Pa netsmb/
282SMB/CIFS requester
283.It Pa nfs/
284C include files for NFS (Network File System)
285.It Pa objc/
286Objective C include files
287.It Pa openssl/
288OpenSSL (Cryptography/SSL toolkit) headers
289.It Pa pccard/
290PC-CARD controllers
291.It Pa posix4/
292POSIX real-time extensions includes;
293see
294.Xr p1003_1b 9
295.It Pa protocols/
296C include files for Berkeley service protocols
297.It Pa readline/
298get a line from a user, with editing;
299see
300.Xr readline 3
301.It Pa rpc/
302remote procedure calls;
303see
304.Xr rpc 3
305.It Pa rpcsvc/
306definition of RPC service structures; see
307.Xr rpc 3
308.It Pa security/
309PAM; see
310.Xr pam 8
311.It Pa sys/
312system C include files (kernel data structures)
313.\" .It Pa tcl/
314.\" Tcl language;
315.\" see
316.\" .Xr Tcl n
317.\" .Bl -tag -width "kerberosIV/" -compact
318.\" .It Pa generic/
319.\" ???
320.\" .It Pa unix/
321.\" ???
322.\" .El
323.It Pa ufs/
324C include files for UFS (The U-word File System)
325.Bl -tag -width "kerberosIV/" -compact
326.It Pa ffs/
327Fast file system
328.It Pa ufs/
329UFS file system
330.El
331.It Pa vm/
332virtual memory;
333see
334.Xr vmstat 8
335.El
336.Pp
337.It Pa lib/
338archive libraries
339.Bl -tag -width Fl -compact
340.It Pa aout/
341a.out archive libraries
342.It Pa compat/
343shared libraries for compatibility
344.Bl -tag -width Fl -compact
345.It Pa aout/
346a.out backward compatibility libraries
347.El
348.El
349.Pp
350.It Pa libdata/
351misc. utility data files
352.Bl -tag -width Fl -compact
353.It Pa doscmd/
354files used by doscmd (drivers, fonts, etc.);
355see
356.Xr doscmd 1
357.Bl -tag -width 6n -compact
358.It Pa fonts/
359fonts used by doscmd
360.El
361.It Pa gcc/
362???
363.It Pa ldscripts/
364linker scripts;
365see
366.Xr ld 1
367.It Pa lint/
368various prebuilt lint libraries;
369see
370.Xr lint 1
371.It Pa msdosfs/
372Character set conversion tables
373.It Pa stallion/
374firmware images for Stallion serial controllers; see
375.Xr stl 4
376.El
377.Pp
378.It Pa libexec/
379system daemons & system utilities (executed by other programs)
380.Bl -tag -width Fl -compact
381.It Pa aout/
382utilities to manipulate a.out executables
383.It Pa elf/
384utilities to manipulate ELF executables
385.It Pa lpr/
386utilities and filters for LP print system;
387see
388.Xr lpr 1
389.It Pa sendmail/
390the
391.Xr sendmail 8
392binary;
393see
394.Xr mailwrapper 8
395.It Pa sm.bin/
396restricted shell for
397.Xr sendmail 8 ;
398see
399.Xr smrsh 8
400.El
401.Pp
402.It Pa local/
403local executables, libraries, etc.
404Also used as the default destination for the
405.Fx
406ports framework.
407Within local/, the general layout sketched out by
408.Nm
409for /usr
410should be used.  Exceptions are the man directory (directly under local/
411rather than under local/share/), ports documentation (in share/doc/<port>/),
412and /usr/local/etc (mimics /etc).
413.It Pa obj/
414architecture-specific target tree produced by building the /usr/src tree
415.It Pa ports/
416The
417.Fx
418ports collection (optional).
419.It Pa sbin/
420system daemons & system utilities (executed by users)
421.It Pa share/
422architecture-independent files
423.Pp
424.Bl -tag -width "calendar/" -compact
425.It Pa calendar/
426a variety of pre-fab calendar files;
427see
428.Xr calendar 1
429.It Pa dict/
430word lists;
431see
432.Xr look 1
433.Pp
434.Bl -tag -width Fl -compact
435.It Pa freebsd
436.Fx Ns -specific
437terms, proper names, and jargon
438.It Pa words
439common words
440.It Pa web2
441words from Webster's 2nd International
442.It Pa papers/
443reference databases;
444see
445.Xr refer 1
446.El
447.Pp
448.It Pa doc/
449miscellaneous documentation;
450source for most of the printed
451.Bx
452manuals (available
453from the
454.Tn USENIX
455association)
456.Bl -tag -width Fl -compact
457.It Pa FAQ/
458Frequently Asked Questions
459.It Pa IPv6/
460implementation notes for IPv6
461.It Pa bind/
462documents pertaining to BIND (the Berkeley Internet Name Domain)
463.It Pa es/
464Spanish translations of documents in /usr/share/doc
465.It Pa handbook/
466.Fx
467Handbook
468.It Pa ja/
469Japanese translations of documents in /usr/share/doc
470.It Pa ncurses/
471HTML documents pertaining to ncurses;
472see
473.Xr ncurses 3X
474.It Pa ntp/
475HTML documents pertaining to the Network Time Protocol
476.It Pa papers/
477UNIX Papers
478.It Pa psd/
479UNIX Programmer's Supplementary Documents
480.It Pa ru/
481Russian translations of documents in /usr/share/doc
482.It Pa smm/
483UNIX System Manager's Manual
484.It Pa tutorials/
485.Fx
486tutorials
487.It Pa usd/
488UNIX User's Supplementary Documents
489.It Pa zh/
490Chinese translations of documents in /usr/share/doc
491.El
492.Pp
493.It Pa examples/
494various examples for users and programmers
495.It Pa games/
496ASCII text files used by various games
497.It Pa groff_font/
498device description file for device name
499.It Pa info/
500GNU Info hypertext system
501.It Pa isdn/
502ISDN
503.It Pa locale/
504localization files;
505see
506.Xr setlocale 3
507.It Pa man/
508manual pages
509.It Pa me/
510macros for use with the me macro package;
511see
512.Xr me 7
513.It Pa misc/
514misc system-wide ASCII text files
515.Bl -tag -width Fl -compact
516.It Pa fonts/
517???
518.It Pa pcvtfonts/
519pcvt fonts;
520see
521.Xr pcvt 4
522.It Pa termcap
523terminal characteristics database;
524see
525.Xr termcap 5
526.El
527.It Pa mk/
528templates for make;
529see
530.Xr make 1
531.It Pa nls/
532national language support files;
533see
534.Xr mklocale 1
535.It Pa pcvt/
536pcvt documentation and etc examples;
537see
538.Xr pcvt 4
539.It Pa sendmail/
540.Xr sendmail 8
541configuration files
542.It Pa skel/
543example . (dot) files for new accounts
544.It Pa syscons/
545files used by syscons;
546see
547.Xr syscons 4
548.Bl -tag -width "scrnmaps/xx" -compact
549.It Pa fonts/
550console fonts;
551see
552.Xr vidcontrol 1
553and
554.Xr vidfont 1
555.It Pa keymaps/
556console keyboard maps;
557see
558.Xr kbdcontrol 1
559and
560.Xr kbdmap 1
561.It Pa scrnmaps/
562console screen maps
563.El
564.It Pa tabset/
565tab description files for a variety of terminals; used in
566the termcap file;
567see
568.Xr termcap 5
569.It Pa tmac/
570text processing macros;
571see
572.Xr nroff 1
573and
574.Xr troff 1
575.It Pa vi/
576localization support and utilities for
577.Xr vi 1
578.It Pa zoneinfo/
579timezone configuration information;
580see
581.Xr tzfile 5
582.El
583.It Pa src/
584.Bx ,
585third-party, and/or local source files
586.Pp
587.Bl -tag -width "kerberosIV/" -compact
588.It Pa bin/
589source code for files in /bin
590.It Pa contrib/
591source code for contributed software
592.It Pa crypto/
593source code for contributed cryptography software
594.It Pa etc/
595source code for files in /etc
596.It Pa games/
597source code for files in /usr/games
598.It Pa gnu/
599Utilities covered by the GNU General Public License
600.It Pa include/
601source code for files in /usr/include
602.It Pa kerberosIV/
603source code for kerberos version IV
604.It Pa lib/
605source code for files in /usr/lib
606.It Pa libexec/
607source code for files in /usr/libexec
608.It Pa release/
609files required to produce a
610.Fx
611release
612.It Pa sbin/
613source code for files in /sbin
614.It Pa secure/
615build directory for files in /usr/src/crypto
616.It Pa share/
617source for files in /usr/share
618.It Pa sys/
619kernel source code
620.It Pa tools/
621tools used for maintenance and testing of
622.Fx
623.It Pa usr.bin/
624source code for files in /usr/bin
625.It Pa usr.sbin/
626source code for files in /usr/sbin
627.El
628.Pp
629.It Pa X11R6/
630X11R6 distribution executables, libraries, etc (optional).
631.Bl -tag -width "include/" -compact
632.It Pa bin/
633X11R6 binaries (servers, utilities, local packages/ports).
634.It Pa etc/
635X11R6 configuration files and scripts.
636.It Pa include/
637X11R6 include files.
638.It Pa lib/
639X11R6 libraries.
640.It Pa man/
641X11R6 manual pages.
642.It Pa share/
643architecture-independent files.
644.El
645.El
646.It Pa /var/
647multi-purpose log, temporary, transient, and spool files
648.Pp
649.Bl -tag -width "preserve/" -compact
650.It Pa account/
651system accounting files
652.Pp
653.Bl -tag -width Fl -compact
654.It Pa acct
655execution accounting file;
656see
657.Xr acct 5
658.El
659.Pp
660.It Pa at/
661timed command scheduling files;
662see
663.Xr \&at 1
664.Bl -tag -width "preserve/" -compact
665.It Pa jobs/
666directory containing job files
667.It Pa spool/
668directory containing output spool files
669.El
670.Pp
671.It Pa backups/
672misc. backup files
673.It Pa crash/
674default directory to store kernel crash dumps; see
675.Xr crash 8
676and
677.Xr savecore 8
678.It Pa cron/
679files used by cron;
680see
681.Xr cron 8
682.Bl -tag -width "preserve/" -compact
683.It Pa tabs/
684crontab files;
685see
686.Xr crontab 5
687.El
688.Pp
689.It Pa db/
690misc. automatically generated system-specific database files
691.It Pa empty/
692empty directory used by
693.Xr sshd 8
694for privilege separation
695.It Pa games/
696misc. game status and score files
697.It Pa heimdal/
698kerberos server databases; see
699.Xr kdc 8
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 msgs/
713system messages database;
714see
715.Xr msgs 1
716.It Pa preserve/
717temporary home of files preserved after an accidental death
718of an editor;
719see
720.Xr \&ex 1
721.It Pa quotas/
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
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 .
802