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