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