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