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.Bl -tag -width ".Pa legal/" -compact 424.It Pa legal/ 425License files for vendor supplied firmware 426.El 427.Pp 428.It Pa examples/ 429various examples for users and programmers 430.It Pa games/ 431ASCII text files used by various games 432.It Pa groff_font/ 433device description file for device name 434.It Pa i18n/ 435internationalization databases; see 436.Xr iconv 3 437.It Pa info/ 438GNU Info hypertext system 439.It Pa libg++/ 440libg++'s genclass prototype/template class files 441.It Pa locale/ 442localization files; 443see 444.Xr setlocale 3 445.It Pa man/ 446manual pages 447.It Pa me/ 448macros for use with the me macro package; 449see 450.Xr me 7 451.It Pa misc/ 452misc system-wide ASCII text files 453.Pp 454.Bl -tag -width ".Pa termcap" -compact 455.It Pa termcap 456terminal characteristics database; 457see 458.Xr termcap 5 459.El 460.Pp 461.It Pa mk/ 462templates for make; 463see 464.Xr make 1 465.It Pa nls/ 466national language support files; 467see 468.Xr mklocale 1 469.It Pa openssl/ 470.Pp 471.Bl -tag -width ".Pa man/" -compact 472.It Pa man/ 473OpenSSL manual pages 474.El 475.Pp 476.It Pa sendmail/ 477sendmail configuration files; 478see 479.Xr sendmail 8 480.It Pa skel/ 481example . (dot) files for new accounts 482.It Pa syscons/ 483files used by 484.Xr syscons 4 485.Pp 486.Bl -tag -width ".Pa scrnmaps/" -compact 487.It Pa fonts/ 488console fonts; 489see 490.Xr vidcontrol 1 491and 492.Xr vidfont 1 493.It Pa keymaps/ 494console keyboard maps; 495see 496.Xr kbdcontrol 1 497and 498.Xr kbdmap 1 499.It Pa scrnmaps/ 500console screen maps 501.El 502.Pp 503.It Pa tabset/ 504tab description files for a variety of terminals; used in 505the termcap file; 506see 507.Xr termcap 5 508.It Pa terminfo/ 509compiled 510.Xr terminfo 5 511database files 512.It Pa tmac/ 513text processing macros; 514see 515.Xr nroff 1 516and 517.Xr troff 1 518.It Pa vi/ 519localization support and utilities for 520.Xr vi 1 521.It Pa zoneinfo/ 522timezone configuration information; 523see 524.Xr tzfile 5 525.El 526.Pp 527.It Pa src/ 528.Bx , 529third-party, and/or local source files 530.Pp 531.Bl -tag -width ".Pa nrelease/" -compact 532.It Pa bin/ 533source code for files in 534.Pa /bin 535.It Pa contrib/ 536source code for contributed software 537.It Pa crypto/ 538source code for contributed cryptography software 539.It Pa etc/ 540source code for files in 541.Pa /etc 542.It Pa games/ 543source code for files in 544.Pa /usr/games 545.It Pa gnu/ 546Utilities covered by the GNU General Public License 547.It Pa include/ 548source code for files in 549.Pa /usr/include 550.It Pa lib/ 551source code for files in 552.Pa /usr/lib 553.It Pa libexec/ 554source code for files in 555.Pa /usr/libexec 556.It Pa nrelease/ 557files required to produce a 558.Dx 559release 560.It Pa sbin/ 561source code for files in 562.Pa /sbin 563.It Pa secure/ 564build directory for files in 565.Pa /usr/src/crypto 566.It Pa share/ 567source for files in 568.Pa /usr/share 569.It Pa sys/ 570kernel source code 571.It Pa tools/ 572tools used for maintenance and testing of 573.Dx 574.It Pa usr.bin/ 575source code for files in 576.Pa /usr/bin 577.It Pa usr.sbin/ 578source code for files in 579.Pa /usr/sbin 580.El 581.El 582.It Pa /var/ 583multi-purpose log, temporary, transient, and spool files 584.Pp 585.Bl -tag -width ".Pa preserve/" -compact 586.It Pa account/ 587system accounting files 588.Pp 589.Bl -tag -width ".Pa acct" -compact 590.It Pa acct 591execution accounting file; 592see 593.Xr acct 5 594.El 595.Pp 596.It Pa at/ 597timed command scheduling files; 598see 599.Xr \&at 1 600.Pp 601.Bl -tag -width ".Pa spool/" -compact 602.It Pa jobs/ 603directory containing job files 604.It Pa spool/ 605directory containing output spool files 606.El 607.Pp 608.It Pa backups/ 609misc. backup files 610.It Pa crash/ 611default directory to store kernel crash dumps; see 612.Xr crash 8 613and 614.Xr savecore 8 615.It Pa cron/ 616files used by cron; 617see 618.Xr cron 8 619.Pp 620.Bl -tag -width ".Pa tabs/" -compact 621.It Pa tabs/ 622crontab files; 623see 624.Xr crontab 5 625.El 626.Pp 627.It Pa db/ 628misc. automatically generated system-specific database files 629.It Pa empty/ 630empty directory used by 631.Xr sshd 8 632for privilege separation 633.It Pa games/ 634misc. game status and score files 635.It Pa hammer/ 636per PFS (pseudo file system) snapshots directory for 637.Xr hammer 5 638file systems 639.It Pa log/ 640misc. system log files 641.Pp 642.Bl -tag -width ".Pa wtmp" -compact 643.It Pa wtmp 644login/logout log; 645see 646.Xr wtmp 5 647.El 648.Pp 649.It Pa mail/ 650user mailbox files 651.It Pa msgs/ 652system messages database; 653see 654.Xr msgs 1 655.It Pa preserve/ 656temporary home of files preserved after an accidental death 657of an editor; 658see 659.Xr \&ex 1 660.It Pa quotas/ 661filesystem quota information files 662.It Pa run/ 663system information files describing various info about 664system since it was booted 665.Pp 666.Bl -tag -width ".Pa ppp/" -compact 667.It Pa ppp/ 668writable by the 669.Dq network 670group for command connection sockets; see 671.Xr ppp 8 672.It Pa utmp 673database of current users; 674see 675.Xr utmp 5 676.El 677.Pp 678.It Pa rwho/ 679rwho data files; 680see 681.Xr rwhod 8 , 682.Xr rwho 1 , 683and 684.Xr ruptime 1 685.It Pa spool/ 686misc. printer and mail system spooling directories 687.Pp 688.Bl -tag -width ".Pa clientmqueue/" -compact 689.It Pa clientmqueue/ 690undelivered submission mail queue; 691see 692.Xr sendmail 8 693.It Pa dma/ 694undelivered mail queue; 695see 696.Xr dma 8 697.It Pa ftp/ 698commonly 699.Pa ~ftp ; 700the anonymous ftp root directory 701.It Pa mqueue/ 702undelivered mail queue; 703see 704.Xr sendmail 8 705.It Pa output/ 706line printer spooling directories 707.It Pa uucp/ 708uucp spool directory 709.It Pa uucppublic/ 710commonly 711.Pa ~uucp ; 712public uucp temporary directory 713.El 714.Pp 715.It Pa tmp/ 716temporary files that are kept between system reboots 717.Pp 718.Bl -tag -width ".Pa vi.recover/" -compact 719.It Pa vi.recover/ 720the directory where recovery files are stored 721.El 722.Pp 723.It Pa yp/ 724the NIS maps 725.El 726.El 727.Sh NOTES 728This manual page documents the default 729.Dx 730filesystem layout, but 731the actual hierarchy on a given system is defined at the system 732administrator's discretion. 733A well-maintained installation will include a customized version of 734this document. 735.Sh SEE ALSO 736.Xr apropos 1 , 737.Xr find 1 , 738.Xr finger 1 , 739.Xr grep 1 , 740.Xr ls 1 , 741.Xr whatis 1 , 742.Xr whereis 1 , 743.Xr which 1 , 744.Xr fsck 8 745.Sh HISTORY 746A 747.Nm 748manual page appeared in 749.At v7 . 750