xref: /dflybsd-src/share/man/man7/hier.7 (revision 678e8cc6002ecd3a79cdae95ac8b454437219fc5)
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.\" $FreeBSD: src/share/man/man7/hier.7,v 1.29.2.17 2003/01/13 21:43:50 ceri Exp $
34.\"
35.Dd November 26, 2011
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 ".Pa /modules/"
44.It Pa /
45root directory of the filesystem
46.It Pa /bin/
47user utilities fundamental to both single-user and multi-user environments
48.It Pa /boot/
49programs and configuration files used during operating system bootstrap
50.Pp
51.Bl -tag -width ".Pa defaults/" -compact
52.It Pa defaults/
53default bootstrapping configuration files; see
54.Xr loader.conf 5
55.It Pa kernel
56pure kernel executable (the operating system loaded into memory
57at boot time).
58.It Pa modules/
59loadable kernel modules;
60see
61.Xr kldstat 8
62.El
63.It Pa /dev/
64block and character device files
65.Pp
66.Bl -tag -width ".Pa fd/" -compact
67.It Pa fd/
68file descriptor files;
69see
70.Xr \&fd 4
71.El
72.It Pa /etc/
73system configuration files and scripts
74.Pp
75.Bl -tag -width ".Pa bluetooth/" -compact
76.It Pa bluetooth/
77bluetooth configuration files
78.It Pa defaults/
79default system configuration files;
80see
81.Xr rc 8
82.It Pa dma/
83.Xr dma 8
84configuration files
85.\".It Pa firmware/
86.\"Firmware image files;
87.\"see
88.\".Xr firmware 9
89.It Pa localtime
90local timezone information;
91see
92.Xr ctime 3
93.It Pa mail/
94Sendmail control files
95.It Pa mtree/
96mtree configuration files;
97see
98.Xr mtree 8
99.It Pa pam.d/
100configuration files for the Pluggable Authentication Modules (PAM)
101library
102.It Pa periodic/
103scripts that are run daily, weekly, and monthly, via
104.Xr cron 8 ;
105see
106.Xr periodic 8
107.It Pa ppp/
108ppp configuration files;
109see
110.Xr ppp 8
111.It Pa rc.d/
112System and daemon startup/control scripts;
113see
114.Xr rc 8
115.It Pa ssh/
116OpenSSH configuration files;
117see
118.Xr ssh 1
119.It Pa ssl/
120OpenSSL configuration files
121.It Pa upgrade/
122Files relevant to system upgrades
123.It Pa uucp/
124uucp configuration files;
125see
126.Xr uucp 1
127.El
128.It Pa /home/
129HOME directories of non-root users
130.It Pa /mnt/
131empty directory commonly used by
132system administrators as a temporary mount point
133.It Pa /pfs/
134pseudo file system directory (on
135.Xr hammer 5
136root file systems)
137.It Pa /proc/
138process file system;
139see
140.Xr procfs 5 ,
141.Xr mount_procfs 8
142.It Pa /root/
143root's HOME directory
144.It Pa /sbin/
145system programs and administration utilities
146fundamental to both single-user and multi-user environments
147.It Pa /sys/
148the kernel's source code (usually a symbolic link to
149.Pa /usr/src/sys )
150.It Pa /tmp/
151temporary files that are not guaranteed to persist across system reboots
152.It Pa /usr/
153contains the majority of user utilities and applications
154.Pp
155.Bl -tag -width ".Pa libdata/" -compact
156.It Pa bin/
157common utilities, programming tools, and applications
158.It Pa games/
159useful and semi-frivolous programs
160.It Pa include/
161standard C include files
162.Pp
163.Bl -tag -width ".Pa libmilter/" -compact
164.It Pa arpa/
165C include files for Internet service protocols
166.It Pa c++/
167C++ include files
168.It Pa cam/
169C include files for the Common Access Methods Layer
170.Pp
171.Bl -tag -width ".Pa scsi/" -compact
172.It Pa scsi/
173The SCSI device on top of CAM
174.El
175.Pp
176.It Pa dev/
177C include files for programming various
178.Dx
179devices
180.It Pa emulation/
181Include Files for various emulation layers
182.It Pa fs/
183.Pp
184.Bl -tag -width ".Pa smbfs/" -compact
185.It Pa smbfs/
186SMB/CIFS filesystem
187.El
188.Pp
189.It Pa isofs/
190.Pp
191.Bl -tag -width ".Pa cd9660/" -compact
192.It Pa cd9660/
193iso9660 filesystem
194.El
195.Pp
196.It Pa libmilter/
197C include files for libmilter,
198the sendmail mail filter API
199.It Pa libprop/
200C include files for libprop
201.It Pa machine/
202machine-specific C include files
203.It Pa msdosfs/
204MS-DOS file system
205.It Pa net/
206misc network C include files
207.It Pa netatm/
208ATM include files;
209see
210.Xr atm 8
211.It Pa netinet/
212C include files for Internet standard protocols;
213see
214.Xr inet 4
215.It Pa netinet6/
216C include files for Internet protocol version 6;
217see
218.Xr inet6 4
219.It Pa netipx/
220IPX/SPX protocol stacks
221.It Pa netkey/
222kernel key-management service
223.It Pa netnatm/
224NATM include files;
225see
226.Xr natm 4
227.It Pa netsmb/
228SMB/CIFS requester
229.It Pa nfs/
230C include files for NFS (Network File System)
231.It Pa objc/
232Objective C include files
233.It Pa openssl/
234OpenSSL (Cryptography/SSL toolkit) headers
235.It Pa pcap/
236Packet Capture (libpcap) headers;
237see
238.Xr pcap 3
239.It Pa pccard/
240PC-CARD controllers
241.It Pa protocols/
242C include files for Berkeley service protocols
243.It Pa readline/
244get a line from a user, with editing;
245see
246.Xr readline 3
247.It Pa rpc/
248remote procedure calls;
249see
250.Xr rpc 3
251.It Pa rpcsvc/
252definition of RPC service structures; see
253.Xr rpc 3
254.It Pa security/
255PAM; see
256.Xr pam 8
257.It Pa sys/
258system C include files (kernel data structures)
259.It Pa ufs/
260C include files for UFS (The U-word File System)
261.Pp
262.Bl -tag -width ".Pa ffs/" -compact
263.It Pa ffs/
264Fast filesystem
265.It Pa mfs/
266memory file system;
267see
268.Xr mount_mfs 8
269.It Pa ufs/
270UFS filesystem
271.El
272.Pp
273.It Pa vm/
274virtual memory;
275see
276.Xr vmstat 8
277.El
278.Pp
279.It Pa lib/
280archive libraries
281.Pp
282.Bl -tag -width ".Pa compat/" -compact
283.It Pa aout/
284a.out archive libraries
285.It Pa compat/
286shared libraries for compatibility
287.Pp
288.Bl -tag -width ".Pa aout/" -compact
289.It Pa aout/
290a.out backward compatibility libraries
291.El
292.It Pa engines/
293OpenSSL dynamic engines
294.El
295.Pp
296.It Pa libdata/
297misc. utility data files
298.Pp
299.Bl -tag -width ".Pa stallion/" -compact
300.It Pa doscmd/
301files used by doscmd (drivers, fonts, etc.);
302see
303.Xr doscmd 1
304.Pp
305.Bl -tag -width ".Pa fonts/" -compact
306.It Pa fonts/
307fonts used by doscmd
308.El
309.Pp
310.It Pa lint/
311various prebuilt lint libraries;
312see
313.Xr lint 1
314.It Pa stallion/
315holds the download firmware images
316.El
317.Pp
318.It Pa libexec/
319system daemons & system utilities (executed by other programs)
320.Pp
321.Bl -tag -width ".Pa binutils221/" -compact
322.It Pa binutils221/
323.Pp
324.Bl -tag -width ".Pa ldscripts/" -compact
325.It Pa ldscripts/
326linker scripts;
327see
328.Xr ld 1
329.El
330.Pp
331.It Pa binutils222/
332.Pp
333.Bl -tag -width ".Pa ldscripts/" -compact
334.It Pa ldscripts/
335linker scripts;
336see
337.Xr ld 1
338.El
339.Pp
340.It Pa lpr/
341utilities and filters for LP print system;
342see
343.Xr lpr 1
344.It Pa sendmail/
345the sendmail binary;
346see
347.Xr mailwrapper 8
348and
349.Xr sendmail 8
350.It Pa sm.bin/
351restricted shell for sendmail;
352see
353.Xr smrsh 8
354.It Pa uucp/
355uucp utilities;
356see
357.Xr uucp 1
358.El
359.Pp
360.It Pa local/
361local executables, libraries, etc.
362Within
363.Pa local/ ,
364the general layout sketched out by
365.Xr hier 7
366for
367.Pa /usr
368should be used.
369Exceptions are the
370.Pa man/
371directory (directly under
372.Pa local/
373rather than under
374.Pa local/share/ ) ,
375documentation (in
376.Pa share/doc/<app>/ ) ,
377and
378.Pa /usr/local/etc
379.Pf ( mimics
380.Pa /etc ) .
381.It Pa obj/
382architecture-specific target tree produced by building the
383.Pa /usr/src
384tree
385.It Pa pkg/
386default destination directory for the
387.Xr pkgsrc 7
388collection.
389Within
390.Pa pkg/ ,
391the general layout sketched out by
392.Xr hier 7
393for
394.Pa /usr
395should be used.
396Exceptions are the
397.Pa man/
398directory (directly under
399.Pa pkg/
400rather than under
401.Pa pkg/share/ ) ,
402documentation (in
403.Pa share/doc/<pkg>/ ) ,
404and
405.Pa /usr/pkg/etc
406.Pf ( mimics
407.Pa /etc ) .
408.It Pa pkgsrc/
409The
410.Xr pkgsrc 7
411collection (optional).
412.It Pa sbin/
413system daemons & system utilities (executed by users)
414.It Pa share/
415architecture-independent files
416.Pp
417.Bl -tag -width ".Pa groff_font/" -compact
418.It Pa calendar/
419a variety of pre-fab calendar files;
420see
421.Xr calendar 1
422.It Pa dict/
423word lists;
424see
425.Xr look 1
426.Pp
427.Bl -tag -width ".Pa papers/" -compact
428.It Pa web2
429words from Webster's 2nd International
430.It Pa words
431common words
432.It Pa papers/
433reference databases;
434see
435.Xr refer 1
436.El
437.Pp
438.It Pa doc/
439miscellaneous documentation
440.Bl -tag -width ".Pa legal/" -compact
441.It Pa legal/
442License files for vendor supplied firmwares
443.El
444.Pp
445.It Pa examples/
446various examples for users and programmers
447.It Pa games/
448ASCII text files used by various games
449.It Pa groff_font/
450device description file for device name
451.It Pa i18n/
452internationalization databases; see
453.Xr iconv 3
454.It Pa info/
455GNU Info hypertext system
456.It Pa libg++/
457libg++'s genclass prototype/template class files
458.It Pa locale/
459localization files;
460see
461.Xr setlocale 3
462.It Pa man/
463manual pages
464.It Pa me/
465macros for use with the me macro package;
466see
467.Xr me 7
468.It Pa misc/
469misc system-wide ASCII text files
470.Pp
471.Bl -tag -width ".Pa termcap" -compact
472.It Pa termcap
473terminal characteristics database;
474see
475.Xr termcap 5
476.El
477.Pp
478.It Pa mk/
479templates for make;
480see
481.Xr make 1
482.It Pa nls/
483national language support files;
484see
485.Xr mklocale 1
486.It Pa openssl/
487.Pp
488.Bl -tag -width ".Pa man/" -compact
489.It Pa man/
490OpenSSL manual pages
491.El
492.Pp
493.It Pa sendmail/
494sendmail configuration files;
495see
496.Xr sendmail 8
497.It Pa skel/
498example . (dot) files for new accounts
499.It Pa syscons/
500files used by
501.Xr syscons 4
502.Pp
503.Bl -tag -width ".Pa scrnmaps/" -compact
504.It Pa fonts/
505console fonts;
506see
507.Xr vidcontrol 1
508and
509.Xr vidfont 1
510.It Pa keymaps/
511console keyboard maps;
512see
513.Xr kbdcontrol 1
514and
515.Xr kbdmap 1
516.It Pa scrnmaps/
517console screen maps
518.El
519.Pp
520.It Pa tabset/
521tab description files for a variety of terminals; used in
522the termcap file;
523see
524.Xr termcap 5
525.It Pa tmac/
526text processing macros;
527see
528.Xr nroff 1
529and
530.Xr troff 1
531.It Pa vi/
532localization support and utilities for
533.Xr vi 1
534.It Pa zoneinfo/
535timezone configuration information;
536see
537.Xr tzfile 5
538.El
539.Pp
540.It Pa src/
541.Bx ,
542third-party, and/or local source files
543.Pp
544.Bl -tag -width ".Pa nrelease/" -compact
545.It Pa bin/
546source code for files in
547.Pa /bin
548.It Pa contrib/
549source code for contributed software
550.It Pa crypto/
551source code for contributed cryptography software
552.It Pa etc/
553source code for files in
554.Pa /etc
555.It Pa games/
556source code for files in
557.Pa /usr/games
558.It Pa gnu/
559Utilities covered by the GNU General Public License
560.It Pa include/
561source code for files in
562.Pa /usr/include
563.It Pa lib/
564source code for files in
565.Pa /usr/lib
566.It Pa libexec/
567source code for files in
568.Pa /usr/libexec
569.It Pa nrelease/
570files required to produce a
571.Dx
572release
573.It Pa sbin/
574source code for files in
575.Pa /sbin
576.It Pa secure/
577build directory for files in
578.Pa /usr/src/crypto
579.It Pa share/
580source for files in
581.Pa /usr/share
582.It Pa sys/
583kernel source code
584.It Pa tools/
585tools used for maintenance and testing of
586.Dx
587.It Pa usr.bin/
588source code for files in
589.Pa /usr/bin
590.It Pa usr.sbin/
591source code for files in
592.Pa /usr/sbin
593.El
594.El
595.It Pa /var/
596multi-purpose log, temporary, transient, and spool files
597.Pp
598.Bl -tag -width ".Pa preserve/" -compact
599.It Pa account/
600system accounting files
601.Pp
602.Bl -tag -width ".Pa acct" -compact
603.It Pa acct
604execution accounting file;
605see
606.Xr acct 5
607.El
608.Pp
609.It Pa at/
610timed command scheduling files;
611see
612.Xr \&at 1
613.Pp
614.Bl -tag -width ".Pa spool/" -compact
615.It Pa jobs/
616directory containing job files
617.It Pa spool/
618directory containing output spool files
619.El
620.Pp
621.It Pa backups/
622misc. backup files
623.It Pa crash/
624default directory to store kernel crash dumps; see
625.Xr crash 8
626and
627.Xr savecore 8
628.It Pa cron/
629files used by cron;
630see
631.Xr cron 8
632.Pp
633.Bl -tag -width ".Pa tabs/" -compact
634.It Pa tabs/
635crontab files;
636see
637.Xr crontab 5
638.El
639.Pp
640.It Pa db/
641misc. automatically generated system-specific database files
642.It Pa empty/
643empty directory used by
644.Xr sshd 8
645for privilege separation
646.It Pa games/
647misc. game status and score files
648.It Pa hammer/
649per PFS (pseudo file system) snapshots directory for
650.Xr hammer 5
651file systems
652.It Pa log/
653misc. system log files
654.Pp
655.Bl -tag -width ".Pa wtmp" -compact
656.It Pa wtmp
657login/logout log;
658see
659.Xr wtmp 5
660.El
661.Pp
662.It Pa mail/
663user mailbox files
664.It Pa msgs/
665system messages database;
666see
667.Xr msgs 1
668.It Pa preserve/
669temporary home of files preserved after an accidental death
670of an editor;
671see
672.Xr \&ex 1
673.It Pa quotas/
674filesystem quota information files
675.It Pa run/
676system information files describing various info about
677system since it was booted
678.Pp
679.Bl -tag -width ".Pa ppp/" -compact
680.It Pa ppp/
681writable by the
682.Dq network
683group for command connection sockets; see
684.Xr ppp 8
685.It Pa utmp
686database of current users;
687see
688.Xr utmp 5
689.El
690.Pp
691.It Pa rwho/
692rwho data files;
693see
694.Xr rwhod 8 ,
695.Xr rwho 1 ,
696and
697.Xr ruptime 1
698.It Pa spool/
699misc. printer and mail system spooling directories
700.Pp
701.Bl -tag -width ".Pa clientmqueue/" -compact
702.It Pa clientmqueue/
703undelivered submission mail queue;
704see
705.Xr sendmail 8
706.It Pa dma/
707undelivered mail queue;
708see
709.Xr dma 8
710.It Pa ftp/
711commonly
712.Pa ~ftp ;
713the anonymous ftp root directory
714.It Pa mqueue/
715undelivered mail queue;
716see
717.Xr sendmail 8
718.It Pa output/
719line printer spooling directories
720.It Pa uucp/
721uucp spool directory
722.It Pa uucppublic/
723commonly
724.Pa ~uucp ;
725public uucp temporary directory
726.El
727.Pp
728.It Pa tmp/
729temporary files that are kept between system reboots
730.Pp
731.Bl -tag -width ".Pa vi.recover/" -compact
732.It Pa vi.recover/
733the directory where recovery files are stored
734.El
735.Pp
736.It Pa yp/
737the NIS maps
738.El
739.El
740.Sh NOTES
741This manual page documents the default
742.Dx
743filesystem layout, but
744the actual hierarchy on a given system is defined at the system
745administrator's discretion.
746A well-maintained installation will include a customized version of
747this document.
748.Sh SEE ALSO
749.Xr apropos 1 ,
750.Xr find 1 ,
751.Xr finger 1 ,
752.Xr grep 1 ,
753.Xr ls 1 ,
754.Xr whatis 1 ,
755.Xr whereis 1 ,
756.Xr which 1 ,
757.Xr fsck 8
758.Sh HISTORY
759A
760.Nm
761manual page appeared in
762.At v7 .
763