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