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