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