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