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