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