xref: /openbsd-src/share/man/man7/hier.7 (revision bf100dfb112c6759e00155977c7e44d50dc6db59)
1.\"	$OpenBSD: hier.7,v 1.162 2019/04/26 07:14:50 florian 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: April 26 2019 $
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.Pp
155.Bl -tag -width _sysupgrade/ -compact
156.It _sysupgrade/
157Download location for
158.Xr sysupgrade 8 .
159.El
160.It /mnt/
161Empty directory commonly used by
162system administrators as a temporary mount point.
163.It /root/
164Default home directory for the superuser.
165.It /sbin/
166System programs and administration utilities
167fundamental to both single and multi-user environments.
168These programs are statically compiled and therefore do not depend on any
169system libraries to run.
170.It /tmp/
171Temporary files that are
172.Em not
173preserved between system reboots.
174Periodically cleaned by
175.Xr daily 8 .
176.It /usr/
177Contains the majority of user utilities and applications.
178.Pp
179.Bl -tag -width "xenocara/" -compact
180.It X11R6/
181Files required for the X11 window system.
182.Pp
183.Bl -tag -width "include/" -compact
184.It bin/
185X11 binaries.
186.It include/
187X11-specific C include files.
188.It lib/
189X11 archive libraries.
190.Pp
191.Bl -tag -width "pkgconfig/" -compact
192.It X11/
193Default configuration files for X11 and companion applications.
194.It modules/
195Various libraries and drivers for the X11 window system.
196.It pkgconfig/
197Package metadata for
198.Xr pkg-config 1 .
199.It xorg/
200Data files used by the X server.
201.El
202.Pp
203.It man/
204X11 manual pages.
205.It share/
206Architecture independent data files.
207.El
208.Pp
209.It bin/
210Common utilities, programming tools, and applications.
211.It games/
212Useful and semi-frivolous programs.
213.It include/
214Standard C include files.
215.Pp
216.Bl -tag -width "libmilter/" -compact
217.It arpa/
218C include files for Internet service protocols.
219.It c++/
220Include files for the Clang C++ compiler.
221.It crypto/
222C include files for the cryptographic libraries.
223.It ddb/
224C include files for the kernel debugger (see
225.Xr ddb 4 ) .
226.It dev/
227Device-specific C include files.
228.It g++/
229Include files for the GNU C++ compiler.
230.It isofs/
231C include files for the ISO standard file systems (currently only cd9660).
232.It machine/
233Machine specific C include files.
234.It miscfs/
235C include files for miscellaneous file systems.
236.It msdosfs/
237C include files for MS-DOS file system.
238.It net/
239Miscellaneous network C include files.
240.It net80211/
241C include files for 802.11 wireless networking.
242.It netinet/
243C include files for Internet standard protocols (see
244.Xr inet 4 ) .
245.It netinet6/
246C include files for Internet protocol version 6 (see
247.Xr inet6 4 ) .
248.It netmpls/
249C include files for the MPLS protocol.
250.It nfs/
251C include files for NFS (Network File System).
252.It ntfs/
253C include files for NTFS file system.
254.It objc/
255C include files for GNU Objective-C.
256.It openssl/
257C include files for the OpenSSL library (see
258.Xr ssl 8 ) .
259.It protocols/
260C include files for Berkeley service protocols.
261.It readline/
262C include files for the
263.Xr readline 3
264library.
265.It rpc/
266C include files for remote procedure calling (see
267.Xr rpc 5 ) .
268.It rpcsvc/
269C include files for rpcsvc.
270.It scsi/
271SCSI-specific C include files.
272.It sys/
273System C include files (kernel data structures).
274.It ufs/
275C include files for UFS (the U-word File System).
276.It uvm/
277C include files for the virtual memory interface.
278.El
279.Pp
280.It lib/
281System libraries.
282See
283.Xr intro 3
284for a description of library types.
285.It libdata/
286Miscellaneous utility data files.
287.Pp
288.Bl -tag -width "ldscripts/" -compact
289.It cvs/
290Placeholder for user contributed
291.Xr cvs 1
292code/scripts.
293.It ldscripts/
294ELF linker scripts.
295.It perl5/
296Data files for
297.Xr perl 1 .
298.El
299.Pp
300.It libexec/
301System daemons and utilities (executed by other programs).
302.Pp
303.Bl -tag -width "cvs/contrib/" -compact
304.It auth/
305Login scripts used to authenticate users (for
306.Bx
307Authentication).
308.It cvs/contrib/
309User contributed
310.Xr cvs 1
311scripts.
312.It lpr/
313Contains the lpf filter for
314.Xr lpd 8 .
315.It radiusd/
316Authentication modules for
317.Xr radiusd 8 .
318.El
319.Pp
320.It local/
321Local executables, libraries, etc.
322.It mdec/
323Boot-related executables.
324.It obj/
325Architecture specific target tree produced by building the
326.Pa /usr/src
327tree.
328.It ports/
329The
330.Ox
331ports collection (see
332.Xr ports 7 ) .
333.It sbin/
334System daemons and utilities (executed by users).
335.It share/
336Architecture independent data files.
337.Pp
338.Bl -tag -width "calendar/" -compact
339.It calendar/
340Variety of pre-fab calendar files (see
341.Xr calendar 1 ) .
342.It dict/
343Word lists (see
344.Xr look 1
345and
346.Xr spell 1 ) .
347.Pp
348.Bl -tag -width propernames -compact
349.It american
350Spellings preferred in American usage.
351.It british
352Spellings preferred in British usage.
353.It eign
354List of common words.
355.It propernames
356List of proper names.
357.It stop
358Forms that would otherwise be derivable by
359.Xr spell 1
360from words in the other files in
361.Pa /usr/share/dict ,
362but should not be accepted.
363.It web2
364Words from Webster's 2nd International.
365.It web2a
366Additional words from Webster's.
367.It words
368Common words.
369.It papers/
370Reference databases.
371.It special/
372Custom word lists.
373.El
374.Pp
375.It doc/
376Miscellaneous documentation.
377.It games/
378ASCII text files used by various games.
379.It info/
380Texinfo source files.
381.It locale/
382Locales for multi-language support.
383.It man/
384Manual pages.
385.Pp
386.Bl -tag -width man3p/ -compact
387.It man1/
388General commands (tools and utilities).
389.It man2/
390System calls and error numbers.
391.It man3/
392Libraries.
393.It man3p/
394.Xr perl 1
395programmers' reference guide.
396.It man4/
397Special files and hardware support.
398.It man5/
399File formats.
400.It man6/
401Games.
402.It man7/
403Miscellaneous.
404.It man8/
405System maintenance and operation commands.
406.It man9/
407Kernel internals.
408.El
409.Pp
410.It misc/
411Miscellaneous system-wide ASCII text files.
412.Pp
413.Bl -tag -width pcvtfonts/ -compact
414.It termcap
415Terminal characteristics database (see
416.Xr termcap 5 ) .
417.It pcvtfonts/
418Additional console fonts.
419.El
420.Pp
421.It mk/
422Templates for
423.Xr make 1 .
424.It relink/
425Link kit for boot-time kernel and library relinking.
426.It snmp/
427Data files for
428.Xr snmpd 8 .
429.Pp
430.Bl -tag -width mibs/ -compact
431.It mibs/
432Management Information Base (MIB) definitions.
433.El
434.Pp
435.It tabset/
436Tab description files for a variety of terminals; used in
437the termcap file (see
438.Xr termcap 5 ) .
439.It terminfo/
440Compiled terminal characteristic files (see
441.Xr terminfo 5 ) .
442.It texinfo/
443Templates for
444.Xr texinfo 5 .
445.It zoneinfo/
446Time zone configuration information (see
447.Xr tzfile 5 ) .
448.El
449.Pp
450.It src/
451.Bx
452and/or local source files.
453.Pp
454.Bl -tag -width "usr.sbin/" -compact
455.It bin/
456Source for files in
457.Pa /bin .
458.It distrib/
459Source for making distribution sets.
460.It etc/
461Source for files in
462.Pa /etc .
463.It games/
464Source for files in
465.Pa /usr/games .
466.It gnu/
467Source for files under GPL or other restrictive licenses.
468.It include/
469Source for files in
470.Pa /usr/include .
471.It lib/
472Source for files in
473.Pa /usr/lib .
474.It libexec/
475Source for files in
476.Pa /usr/libexec .
477.It regress/
478Regress framework.
479.It sbin/
480Source for files in
481.Pa /sbin .
482.It share/
483Source for files in
484.Pa /usr/share .
485.It sys/
486Kernel source files.
487.It usr.bin/
488Source for files in
489.Pa /usr/bin .
490.It usr.sbin/
491Source for files in
492.Pa /usr/sbin .
493.El
494.Pp
495.It xenocara/
496Source for the X11 window system.
497.Pp
498.It xobj/
499Architecture specific target tree produced by building the
500.Pa /usr/xenocara
501tree.
502.El
503.It /var/
504Multi-purpose log, temporary, transient, and spool files.
505.Pp
506.Bl -tag -width "sysmerge/" -compact
507.It account/
508System accounting files.
509.Pp
510.Bl -tag -width Fl -compact
511.It acct
512Execution accounting file (see
513.Xr acct 5 ) .
514.El
515.Pp
516.It audit/
517Audit logs.
518.It authpf/
519PID file for
520.Xr authpf 8 .
521.It backups/
522Miscellaneous backup files.
523.It cache/
524Data cached for programs.
525.It crash/
526Crash dumps written by
527.Xr savecore 8 .
528.It cron/
529Spools and configuration files for
530.Xr cron 8
531and
532.Xr at 1 .
533.Pp
534.Bl -tag -width Fl -compact
535.It atjobs/
536.Xr at 1
537jobs.
538.It tabs/
539Individual
540.Xr crontab 1
541files.
542.El
543.Pp
544.It db/
545Miscellaneous, automatically generated system-specific database files.
546.It empty/
547Generic
548.Xr chroot 2
549directory.
550.It games/
551Miscellaneous game status and log files.
552.It log/
553Miscellaneous system log files.
554.Pp
555.Bl -tag -width Fl -compact
556.It wtmp
557Login/logout log (see
558.Xr wtmp 5 ) .
559.It rdist/
560Log files for
561.Xr rdist 1 .
562.El
563.Pp
564.It mail/
565User mailbox files.
566.It nsd/
567Database and zone files for
568.Xr nsd 8 .
569.It quotas/
570Filesystem quota information files.
571.It run/
572System information files describing various info about the
573system since it was booted.
574.Pp
575.Bl -tag -width Fl -compact
576.It rc.d/
577Details of currently running daemons;
578used by
579.Xr rc.d 8 .
580.It utmp
581Database of current users (see
582.Xr utmp 5 ) .
583.El
584.Pp
585.It spool/
586Miscellaneous printer and mail system spooling directories.
587.Pp
588.Bl -tag -width "output/" -compact
589.It ftp/
590Commonly ~ftp; the anonymous ftp root directory.
591.It lock/
592Lock files for utilities such as
593.Xr pppd 8 .
594.It output/
595Line printer spooling directories.
596.It smtpd/
597Mail spool for
598.Xr smtpd 8 .
599.El
600.Pp
601.It sysmerge/
602Checksum files and reference sets
603for
604.Xr sysmerge 8 .
605.It syspatch/
606Rollback tarballs and patch files for
607.Xr syspatch 8 .
608.It tmp -> ../tmp
609A symbolic link to the system
610.Pa /tmp
611directory.
612To protect other users of
613.Pa /var
614from overfill conditions, this is no longer a space you can trust to
615retain storage over a reboot.
616Periodically cleaned by
617.Xr daily 8 .
618.It unbound/
619Configuration files for
620.Xr unbound 8 .
621.It www/
622Configuration files for
623.Xr httpd 8 .
624.It yp/
625Files for the
626.Xr yp 8
627subsystem.
628.El
629.El
630.Sh SEE ALSO
631.Xr apropos 1 ,
632.Xr find 1 ,
633.Xr locate 1 ,
634.Xr whatis 1 ,
635.Xr whereis 1 ,
636.Xr which 1
637.Sh HISTORY
638A
639.Nm
640manual page appeared in
641.At v7 .
642