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