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