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