xref: /freebsd/share/man/man7/hier.7 (revision 2ad872c5794e4c26fdf6ed219ad3f09ca0d5304a)
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.15 1997/09/13 17:52:36 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
284.Tn FreeBSD
285ports framework.
286Within local/, the general layout sketched out by
287.Xr hier 7
288for /usr
289should be used.  Exceptions are the man directory is directly under local/
290rather than under local/share/.  Ports documentation is in share/doc/<port>/
291.It Li mdec/
292boot programs;
293see
294.Xr disklabel 8
295.It Li obj/
296architecture-specific target tree produced by building the /usr/src tree
297.It Li ports
298The
299.Tn FreeBSD
300ports collection (optional).
301.It Li sbin/
302system daemons & system utilities (executed by users)
303.It Li share/
304architecture-independent files
305.Pp
306.Bl -tag -width "calendar/" -compact
307.It Li calendar/
308a variety of pre-fab calendar files;
309see
310.Xr calendar 1
311.It Li dict/
312word lists;
313see
314.Xr look 1
315.Pp
316.Bl -tag -width Fl -compact
317.It Li words
318common words
319.It Li web2
320words from Webster's 2nd International
321.It Li papers/
322reference databases;
323see
324.Xr refer 1
325.It Li special/
326custom word lists;
327see
328.Xr spell 1
329.El
330.Pp
331.It Li doc/
332misc documentation;
333src for most of the printed
334.Bx BSD
335manuals (available
336from the
337.Tn USENIX
338association)
339.Bl -tag -width Fl -compact
340.It Li FAQ/
341Frequently Asked Questions
342.It Li handbook/
343.Tn FreeBSD
344Handbook
345.It Li papers/
346UNIX Papers
347.It Li psd/
348UNIX Programmer's Supplementary Documents
349.It Li smm/
350UNIX System Manager's Manual
351.It Li usd/
352UNIX User's Supplementary Documents
353.El
354.Pp
355.It Li examples/
356various examples for users and programmers
357.It Li games/
358ascii text files used by various games
359.It Li groff_font/
360device description file for device name
361.It Li info/
362GNU Info hypertext system
363.It Li isdn/
364ISDN
365.It Li libg++/
366libg++'s genclass prototype/template class files
367.It Li locale/
368internationalization files;
369see
370.Xr setlocale 3
371.It Li man/
372manual pages
373.It Li me/
374macros for use with the me macro package
375.It Li misc/
376misc system-wide ascii text files
377.Bl -tag -width Fl -compact
378.It Li fonts/
379???
380.It Li pcvtfonts/
381???;
382see
383.Xr pcvt 4
384.It Li pkg_manage/
385package manager help files;
386see
387.Xr pkg_manage
388.It Li termcap
389terminal characteristics database;
390see
391.Xr termcap 5
392.El
393.It Li mk/
394templates for make;
395see
396.Xr make 1
397.It Li ms/
398macros for use with the ms macro package
399.It Li nls/
400national language support files;
401see
402.Xr mklocale 1
403.It Li perl/
404perl library files;
405see
406.Xr perl 1
407.It Li sgml/
408SGML tools files;
409see
410.Xr instant 1
411.It Li skel/
412example . (dot) files for new accounts
413.It Li tabset/
414tab description files for a variety of terminals; used in
415the termcap file;
416see
417.Xr termcap 5
418.It Li tmac/
419text processing macros;
420see
421.Xr nroff 1
422and
423.Xr troff 1
424.It Li zoneinfo/
425timezone configuration information;
426see
427.Xr tzfile 5
428.El
429.It Li src/
430BSD and/or local source files
431.Pp
432.Bl -tag -width "kerberosIV/" -compact
433.It Li bin/
434src for files in /bin
435.It Li contrib/
436src for file from contributed software
437.It Li eBones
438Kerberos and DES
439.It Li etc/
440src for files in /etc
441.It Li games/
442src for files in /usr/games
443.It Li gnu/
444Utilities covered by the GNU Public License
445.It Li include/
446src for files in /usr/include
447.It Li kerberosIV/
448src for kerberos version IV
449.It Li lib/
450src for files in /usr/lib
451.It Li libexec/
452src for files in /usr/libexec
453.It Li local/
454src for files in /usr/local
455.It Li lkm
456src for files in /lkm
457.It Li release
458Files required to produce a
459.Tn FreeBSD
460release
461.It Li sbin/
462src for files in /sbin
463.It Li secure
464DES Sources
465.It Li share/
466src for files in /usr/share
467.It Li sys/
468kernel src files
469.It Li usr.bin/
470src for files in /usr/bin
471.It Li usr.sbin/
472src for files in /usr/sbin
473.El
474.Pp
475.It Li X11R6/
476X11R6 distribution executables, libraries, etc (optional).
477.El
478.It Li /var/
479multi-purpose log, temporary, transient, and spool files
480.Pp
481.Bl -tag -width "preserve/" -compact
482.It Li account/
483system accounting files
484.Pp
485.Bl -tag -width Fl -compact
486.It Li acct
487execution accounting file;
488see
489.Xr acct 5
490.El
491.Pp
492.It Li at/
493timed command scheduling files;
494see
495.Xr \&at 1
496.Bl -tag -width "preserve/" -compact
497.It Li jobs
498directory containing job files
499.It Li spool
500directory containing output spool files
501.El
502.Pp
503.It Li backups/
504misc. backup files
505.It Li crash
506???;
507see
508.Xr crash 8
509.It Li cron/
510.Bl -tag -width "preserve/" -compact
511.It Li log
512cron log files;
513see
514.Xr cron 8
515.It Li tabs
516crontab files;
517see
518.Xr crontab 5
519.El
520.Pp
521.It Li db/
522misc. automatically generated system-specific database files
523.It Li games/
524misc. game status and log files
525.It Li games/
526games score files
527.It Li log/
528misc. system log files
529.Pp
530.Bl -tag -width Fl -compact
531.It Li wtmp
532login/logout log;
533see
534.Xr wtmp 5
535.El
536.Pp
537.It Li mail/
538user mailbox files
539.It Li preserve/
540temporary home of files preserved after an accidental death
541of an editor;
542see
543.Xr \&ex 1
544.It Li msgs/
545system messages database;
546see
547.Xr msgs 1
548.It Li quotas/
549filesystem quota information files
550.It preserve
551???
552.It Li run/
553system information files describing various info about
554system since it was booted
555.Pp
556.Bl -tag -width Fl -compact
557.It Li utmp
558database of current users;
559see
560.Xr utmp 5
561.El
562.Pp
563.It Li rwho/
564rwho data files;
565see
566.Xr rwhod 8 ,
567.Xr rwho 1 ,
568and
569.Xr ruptime 1
570.It Li spool/
571misc. printer and mail system spooling directories
572.Pp
573.Bl -tag -width Fl -compact
574.It Li ftp/
575commonly ~ftp; the anonymous ftp root directory
576.It Li mqueue/
577undelivered mail queue;
578see
579.Xr sendmail 8
580.It Li output/
581line printer spooling directories
582.It Li secretmail/
583secretmail spool directory;
584see
585.Xr xget 1
586.It Li uucp/
587uucp spool directory
588.It Li uucppublic/
589commonly ~uucp; public uucp temporary directory
590.El
591.Pp
592.It Li tmp/
593temporary files that are kept between system reboots
594.Bl -tag -width Fl -compact
595.It Li vi.recover
596the directory where recovery files are stored
597.El
598.It Li yp
599the NIS maps
600.El
601.El
602.Sh SEE ALSO
603.Xr apropos 1 ,
604.Xr find 1 ,
605.Xr finger 1 ,
606.Xr grep 1 ,
607.Xr ls 1 ,
608.Xr whatis 1 ,
609.Xr whereis 1 ,
610.Xr which 1 ,
611.Xr fsck 8
612.Sh HISTORY
613A
614.Nm hier
615manual page appeared in
616.At v7 .
617