Deleted Added
full compact
hier.7 (257100) hier.7 (257150)
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
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: head/share/man/man7/hier.7 257100 2013-10-25 05:33:04Z rpaulo $
33.\" $FreeBSD: head/share/man/man7/hier.7 257150 2013-10-26 03:53:24Z bdrewery $
34.\"
34.\"
35.Dd October 19, 2013
35.Dd October 23, 2013
36.Dt HIER 7
37.Os
38.Sh NAME
39.Nm hier
40.Nd layout of file systems
41.Sh DESCRIPTION
42A sketch of the file system hierarchy.
43.Bl -tag -width ".Pa /libexec/"
44.It Pa /
45root directory of the file system
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 ".Pa 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-party loadable kernel modules;
60see
61.Xr kldstat 8
62.El
63.It Pa /cdrom/
64default mount point for CD-ROM drives
65.It Pa /compat/
66normally a link to
67.Pa /usr/compat .
68If not, then the
69.Pa /usr/compat
70comments apply
71.It Pa /dev/
72device special files managed by
73.Xr devfs 5
74.Pp
75.Bl -tag -width ".Pa net/" -compact
76.It Pa fd/
77file descriptor files;
78see
79.Xr \&fd 4
80.It Pa net/
81network devices
82.El
83.It Pa /etc/
84system configuration files and scripts
85.Pp
86.Bl -tag -width ".Pa bluetooth/" -compact
87.It Pa defaults/
88default system configuration files;
89see
90.Xr rc 8
91.It Pa bluetooth/
92bluetooth configuration files
93.It Pa gnats/
94gnats configuration files;
95see
96.Xr send-pr 1
36.Dt HIER 7
37.Os
38.Sh NAME
39.Nm hier
40.Nd layout of file systems
41.Sh DESCRIPTION
42A sketch of the file system hierarchy.
43.Bl -tag -width ".Pa /libexec/"
44.It Pa /
45root directory of the file system
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 ".Pa 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-party loadable kernel modules;
60see
61.Xr kldstat 8
62.El
63.It Pa /cdrom/
64default mount point for CD-ROM drives
65.It Pa /compat/
66normally a link to
67.Pa /usr/compat .
68If not, then the
69.Pa /usr/compat
70comments apply
71.It Pa /dev/
72device special files managed by
73.Xr devfs 5
74.Pp
75.Bl -tag -width ".Pa net/" -compact
76.It Pa fd/
77file descriptor files;
78see
79.Xr \&fd 4
80.It Pa net/
81network devices
82.El
83.It Pa /etc/
84system configuration files and scripts
85.Pp
86.Bl -tag -width ".Pa bluetooth/" -compact
87.It Pa defaults/
88default system configuration files;
89see
90.Xr rc 8
91.It Pa bluetooth/
92bluetooth configuration files
93.It Pa gnats/
94gnats configuration files;
95see
96.Xr send-pr 1
97.It Pa keys/
98known trusted and revoked keys.
99.Pp
100.Bl -tag -width ".Pa keys/pkg/" -compact
101.It Pa keys/pkg/
102fingerprints for
103.Xr pkg 8
104.El
105.Pp
97.It Pa localtime
98local timezone information;
99see
100.Xr ctime 3
101.It Pa mail/
102Sendmail control files
103.It Pa mtree/
104mtree configuration files;
105see
106.Xr mtree 8
107.It Pa namedb/
108named configuration files;
109see
110.Xr named 8
111.It Pa pam.d/
112configuration files for the Pluggable Authentication Modules (PAM)
113library
114.It Pa periodic/
115scripts that are run daily, weekly, and monthly, via
116.Xr cron 8 ;
117see
118.Xr periodic 8
119.It Pa rc.d/
120System and daemon startup/control scripts;
121see
122.Xr rc 8
123.It Pa security/
124OpenBSM audit configuration files;
125see
126.Xr audit 8
127.It Pa ppp/
128ppp configuration files;
129see
130.Xr ppp 8
131.It Pa ssh/
132OpenSSH configuration files;
133see
134.Xr ssh 1
135.It Pa ssl/
136OpenSSL configuration files
137.El
138.It Pa /lib/
139critical system libraries needed for binaries in
140.Pa /bin
141and
142.Pa /sbin
143.Pp
144.Bl -tag -width ".Pa geom/" -compact
145.It Pa geom/
146class-specific libraries for the
147.Xr geom 8
148utility
149.El
150.It Pa /libexec/
151critical system utilities needed for binaries in
152.Pa /bin
153and
154.Pa /sbin
155.It Pa /media/
156contains subdirectories to be used as mount points
157for removable media such as CDs, USB drives, and
158floppy disks
159.It Pa /mnt/
160empty directory commonly used by
161system administrators as a temporary mount point
162.It Pa /proc/
163process file system;
164see
165.Xr procfs 5
166.It Pa /rescue/
167statically linked programs for emergency recovery;
168see
169.Xr rescue 8
170.It Pa /root/
171root's HOME directory
172.It Pa /sbin/
173system programs and administration utilities
174fundamental to both single-user and multi-user environments
175.It Pa /tmp/
176temporary files that are not guaranteed to persist across system reboots
177.It Pa /usr/
178contains the majority of user utilities and applications
179.Pp
180.Bl -tag -width ".Pa libdata/" -compact
181.It Pa bin/
182common utilities, programming tools, and applications
183.It Pa compat/
184files needed to support binary compatibility with other operating systems,
185such as Linux
186.It Pa games/
187useful and semi-frivolous programs
188.It Pa include/
189standard C include files
190.Pp
191.Bl -tag -width ".Pa kerberos5/" -compact
192.It Pa altq/
193C include files for alternate queueing
194.It Pa arpa/
195C include files for Internet service protocols
196.It Pa bsnmp/
197C include files for the SNMP daemon
198.It Pa c++/
199C++ include files
200.It Pa cam/
201C include files for the Common Access Methods Layer
202.Bl -tag -width ".Pa kerberos5/" -compact
203.It Pa scsi/
204The SCSI device on top of CAM
205.El
206.It Pa dev/
207C include files for programming various
208.Fx
209devices
210.Bl -tag -width ".Pa kerberos5/" -compact
211.It Pa ic/
212Various header files describing driver- and bus-independent
213hardware circuits
214.It Pa ofw/
215Open Firmware support
216.It Pa pbio/
2178255 PPI cards;
218see
219.Xr pbio 4
220.It Pa ppbus/
221The parallel port bus;
222see
223.Xr ppbus 4
224.It Pa usb/
225The USB subsystem
226.It Pa utopia/
227Physical chip driver for ATM interfaces;
228see
229.Xr utopia 4
230.It Pa wi/
231The
232.Xr wi 4
233WaveLAN driver
234.El
235.It Pa fs/
236.Bl -tag -width ".Pa kerberos5/" -compact
237.It Pa fdescfs/
238per-process file descriptors file system
239.It Pa fifofs/
240.St -p1003.1
241FIFOs file system
242.It Pa msdosfs/
243MS-DOS file system
244.It Pa nfs/
245C include files for NFS (Network File System) version 2, 3 and 4
246.It Pa nullfs/
247loopback file system
248.It Pa procfs/
249process file system
250.It Pa smbfs/
251SMB/CIFS file system
252.It Pa udf/
253UDF file system
254.It Pa unionfs
255union file system
256.El
257.It Pa geom/
258GEOM framework
259.Bl -tag -width ".Pa kerberos5/" -compact
260.It Pa concat/
261CONCAT GEOM class
262.It Pa gate/
263GATE GEOM class
264.It Pa mirror/
265MIRROR GEOM class
266.It Pa nop/
267NOP GEOM class
268.It Pa raid3/
269RAID3 GEOM class
270.It Pa stripe/
271STRIPE GEOM class
272.El
273.Pp
274.It Pa isc/
275ISC utility library libisc include files
276.It Pa isofs/
277.Bl -tag -width ".Pa kerberos5/" -compact
278.It Pa cd9660/
279iso9660 file system
280.El
281.It Pa libmilter/
282C include files for libmilter,
283the
284.Xr sendmail 8
285mail filter API
286.It Pa machine/
287machine-specific C include files
288.It Pa net/
289miscellaneous network C include files
290.It Pa netatalk/
291Appletalk protocol
292.It Pa netinet/
293C include files for Internet standard protocols;
294see
295.Xr inet 4
296.It Pa netinet6/
297C include files for Internet protocol version 6;
298see
299.Xr inet6 4
300.It Pa netipsec/
301kernel key-management service;
302see
303.Xr ipsec 4
304.It Pa netipx/
305IPX/SPX protocol stacks
306.It Pa netnatm/
307NATM include files;
308see
309.Xr natm 4
310.Bl -tag -width ".Pa kerberos5/" -compact
311.It Pa api/
312include files for the signalling API
313.It Pa msg/
314include files that describe signalling messages and
315declare associated functions
316.It Pa saal/
317include files for the signalling AAL layer
318.It Pa sig/
319include files for the UNI signalling protocol
320.El
321.It Pa netsmb/
322SMB/CIFS requester
323.It Pa nfs/
324C include files for NFS (Network File System) version 2 and 3 (legacy)
325.It Pa objc/
326Objective C include files
327.It Pa openssl/
328OpenSSL (Cryptography/SSL toolkit) headers
329.It Pa pccard/
330PC-CARD controllers
331.It Pa protocols/
332C include files for Berkeley service protocols
333.It Pa readline/
334get a line from a user, with editing;
335see
336.Xr readline 3
337.It Pa rpc/
338remote procedure calls;
339see
340.Xr rpc 3
341.It Pa rpcsvc/
342definition of RPC service structures; see
343.Xr rpc 3
344.It Pa security/
345PAM; see
346.Xr pam 8
347.It Pa sys/
348system C include files (kernel data structures)
349.\" .It Pa tcl/
350.\" Tcl language;
351.\" see
352.\" .Xr Tcl n
353.\" .Bl -tag -width ".Pa kerberos5/" -compact
354.\" .It Pa generic/
355.\" ???
356.\" .It Pa unix/
357.\" ???
358.\" .El
359.It Pa ufs/
360C include files for UFS (The U-word File System)
361.Bl -tag -width ".Pa kerberos5/" -compact
362.It Pa ffs/
363Fast file system
364.It Pa ufs/
365UFS file system
366.El
367.It Pa vm/
368virtual memory;
369see
370.Xr vmstat 8
371.El
372.Pp
373.It Pa lib/
374shared and archive
375.Xr ar 1 Ns -type
376libraries
377.Bl -tag -width Fl -compact
378.It Pa aout/
379a.out archive libraries
380.It Pa compat/
381shared libraries for compatibility
382.Bl -tag -width Fl -compact
383.It Pa aout/
384a.out backward compatibility libraries
385.El
386.It Pa dtrace/
387DTrace library scripts
388.It Pa engines/
389OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines
390.El
391.Pp
392.It Pa libdata/
393miscellaneous utility data files
394.Bl -tag -width Fl -compact
395.It Pa gcc/
396.Xr gcc 1
397configuration data
398.It Pa ldscripts/
399linker scripts;
400see
401.Xr ld 1
402.It Pa lint/
403various prebuilt lint libraries;
404see
405.Xr lint 1
406.El
407.Pp
408.It Pa libexec/
409system daemons & system utilities (executed by other programs)
410.Bl -tag -width Fl -compact
411.It Pa aout/
412utilities to manipulate a.out executables
413.It Pa elf/
414utilities to manipulate ELF executables
415.It Pa lpr/
416utilities and filters for LP print system;
417see
418.Xr lpr 1
419.It Pa sendmail/
420the
421.Xr sendmail 8
422binary;
423see
424.Xr mailwrapper 8
425.It Pa sm.bin/
426restricted shell for
427.Xr sendmail 8 ;
428see
429.Xr smrsh 8
430.El
431.Pp
432.It Pa local/
433local executables, libraries, etc.
434Also used as the default destination for the
435.Fx
436ports framework.
437Within
438.Pa local/ ,
439the general layout sketched out by
440.Nm
441for
442.Pa /usr
443should be used.
444Exceptions are the
445.Pa man
446directory
447.Po directly under
448.Pa local/
449rather than under
450.Pa local/share/ Ns Pc ,
451ports documentation
452.Po in
453.Pa share/doc/<port>/ Ns Pc ,
454and
455.Pa /usr/local/etc
456.Po mimics
457.Pa /etc Ns Pc .
458.It Pa obj/
459architecture-specific target tree produced by building the
460.Pa /usr/src
461tree
462.It Pa ports/
463The
464.Fx
465ports collection (optional).
466.It Pa sbin/
467system daemons & system utilities (executed by users)
468.It Pa share/
469architecture-independent files
470.Pp
471.Bl -tag -width ".Pa calendar/" -compact
472.It Pa calendar/
473a variety of pre-fab calendar files;
474see
475.Xr calendar 1
476.It Pa dict/
477word lists;
478see
479.Xr look 1
480.Pp
481.Bl -tag -width Fl -compact
482.It Pa freebsd
483.Fx Ns -specific
484terms, proper names, and jargon
485.It Pa words
486common words
487.It Pa web2
488words from Webster's 2nd International
489.It Pa papers/
490reference databases;
491see
492.Xr refer 1
493.El
494.Pp
495.It Pa doc/
496miscellaneous documentation;
497source for most of the printed
498.Bx
499manuals (available
500from the
501.Tn USENIX
502association)
503.Bl -tag -width Fl -compact
504.It Pa FAQ/
505Frequently Asked Questions
506.It Pa IPv6/
507implementation notes for IPv6
508.It Pa bind/
509documents pertaining to BIND (the Berkeley Internet Name Domain)
510.It Pa es/
511Spanish translations of documents in /usr/share/doc
512.It Pa handbook/
513.Fx
514Handbook
515.It Pa ja/
516Japanese translations of documents in /usr/share/doc
517.It Pa legal/
518License files for vendor supplied firmwares
519.It Pa ncurses/
520HTML documents pertaining to ncurses;
521see
522.Xr ncurses 3
523.It Pa ntp/
524HTML documents pertaining to the Network Time Protocol
525.It Pa papers/
526UNIX Papers
527.It Pa psd/
528UNIX Programmer's Supplementary Documents
529.It Pa ru/
530Russian translations of documents in /usr/share/doc
531.It Pa smm/
532UNIX System Manager's Manual
533.It Pa tutorials/
534.Fx
535tutorials
536.It Pa usd/
537UNIX User's Supplementary Documents
538.It Pa zh/
539Chinese translations of documents in /usr/share/doc
540.El
541.Pp
542.It Pa examples/
543various examples for users and programmers
544.It Pa games/
545ASCII text files used by various games
546.It Pa groff_font/
547device description file for device name
548.It Pa info/
549GNU Info hypertext system
550.It Pa locale/
551localization files;
552see
553.Xr setlocale 3
554.It Pa man/
555manual pages
556.It Pa mdocml/
557data files used by mdocml
558.It Pa me/
559macros for use with the me macro package;
560see
561.Xr me 7
562.It Pa misc/
563miscellaneous system-wide ASCII text files
564.Bl -tag -width Fl -compact
565.It Pa fonts/
566???
567.It Pa termcap
568terminal characteristics database;
569see
570.Xr termcap 5
571.El
572.It Pa mk/
573templates for make;
574see
575.Xr make 1
576.It Pa nls/
577national language support files;
578see
579.Xr mklocale 1
580.It Pa security/
581data files for security policies such as
582.Xr mac_lomac 4
583.It Pa sendmail/
584.Xr sendmail 8
585configuration files
586.It Pa skel/
587example
588.Pa .\&
589(dot) files for new accounts
590.It Pa snmp/
591MIBs, example files and tree definitions for the SNMP daemon.
592.Bl -tag -width Fl -compact
593.It Pa defs/
594Tree definition files for use with
595.Xr gensnmptree 1
596.It Pa mibs/
597MIB files
598.El
599.It Pa syscons/
600files used by syscons;
601see
602.Xr syscons 4
603.Bl -tag -width ".Pa scrnmaps/" -compact
604.It Pa fonts/
605console fonts;
606see
607.Xr vidcontrol 1
608and
609.Xr vidfont 1
610.It Pa keymaps/
611console keyboard maps;
612see
613.Xr kbdcontrol 1
614and
615.Xr kbdmap 1
616.It Pa scrnmaps/
617console screen maps
618.El
619.It Pa tabset/
620tab description files for a variety of terminals; used in
621the termcap file;
622see
623.Xr termcap 5
624.It Pa tmac/
625text processing macros;
626see
627.Xr nroff 1
628and
629.Xr troff 1
630.It Pa vi/
631localization support and utilities for
632.Xr vi 1
633.It Pa zoneinfo/
634timezone configuration information;
635see
636.Xr tzfile 5
637.El
638.It Pa src/
639.Bx ,
640third-party, and/or local source files
641.Pp
642.Bl -tag -width ".Pa kerberos5/" -compact
643.It Pa bin/
644source code for files in /bin
645.It Pa cddl/
646Utilities covered by the Common Development and Distribution License
647.It Pa contrib/
648source code for contributed software
649.It Pa crypto/
650source code for contributed cryptography software
651.It Pa etc/
652source code for files in
653.Pa /etc
654.It Pa games/
655source code for files in
656.Pa /usr/games
657.It Pa gnu/
658Utilities covered by the GNU General Public License
659.It Pa include/
660source code for files in
661.Pa /usr/include
662.It Pa kerberos5/
663build infrastructure for kerberos version 5
664.It Pa lib/
665source code for files in
666.Pa /usr/lib
667.It Pa libexec/
668source code for files in
669.Pa /usr/libexec
670.It Pa release/
671files required to produce a
672.Fx
673release
674.It Pa sbin/
675source code for files in
676.Pa /sbin
677.It Pa secure/
678build directory for files in
679.Pa /usr/src/crypto
680.It Pa share/
681source for files in
682.Pa /usr/share
683.It Pa sys/
684kernel source code
685.It Pa tools/
686tools used for maintenance and testing of
687.Fx
688.It Pa usr.bin/
689source code for files in
690.Pa /usr/bin
691.It Pa usr.sbin/
692source code for files in
693.Pa /usr/sbin
694.El
695.Pp
696.It Pa tests/
697The
698.Fx
699test suite.
700See tests(7) for more details.
701.El
702.It Pa /var/
703multi-purpose log, temporary, transient, and spool files
704.Pp
705.Bl -tag -width ".Pa preserve/" -compact
706.It Pa account/
707system accounting files
708.Pp
709.Bl -tag -width Fl -compact
710.It Pa acct
711execution accounting file;
712see
713.Xr acct 5
714.El
715.Pp
716.It Pa at/
717timed command scheduling files;
718see
719.Xr \&at 1
720.Bl -tag -width ".Pa preserve/" -compact
721.It Pa jobs/
722directory containing job files
723.It Pa spool/
724directory containing output spool files
725.El
726.Pp
727.It Pa backups/
728miscellaneous backup files
729.It Pa crash/
730default directory to store kernel crash dumps; see
731.Xr crash 8
732and
733.Xr savecore 8
734.It Pa cron/
735files used by cron;
736see
737.Xr cron 8
738.Bl -tag -width ".Pa preserve/" -compact
739.It Pa tabs/
740crontab files;
741see
742.Xr crontab 5
743.El
744.Pp
745.It Pa db/
746miscellaneous automatically generated system-specific database files
747.It Pa empty/
748empty directory for use by programs that need a specifically empty directory.
749Used for instance by
750.Xr sshd 8
751for privilege separation.
752.It Pa games/
753miscellaneous game status and score files
754.It Pa heimdal/
755kerberos server databases; see
756.Xr kdc 8
757.It Pa log/
758miscellaneous system log files
759.Pp
760.Bl -tag -width Fl -compact
761.It Pa utx.lastlogin
762last login log;
763see
764.Xr getutxent 3
765.It Pa utx.log
766login/logout log;
767see
768.Xr getutxent 3
769.El
770.Pp
771.It Pa mail/
772user mailbox files
773.It Pa msgs/
774system messages database;
775see
776.Xr msgs 1
777.It Pa preserve/
778temporary home of files preserved after an accidental death
779of an editor;
780see
781.Xr \&ex 1
782.It Pa quotas/
783file system quota information files
784.It Pa run/
785system information files describing various info about
786system since it was booted
787.Pp
788.Bl -tag -width Fl -compact
789.It Pa named/
790writable by the
791.Dq bind
792user; see
793.Xr named 8
794.It Pa ppp/
795writable by the
796.Dq network
797group for command connection sockets; see
798.Xr ppp 8
799.It Pa utx.active
800database of current users;
801see
802.Xr getutxent 3
803.El
804.Pp
805.It Pa rwho/
806rwho data files;
807see
808.Xr rwhod 8 ,
809.Xr rwho 1 ,
810and
811.Xr ruptime 1
812.It Pa spool/
813miscellaneous printer and mail system spooling directories
814.Pp
815.Bl -tag -width Fl -compact
816.It Pa clientmqueue/
817undelivered submission mail queue;
818see
819.Xr sendmail 8
820.It Pa ftp/
821commonly ~ftp; the anonymous ftp root directory
822.It Pa mqueue/
823undelivered mail queue;
824see
825.Xr sendmail 8
826.It Pa output/
827line printer spooling directories
828.El
829.Pp
830.It Pa tmp/
831temporary files that are kept between system reboots
832.Bl -tag -width Fl -compact
833.It Pa vi.recover/
834the directory where recovery files are stored
835.El
836.It Pa yp/
837the NIS maps
838.El
839.El
840.Sh NOTES
841This manual page documents the default
842.Fx
843file system layout, but
844the actual hierarchy on a given system is defined at the system
845administrator's discretion.
846A well-maintained installation will include a customized version of
847this document.
848.Sh SEE ALSO
849.Xr apropos 1 ,
850.Xr find 1 ,
851.Xr finger 1 ,
852.Xr grep 1 ,
853.Xr ls 1 ,
854.Xr whatis 1 ,
855.Xr whereis 1 ,
856.Xr which 1 ,
857.Xr fd 4 ,
858.Xr devfs 5 ,
859.Xr fsck 8
860.Sh HISTORY
861A
862.Nm
863manual page appeared in
864.At v7 .
106.It Pa localtime
107local timezone information;
108see
109.Xr ctime 3
110.It Pa mail/
111Sendmail control files
112.It Pa mtree/
113mtree configuration files;
114see
115.Xr mtree 8
116.It Pa namedb/
117named configuration files;
118see
119.Xr named 8
120.It Pa pam.d/
121configuration files for the Pluggable Authentication Modules (PAM)
122library
123.It Pa periodic/
124scripts that are run daily, weekly, and monthly, via
125.Xr cron 8 ;
126see
127.Xr periodic 8
128.It Pa rc.d/
129System and daemon startup/control scripts;
130see
131.Xr rc 8
132.It Pa security/
133OpenBSM audit configuration files;
134see
135.Xr audit 8
136.It Pa ppp/
137ppp configuration files;
138see
139.Xr ppp 8
140.It Pa ssh/
141OpenSSH configuration files;
142see
143.Xr ssh 1
144.It Pa ssl/
145OpenSSL configuration files
146.El
147.It Pa /lib/
148critical system libraries needed for binaries in
149.Pa /bin
150and
151.Pa /sbin
152.Pp
153.Bl -tag -width ".Pa geom/" -compact
154.It Pa geom/
155class-specific libraries for the
156.Xr geom 8
157utility
158.El
159.It Pa /libexec/
160critical system utilities needed for binaries in
161.Pa /bin
162and
163.Pa /sbin
164.It Pa /media/
165contains subdirectories to be used as mount points
166for removable media such as CDs, USB drives, and
167floppy disks
168.It Pa /mnt/
169empty directory commonly used by
170system administrators as a temporary mount point
171.It Pa /proc/
172process file system;
173see
174.Xr procfs 5
175.It Pa /rescue/
176statically linked programs for emergency recovery;
177see
178.Xr rescue 8
179.It Pa /root/
180root's HOME directory
181.It Pa /sbin/
182system programs and administration utilities
183fundamental to both single-user and multi-user environments
184.It Pa /tmp/
185temporary files that are not guaranteed to persist across system reboots
186.It Pa /usr/
187contains the majority of user utilities and applications
188.Pp
189.Bl -tag -width ".Pa libdata/" -compact
190.It Pa bin/
191common utilities, programming tools, and applications
192.It Pa compat/
193files needed to support binary compatibility with other operating systems,
194such as Linux
195.It Pa games/
196useful and semi-frivolous programs
197.It Pa include/
198standard C include files
199.Pp
200.Bl -tag -width ".Pa kerberos5/" -compact
201.It Pa altq/
202C include files for alternate queueing
203.It Pa arpa/
204C include files for Internet service protocols
205.It Pa bsnmp/
206C include files for the SNMP daemon
207.It Pa c++/
208C++ include files
209.It Pa cam/
210C include files for the Common Access Methods Layer
211.Bl -tag -width ".Pa kerberos5/" -compact
212.It Pa scsi/
213The SCSI device on top of CAM
214.El
215.It Pa dev/
216C include files for programming various
217.Fx
218devices
219.Bl -tag -width ".Pa kerberos5/" -compact
220.It Pa ic/
221Various header files describing driver- and bus-independent
222hardware circuits
223.It Pa ofw/
224Open Firmware support
225.It Pa pbio/
2268255 PPI cards;
227see
228.Xr pbio 4
229.It Pa ppbus/
230The parallel port bus;
231see
232.Xr ppbus 4
233.It Pa usb/
234The USB subsystem
235.It Pa utopia/
236Physical chip driver for ATM interfaces;
237see
238.Xr utopia 4
239.It Pa wi/
240The
241.Xr wi 4
242WaveLAN driver
243.El
244.It Pa fs/
245.Bl -tag -width ".Pa kerberos5/" -compact
246.It Pa fdescfs/
247per-process file descriptors file system
248.It Pa fifofs/
249.St -p1003.1
250FIFOs file system
251.It Pa msdosfs/
252MS-DOS file system
253.It Pa nfs/
254C include files for NFS (Network File System) version 2, 3 and 4
255.It Pa nullfs/
256loopback file system
257.It Pa procfs/
258process file system
259.It Pa smbfs/
260SMB/CIFS file system
261.It Pa udf/
262UDF file system
263.It Pa unionfs
264union file system
265.El
266.It Pa geom/
267GEOM framework
268.Bl -tag -width ".Pa kerberos5/" -compact
269.It Pa concat/
270CONCAT GEOM class
271.It Pa gate/
272GATE GEOM class
273.It Pa mirror/
274MIRROR GEOM class
275.It Pa nop/
276NOP GEOM class
277.It Pa raid3/
278RAID3 GEOM class
279.It Pa stripe/
280STRIPE GEOM class
281.El
282.Pp
283.It Pa isc/
284ISC utility library libisc include files
285.It Pa isofs/
286.Bl -tag -width ".Pa kerberos5/" -compact
287.It Pa cd9660/
288iso9660 file system
289.El
290.It Pa libmilter/
291C include files for libmilter,
292the
293.Xr sendmail 8
294mail filter API
295.It Pa machine/
296machine-specific C include files
297.It Pa net/
298miscellaneous network C include files
299.It Pa netatalk/
300Appletalk protocol
301.It Pa netinet/
302C include files for Internet standard protocols;
303see
304.Xr inet 4
305.It Pa netinet6/
306C include files for Internet protocol version 6;
307see
308.Xr inet6 4
309.It Pa netipsec/
310kernel key-management service;
311see
312.Xr ipsec 4
313.It Pa netipx/
314IPX/SPX protocol stacks
315.It Pa netnatm/
316NATM include files;
317see
318.Xr natm 4
319.Bl -tag -width ".Pa kerberos5/" -compact
320.It Pa api/
321include files for the signalling API
322.It Pa msg/
323include files that describe signalling messages and
324declare associated functions
325.It Pa saal/
326include files for the signalling AAL layer
327.It Pa sig/
328include files for the UNI signalling protocol
329.El
330.It Pa netsmb/
331SMB/CIFS requester
332.It Pa nfs/
333C include files for NFS (Network File System) version 2 and 3 (legacy)
334.It Pa objc/
335Objective C include files
336.It Pa openssl/
337OpenSSL (Cryptography/SSL toolkit) headers
338.It Pa pccard/
339PC-CARD controllers
340.It Pa protocols/
341C include files for Berkeley service protocols
342.It Pa readline/
343get a line from a user, with editing;
344see
345.Xr readline 3
346.It Pa rpc/
347remote procedure calls;
348see
349.Xr rpc 3
350.It Pa rpcsvc/
351definition of RPC service structures; see
352.Xr rpc 3
353.It Pa security/
354PAM; see
355.Xr pam 8
356.It Pa sys/
357system C include files (kernel data structures)
358.\" .It Pa tcl/
359.\" Tcl language;
360.\" see
361.\" .Xr Tcl n
362.\" .Bl -tag -width ".Pa kerberos5/" -compact
363.\" .It Pa generic/
364.\" ???
365.\" .It Pa unix/
366.\" ???
367.\" .El
368.It Pa ufs/
369C include files for UFS (The U-word File System)
370.Bl -tag -width ".Pa kerberos5/" -compact
371.It Pa ffs/
372Fast file system
373.It Pa ufs/
374UFS file system
375.El
376.It Pa vm/
377virtual memory;
378see
379.Xr vmstat 8
380.El
381.Pp
382.It Pa lib/
383shared and archive
384.Xr ar 1 Ns -type
385libraries
386.Bl -tag -width Fl -compact
387.It Pa aout/
388a.out archive libraries
389.It Pa compat/
390shared libraries for compatibility
391.Bl -tag -width Fl -compact
392.It Pa aout/
393a.out backward compatibility libraries
394.El
395.It Pa dtrace/
396DTrace library scripts
397.It Pa engines/
398OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines
399.El
400.Pp
401.It Pa libdata/
402miscellaneous utility data files
403.Bl -tag -width Fl -compact
404.It Pa gcc/
405.Xr gcc 1
406configuration data
407.It Pa ldscripts/
408linker scripts;
409see
410.Xr ld 1
411.It Pa lint/
412various prebuilt lint libraries;
413see
414.Xr lint 1
415.El
416.Pp
417.It Pa libexec/
418system daemons & system utilities (executed by other programs)
419.Bl -tag -width Fl -compact
420.It Pa aout/
421utilities to manipulate a.out executables
422.It Pa elf/
423utilities to manipulate ELF executables
424.It Pa lpr/
425utilities and filters for LP print system;
426see
427.Xr lpr 1
428.It Pa sendmail/
429the
430.Xr sendmail 8
431binary;
432see
433.Xr mailwrapper 8
434.It Pa sm.bin/
435restricted shell for
436.Xr sendmail 8 ;
437see
438.Xr smrsh 8
439.El
440.Pp
441.It Pa local/
442local executables, libraries, etc.
443Also used as the default destination for the
444.Fx
445ports framework.
446Within
447.Pa local/ ,
448the general layout sketched out by
449.Nm
450for
451.Pa /usr
452should be used.
453Exceptions are the
454.Pa man
455directory
456.Po directly under
457.Pa local/
458rather than under
459.Pa local/share/ Ns Pc ,
460ports documentation
461.Po in
462.Pa share/doc/<port>/ Ns Pc ,
463and
464.Pa /usr/local/etc
465.Po mimics
466.Pa /etc Ns Pc .
467.It Pa obj/
468architecture-specific target tree produced by building the
469.Pa /usr/src
470tree
471.It Pa ports/
472The
473.Fx
474ports collection (optional).
475.It Pa sbin/
476system daemons & system utilities (executed by users)
477.It Pa share/
478architecture-independent files
479.Pp
480.Bl -tag -width ".Pa calendar/" -compact
481.It Pa calendar/
482a variety of pre-fab calendar files;
483see
484.Xr calendar 1
485.It Pa dict/
486word lists;
487see
488.Xr look 1
489.Pp
490.Bl -tag -width Fl -compact
491.It Pa freebsd
492.Fx Ns -specific
493terms, proper names, and jargon
494.It Pa words
495common words
496.It Pa web2
497words from Webster's 2nd International
498.It Pa papers/
499reference databases;
500see
501.Xr refer 1
502.El
503.Pp
504.It Pa doc/
505miscellaneous documentation;
506source for most of the printed
507.Bx
508manuals (available
509from the
510.Tn USENIX
511association)
512.Bl -tag -width Fl -compact
513.It Pa FAQ/
514Frequently Asked Questions
515.It Pa IPv6/
516implementation notes for IPv6
517.It Pa bind/
518documents pertaining to BIND (the Berkeley Internet Name Domain)
519.It Pa es/
520Spanish translations of documents in /usr/share/doc
521.It Pa handbook/
522.Fx
523Handbook
524.It Pa ja/
525Japanese translations of documents in /usr/share/doc
526.It Pa legal/
527License files for vendor supplied firmwares
528.It Pa ncurses/
529HTML documents pertaining to ncurses;
530see
531.Xr ncurses 3
532.It Pa ntp/
533HTML documents pertaining to the Network Time Protocol
534.It Pa papers/
535UNIX Papers
536.It Pa psd/
537UNIX Programmer's Supplementary Documents
538.It Pa ru/
539Russian translations of documents in /usr/share/doc
540.It Pa smm/
541UNIX System Manager's Manual
542.It Pa tutorials/
543.Fx
544tutorials
545.It Pa usd/
546UNIX User's Supplementary Documents
547.It Pa zh/
548Chinese translations of documents in /usr/share/doc
549.El
550.Pp
551.It Pa examples/
552various examples for users and programmers
553.It Pa games/
554ASCII text files used by various games
555.It Pa groff_font/
556device description file for device name
557.It Pa info/
558GNU Info hypertext system
559.It Pa locale/
560localization files;
561see
562.Xr setlocale 3
563.It Pa man/
564manual pages
565.It Pa mdocml/
566data files used by mdocml
567.It Pa me/
568macros for use with the me macro package;
569see
570.Xr me 7
571.It Pa misc/
572miscellaneous system-wide ASCII text files
573.Bl -tag -width Fl -compact
574.It Pa fonts/
575???
576.It Pa termcap
577terminal characteristics database;
578see
579.Xr termcap 5
580.El
581.It Pa mk/
582templates for make;
583see
584.Xr make 1
585.It Pa nls/
586national language support files;
587see
588.Xr mklocale 1
589.It Pa security/
590data files for security policies such as
591.Xr mac_lomac 4
592.It Pa sendmail/
593.Xr sendmail 8
594configuration files
595.It Pa skel/
596example
597.Pa .\&
598(dot) files for new accounts
599.It Pa snmp/
600MIBs, example files and tree definitions for the SNMP daemon.
601.Bl -tag -width Fl -compact
602.It Pa defs/
603Tree definition files for use with
604.Xr gensnmptree 1
605.It Pa mibs/
606MIB files
607.El
608.It Pa syscons/
609files used by syscons;
610see
611.Xr syscons 4
612.Bl -tag -width ".Pa scrnmaps/" -compact
613.It Pa fonts/
614console fonts;
615see
616.Xr vidcontrol 1
617and
618.Xr vidfont 1
619.It Pa keymaps/
620console keyboard maps;
621see
622.Xr kbdcontrol 1
623and
624.Xr kbdmap 1
625.It Pa scrnmaps/
626console screen maps
627.El
628.It Pa tabset/
629tab description files for a variety of terminals; used in
630the termcap file;
631see
632.Xr termcap 5
633.It Pa tmac/
634text processing macros;
635see
636.Xr nroff 1
637and
638.Xr troff 1
639.It Pa vi/
640localization support and utilities for
641.Xr vi 1
642.It Pa zoneinfo/
643timezone configuration information;
644see
645.Xr tzfile 5
646.El
647.It Pa src/
648.Bx ,
649third-party, and/or local source files
650.Pp
651.Bl -tag -width ".Pa kerberos5/" -compact
652.It Pa bin/
653source code for files in /bin
654.It Pa cddl/
655Utilities covered by the Common Development and Distribution License
656.It Pa contrib/
657source code for contributed software
658.It Pa crypto/
659source code for contributed cryptography software
660.It Pa etc/
661source code for files in
662.Pa /etc
663.It Pa games/
664source code for files in
665.Pa /usr/games
666.It Pa gnu/
667Utilities covered by the GNU General Public License
668.It Pa include/
669source code for files in
670.Pa /usr/include
671.It Pa kerberos5/
672build infrastructure for kerberos version 5
673.It Pa lib/
674source code for files in
675.Pa /usr/lib
676.It Pa libexec/
677source code for files in
678.Pa /usr/libexec
679.It Pa release/
680files required to produce a
681.Fx
682release
683.It Pa sbin/
684source code for files in
685.Pa /sbin
686.It Pa secure/
687build directory for files in
688.Pa /usr/src/crypto
689.It Pa share/
690source for files in
691.Pa /usr/share
692.It Pa sys/
693kernel source code
694.It Pa tools/
695tools used for maintenance and testing of
696.Fx
697.It Pa usr.bin/
698source code for files in
699.Pa /usr/bin
700.It Pa usr.sbin/
701source code for files in
702.Pa /usr/sbin
703.El
704.Pp
705.It Pa tests/
706The
707.Fx
708test suite.
709See tests(7) for more details.
710.El
711.It Pa /var/
712multi-purpose log, temporary, transient, and spool files
713.Pp
714.Bl -tag -width ".Pa preserve/" -compact
715.It Pa account/
716system accounting files
717.Pp
718.Bl -tag -width Fl -compact
719.It Pa acct
720execution accounting file;
721see
722.Xr acct 5
723.El
724.Pp
725.It Pa at/
726timed command scheduling files;
727see
728.Xr \&at 1
729.Bl -tag -width ".Pa preserve/" -compact
730.It Pa jobs/
731directory containing job files
732.It Pa spool/
733directory containing output spool files
734.El
735.Pp
736.It Pa backups/
737miscellaneous backup files
738.It Pa crash/
739default directory to store kernel crash dumps; see
740.Xr crash 8
741and
742.Xr savecore 8
743.It Pa cron/
744files used by cron;
745see
746.Xr cron 8
747.Bl -tag -width ".Pa preserve/" -compact
748.It Pa tabs/
749crontab files;
750see
751.Xr crontab 5
752.El
753.Pp
754.It Pa db/
755miscellaneous automatically generated system-specific database files
756.It Pa empty/
757empty directory for use by programs that need a specifically empty directory.
758Used for instance by
759.Xr sshd 8
760for privilege separation.
761.It Pa games/
762miscellaneous game status and score files
763.It Pa heimdal/
764kerberos server databases; see
765.Xr kdc 8
766.It Pa log/
767miscellaneous system log files
768.Pp
769.Bl -tag -width Fl -compact
770.It Pa utx.lastlogin
771last login log;
772see
773.Xr getutxent 3
774.It Pa utx.log
775login/logout log;
776see
777.Xr getutxent 3
778.El
779.Pp
780.It Pa mail/
781user mailbox files
782.It Pa msgs/
783system messages database;
784see
785.Xr msgs 1
786.It Pa preserve/
787temporary home of files preserved after an accidental death
788of an editor;
789see
790.Xr \&ex 1
791.It Pa quotas/
792file system quota information files
793.It Pa run/
794system information files describing various info about
795system since it was booted
796.Pp
797.Bl -tag -width Fl -compact
798.It Pa named/
799writable by the
800.Dq bind
801user; see
802.Xr named 8
803.It Pa ppp/
804writable by the
805.Dq network
806group for command connection sockets; see
807.Xr ppp 8
808.It Pa utx.active
809database of current users;
810see
811.Xr getutxent 3
812.El
813.Pp
814.It Pa rwho/
815rwho data files;
816see
817.Xr rwhod 8 ,
818.Xr rwho 1 ,
819and
820.Xr ruptime 1
821.It Pa spool/
822miscellaneous printer and mail system spooling directories
823.Pp
824.Bl -tag -width Fl -compact
825.It Pa clientmqueue/
826undelivered submission mail queue;
827see
828.Xr sendmail 8
829.It Pa ftp/
830commonly ~ftp; the anonymous ftp root directory
831.It Pa mqueue/
832undelivered mail queue;
833see
834.Xr sendmail 8
835.It Pa output/
836line printer spooling directories
837.El
838.Pp
839.It Pa tmp/
840temporary files that are kept between system reboots
841.Bl -tag -width Fl -compact
842.It Pa vi.recover/
843the directory where recovery files are stored
844.El
845.It Pa yp/
846the NIS maps
847.El
848.El
849.Sh NOTES
850This manual page documents the default
851.Fx
852file system layout, but
853the actual hierarchy on a given system is defined at the system
854administrator's discretion.
855A well-maintained installation will include a customized version of
856this document.
857.Sh SEE ALSO
858.Xr apropos 1 ,
859.Xr find 1 ,
860.Xr finger 1 ,
861.Xr grep 1 ,
862.Xr ls 1 ,
863.Xr whatis 1 ,
864.Xr whereis 1 ,
865.Xr which 1 ,
866.Xr fd 4 ,
867.Xr devfs 5 ,
868.Xr fsck 8
869.Sh HISTORY
870A
871.Nm
872manual page appeared in
873.At v7 .