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