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