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