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 doscmd/ 360files used by doscmd (drivers, fonts, etc.); 361see 362.Xr doscmd 1 363.Bl -tag -width 6n -compact 364.It Pa fonts/ 365fonts used by doscmd 366.El 367.It Pa gcc/ 368??? 369.It Pa ldscripts/ 370linker scripts; 371see 372.Xr ld 1 373.It Pa lint/ 374various prebuilt lint libraries; 375see 376.Xr lint 1 377.It Pa stallion/ 378firmware images for Stallion serial controllers; see 379.Xr stl 4 380.El 381.Pp 382.It Pa libexec/ 383system daemons & system utilities (executed by other programs) 384.Bl -tag -width Fl -compact 385.It Pa aout/ 386utilities to manipulate a.out executables 387.It Pa elf/ 388utilities to manipulate ELF executables 389.It Pa lpr/ 390utilities and filters for LP print system; 391see 392.Xr lpr 1 393.It Pa sendmail/ 394the 395.Xr sendmail 8 396binary; 397see 398.Xr mailwrapper 8 399.It Pa sm.bin/ 400restricted shell for 401.Xr sendmail 8 ; 402see 403.Xr smrsh 8 404.El 405.Pp 406.It Pa local/ 407local executables, libraries, etc. 408Also used as the default destination for the 409.Fx 410ports framework. 411Within local/, the general layout sketched out by 412.Nm 413for /usr 414should be used. Exceptions are the man directory (directly under local/ 415rather than under local/share/), ports documentation (in share/doc/<port>/), 416and /usr/local/etc (mimics /etc). 417.It Pa obj/ 418architecture-specific target tree produced by building the /usr/src tree 419.It Pa ports/ 420The 421.Fx 422ports collection (optional). 423.It Pa sbin/ 424system daemons & system utilities (executed by users) 425.It Pa share/ 426architecture-independent files 427.Pp 428.Bl -tag -width "calendar/" -compact 429.It Pa calendar/ 430a variety of pre-fab calendar files; 431see 432.Xr calendar 1 433.It Pa dict/ 434word lists; 435see 436.Xr look 1 437.Pp 438.Bl -tag -width Fl -compact 439.It Pa freebsd 440.Fx Ns -specific 441terms, proper names, and jargon 442.It Pa words 443common words 444.It Pa web2 445words from Webster's 2nd International 446.It Pa papers/ 447reference databases; 448see 449.Xr refer 1 450.El 451.Pp 452.It Pa doc/ 453miscellaneous documentation; 454source for most of the printed 455.Bx 456manuals (available 457from the 458.Tn USENIX 459association) 460.Bl -tag -width Fl -compact 461.It Pa FAQ/ 462Frequently Asked Questions 463.It Pa IPv6/ 464implementation notes for IPv6 465.It Pa bind/ 466documents pertaining to BIND (the Berkeley Internet Name Domain) 467.It Pa es/ 468Spanish translations of documents in /usr/share/doc 469.It Pa handbook/ 470.Fx 471Handbook 472.It Pa ja/ 473Japanese translations of documents in /usr/share/doc 474.It Pa ncurses/ 475HTML documents pertaining to ncurses; 476see 477.Xr ncurses 3X 478.It Pa ntp/ 479HTML documents pertaining to the Network Time Protocol 480.It Pa papers/ 481UNIX Papers 482.It Pa psd/ 483UNIX Programmer's Supplementary Documents 484.It Pa ru/ 485Russian translations of documents in /usr/share/doc 486.It Pa smm/ 487UNIX System Manager's Manual 488.It Pa tutorials/ 489.Fx 490tutorials 491.It Pa usd/ 492UNIX User's Supplementary Documents 493.It Pa zh/ 494Chinese translations of documents in /usr/share/doc 495.El 496.Pp 497.It Pa examples/ 498various examples for users and programmers 499.It Pa games/ 500ASCII text files used by various games 501.It Pa groff_font/ 502device description file for device name 503.It Pa info/ 504GNU Info hypertext system 505.It Pa isdn/ 506ISDN 507.It Pa locale/ 508localization files; 509see 510.Xr setlocale 3 511.It Pa man/ 512manual pages 513.It Pa me/ 514macros for use with the me macro package; 515see 516.Xr me 7 517.It Pa misc/ 518misc system-wide ASCII text files 519.Bl -tag -width Fl -compact 520.It Pa fonts/ 521??? 522.It Pa pcvtfonts/ 523pcvt fonts; 524see 525.Xr pcvt 4 526.It Pa termcap 527terminal characteristics database; 528see 529.Xr termcap 5 530.El 531.It Pa mk/ 532templates for make; 533see 534.Xr make 1 535.It Pa nls/ 536national language support files; 537see 538.Xr mklocale 1 539.It Pa pcvt/ 540pcvt documentation and etc examples; 541see 542.Xr pcvt 4 543.It Pa security/ 544data files for security policies such as 545.Xr mac_lomac 4 546.It Pa sendmail/ 547.Xr sendmail 8 548configuration files 549.It Pa skel/ 550example . (dot) files for new accounts 551.It Pa syscons/ 552files used by syscons; 553see 554.Xr syscons 4 555.Bl -tag -width "scrnmaps/xx" -compact 556.It Pa fonts/ 557console fonts; 558see 559.Xr vidcontrol 1 560and 561.Xr vidfont 1 562.It Pa keymaps/ 563console keyboard maps; 564see 565.Xr kbdcontrol 1 566and 567.Xr kbdmap 1 568.It Pa scrnmaps/ 569console screen maps 570.El 571.It Pa tabset/ 572tab description files for a variety of terminals; used in 573the termcap file; 574see 575.Xr termcap 5 576.It Pa tmac/ 577text processing macros; 578see 579.Xr nroff 1 580and 581.Xr troff 1 582.It Pa vi/ 583localization support and utilities for 584.Xr vi 1 585.It Pa zoneinfo/ 586timezone configuration information; 587see 588.Xr tzfile 5 589.El 590.It Pa src/ 591.Bx , 592third-party, and/or local source files 593.Pp 594.Bl -tag -width "kerberos5/" -compact 595.It Pa bin/ 596source code for files in /bin 597.It Pa contrib/ 598source code for contributed software 599.It Pa crypto/ 600source code for contributed cryptography software 601.It Pa etc/ 602source code for files in /etc 603.It Pa games/ 604source code for files in /usr/games 605.It Pa gnu/ 606Utilities covered by the GNU General Public License 607.It Pa include/ 608source code for files in /usr/include 609.It Pa kerberos5/ 610build infrastructure for kerberos version 5 611.It Pa lib/ 612source code for files in /usr/lib 613.It Pa libexec/ 614source code for files in /usr/libexec 615.It Pa release/ 616files required to produce a 617.Fx 618release 619.It Pa sbin/ 620source code for files in /sbin 621.It Pa secure/ 622build directory for files in /usr/src/crypto 623.It Pa share/ 624source for files in /usr/share 625.It Pa sys/ 626kernel source code 627.It Pa tools/ 628tools used for maintenance and testing of 629.Fx 630.It Pa usr.bin/ 631source code for files in /usr/bin 632.It Pa usr.sbin/ 633source code for files in /usr/sbin 634.El 635.Pp 636.It Pa X11R6/ 637X11R6 distribution executables, libraries, etc (optional). 638.Bl -tag -width "include/" -compact 639.It Pa bin/ 640X11R6 binaries (servers, utilities, local packages/ports). 641.It Pa etc/ 642X11R6 configuration files and scripts. 643.It Pa include/ 644X11R6 include files. 645.It Pa lib/ 646X11R6 libraries. 647.It Pa man/ 648X11R6 manual pages. 649.It Pa share/ 650architecture-independent files. 651.El 652.El 653.It Pa /var/ 654multi-purpose log, temporary, transient, and spool files 655.Pp 656.Bl -tag -width "preserve/" -compact 657.It Pa account/ 658system accounting files 659.Pp 660.Bl -tag -width Fl -compact 661.It Pa acct 662execution accounting file; 663see 664.Xr acct 5 665.El 666.Pp 667.It Pa at/ 668timed command scheduling files; 669see 670.Xr \&at 1 671.Bl -tag -width "preserve/" -compact 672.It Pa jobs/ 673directory containing job files 674.It Pa spool/ 675directory containing output spool files 676.El 677.Pp 678.It Pa backups/ 679misc. backup files 680.It Pa crash/ 681default directory to store kernel crash dumps; see 682.Xr crash 8 683and 684.Xr savecore 8 685.It Pa cron/ 686files used by cron; 687see 688.Xr cron 8 689.Bl -tag -width "preserve/" -compact 690.It Pa tabs/ 691crontab files; 692see 693.Xr crontab 5 694.El 695.Pp 696.It Pa db/ 697misc. automatically generated system-specific database files 698.It Pa empty/ 699empty directory for use by programs that need a specifically empty directory. 700Used for instance by 701.Xr sshd 8 702for privilege separation. 703.It Pa games/ 704misc. game status and score files 705.It Pa heimdal/ 706kerberos server databases; see 707.Xr kdc 8 708.It Pa log/ 709misc. system log files 710.Pp 711.Bl -tag -width Fl -compact 712.It Pa wtmp 713login/logout log; 714see 715.Xr wtmp 5 716.El 717.Pp 718.It Pa mail/ 719user mailbox files 720.It Pa msgs/ 721system messages database; 722see 723.Xr msgs 1 724.It Pa preserve/ 725temporary home of files preserved after an accidental death 726of an editor; 727see 728.Xr \&ex 1 729.It Pa quotas/ 730file system quota information files 731.It Pa run/ 732system information files describing various info about 733system since it was booted 734.Pp 735.Bl -tag -width Fl -compact 736.It Pa named/ 737writable by the 738.Dq bind 739user; see 740.Xr named 8 741.It Pa ppp/ 742writable by the 743.Dq network 744group for command connection sockets; see 745.Xr ppp 8 746.It Pa utmp 747database of current users; 748see 749.Xr utmp 5 750.El 751.Pp 752.It Pa rwho/ 753rwho data files; 754see 755.Xr rwhod 8 , 756.Xr rwho 1 , 757and 758.Xr ruptime 1 759.It Pa spool/ 760misc. printer and mail system spooling directories 761.Pp 762.Bl -tag -width Fl -compact 763.It Pa clientmqueue/ 764undelivered submission mail queue; 765see 766.Xr sendmail 8 767.It Pa ftp/ 768commonly ~ftp; the anonymous ftp root directory 769.It Pa mqueue/ 770undelivered mail queue; 771see 772.Xr sendmail 8 773.It Pa output/ 774line printer spooling directories 775.El 776.Pp 777.It Pa tmp/ 778temporary files that are kept between system reboots 779.Bl -tag -width Fl -compact 780.It Pa vi.recover/ 781the directory where recovery files are stored 782.El 783.It Pa yp/ 784the NIS maps 785.El 786.El 787.Sh NOTES 788This manual page documents the default 789.Fx 790file system layout, but 791the actual hierarchy on a given system is defined at the system 792administrator's discretion. 793A well-maintained installation will include a customized version of 794this document. 795.Sh SEE ALSO 796.Xr apropos 1 , 797.Xr find 1 , 798.Xr finger 1 , 799.Xr grep 1 , 800.Xr ls 1 , 801.Xr whatis 1 , 802.Xr whereis 1 , 803.Xr which 1 , 804.Xr fsck 8 805.Sh HISTORY 806A 807.Nm 808manual page appeared in 809.At v7 . 810