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