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