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: src/share/man/man7/hier.7,v 1.29.2.17 2003/01/13 21:43:50 ceri Exp $ 34.\" 35.Dd November 26, 2011 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 ".Pa /modules/" 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 ".Pa 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/ 59loadable kernel modules; 60see 61.Xr kldstat 8 62.El 63.It Pa /dev/ 64block and character device files 65.Pp 66.Bl -tag -width ".Pa fd/" -compact 67.It Pa fd/ 68file descriptor files; 69see 70.Xr \&fd 4 71.El 72.It Pa /etc/ 73system configuration files and scripts 74.Pp 75.Bl -tag -width ".Pa bluetooth/" -compact 76.It Pa bluetooth/ 77bluetooth configuration files 78.It Pa defaults/ 79default system configuration files; 80see 81.Xr rc 8 82.It Pa dma/ 83.Xr dma 8 84configuration files 85.\".It Pa firmware/ 86.\"Firmware image files; 87.\"see 88.\".Xr firmware 9 89.It Pa localtime 90local timezone information; 91see 92.Xr ctime 3 93.It Pa mail/ 94Sendmail control files 95.It Pa mtree/ 96mtree configuration files; 97see 98.Xr mtree 8 99.It Pa pam.d/ 100configuration files for the Pluggable Authentication Modules (PAM) 101library 102.It Pa periodic/ 103scripts that are run daily, weekly, and monthly, via 104.Xr cron 8 ; 105see 106.Xr periodic 8 107.It Pa ppp/ 108ppp configuration files; 109see 110.Xr ppp 8 111.It Pa rc.d/ 112System and daemon startup/control scripts; 113see 114.Xr rc 8 115.It Pa ssh/ 116OpenSSH configuration files; 117see 118.Xr ssh 1 119.It Pa ssl/ 120OpenSSL configuration files 121.It Pa upgrade/ 122Files relevant to system upgrades 123.It Pa uucp/ 124uucp configuration files; 125see 126.Xr uucp 1 127.El 128.It Pa /home/ 129HOME directories of non-root users 130.It Pa /mnt/ 131empty directory commonly used by 132system administrators as a temporary mount point 133.It Pa /pfs/ 134pseudo file system directory (on 135.Xr hammer 5 136root file systems) 137.It Pa /proc/ 138process file system; 139see 140.Xr procfs 5 , 141.Xr mount_procfs 8 142.It Pa /root/ 143root's HOME directory 144.It Pa /sbin/ 145system programs and administration utilities 146fundamental to both single-user and multi-user environments 147.It Pa /sys/ 148the kernel's source code (usually a symbolic link to 149.Pa /usr/src/sys ) 150.It Pa /tmp/ 151temporary files that are not guaranteed to persist across system reboots 152.It Pa /usr/ 153contains the majority of user utilities and applications 154.Pp 155.Bl -tag -width ".Pa libdata/" -compact 156.It Pa bin/ 157common utilities, programming tools, and applications 158.It Pa games/ 159useful and semi-frivolous programs 160.It Pa include/ 161standard C include files 162.Pp 163.Bl -tag -width ".Pa libmilter/" -compact 164.It Pa arpa/ 165C include files for Internet service protocols 166.It Pa c++/ 167C++ include files 168.It Pa cam/ 169C include files for the Common Access Methods Layer 170.Pp 171.Bl -tag -width ".Pa scsi/" -compact 172.It Pa scsi/ 173The SCSI device on top of CAM 174.El 175.Pp 176.It Pa dev/ 177C include files for programming various 178.Dx 179devices 180.It Pa emulation/ 181Include Files for various emulation layers 182.It Pa fs/ 183.Pp 184.Bl -tag -width ".Pa smbfs/" -compact 185.It Pa smbfs/ 186SMB/CIFS filesystem 187.El 188.Pp 189.It Pa isofs/ 190.Pp 191.Bl -tag -width ".Pa cd9660/" -compact 192.It Pa cd9660/ 193iso9660 filesystem 194.El 195.Pp 196.It Pa libmilter/ 197C include files for libmilter, 198the sendmail mail filter API 199.It Pa libprop/ 200C include files for libprop 201.It Pa machine/ 202machine-specific C include files 203.It Pa msdosfs/ 204MS-DOS file system 205.It Pa net/ 206misc network C include files 207.It Pa netatm/ 208ATM include files; 209see 210.Xr atm 8 211.It Pa netinet/ 212C include files for Internet standard protocols; 213see 214.Xr inet 4 215.It Pa netinet6/ 216C include files for Internet protocol version 6; 217see 218.Xr inet6 4 219.It Pa netipx/ 220IPX/SPX protocol stacks 221.It Pa netkey/ 222kernel key-management service 223.It Pa netnatm/ 224NATM include files; 225see 226.Xr natm 4 227.It Pa netsmb/ 228SMB/CIFS requester 229.It Pa nfs/ 230C include files for NFS (Network File System) 231.It Pa objc/ 232Objective C include files 233.It Pa openssl/ 234OpenSSL (Cryptography/SSL toolkit) headers 235.It Pa pcap/ 236Packet Capture (libpcap) headers; 237see 238.Xr pcap 3 239.It Pa pccard/ 240PC-CARD controllers 241.It Pa protocols/ 242C include files for Berkeley service protocols 243.It Pa readline/ 244get a line from a user, with editing; 245see 246.Xr readline 3 247.It Pa rpc/ 248remote procedure calls; 249see 250.Xr rpc 3 251.It Pa rpcsvc/ 252definition of RPC service structures; see 253.Xr rpc 3 254.It Pa security/ 255PAM; see 256.Xr pam 8 257.It Pa sys/ 258system C include files (kernel data structures) 259.It Pa ufs/ 260C include files for UFS (The U-word File System) 261.Pp 262.Bl -tag -width ".Pa ffs/" -compact 263.It Pa ffs/ 264Fast filesystem 265.It Pa mfs/ 266memory file system; 267see 268.Xr mount_mfs 8 269.It Pa ufs/ 270UFS filesystem 271.El 272.Pp 273.It Pa vm/ 274virtual memory; 275see 276.Xr vmstat 8 277.El 278.Pp 279.It Pa lib/ 280archive libraries 281.Pp 282.Bl -tag -width ".Pa compat/" -compact 283.It Pa aout/ 284a.out archive libraries 285.It Pa compat/ 286shared libraries for compatibility 287.Pp 288.Bl -tag -width ".Pa aout/" -compact 289.It Pa aout/ 290a.out backward compatibility libraries 291.El 292.It Pa engines/ 293OpenSSL dynamic engines 294.El 295.Pp 296.It Pa libdata/ 297misc. utility data files 298.Pp 299.Bl -tag -width ".Pa stallion/" -compact 300.It Pa doscmd/ 301files used by doscmd (drivers, fonts, etc.); 302see 303.Xr doscmd 1 304.Pp 305.Bl -tag -width ".Pa fonts/" -compact 306.It Pa fonts/ 307fonts used by doscmd 308.El 309.Pp 310.It Pa lint/ 311various prebuilt lint libraries; 312see 313.Xr lint 1 314.It Pa stallion/ 315holds the download firmware images 316.El 317.Pp 318.It Pa libexec/ 319system daemons & system utilities (executed by other programs) 320.Pp 321.It Pa binutils221/ 322.Pp 323.Bl -tag -width ".Pa ldscripts/" -compact 324.It Pa ldscripts/ 325linker scripts; 326see 327.Xr ld 1 328.El 329.Pp 330.It Pa binutils222/ 331.Pp 332.Bl -tag -width ".Pa ldscripts/" -compact 333.It Pa ldscripts/ 334linker scripts; 335see 336.Xr ld 1 337.El 338.Pp 339.It Pa lpr/ 340utilities and filters for LP print system; 341see 342.Xr lpr 1 343.It Pa sendmail/ 344the sendmail binary; 345see 346.Xr mailwrapper 8 347and 348.Xr sendmail 8 349.It Pa sm.bin/ 350restricted shell for sendmail; 351see 352.Xr smrsh 8 353.It Pa uucp/ 354uucp utilities; 355see 356.Xr uucp 1 357.El 358.Pp 359.It Pa local/ 360local executables, libraries, etc. 361Within 362.Pa local/ , 363the general layout sketched out by 364.Xr hier 7 365for 366.Pa /usr 367should be used. 368Exceptions are the 369.Pa man/ 370directory (directly under 371.Pa local/ 372rather than under 373.Pa local/share/ ) , 374documentation (in 375.Pa share/doc/<app>/ ) , 376and 377.Pa /usr/local/etc 378.Pf ( mimics 379.Pa /etc ) . 380.It Pa obj/ 381architecture-specific target tree produced by building the 382.Pa /usr/src 383tree 384.It Pa pkg/ 385default destination directory for the 386.Xr pkgsrc 7 387collection. 388Within 389.Pa pkg/ , 390the general layout sketched out by 391.Xr hier 7 392for 393.Pa /usr 394should be used. 395Exceptions are the 396.Pa man/ 397directory (directly under 398.Pa pkg/ 399rather than under 400.Pa pkg/share/ ) , 401documentation (in 402.Pa share/doc/<pkg>/ ) , 403and 404.Pa /usr/pkg/etc 405.Pf ( mimics 406.Pa /etc ) . 407.It Pa pkgsrc/ 408The 409.Xr pkgsrc 7 410collection (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 ".Pa groff_font/" -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 ".Pa papers/" -compact 427.It Pa web2 428words from Webster's 2nd International 429.It Pa words 430common words 431.It Pa papers/ 432reference databases; 433see 434.Xr refer 1 435.El 436.Pp 437.It Pa doc/ 438miscellaneous documentation 439.Bl -tag -width ".Pa legal/" -compact 440.It Pa legal/ 441License files for vendor supplied firmwares 442.El 443.Pp 444.It Pa examples/ 445various examples for users and programmers 446.It Pa games/ 447ASCII text files used by various games 448.It Pa groff_font/ 449device description file for device name 450.It Pa i18n/ 451internationalization databases; see 452.Xr iconv 3 453.It Pa info/ 454GNU Info hypertext system 455.It Pa libg++/ 456libg++'s genclass prototype/template class files 457.It Pa locale/ 458localization files; 459see 460.Xr setlocale 3 461.It Pa man/ 462manual pages 463.It Pa me/ 464macros for use with the me macro package; 465see 466.Xr me 7 467.It Pa misc/ 468misc system-wide ASCII text files 469.Pp 470.Bl -tag -width ".Pa termcap" -compact 471.It Pa termcap 472terminal characteristics database; 473see 474.Xr termcap 5 475.El 476.Pp 477.It Pa mk/ 478templates for make; 479see 480.Xr make 1 481.It Pa nls/ 482national language support files; 483see 484.Xr mklocale 1 485.It Pa openssl/ 486.Pp 487.Bl -tag -width ".Pa man/" -compact 488.It Pa man/ 489OpenSSL manual pages 490.El 491.Pp 492.It Pa sendmail/ 493sendmail configuration files; 494see 495.Xr sendmail 8 496.It Pa skel/ 497example . (dot) files for new accounts 498.It Pa syscons/ 499files used by 500.Xr syscons 4 501.Pp 502.Bl -tag -width ".Pa scrnmaps/" -compact 503.It Pa fonts/ 504console fonts; 505see 506.Xr vidcontrol 1 507and 508.Xr vidfont 1 509.It Pa keymaps/ 510console keyboard maps; 511see 512.Xr kbdcontrol 1 513and 514.Xr kbdmap 1 515.It Pa scrnmaps/ 516console screen maps 517.El 518.Pp 519.It Pa tabset/ 520tab description files for a variety of terminals; used in 521the termcap file; 522see 523.Xr termcap 5 524.It Pa tmac/ 525text processing macros; 526see 527.Xr nroff 1 528and 529.Xr troff 1 530.It Pa vi/ 531localization support and utilities for 532.Xr vi 1 533.It Pa zoneinfo/ 534timezone configuration information; 535see 536.Xr tzfile 5 537.El 538.Pp 539.It Pa src/ 540.Bx , 541third-party, and/or local source files 542.Pp 543.Bl -tag -width ".Pa nrelease/" -compact 544.It Pa bin/ 545source code for files in 546.Pa /bin 547.It Pa contrib/ 548source code for contributed software 549.It Pa crypto/ 550source code for contributed cryptography software 551.It Pa etc/ 552source code for files in 553.Pa /etc 554.It Pa games/ 555source code for files in 556.Pa /usr/games 557.It Pa gnu/ 558Utilities covered by the GNU General Public License 559.It Pa include/ 560source code for files in 561.Pa /usr/include 562.It Pa lib/ 563source code for files in 564.Pa /usr/lib 565.It Pa libexec/ 566source code for files in 567.Pa /usr/libexec 568.It Pa nrelease/ 569files required to produce a 570.Dx 571release 572.It Pa sbin/ 573source code for files in 574.Pa /sbin 575.It Pa secure/ 576build directory for files in 577.Pa /usr/src/crypto 578.It Pa share/ 579source for files in 580.Pa /usr/share 581.It Pa sys/ 582kernel source code 583.It Pa tools/ 584tools used for maintenance and testing of 585.Dx 586.It Pa usr.bin/ 587source code for files in 588.Pa /usr/bin 589.It Pa usr.sbin/ 590source code for files in 591.Pa /usr/sbin 592.El 593.El 594.It Pa /var/ 595multi-purpose log, temporary, transient, and spool files 596.Pp 597.Bl -tag -width ".Pa preserve/" -compact 598.It Pa account/ 599system accounting files 600.Pp 601.Bl -tag -width ".Pa acct" -compact 602.It Pa acct 603execution accounting file; 604see 605.Xr acct 5 606.El 607.Pp 608.It Pa at/ 609timed command scheduling files; 610see 611.Xr \&at 1 612.Pp 613.Bl -tag -width ".Pa spool/" -compact 614.It Pa jobs/ 615directory containing job files 616.It Pa spool/ 617directory containing output spool files 618.El 619.Pp 620.It Pa backups/ 621misc. backup files 622.It Pa crash/ 623default directory to store kernel crash dumps; see 624.Xr crash 8 625and 626.Xr savecore 8 627.It Pa cron/ 628files used by cron; 629see 630.Xr cron 8 631.Pp 632.Bl -tag -width ".Pa tabs/" -compact 633.It Pa tabs/ 634crontab files; 635see 636.Xr crontab 5 637.El 638.Pp 639.It Pa db/ 640misc. automatically generated system-specific database files 641.It Pa empty/ 642empty directory used by 643.Xr sshd 8 644for privilege separation 645.It Pa games/ 646misc. game status and score files 647.It Pa hammer/ 648per PFS (pseudo file system) snapshots directory for 649.Xr hammer 5 650file systems 651.It Pa log/ 652misc. system log files 653.Pp 654.Bl -tag -width ".Pa wtmp" -compact 655.It Pa wtmp 656login/logout log; 657see 658.Xr wtmp 5 659.El 660.Pp 661.It Pa mail/ 662user mailbox files 663.It Pa msgs/ 664system messages database; 665see 666.Xr msgs 1 667.It Pa preserve/ 668temporary home of files preserved after an accidental death 669of an editor; 670see 671.Xr \&ex 1 672.It Pa quotas/ 673filesystem quota information files 674.It Pa run/ 675system information files describing various info about 676system since it was booted 677.Pp 678.Bl -tag -width ".Pa ppp/" -compact 679.It Pa ppp/ 680writable by the 681.Dq network 682group for command connection sockets; see 683.Xr ppp 8 684.It Pa utmp 685database of current users; 686see 687.Xr utmp 5 688.El 689.Pp 690.It Pa rwho/ 691rwho data files; 692see 693.Xr rwhod 8 , 694.Xr rwho 1 , 695and 696.Xr ruptime 1 697.It Pa spool/ 698misc. printer and mail system spooling directories 699.Pp 700.Bl -tag -width ".Pa clientmqueue/" -compact 701.It Pa clientmqueue/ 702undelivered submission mail queue; 703see 704.Xr sendmail 8 705.It Pa dma/ 706undelivered mail queue; 707see 708.Xr dma 8 709.It Pa ftp/ 710commonly 711.Pa ~ftp ; 712the anonymous ftp root directory 713.It Pa mqueue/ 714undelivered mail queue; 715see 716.Xr sendmail 8 717.It Pa output/ 718line printer spooling directories 719.It Pa uucp/ 720uucp spool directory 721.It Pa uucppublic/ 722commonly 723.Pa ~uucp ; 724public uucp temporary directory 725.El 726.Pp 727.It Pa tmp/ 728temporary files that are kept between system reboots 729.Pp 730.Bl -tag -width ".Pa vi.recover/" -compact 731.It Pa vi.recover/ 732the directory where recovery files are stored 733.El 734.Pp 735.It Pa yp/ 736the NIS maps 737.El 738.El 739.Sh NOTES 740This manual page documents the default 741.Dx 742filesystem layout, but 743the actual hierarchy on a given system is defined at the system 744administrator's discretion. 745A well-maintained installation will include a customized version of 746this document. 747.Sh SEE ALSO 748.Xr apropos 1 , 749.Xr find 1 , 750.Xr finger 1 , 751.Xr grep 1 , 752.Xr ls 1 , 753.Xr whatis 1 , 754.Xr whereis 1 , 755.Xr which 1 , 756.Xr fsck 8 757.Sh HISTORY 758A 759.Nm 760manual page appeared in 761.At v7 . 762