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