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