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