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