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