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 udf/ 237UDF file system 238.It Pa umapfs/ 239alternate uid/gid mappings file system 240.It Pa unionfs 241union file system 242.El 243.It Pa g++/ 244GNU C++ include files 245.Bl -tag -width "kerberos5/" -compact 246.It Pa std/ 247GNU C++ libstdc++ include files 248.El 249.It Pa isc/ 250ISC utility library libisc include files 251.It Pa isofs/ 252.Bl -tag -width "kerberos5/" -compact 253.It Pa cd9660/ 254iso9660 file system 255.El 256.It Pa libmilter/ 257C include files for libmilter, 258the 259.Xr sendmail 8 260mail filter API 261.It Pa machine/ 262machine-specific C include files 263.It Pa net/ 264misc network C include files 265.It Pa netatalk/ 266Appletalk protocol 267.It Pa netatm/ 268ATM include files; 269see 270.Xr atm 8 271.It Pa netinet/ 272C include files for Internet standard protocols; 273see 274.Xr inet 4 275.It Pa netinet6/ 276C include files for Internet protocol version 6; 277see 278.Xr inet6 4 279.It Pa netipx/ 280IPX/SPX protocol stacks 281.It Pa netkey/ 282kernel key-management service 283.It Pa netnatm/ 284NATM include files; 285see 286.Xr natm 4 287.It Pa netsmb/ 288SMB/CIFS requester 289.It Pa nfs/ 290C include files for NFS (Network File System) 291.It Pa objc/ 292Objective C include files 293.It Pa openssl/ 294OpenSSL (Cryptography/SSL toolkit) headers 295.It Pa pccard/ 296PC-CARD controllers 297.It Pa posix4/ 298POSIX real-time extensions includes; 299see 300.Xr p1003_1b 9 301.It Pa protocols/ 302C include files for Berkeley service protocols 303.It Pa readline/ 304get a line from a user, with editing; 305see 306.Xr readline 3 307.It Pa rpc/ 308remote procedure calls; 309see 310.Xr rpc 3 311.It Pa rpcsvc/ 312definition of RPC service structures; see 313.Xr rpc 3 314.It Pa security/ 315PAM; see 316.Xr pam 8 317.It Pa sys/ 318system C include files (kernel data structures) 319.\" .It Pa tcl/ 320.\" Tcl language; 321.\" see 322.\" .Xr Tcl n 323.\" .Bl -tag -width "kerberos5/" -compact 324.\" .It Pa generic/ 325.\" ??? 326.\" .It Pa unix/ 327.\" ??? 328.\" .El 329.It Pa ufs/ 330C include files for UFS (The U-word File System) 331.Bl -tag -width "kerberos5/" -compact 332.It Pa ffs/ 333Fast file system 334.It Pa ufs/ 335UFS file system 336.El 337.It Pa vm/ 338virtual memory; 339see 340.Xr vmstat 8 341.El 342.Pp 343.It Pa lib/ 344archive libraries 345.Bl -tag -width Fl -compact 346.It Pa aout/ 347a.out archive libraries 348.It Pa compat/ 349shared libraries for compatibility 350.Bl -tag -width Fl -compact 351.It Pa aout/ 352a.out backward compatibility libraries 353.El 354.El 355.Pp 356.It Pa libdata/ 357misc. utility data files 358.Bl -tag -width Fl -compact 359.It Pa gcc/ 360.Xr gcc 1 361configuration data 362.It Pa ldscripts/ 363linker scripts; 364see 365.Xr ld 1 366.It Pa lint/ 367various prebuilt lint libraries; 368see 369.Xr lint 1 370.El 371.Pp 372.It Pa libexec/ 373system daemons & system utilities (executed by other programs) 374.Bl -tag -width Fl -compact 375.It Pa aout/ 376utilities to manipulate a.out executables 377.It Pa elf/ 378utilities to manipulate ELF executables 379.It Pa lpr/ 380utilities and filters for LP print system; 381see 382.Xr lpr 1 383.It Pa sendmail/ 384the 385.Xr sendmail 8 386binary; 387see 388.Xr mailwrapper 8 389.It Pa sm.bin/ 390restricted shell for 391.Xr sendmail 8 ; 392see 393.Xr smrsh 8 394.El 395.Pp 396.It Pa local/ 397local executables, libraries, etc. 398Also used as the default destination for the 399.Fx 400ports framework. 401Within local/, the general layout sketched out by 402.Nm 403for /usr 404should be used. Exceptions are the man directory (directly under local/ 405rather than under local/share/), ports documentation (in share/doc/<port>/), 406and /usr/local/etc (mimics /etc). 407.It Pa obj/ 408architecture-specific target tree produced by building the /usr/src tree 409.It Pa ports/ 410The 411.Fx 412ports collection (optional). 413.It Pa sbin/ 414system daemons & system utilities (executed by users) 415.It Pa share/ 416architecture-independent files 417.Pp 418.Bl -tag -width "calendar/" -compact 419.It Pa calendar/ 420a variety of pre-fab calendar files; 421see 422.Xr calendar 1 423.It Pa dict/ 424word lists; 425see 426.Xr look 1 427.Pp 428.Bl -tag -width Fl -compact 429.It Pa freebsd 430.Fx Ns -specific 431terms, proper names, and jargon 432.It Pa words 433common words 434.It Pa web2 435words from Webster's 2nd International 436.It Pa papers/ 437reference databases; 438see 439.Xr refer 1 440.El 441.Pp 442.It Pa doc/ 443miscellaneous documentation; 444source for most of the printed 445.Bx 446manuals (available 447from the 448.Tn USENIX 449association) 450.Bl -tag -width Fl -compact 451.It Pa FAQ/ 452Frequently Asked Questions 453.It Pa IPv6/ 454implementation notes for IPv6 455.It Pa bind/ 456documents pertaining to BIND (the Berkeley Internet Name Domain) 457.It Pa es/ 458Spanish translations of documents in /usr/share/doc 459.It Pa handbook/ 460.Fx 461Handbook 462.It Pa ja/ 463Japanese translations of documents in /usr/share/doc 464.It Pa ncurses/ 465HTML documents pertaining to ncurses; 466see 467.Xr ncurses 3X 468.It Pa ntp/ 469HTML documents pertaining to the Network Time Protocol 470.It Pa papers/ 471UNIX Papers 472.It Pa psd/ 473UNIX Programmer's Supplementary Documents 474.It Pa ru/ 475Russian translations of documents in /usr/share/doc 476.It Pa smm/ 477UNIX System Manager's Manual 478.It Pa tutorials/ 479.Fx 480tutorials 481.It Pa usd/ 482UNIX User's Supplementary Documents 483.It Pa zh/ 484Chinese translations of documents in /usr/share/doc 485.El 486.Pp 487.It Pa examples/ 488various examples for users and programmers 489.It Pa games/ 490ASCII text files used by various games 491.It Pa groff_font/ 492device description file for device name 493.It Pa info/ 494GNU Info hypertext system 495.It Pa isdn/ 496ISDN 497.It Pa locale/ 498localization files; 499see 500.Xr setlocale 3 501.It Pa man/ 502manual pages 503.It Pa me/ 504macros for use with the me macro package; 505see 506.Xr me 7 507.It Pa misc/ 508misc system-wide ASCII text files 509.Bl -tag -width Fl -compact 510.It Pa fonts/ 511??? 512.It Pa pcvtfonts/ 513pcvt fonts; 514see 515.Xr pcvt 4 516.It Pa termcap 517terminal characteristics database; 518see 519.Xr termcap 5 520.El 521.It Pa mk/ 522templates for make; 523see 524.Xr make 1 525.It Pa nls/ 526national language support files; 527see 528.Xr mklocale 1 529.It Pa pcvt/ 530pcvt documentation and etc examples; 531see 532.Xr pcvt 4 533.It Pa security/ 534data files for security policies such as 535.Xr mac_lomac 4 536.It Pa sendmail/ 537.Xr sendmail 8 538configuration files 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 "kerberos5/" -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 kerberos5/ 600build infrastructure for kerberos version 5 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 empty/ 689empty directory for use by programs that need a specifically empty directory. 690Used for instance by 691.Xr sshd 8 692for privilege separation. 693.It Pa games/ 694misc. game status and score files 695.It Pa heimdal/ 696kerberos server databases; see 697.Xr kdc 8 698.It Pa log/ 699misc. system log files 700.Pp 701.Bl -tag -width Fl -compact 702.It Pa wtmp 703login/logout log; 704see 705.Xr wtmp 5 706.El 707.Pp 708.It Pa mail/ 709user mailbox files 710.It Pa msgs/ 711system messages database; 712see 713.Xr msgs 1 714.It Pa preserve/ 715temporary home of files preserved after an accidental death 716of an editor; 717see 718.Xr \&ex 1 719.It Pa quotas/ 720file system quota information files 721.It Pa run/ 722system information files describing various info about 723system since it was booted 724.Pp 725.Bl -tag -width Fl -compact 726.It Pa named/ 727writable by the 728.Dq bind 729user; see 730.Xr named 8 731.It Pa ppp/ 732writable by the 733.Dq network 734group for command connection sockets; see 735.Xr ppp 8 736.It Pa utmp 737database of current users; 738see 739.Xr utmp 5 740.El 741.Pp 742.It Pa rwho/ 743rwho data files; 744see 745.Xr rwhod 8 , 746.Xr rwho 1 , 747and 748.Xr ruptime 1 749.It Pa spool/ 750misc. printer and mail system spooling directories 751.Pp 752.Bl -tag -width Fl -compact 753.It Pa clientmqueue/ 754undelivered submission mail queue; 755see 756.Xr sendmail 8 757.It Pa ftp/ 758commonly ~ftp; the anonymous ftp root directory 759.It Pa mqueue/ 760undelivered mail queue; 761see 762.Xr sendmail 8 763.It Pa output/ 764line printer spooling directories 765.El 766.Pp 767.It Pa tmp/ 768temporary files that are kept between system reboots 769.Bl -tag -width Fl -compact 770.It Pa vi.recover/ 771the directory where recovery files are stored 772.El 773.It Pa yp/ 774the NIS maps 775.El 776.El 777.Sh NOTES 778This manual page documents the default 779.Fx 780file system layout, but 781the actual hierarchy on a given system is defined at the system 782administrator's discretion. 783A well-maintained installation will include a customized version of 784this document. 785.Sh SEE ALSO 786.Xr apropos 1 , 787.Xr find 1 , 788.Xr finger 1 , 789.Xr grep 1 , 790.Xr ls 1 , 791.Xr whatis 1 , 792.Xr whereis 1 , 793.Xr which 1 , 794.Xr fsck 8 795.Sh HISTORY 796A 797.Nm 798manual page appeared in 799.At v7 . 800