xref: /freebsd/share/man/man7/hier.7 (revision b5b2a90624d3d900a42e99758eb95293d04f37fa)
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$
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 localtime
66local timezone information;
67see
68.Xr ctime 3
69.It Li disklabels/
70backup disklabels;
71see
72.Xr disklabel 8
73.It Li kerberosIV/
74configuration files for the kerberos version IV;
75see
76.Xr kerberos 1
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.El
86.It Li /mnt/
87empty directory commonly used by
88system administrators as a temporary mount point
89.It Li /sbin/
90system programs and administration utilities
91fundamental to both single-user and multi-user environments
92.It Li /stand/
93programs used in a standalone environment
94.It Li /tmp/
95temporary files, usually a
96.Xr mfs 8
97memory-based filesystem (the contents
98of /tmp are usually NOT preserved across a system reboot)
99.It Li /usr/
100contains the majority of user utilities and applications
101.Pp
102.Bl -tag -width "libdata/" -compact
103.It Li bin/
104common utilities, programming tools, and applications
105.It Li games/
106useful and semi-frivolous programs
107.It Li include/
108standard C include files
109.Pp
110.Bl -tag -width "kerberosIV/" -compact
111.It Li arpa/
112C include files for Internet service protocols
113.It Li kerberosIV/
114C include files for kerberos authentication package;
115see
116.Xr kerberos 1
117.It Li machine/
118machine specific C include files
119.It Li net/
120misc network C include files
121.\" .It Li netimp/
122.\" C include files for IMP protocols;
123.\" see
124.\" .Xr imp 4
125.It Li netinet/
126C include files for Internet standard protocols;
127see
128.Xr inet 4
129.\" .It Li netiso/
130.\" C include files for ISO standard protocols;
131.\" see
132.\" .Xr iso 4
133.\" .It Li netns/
134.\" C include files for XNS standard protocols;
135.\" see
136.\" .Xr \&ns 4
137.It Li nfs/
138C include files for NFS (Network File System)
139.It Li pascal/
140include files for pc 1
141.It Li protocols/
142C include files for Berkeley service protocols
143.It Li sys/
144system C include files (kernel data structures)
145.It Li ufs/
146C include files for UFS (The U-word File System)
147.El
148.Pp
149.It Li lib/
150archive libraries
151.Pp
152.Bl -tag -width Fl -compact
153.It Li uucp/
154UUCP configuration files (historically placed; to be moved)
155.El
156.It Li libdata/
157misc. utility data files
158.It Li libexec/
159system daemons & system utilities (executed by other programs)
160.It Li local/
161local executables, libraries, etc.
162.br
163Also used as the default destination for the FreeBSD ports framework.
164Within local/, the general layout sketched out by
165.Xr hier 7
166should be used.  Exceptions are the man directory is directly under local/
167rather than under local/share/.  Ports documentation is in share/doc/<port>/
168.It Li X11R6/
169X11R6 distribution executables, libraries, etc.
170.It Li ports
171The FreeBSD ports collection (optional).
172.It Li obj/
173architecture-specific target tree produced by building the /usr/src tree
174.It Li old/
175programs from past lives of BSD which may disappear in future
176releases
177.It Li sbin/
178system daemons & system utilities (executed by users)
179.It Li share/
180architecture-independent ascii text files
181.Pp
182.Bl -tag -width "calendar/" -compact
183.It Li calendar/
184a variety of pre-fab calendar files;
185see
186.Xr calendar 1
187.It Li dict/
188word lists;
189see
190.Xr look 1
191.Pp
192.Bl -tag -width Fl -compact
193.It Li words
194common words
195.It Li web2
196words from Webster's 2nd International
197.It Li papers/
198reference databases;
199see
200.Xr refer 1
201.It Li special/
202custom word lists;
203see
204.Xr spell 1
205.El
206.Pp
207.It Li doc/
208misc documentation;
209src for most of the printed
210.Bx BSD
211manuals (available
212from the
213.Tn USENIX
214association)
215.It Li games/
216ascii text files used by various games
217.It Li man/
218manual pages
219.It Li me/
220macros for use with the me macro package
221.It Li misc/
222misc system-wide ascii text files
223.Bl -tag -width Fl -compact
224.It Li termcap
225terminal characteristics database;
226see
227.Xr termcap 5
228.El
229.It Li mk/
230templates for make;
231see
232.Xr make 1
233.It Li ms/
234macros for use with the ms macro package
235.It Li skel/
236example . (dot) files for new accounts
237.It Li tabset/
238tab description files for a variety of terminals; used in
239the termcap file;
240see
241.Xr termcap 5
242.It Li tmac/
243text processing macros;
244see
245.Xr nroff 1
246and
247.Xr troff 1
248.It Li zoneinfo/
249timezone configuration information;
250see
251.Xr tzfile 5
252.El
253.Pp
254.It Li src/
255BSD and/or local source files
256.Pp
257.Bl -tag -width "kerberosIV/" -compact
258.It Li bin/
259src for files in /bin
260.It Li etc/
261src for files in /etc
262.It Li games/
263src for files in /usr/games
264.It Li include/
265src for files in /usr/include
266.It Li kerberosIV/
267src for kerberos version IV
268.It Li lib/
269src for files in /usr/lib
270.It Li libexec/
271src for files in /usr/libexec
272.It Li local/
273src for files in /usr/local
274.It Li old/
275src for files in /usr/old
276.It Li sbin/
277src for files in /sbin
278.It Li share/
279src for files in /usr/share
280.It Li sys/
281kernel src files
282.It Li usr.bin/
283src for files in /usr/bin
284.It Li usr.sbin/
285src for files in /usr/sbin
286.El
287.El
288.It Li /var/
289multi-purpose log, temporary, transient, and spool files
290.Pp
291.Bl -tag -width "preserve/" -compact
292.It Li account/
293system accounting files
294.Pp
295.Bl -tag -width Fl -compact
296.It Li acct
297execution accounting file;
298see
299.Xr acct 5
300.El
301.Pp
302.It Li at/
303timed command scheduling files;
304see
305.Xr \&at 1
306.It Li backups/
307misc. backup files
308.It Li db/
309misc. automatically generated system-specific database files
310.It Li games/
311misc. game status and log files
312.It Li log/
313misc. system log files
314.Pp
315.Bl -tag -width Fl -compact
316.It Li wtmp
317login/logout log;
318see
319.Xr wtmp 5
320.El
321.Pp
322.It Li mail/
323user mailbox files
324.It Li preserve/
325temporary home of files preserved after an accidental death
326of an editor;
327see
328.Xr \&ex 1
329.It Li quotas/
330filesystem quota information files
331.It Li run/
332system information files describing various info about
333system since it was booted
334.Pp
335.Bl -tag -width Fl -compact
336.It Li utmp
337database of current users;
338see
339.Xr utmp 5
340.El
341.Pp
342.It Li rwho/
343rwho data files;
344see
345.Xr rwhod 8 ,
346.Xr rwho 1 ,
347and
348.Xr ruptime 1
349.It Li spool/
350misc. printer and mail system spooling directories
351.Pp
352.Bl -tag -width Fl -compact
353.It Li ftp/
354commonly ~ftp; the anonymous ftp root directory
355.It Li mqueue/
356undelivered mail queue;
357see
358.Xr sendmail 8
359.It Li output/
360line printer spooling directories
361.It Li secretmail/
362secretmail spool directory;
363see
364.Xr xget 1
365.It Li uucp/
366uucp spool directory
367.It Li uucppublic/
368commonly ~uucp; public uucp temporary directory
369.El
370.Pp
371.It Li tmp/
372temporary files that are kept between system reboots
373.El
374.It Li /kernel
375pure kernel executable (the operating system loaded into memory
376at boot time).
377.El
378.Sh SEE ALSO
379.Xr apropos 1 ,
380.Xr find 1 ,
381.Xr finger 1 ,
382.Xr grep 1 ,
383.Xr ls 1 ,
384.Xr whatis 1 ,
385.Xr whereis 1 ,
386.Xr which 1 ,
387.Xr fsck 8
388.Sh HISTORY
389A
390.Nm hier
391manual page appeared in
392.At v7 .
393