xref: /openbsd-src/share/man/man7/hier.7 (revision c90a81c56dcebd6a1b73fe4aff9b03385b8e63b3)
1.\"	$OpenBSD: hier.7,v 1.161 2018/08/15 19:40:30 fcambus Exp $
2.\"	$NetBSD: hier.7,v 1.7 1994/11/30 19:07:10 jtc Exp $
3.\"
4.\" Copyright (c) 1990, 1993
5.\"	The Regents of the University of California.  All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. Neither the name of the University nor the names of its contributors
16.\"    may be used to endorse or promote products derived from this software
17.\"    without specific prior written permission.
18.\"
19.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.\"	@(#)hier.7	8.1 (Berkeley) 6/5/93
32.\"
33.Dd $Mdocdate: August 15 2018 $
34.Dt HIER 7
35.Os
36.Sh NAME
37.Nm hier
38.Nd layout of filesystems
39.Sh DESCRIPTION
40A sketch of the filesystem hierarchy.
41.Bl -tag -width "/altroot/"
42.It /
43Root directory.
44.It /altroot/
45Alternate (backup) location for the root
46.Pq Sq /
47filesystem
48(see
49.Xr daily 8 ) .
50.It /bin/
51User utilities fundamental to both single and multi-user environments.
52These programs are statically compiled and therefore do not depend on any
53system libraries to run.
54.It /bsd
55Pure kernel executable
56(the operating system loaded into memory at boot-time).
57.It /bsd.mp
58Pure kernel executable
59for multiprocessor machines.
60.It /bsd.rd
61Installation kernel.
62The built-in RAM disk contains utilities which can be run
63without an external file system, so this kernel is useful
64for limited system maintenance too.
65.It /bsd.sp
66Pure kernel executable
67for single processor machines.
68.It /dev/
69Block and character device files.
70.Pp
71.Bl -tag -width MAKEDEV -compact
72.It MAKEDEV
73Script for creating device files (see
74.Xr MAKEDEV 8 ) .
75.It fd/
76File descriptor files (see
77.Xr fd 4 ) .
78.El
79.It /etc/
80System configuration files and scripts.
81.Pp
82.Bl -tag -width "raddb/servers/" -compact
83.It localtime
84Local time zone information (see
85.Xr ctime 3 ) .
86.It X11/
87Configuration files for the X11 window system.
88.It acme/
89Private keys for
90.Xr acme-client 1 .
91.It amd/
92Contains map files for
93.Xr amd 8 .
94.It authpf/
95Configuration files for the authenticating gateway user shell (see
96.Xr authpf 8 ) .
97.It examples/
98Example configuration files for base system daemons.
99.It firmware/
100Firmware files for various devices.
101.It fonts/
102Configuration files for X11 window system fonts.
103.It hotplug/
104Scripts for the hotplug daemon,
105.Xr hotplugd 8 .
106.It iked/
107Configuration files for
108.Xr iked 8 .
109.It isakmpd/
110Configuration files for
111.Xr isakmpd 8 .
112.It ldap/
113Certificates and schema definition files for
114.Xr ldapd 8 .
115.It mail/
116System mail configuration files.
117.It mtree/
118.Xr mtree 8
119configuration files.
120.It npppd/
121.Xr npppd 8
122configuration files.
123.It ppp/
124.Xr pppd 8
125configuration files.
126.It raddb/servers/
127List of radius servers and their associated shared secrets for
128.Xr login_radius 8 .
129.It rc.d/
130.Xr packages 7
131start/stop scripts and subroutines for
132.Xr rc 8 .
133.It signify/
134Key files used by
135.Xr signify 1 .
136.It skel/
137Example
138.Sq .\&
139(dot) files for new accounts.
140.It skey/
141One-time password user database for
142.Xr skey 1 .
143.It ssh/
144Configuration files for
145.Xr ssh 1
146and
147.Xr sshd 8 .
148.It ssl/
149OpenSSL configuration files (see
150.Xr openssl 1 ) .
151.El
152.It /home/
153Default location for user home directories.
154.It /mnt/
155Empty directory commonly used by
156system administrators as a temporary mount point.
157.It /root/
158Default home directory for the superuser.
159.It /sbin/
160System programs and administration utilities
161fundamental to both single and multi-user environments.
162These programs are statically compiled and therefore do not depend on any
163system libraries to run.
164.It /tmp/
165Temporary files that are
166.Em not
167preserved between system reboots.
168Periodically cleaned by
169.Xr daily 8 .
170.It /usr/
171Contains the majority of user utilities and applications.
172.Pp
173.Bl -tag -width "xenocara/" -compact
174.It X11R6/
175Files required for the X11 window system.
176.Pp
177.Bl -tag -width "include/" -compact
178.It bin/
179X11 binaries.
180.It include/
181X11-specific C include files.
182.It lib/
183X11 archive libraries.
184.Pp
185.Bl -tag -width "pkgconfig/" -compact
186.It X11/
187Default configuration files for X11 and companion applications.
188.It modules/
189Various libraries and drivers for the X11 window system.
190.It pkgconfig/
191Package metadata for
192.Xr pkg-config 1 .
193.It xorg/
194Data files used by the X server.
195.El
196.Pp
197.It man/
198X11 manual pages.
199.It share/
200Architecture independent data files.
201.El
202.Pp
203.It bin/
204Common utilities, programming tools, and applications.
205.It games/
206Useful and semi-frivolous programs.
207.It include/
208Standard C include files.
209.Pp
210.Bl -tag -width "libmilter/" -compact
211.It arpa/
212C include files for Internet service protocols.
213.It c++/
214Include files for the Clang C++ compiler.
215.It crypto/
216C include files for the cryptographic libraries.
217.It ddb/
218C include files for the kernel debugger (see
219.Xr ddb 4 ) .
220.It dev/
221Device-specific C include files.
222.It g++/
223Include files for the GNU C++ compiler.
224.It isofs/
225C include files for the ISO standard file systems (currently only cd9660).
226.It machine/
227Machine specific C include files.
228.It miscfs/
229C include files for miscellaneous file systems.
230.It msdosfs/
231C include files for MS-DOS file system.
232.It net/
233Miscellaneous network C include files.
234.It net80211/
235C include files for 802.11 wireless networking.
236.It netinet/
237C include files for Internet standard protocols (see
238.Xr inet 4 ) .
239.It netinet6/
240C include files for Internet protocol version 6 (see
241.Xr inet6 4 ) .
242.It netmpls/
243C include files for the MPLS protocol.
244.It nfs/
245C include files for NFS (Network File System).
246.It ntfs/
247C include files for NTFS file system.
248.It objc/
249C include files for GNU Objective-C.
250.It openssl/
251C include files for the OpenSSL library (see
252.Xr ssl 8 ) .
253.It protocols/
254C include files for Berkeley service protocols.
255.It readline/
256C include files for the
257.Xr readline 3
258library.
259.It rpc/
260C include files for remote procedure calling (see
261.Xr rpc 5 ) .
262.It rpcsvc/
263C include files for rpcsvc.
264.It scsi/
265SCSI-specific C include files.
266.It sys/
267System C include files (kernel data structures).
268.It ufs/
269C include files for UFS (the U-word File System).
270.It uvm/
271C include files for the virtual memory interface.
272.El
273.Pp
274.It lib/
275System libraries.
276See
277.Xr intro 3
278for a description of library types.
279.It libdata/
280Miscellaneous utility data files.
281.Pp
282.Bl -tag -width "ldscripts/" -compact
283.It cvs/
284Placeholder for user contributed
285.Xr cvs 1
286code/scripts.
287.It ldscripts/
288ELF linker scripts.
289.It perl5/
290Data files for
291.Xr perl 1 .
292.El
293.Pp
294.It libexec/
295System daemons and utilities (executed by other programs).
296.Pp
297.Bl -tag -width "cvs/contrib/" -compact
298.It auth/
299Login scripts used to authenticate users (for
300.Bx
301Authentication).
302.It cvs/contrib/
303User contributed
304.Xr cvs 1
305scripts.
306.It lpr/
307Contains the lpf filter for
308.Xr lpd 8 .
309.It radiusd/
310Authentication modules for
311.Xr radiusd 8 .
312.El
313.Pp
314.It local/
315Local executables, libraries, etc.
316.It mdec/
317Boot-related executables.
318.It obj/
319Architecture specific target tree produced by building the
320.Pa /usr/src
321tree.
322.It ports/
323The
324.Ox
325ports collection (see
326.Xr ports 7 ) .
327.It sbin/
328System daemons and utilities (executed by users).
329.It share/
330Architecture independent data files.
331.Pp
332.Bl -tag -width "calendar/" -compact
333.It calendar/
334Variety of pre-fab calendar files (see
335.Xr calendar 1 ) .
336.It dict/
337Word lists (see
338.Xr look 1
339and
340.Xr spell 1 ) .
341.Pp
342.Bl -tag -width propernames -compact
343.It american
344Spellings preferred in American usage.
345.It british
346Spellings preferred in British usage.
347.It eign
348List of common words.
349.It propernames
350List of proper names.
351.It stop
352Forms that would otherwise be derivable by
353.Xr spell 1
354from words in the other files in
355.Pa /usr/share/dict ,
356but should not be accepted.
357.It web2
358Words from Webster's 2nd International.
359.It web2a
360Additional words from Webster's.
361.It words
362Common words.
363.It papers/
364Reference databases.
365.It special/
366Custom word lists.
367.El
368.Pp
369.It doc/
370Miscellaneous documentation.
371.It games/
372ASCII text files used by various games.
373.It info/
374Texinfo source files.
375.It locale/
376Locales for multi-language support.
377.It man/
378Manual pages.
379.Pp
380.Bl -tag -width man3p/ -compact
381.It man1/
382General commands (tools and utilities).
383.It man2/
384System calls and error numbers.
385.It man3/
386Libraries.
387.It man3p/
388.Xr perl 1
389programmers' reference guide.
390.It man4/
391Special files and hardware support.
392.It man5/
393File formats.
394.It man6/
395Games.
396.It man7/
397Miscellaneous.
398.It man8/
399System maintenance and operation commands.
400.It man9/
401Kernel internals.
402.El
403.Pp
404.It misc/
405Miscellaneous system-wide ASCII text files.
406.Pp
407.Bl -tag -width pcvtfonts/ -compact
408.It termcap
409Terminal characteristics database (see
410.Xr termcap 5 ) .
411.It pcvtfonts/
412Additional console fonts.
413.El
414.Pp
415.It mk/
416Templates for
417.Xr make 1 .
418.It relink/
419Link kit for boot-time kernel and library relinking.
420.It snmp/
421Data files for
422.Xr snmpd 8 .
423.Pp
424.Bl -tag -width mibs/ -compact
425.It mibs/
426Management Information Base (MIB) definitions.
427.El
428.Pp
429.It tabset/
430Tab description files for a variety of terminals; used in
431the termcap file (see
432.Xr termcap 5 ) .
433.It terminfo/
434Compiled terminal characteristic files (see
435.Xr terminfo 5 ) .
436.It texinfo/
437Templates for
438.Xr texinfo 5 .
439.It zoneinfo/
440Time zone configuration information (see
441.Xr tzfile 5 ) .
442.El
443.Pp
444.It src/
445.Bx
446and/or local source files.
447.Pp
448.Bl -tag -width "usr.sbin/" -compact
449.It bin/
450Source for files in
451.Pa /bin .
452.It distrib/
453Source for making distribution sets.
454.It etc/
455Source for files in
456.Pa /etc .
457.It games/
458Source for files in
459.Pa /usr/games .
460.It gnu/
461Source for files under GPL or other restrictive licenses.
462.It include/
463Source for files in
464.Pa /usr/include .
465.It lib/
466Source for files in
467.Pa /usr/lib .
468.It libexec/
469Source for files in
470.Pa /usr/libexec .
471.It regress/
472Regress framework.
473.It sbin/
474Source for files in
475.Pa /sbin .
476.It share/
477Source for files in
478.Pa /usr/share .
479.It sys/
480Kernel source files.
481.It usr.bin/
482Source for files in
483.Pa /usr/bin .
484.It usr.sbin/
485Source for files in
486.Pa /usr/sbin .
487.El
488.Pp
489.It xenocara/
490Source for the X11 window system.
491.Pp
492.It xobj/
493Architecture specific target tree produced by building the
494.Pa /usr/xenocara
495tree.
496.El
497.It /var/
498Multi-purpose log, temporary, transient, and spool files.
499.Pp
500.Bl -tag -width "sysmerge/" -compact
501.It account/
502System accounting files.
503.Pp
504.Bl -tag -width Fl -compact
505.It acct
506Execution accounting file (see
507.Xr acct 5 ) .
508.El
509.Pp
510.It audit/
511Audit logs.
512.It authpf/
513PID file for
514.Xr authpf 8 .
515.It backups/
516Miscellaneous backup files.
517.It cache/
518Data cached for programs.
519.It crash/
520Crash dumps written by
521.Xr savecore 8 .
522.It cron/
523Spools and configuration files for
524.Xr cron 8
525and
526.Xr at 1 .
527.Pp
528.Bl -tag -width Fl -compact
529.It atjobs/
530.Xr at 1
531jobs.
532.It tabs/
533Individual
534.Xr crontab 1
535files.
536.El
537.Pp
538.It db/
539Miscellaneous, automatically generated system-specific database files.
540.It empty/
541Generic
542.Xr chroot 2
543directory.
544.It games/
545Miscellaneous game status and log files.
546.It log/
547Miscellaneous system log files.
548.Pp
549.Bl -tag -width Fl -compact
550.It wtmp
551Login/logout log (see
552.Xr wtmp 5 ) .
553.It rdist/
554Log files for
555.Xr rdist 1 .
556.El
557.Pp
558.It mail/
559User mailbox files.
560.It nsd/
561Database and zone files for
562.Xr nsd 8 .
563.It quotas/
564Filesystem quota information files.
565.It run/
566System information files describing various info about the
567system since it was booted.
568.Pp
569.Bl -tag -width Fl -compact
570.It rc.d/
571Details of currently running daemons;
572used by
573.Xr rc.d 8 .
574.It utmp
575Database of current users (see
576.Xr utmp 5 ) .
577.El
578.Pp
579.It spool/
580Miscellaneous printer and mail system spooling directories.
581.Pp
582.Bl -tag -width "output/" -compact
583.It ftp/
584Commonly ~ftp; the anonymous ftp root directory.
585.It lock/
586Lock files for utilities such as
587.Xr pppd 8 .
588.It output/
589Line printer spooling directories.
590.It smtpd/
591Mail spool for
592.Xr smtpd 8 .
593.El
594.Pp
595.It sysmerge/
596Checksum files and reference sets
597for
598.Xr sysmerge 8 .
599.It syspatch/
600Rollback tarballs and patch files for
601.Xr syspatch 8 .
602.It tmp -> ../tmp
603A symbolic link to the system
604.Pa /tmp
605directory.
606To protect other users of
607.Pa /var
608from overfill conditions, this is no longer a space you can trust to
609retain storage over a reboot.
610Periodically cleaned by
611.Xr daily 8 .
612.It unbound/
613Configuration files for
614.Xr unbound 8 .
615.It www/
616Configuration files for
617.Xr httpd 8 .
618.It yp/
619Files for the
620.Xr yp 8
621subsystem.
622.El
623.El
624.Sh SEE ALSO
625.Xr apropos 1 ,
626.Xr find 1 ,
627.Xr locate 1 ,
628.Xr whatis 1 ,
629.Xr whereis 1 ,
630.Xr which 1
631.Sh HISTORY
632A
633.Nm
634manual page appeared in
635.At v7 .
636