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