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