xref: /freebsd/share/man/man7/hier.7 (revision 0fddbf874719b9bd50cf66ac26d1140bb3f2be69)
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 filesystems
41.Sh DESCRIPTION
42A sketch of the filesystem hierarchy.
43.Bl -tag -width "/stand/"
44.It Pa /
45root directory of the filesystem
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-part 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 periodic/
126scripts that are run daily, weekly, and monthly, via
127.Xr cron 8 ;
128see
129.Xr periodic 8
130.It Pa ppp/
131ppp configuration files;
132see
133.Xr ppp 8
134.It Pa ssl/
135OpenSSL configuration files
136.It Pa uucp/
137uucp configuration files;
138see
139.Xr uucp 1
140.El
141.It Pa /mnt/
142empty directory commonly used by
143system administrators as a temporary mount point
144.It Pa /proc/
145process file system;
146see
147.Xr procfs 5 ,
148.Xr mount_procfs 8
149.It Pa /root/
150root's HOME directory
151.It Pa /sbin/
152system programs and administration utilities
153fundamental to both single-user and multi-user environments
154.It Pa /stand/
155programs used in a standalone environment
156.It Pa /tmp/
157temporary files
158.It Pa /usr/
159contains the majority of user utilities and applications
160.Pp
161.Bl -tag -width "libdata/" -compact
162.It Pa bin/
163common utilities, programming tools, and applications
164.It Pa compat/
165files needed to support binary compatability with other operating systems,
166such as Linux
167(created by
168.Xr sysinstall 8 )
169.It Pa games/
170useful and semi-frivolous programs
171.It Pa include/
172standard C include files
173.Pp
174.Bl -tag -width "kerberosIV/" -compact
175.It Pa arpa/
176C include files for Internet service protocols
177.It Pa cam/
178C include files for the Common Access Methods Layer
179.Bl -tag -width "kerberosIV/" -compact
180.It scsi/
181The SCSI device on top of CAM
182.El
183.It Pa dev/
184C include files for programming various
185.Fx
186devices
187.Bl -tag -width "kerberosIV/" -compact
188.It Pa ic/
189Various header files describing driver- and bus-independent
190hardware circuits
191.It Pa ppbus/
192The parallel port bus;
193see
194.Xr ppbus 4
195.It Pa usb/
196The USB subsystem
197.It Pa wi/
198The
199.Xr wi 4
200WaveLAN driver
201.El
202.It Pa fs/
203.Bl -tag -width "kerberosIV/" -compact
204.It Pa fdescfs/
205per-process file descriptors file system
206.It Pa fifofs/
207.St -p1003.1
208FIFOs file system
209.It Pa msdosfs/
210MS-DOS file system
211.It Pa ntfs/
212NTFS file system
213.It Pa nullfs/
214loopback file system
215.It Pa nwfs/
216NetWare file system
217.It Pa portalfs/
218portal file system
219.It Pa procfs/
220process file system
221.It Pa smbfs/
222SMB/CIFS filesystem
223.It Pa umapfs/
224alternate uid/gid mappings file system
225.It Pa unionfs
226union file system
227.El
228.It Pa g++/
229GNU C++ include files
230.Bl -tag -width "kerberosIV/" -compact
231.It Pa std/
232GNU C++ libstdc++ include files
233.El
234.It Pa isc/
235ISC utility library libisc include files
236.It Pa isofs/
237.Bl -tag -width "kerberosIV/" -compact
238.It Pa cd9660/
239iso9660 filesystem
240.El
241.It Pa kerberosIV/
242C include files for kerberos authentication package;
243see
244.Xr kerberos 1
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 netns/
268Xerox NS protocols
269.It Pa netsmb/
270SMB/CIFS requester
271.It Pa netnatm/
272NATM include files;
273see
274.Xr natm 4
275.It Pa nfs/
276C include files for NFS (Network File System)
277.It Pa objc/
278Objective C include files
279.It Pa openssl/
280OpenSSL (Cryptography/SSL toolkit) headers
281.It Pa pccard/
282PC-CARD controllers
283.It Pa posix4/
284POSIX real-time extensions includes;
285see
286.Xr p1003_1b 9
287.It Pa protocols/
288C include files for Berkeley service protocols
289.It Pa readline/
290get a line from a user, with editing;
291see
292.Xr readline 3
293.It Pa rpc/
294remote procedure calls;
295see
296.Xr rpc 3
297.It Pa rpcsvc/
298definition of RPC service structures; see
299.Xr rpc 3
300.It Pa security/
301PAM; see
302.Xr pam 8
303.It Pa sys/
304system C include files (kernel data structures)
305.\" .It Pa tcl/
306.\" Tcl language;
307.\" see
308.\" .Xr Tcl n
309.\" .Bl -tag -width "kerberosIV/" -compact
310.\" .It Pa generic/
311.\" ???
312.\" .It Pa unix/
313.\" ???
314.\" .El
315.It Pa ufs/
316C include files for UFS (The U-word File System)
317.Bl -tag -width "kerberosIV/" -compact
318.It Pa ffs/
319Fast filesystem
320.It Pa ufs/
321UFS filesystem
322.El
323.It Pa vm/
324virtual memory;
325see
326.Xr vmstat 8
327.El
328.Pp
329.It Pa lib/
330archive libraries
331.Bl -tag -width Fl -compact
332.It Pa aout/
333a.out archive libraries
334.It Pa compat/
335shared libraries for compatibility
336.Bl -tag -width Fl -compact
337.It Pa aout/
338a.out backward compatibility libraries
339.El
340.El
341.Pp
342.It Pa libdata/
343misc. utility data files
344.Bl -tag -width Fl -compact
345.It Pa doscmd/
346files used by doscmd (drivers, fonts, etc.);
347see
348.Xr doscmd 1
349.Bl -tag -width 6n -compact
350.It Pa fonts/
351fonts used by doscmd
352.El
353.It Pa gcc/
354???
355.It Pa ldscripts/
356linker scripts;
357see
358.Xr ld 1
359.It Pa lint/
360various prebuilt lint libraries;
361see
362.Xr lint 1
363.It Pa msdosfs/
364Character set conversion tables
365.It Pa perl/
366.Bl -tag -width Fl -compact
367.It Pa 5.00503/
368contains Perl modules for Perl version 5.00503;
369see
370.Xr perl 1
371.El
372.It Pa stallion/
373holds the download firmware images
374.El
375.Pp
376.It Pa libexec/
377system daemons & system utilities (executed by other programs)
378.Bl -tag -width Fl -compact
379.It Pa aout/
380utilities to manipulate a.out executables
381.It Pa elf/
382utilities to manipulate ELF executables
383.It Pa lpr/
384utilities and filters for LP print system;
385see
386.Xr lpr 1
387.It Pa sm.bin/
388restricted shell for sendmail;
389see
390.Xr smrsh 8
391.It Pa uucp/
392uucp utilities;
393see
394.Xr uucp 1
395.El
396.Pp
397.It Pa local/
398local executables, libraries, etc.
399Also used as the default destination for the
400.Fx
401ports framework.
402Within local/, the general layout sketched out by
403.Xr hier 7
404for /usr
405should be used.  Exceptions are the man directory (directly under local/
406rather than under local/share/), ports documentation (in share/doc/<port>/),
407and /usr/local/etc (mimics /etc).
408.It Pa obj/
409architecture-specific target tree produced by building the /usr/src tree
410.It Pa ports/
411The
412.Fx
413ports collection (optional).
414.It Pa sbin/
415system daemons & system utilities (executed by users)
416.It Pa share/
417architecture-independent files
418.Pp
419.Bl -tag -width "calendar/" -compact
420.It Pa calendar/
421a variety of pre-fab calendar files;
422see
423.Xr calendar 1
424.It Pa dict/
425word lists;
426see
427.Xr look 1
428.Pp
429.Bl -tag -width Fl -compact
430.It Pa words
431common words
432.It Pa web2
433words from Webster's 2nd International
434.It Pa papers/
435reference databases;
436see
437.Xr refer 1
438.It Pa special/
439custom word lists;
440see
441.Xr spell 1
442.El
443.Pp
444.It Pa doc/
445miscellaneous documentation;
446source for most of the printed
447.Bx
448manuals (available
449from the
450.Tn USENIX
451association)
452.Bl -tag -width Fl -compact
453.It Pa FAQ/
454Frequently Asked Questions
455.It Pa IPv6/
456implementation notes for IPv6
457.It Pa bind/
458documents pertaining to BIND (the Berkeley Internet Name Domain)
459.It Pa es/
460Spanish translations of documents in /usr/share/doc
461.It Pa handbook/
462.Fx
463Handbook
464.It Pa ja/
465Japanese translations of documents in /usr/share/doc
466.It Pa ncurses/
467HTML documents pertaining to ncurses;
468see
469.Xr ncurses 3X
470.It Pa ntp/
471HTML documents pertaining to the Network Time Protocol
472.It Pa papers/
473UNIX Papers
474.It Pa psd/
475UNIX Programmer's Supplementary Documents
476.It Pa ru/
477Russian translations of documents in /usr/share/doc
478.It Pa smm/
479UNIX System Manager's Manual
480.It Pa tutorials/
481.Fx
482tutorials
483.It Pa usd/
484UNIX User's Supplementary Documents
485.It Pa zh/
486Chinese translations of documents in /usr/share/doc
487.El
488.Pp
489.It Pa examples/
490various examples for users and programmers
491.It Pa games/
492ASCII text files used by various games
493.It Pa groff_font/
494device description file for device name
495.It Pa info/
496GNU Info hypertext system
497.It Pa isdn/
498ISDN
499.It Pa libg++/
500libg++'s genclass prototype/template class files
501.It Pa locale/
502localization files;
503see
504.Xr setlocale 3
505.It Pa man/
506manual pages
507.It Pa me/
508macros for use with the me macro package;
509see
510.Xr me 7
511.It Pa misc/
512misc system-wide ASCII text files
513.Bl -tag -width Fl -compact
514.It Pa fonts/
515???
516.It Pa pcvtfonts/
517pcvt fonts;
518see
519.Xr pcvt 4
520.It Pa termcap
521terminal characteristics database;
522see
523.Xr termcap 5
524.El
525.It Pa mk/
526templates for make;
527see
528.Xr make 1
529.It Pa nls/
530national language support files;
531see
532.Xr mklocale 1
533.It Pa pcvt/
534pcvt documentation and etc examples;
535see
536.Xr pcvt 4
537.It Pa perl/
538perl library files;
539see
540.Xr perl 1
541.It Pa sendmail/
542sendmail configuration files;
543see
544.Xr sendmail 8
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 games/
695misc. game status and score files
696.It Pa log/
697misc. system log files
698.Pp
699.Bl -tag -width Fl -compact
700.It Pa wtmp
701login/logout log;
702see
703.Xr wtmp 5
704.El
705.Pp
706.It Pa mail/
707user mailbox files
708.It Pa preserve/
709temporary home of files preserved after an accidental death
710of an editor;
711see
712.Xr \&ex 1
713.It Pa msgs/
714system messages database;
715see
716.Xr msgs 1
717.It Pa quotas/
718filesystem quota information files
719.It Pa run/
720system information files describing various info about
721system since it was booted
722.Pp
723.Bl -tag -width Fl -compact
724.It Pa utmp
725database of current users;
726see
727.Xr utmp 5
728.El
729.Pp
730.It Pa rwho/
731rwho data files;
732see
733.Xr rwhod 8 ,
734.Xr rwho 1 ,
735and
736.Xr ruptime 1
737.It Pa spool/
738misc. printer and mail system spooling directories
739.Pp
740.Bl -tag -width Fl -compact
741.It Pa ftp/
742commonly ~ftp; the anonymous ftp root directory
743.It Pa mqueue/
744undelivered mail queue;
745see
746.Xr sendmail 8
747.It Pa output/
748line printer spooling directories
749.It Pa uucp/
750uucp spool directory
751.It Pa uucppublic/
752commonly ~uucp; public uucp temporary directory
753.El
754.Pp
755.It Pa tmp/
756temporary files that are kept between system reboots
757.Bl -tag -width Fl -compact
758.It Pa vi.recover/
759the directory where recovery files are stored
760.El
761.It Pa yp/
762the NIS maps
763.El
764.El
765.Sh SEE ALSO
766.Xr apropos 1 ,
767.Xr find 1 ,
768.Xr finger 1 ,
769.Xr grep 1 ,
770.Xr ls 1 ,
771.Xr whatis 1 ,
772.Xr whereis 1 ,
773.Xr which 1 ,
774.Xr fsck 8
775.Sh HISTORY
776A
777.Nm
778manual page appeared in
779.At v7 .
780