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