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 September 11, 2012 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 lint/" -compact 300.It Pa lint/ 301various prebuilt lint libraries; 302see 303.Xr lint 1 304.El 305.Pp 306.It Pa libexec/ 307system daemons & system utilities (executed by other programs) 308.Pp 309.Bl -tag -width ".Pa binutils221/" -compact 310.It Pa binutils221/ 311.Pp 312.Bl -tag -width ".Pa ldscripts/" -compact 313.It Pa ldscripts/ 314linker scripts; 315see 316.Xr ld 1 317.El 318.Pp 319.It Pa binutils222/ 320.Pp 321.Bl -tag -width ".Pa ldscripts/" -compact 322.It Pa ldscripts/ 323linker scripts; 324see 325.Xr ld 1 326.El 327.Pp 328.It Pa lpr/ 329utilities and filters for LP print system; 330see 331.Xr lpr 1 332.It Pa sendmail/ 333the sendmail binary; 334see 335.Xr mailwrapper 8 336and 337.Xr sendmail 8 338.It Pa sm.bin/ 339restricted shell for sendmail; 340see 341.Xr smrsh 8 342.It Pa uucp/ 343uucp utilities; 344see 345.Xr uucp 1 346.El 347.Pp 348.It Pa local/ 349local executables, libraries, etc. 350Within 351.Pa local/ , 352the general layout sketched out by 353.Xr hier 7 354for 355.Pa /usr 356should be used. 357Exceptions are the 358.Pa man/ 359directory (directly under 360.Pa local/ 361rather than under 362.Pa local/share/ ) , 363documentation (in 364.Pa share/doc/<app>/ ) , 365and 366.Pa /usr/local/etc 367.Pf ( mimics 368.Pa /etc ) . 369.It Pa obj/ 370architecture-specific target tree produced by building the 371.Pa /usr/src 372tree 373.It Pa pkg/ 374default destination directory for the 375.Xr pkgsrc 7 376collection. 377Within 378.Pa pkg/ , 379the general layout sketched out by 380.Xr hier 7 381for 382.Pa /usr 383should be used. 384Exceptions are the 385.Pa man/ 386directory (directly under 387.Pa pkg/ 388rather than under 389.Pa pkg/share/ ) , 390documentation (in 391.Pa share/doc/<pkg>/ ) , 392and 393.Pa /usr/pkg/etc 394.Pf ( mimics 395.Pa /etc ) . 396.It Pa pkgsrc/ 397The 398.Xr pkgsrc 7 399collection (optional). 400.It Pa sbin/ 401system daemons & system utilities (executed by users) 402.It Pa share/ 403architecture-independent files 404.Pp 405.Bl -tag -width ".Pa groff_font/" -compact 406.It Pa calendar/ 407a variety of pre-fab calendar files; 408see 409.Xr calendar 1 410.It Pa dict/ 411word lists; 412see 413.Xr look 1 414.Pp 415.Bl -tag -width ".Pa papers/" -compact 416.It Pa web2 417words from Webster's 2nd International 418.It Pa words 419common words 420.It Pa papers/ 421reference databases; 422see 423.Xr refer 1 424.El 425.Pp 426.It Pa doc/ 427miscellaneous documentation 428.Bl -tag -width ".Pa legal/" -compact 429.It Pa legal/ 430License files for vendor supplied firmware 431.El 432.Pp 433.It Pa examples/ 434various examples for users and programmers 435.It Pa games/ 436ASCII text files used by various games 437.It Pa groff_font/ 438device description file for device name 439.It Pa i18n/ 440internationalization databases; see 441.Xr iconv 3 442.It Pa info/ 443GNU Info hypertext system 444.It Pa libg++/ 445libg++'s genclass prototype/template class files 446.It Pa locale/ 447localization files; 448see 449.Xr setlocale 3 450.It Pa man/ 451manual pages 452.It Pa me/ 453macros for use with the me macro package; 454see 455.Xr me 7 456.It Pa misc/ 457misc system-wide ASCII text files 458.Pp 459.Bl -tag -width ".Pa termcap" -compact 460.It Pa termcap 461terminal characteristics database; 462see 463.Xr termcap 5 464.El 465.Pp 466.It Pa mk/ 467templates for make; 468see 469.Xr make 1 470.It Pa nls/ 471national language support files; 472see 473.Xr mklocale 1 474.It Pa openssl/ 475.Pp 476.Bl -tag -width ".Pa man/" -compact 477.It Pa man/ 478OpenSSL manual pages 479.El 480.Pp 481.It Pa sendmail/ 482sendmail configuration files; 483see 484.Xr sendmail 8 485.It Pa skel/ 486example . (dot) files for new accounts 487.It Pa syscons/ 488files used by 489.Xr syscons 4 490.Pp 491.Bl -tag -width ".Pa scrnmaps/" -compact 492.It Pa fonts/ 493console fonts; 494see 495.Xr vidcontrol 1 496and 497.Xr vidfont 1 498.It Pa keymaps/ 499console keyboard maps; 500see 501.Xr kbdcontrol 1 502and 503.Xr kbdmap 1 504.It Pa scrnmaps/ 505console screen maps 506.El 507.Pp 508.It Pa tabset/ 509tab description files for a variety of terminals; used in 510the termcap file; 511see 512.Xr termcap 5 513.It Pa terminfo/ 514compiled 515.Xr terminfo 5 516database files 517.It Pa tmac/ 518text processing macros; 519see 520.Xr nroff 1 521and 522.Xr troff 1 523.It Pa vi/ 524localization support and utilities for 525.Xr vi 1 526.It Pa zoneinfo/ 527timezone configuration information; 528see 529.Xr tzfile 5 530.El 531.Pp 532.It Pa src/ 533.Bx , 534third-party, and/or local source files 535.Pp 536.Bl -tag -width ".Pa nrelease/" -compact 537.It Pa bin/ 538source code for files in 539.Pa /bin 540.It Pa contrib/ 541source code for contributed software 542.It Pa crypto/ 543source code for contributed cryptography software 544.It Pa etc/ 545source code for files in 546.Pa /etc 547.It Pa games/ 548source code for files in 549.Pa /usr/games 550.It Pa gnu/ 551Utilities covered by the GNU General Public License 552.It Pa include/ 553source code for files in 554.Pa /usr/include 555.It Pa lib/ 556source code for files in 557.Pa /usr/lib 558.It Pa libexec/ 559source code for files in 560.Pa /usr/libexec 561.It Pa nrelease/ 562files required to produce a 563.Dx 564release 565.It Pa sbin/ 566source code for files in 567.Pa /sbin 568.It Pa secure/ 569build directory for files in 570.Pa /usr/src/crypto 571.It Pa share/ 572source for files in 573.Pa /usr/share 574.It Pa sys/ 575kernel source code 576.It Pa tools/ 577tools used for maintenance and testing of 578.Dx 579.It Pa usr.bin/ 580source code for files in 581.Pa /usr/bin 582.It Pa usr.sbin/ 583source code for files in 584.Pa /usr/sbin 585.El 586.El 587.It Pa /var/ 588multi-purpose log, temporary, transient, and spool files 589.Pp 590.Bl -tag -width ".Pa preserve/" -compact 591.It Pa account/ 592system accounting files 593.Pp 594.Bl -tag -width ".Pa acct" -compact 595.It Pa acct 596execution accounting file; 597see 598.Xr acct 5 599.El 600.Pp 601.It Pa at/ 602timed command scheduling files; 603see 604.Xr \&at 1 605.Pp 606.Bl -tag -width ".Pa spool/" -compact 607.It Pa jobs/ 608directory containing job files 609.It Pa spool/ 610directory containing output spool files 611.El 612.Pp 613.It Pa backups/ 614misc. backup files 615.It Pa crash/ 616default directory to store kernel crash dumps; see 617.Xr crash 8 618and 619.Xr savecore 8 620.It Pa cron/ 621files used by cron; 622see 623.Xr cron 8 624.Pp 625.Bl -tag -width ".Pa tabs/" -compact 626.It Pa tabs/ 627crontab files; 628see 629.Xr crontab 5 630.El 631.Pp 632.It Pa db/ 633misc. automatically generated system-specific database files 634.It Pa empty/ 635empty directory used by 636.Xr sshd 8 637for privilege separation 638.It Pa games/ 639misc. game status and score files 640.It Pa hammer/ 641per PFS (pseudo file system) snapshots directory for 642.Xr hammer 5 643file systems 644.It Pa log/ 645misc. system log files 646.Pp 647.Bl -tag -width ".Pa wtmp" -compact 648.It Pa wtmp 649login/logout log; 650see 651.Xr wtmp 5 652.El 653.Pp 654.It Pa mail/ 655user mailbox files 656.It Pa msgs/ 657system messages database; 658see 659.Xr msgs 1 660.It Pa preserve/ 661temporary home of files preserved after an accidental death 662of an editor; 663see 664.Xr \&ex 1 665.It Pa quotas/ 666filesystem quota information files 667.It Pa run/ 668system information files describing various info about 669system since it was booted 670.Pp 671.Bl -tag -width ".Pa ppp/" -compact 672.It Pa ppp/ 673writable by the 674.Dq network 675group for command connection sockets; see 676.Xr ppp 8 677.It Pa utmp 678database of current users; 679see 680.Xr utmp 5 681.El 682.Pp 683.It Pa rwho/ 684rwho data files; 685see 686.Xr rwhod 8 , 687.Xr rwho 1 , 688and 689.Xr ruptime 1 690.It Pa spool/ 691misc. printer and mail system spooling directories 692.Pp 693.Bl -tag -width ".Pa clientmqueue/" -compact 694.It Pa clientmqueue/ 695undelivered submission mail queue; 696see 697.Xr sendmail 8 698.It Pa dma/ 699undelivered mail queue; 700see 701.Xr dma 8 702.It Pa ftp/ 703commonly 704.Pa ~ftp ; 705the anonymous ftp root directory 706.It Pa mqueue/ 707undelivered mail queue; 708see 709.Xr sendmail 8 710.It Pa output/ 711line printer spooling directories 712.It Pa uucp/ 713uucp spool directory 714.It Pa uucppublic/ 715commonly 716.Pa ~uucp ; 717public uucp temporary directory 718.El 719.Pp 720.It Pa tmp/ 721temporary files that are kept between system reboots 722.Pp 723.Bl -tag -width ".Pa vi.recover/" -compact 724.It Pa vi.recover/ 725the directory where recovery files are stored 726.El 727.Pp 728.It Pa yp/ 729the NIS maps 730.El 731.El 732.Sh NOTES 733This manual page documents the default 734.Dx 735filesystem layout, but 736the actual hierarchy on a given system is defined at the system 737administrator's discretion. 738A well-maintained installation will include a customized version of 739this document. 740.Sh SEE ALSO 741.Xr apropos 1 , 742.Xr find 1 , 743.Xr finger 1 , 744.Xr grep 1 , 745.Xr ls 1 , 746.Xr whatis 1 , 747.Xr whereis 1 , 748.Xr which 1 , 749.Xr fsck 8 750.Sh HISTORY 751A 752.Nm 753manual page appeared in 754.At v7 . 755