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$ 34.\" 35.Dd January 21, 2010 36.Dt HIER 7 37.Os 38.Sh NAME 39.Nm hier 40.Nd layout of file systems 41.Sh DESCRIPTION 42A sketch of the file system hierarchy. 43.Bl -tag -width ".Pa /libexec/" 44.It Pa / 45root directory of the file system 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/ 59third-party loadable kernel modules; 60see 61.Xr kldstat 8 62.El 63.It Pa /cdrom/ 64default mount point for CD-ROM drives 65(created by 66.Xr sysinstall 8 ) 67.It Pa /compat/ 68normally a link to 69.Pa /usr/compat . 70If not, then the 71.Pa /usr/compat 72comments apply 73(created by 74.Xr sysinstall 8 ) 75.It Pa /dev/ 76device special files managed by 77.Xr devfs 5 78.Pp 79.Bl -tag -width ".Pa net/" -compact 80.It Pa fd/ 81file descriptor files; 82see 83.Xr \&fd 4 84.It Pa net/ 85network devices 86.El 87.It Pa /dist/ 88mount point used by 89.Xr sysinstall 8 90.It Pa /etc/ 91system configuration files and scripts 92.Pp 93.Bl -tag -width ".Pa bluetooth/" -compact 94.It Pa defaults/ 95default system configuration files; 96see 97.Xr rc 8 98.It Pa bluetooth/ 99bluetooth configuration files 100.It Pa gnats/ 101gnats configuration files; 102see 103.Xr send-pr 1 104.It Pa localtime 105local timezone information; 106see 107.Xr ctime 3 108.It Pa mail/ 109Sendmail control files 110.It Pa mtree/ 111mtree configuration files; 112see 113.Xr mtree 8 114.It Pa namedb/ 115named configuration files; 116see 117.Xr named 8 118.It Pa pam.d/ 119configuration files for the Pluggable Authentication Modules (PAM) 120library 121.It Pa periodic/ 122scripts that are run daily, weekly, and monthly, via 123.Xr cron 8 ; 124see 125.Xr periodic 8 126.It Pa rc.d/ 127System and daemon startup/control scripts; 128see 129.Xr rc 8 130.It Pa security/ 131OpenBSM audit configuration files; 132see 133.Xr audit 8 134.It Pa ppp/ 135ppp configuration files; 136see 137.Xr ppp 8 138.It Pa ssh/ 139OpenSSH configuration files; 140see 141.Xr ssh 1 142.It Pa ssl/ 143OpenSSL configuration files 144.El 145.It Pa /lib/ 146critical system libraries needed for binaries in 147.Pa /bin 148and 149.Pa /sbin 150.Pp 151.Bl -tag -width ".Pa geom/" -compact 152.It Pa geom/ 153class-specific libraries for the 154.Xr geom 8 155utility 156.El 157.It Pa /libexec/ 158critical system utilities needed for binaries in 159.Pa /bin 160and 161.Pa /sbin 162.It Pa /media/ 163contains subdirectories to be used as mount points 164for removable media such as CDs, USB drives, and 165floppy disks 166.It Pa /mnt/ 167empty directory commonly used by 168system administrators as a temporary mount point 169.It Pa /proc/ 170process file system; 171see 172.Xr procfs 5 173.It Pa /rescue/ 174statically linked programs for emergency recovery; 175see 176.Xr rescue 8 177.It Pa /root/ 178root's HOME directory 179.It Pa /sbin/ 180system programs and administration utilities 181fundamental to both single-user and multi-user environments 182.It Pa /tmp/ 183temporary files that are not guaranteed to persist across system reboots 184.It Pa /usr/ 185contains the majority of user utilities and applications 186.Pp 187.Bl -tag -width ".Pa libdata/" -compact 188.It Pa bin/ 189common utilities, programming tools, and applications 190.It Pa compat/ 191files needed to support binary compatibility with other operating systems, 192such as Linux 193(created by 194.Xr sysinstall 8 ) 195.It Pa games/ 196useful and semi-frivolous programs 197.It Pa include/ 198standard C include files 199.Pp 200.Bl -tag -width ".Pa kerberos5/" -compact 201.It Pa altq/ 202C include files for alternate queueing 203.It Pa arpa/ 204C include files for Internet service protocols 205.It Pa bsnmp/ 206C include files for the SNMP daemon 207.It Pa c++/ 208C++ include files 209.It Pa cam/ 210C include files for the Common Access Methods Layer 211.Bl -tag -width ".Pa kerberos5/" -compact 212.It Pa scsi/ 213The SCSI device on top of CAM 214.El 215.It Pa dev/ 216C include files for programming various 217.Fx 218devices 219.Bl -tag -width ".Pa kerberos5/" -compact 220.It Pa ic/ 221Various header files describing driver- and bus-independent 222hardware circuits 223.It Pa ofw/ 224Open Firmware support 225.It Pa pbio/ 2268255 PPI cards; 227see 228.Xr pbio 4 229.It Pa ppbus/ 230The parallel port bus; 231see 232.Xr ppbus 4 233.It Pa usb/ 234The USB subsystem 235.It Pa utopia/ 236Physical chip driver for ATM interfaces; 237see 238.Xr utopia 4 239.It Pa wi/ 240The 241.Xr wi 4 242WaveLAN driver 243.El 244.It Pa fs/ 245.Bl -tag -width ".Pa kerberos5/" -compact 246.It Pa fdescfs/ 247per-process file descriptors file system 248.It Pa fifofs/ 249.St -p1003.1 250FIFOs file system 251.It Pa msdosfs/ 252MS-DOS file system 253.It Pa nfs/ 254C include files for NFS (Network File System) version 2, 3 and 4 255.It Pa nullfs/ 256loopback file system 257.It Pa procfs/ 258process file system 259.It Pa smbfs/ 260SMB/CIFS file system 261.It Pa udf/ 262UDF file system 263.It Pa unionfs 264union file system 265.El 266.It Pa geom/ 267GEOM framework 268.Bl -tag -width ".Pa kerberos5/" -compact 269.It Pa concat/ 270CONCAT GEOM class 271.It Pa gate/ 272GATE GEOM class 273.It Pa mirror/ 274MIRROR GEOM class 275.It Pa nop/ 276NOP GEOM class 277.It Pa raid3/ 278RAID3 GEOM class 279.It Pa stripe/ 280STRIPE GEOM class 281.El 282.Pp 283.It Pa isc/ 284ISC utility library libisc include files 285.It Pa isofs/ 286.Bl -tag -width ".Pa kerberos5/" -compact 287.It Pa cd9660/ 288iso9660 file system 289.El 290.It Pa libmilter/ 291C include files for libmilter, 292the 293.Xr sendmail 8 294mail filter API 295.It Pa machine/ 296machine-specific C include files 297.It Pa net/ 298miscellaneous network C include files 299.It Pa netatalk/ 300Appletalk protocol 301.It Pa netinet/ 302C include files for Internet standard protocols; 303see 304.Xr inet 4 305.It Pa netinet6/ 306C include files for Internet protocol version 6; 307see 308.Xr inet6 4 309.It Pa netipsec/ 310kernel key-management service; 311see 312.Xr ipsec 4 313.It Pa netipx/ 314IPX/SPX protocol stacks 315.It Pa netnatm/ 316NATM include files; 317see 318.Xr natm 4 319.Bl -tag -width ".Pa kerberos5/" -compact 320.It Pa api/ 321include files for the signalling API 322.It Pa msg/ 323include files that describe signalling messages and 324declare associated functions 325.It Pa saal/ 326include files for the signalling AAL layer 327.It Pa sig/ 328include files for the UNI signalling protocol 329.El 330.It Pa netsmb/ 331SMB/CIFS requester 332.It Pa nfs/ 333C include files for NFS (Network File System) version 2 and 3 (legacy) 334.It Pa objc/ 335Objective C include files 336.It Pa openssl/ 337OpenSSL (Cryptography/SSL toolkit) headers 338.It Pa pccard/ 339PC-CARD controllers 340.It Pa protocols/ 341C include files for Berkeley service protocols 342.It Pa readline/ 343get a line from a user, with editing; 344see 345.Xr readline 3 346.It Pa rpc/ 347remote procedure calls; 348see 349.Xr rpc 3 350.It Pa rpcsvc/ 351definition of RPC service structures; see 352.Xr rpc 3 353.It Pa security/ 354PAM; see 355.Xr pam 8 356.It Pa sys/ 357system C include files (kernel data structures) 358.\" .It Pa tcl/ 359.\" Tcl language; 360.\" see 361.\" .Xr Tcl n 362.\" .Bl -tag -width ".Pa kerberos5/" -compact 363.\" .It Pa generic/ 364.\" ??? 365.\" .It Pa unix/ 366.\" ??? 367.\" .El 368.It Pa ufs/ 369C include files for UFS (The U-word File System) 370.Bl -tag -width ".Pa kerberos5/" -compact 371.It Pa ffs/ 372Fast file system 373.It Pa ufs/ 374UFS file system 375.El 376.It Pa vm/ 377virtual memory; 378see 379.Xr vmstat 8 380.El 381.Pp 382.It Pa lib/ 383shared and archive 384.Xr ar 1 Ns -type 385libraries 386.Bl -tag -width Fl -compact 387.It Pa aout/ 388a.out archive libraries 389.It Pa compat/ 390shared libraries for compatibility 391.Bl -tag -width Fl -compact 392.It Pa aout/ 393a.out backward compatibility libraries 394.El 395.It Pa dtrace/ 396DTrace library scripts 397.It Pa engines/ 398OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines 399.El 400.Pp 401.It Pa libdata/ 402miscellaneous utility data files 403.Bl -tag -width Fl -compact 404.It Pa gcc/ 405.Xr gcc 1 406configuration data 407.It Pa ldscripts/ 408linker scripts; 409see 410.Xr ld 1 411.It Pa lint/ 412various prebuilt lint libraries; 413see 414.Xr lint 1 415.El 416.Pp 417.It Pa libexec/ 418system daemons & system utilities (executed by other programs) 419.Bl -tag -width Fl -compact 420.It Pa aout/ 421utilities to manipulate a.out executables 422.It Pa elf/ 423utilities to manipulate ELF executables 424.It Pa lpr/ 425utilities and filters for LP print system; 426see 427.Xr lpr 1 428.It Pa sendmail/ 429the 430.Xr sendmail 8 431binary; 432see 433.Xr mailwrapper 8 434.It Pa sm.bin/ 435restricted shell for 436.Xr sendmail 8 ; 437see 438.Xr smrsh 8 439.El 440.Pp 441.It Pa local/ 442local executables, libraries, etc. 443Also used as the default destination for the 444.Fx 445ports framework. 446Within local/, the general layout sketched out by 447.Nm 448for /usr 449should be used. 450Exceptions are the man directory (directly under local/ 451rather than under local/share/), ports documentation (in share/doc/<port>/), 452and /usr/local/etc (mimics /etc). 453.It Pa obj/ 454architecture-specific target tree produced by building the /usr/src tree 455.It Pa ports/ 456The 457.Fx 458ports collection (optional). 459.It Pa sbin/ 460system daemons & system utilities (executed by users) 461.It Pa share/ 462architecture-independent files 463.Pp 464.Bl -tag -width ".Pa calendar/" -compact 465.It Pa calendar/ 466a variety of pre-fab calendar files; 467see 468.Xr calendar 1 469.It Pa dict/ 470word lists; 471see 472.Xr look 1 473.Pp 474.Bl -tag -width Fl -compact 475.It Pa freebsd 476.Fx Ns -specific 477terms, proper names, and jargon 478.It Pa words 479common words 480.It Pa web2 481words from Webster's 2nd International 482.It Pa papers/ 483reference databases; 484see 485.Xr refer 1 486.El 487.Pp 488.It Pa doc/ 489miscellaneous documentation; 490source for most of the printed 491.Bx 492manuals (available 493from the 494.Tn USENIX 495association) 496.Bl -tag -width Fl -compact 497.It Pa FAQ/ 498Frequently Asked Questions 499.It Pa IPv6/ 500implementation notes for IPv6 501.It Pa bind/ 502documents pertaining to BIND (the Berkeley Internet Name Domain) 503.It Pa es/ 504Spanish translations of documents in /usr/share/doc 505.It Pa handbook/ 506.Fx 507Handbook 508.It Pa ja/ 509Japanese translations of documents in /usr/share/doc 510.It Pa legal/ 511License files for vendor supplied firmwares 512.It Pa ncurses/ 513HTML documents pertaining to ncurses; 514see 515.Xr ncurses 3 516.It Pa ntp/ 517HTML documents pertaining to the Network Time Protocol 518.It Pa papers/ 519UNIX Papers 520.It Pa psd/ 521UNIX Programmer's Supplementary Documents 522.It Pa ru/ 523Russian translations of documents in /usr/share/doc 524.It Pa smm/ 525UNIX System Manager's Manual 526.It Pa tutorials/ 527.Fx 528tutorials 529.It Pa usd/ 530UNIX User's Supplementary Documents 531.It Pa zh/ 532Chinese translations of documents in /usr/share/doc 533.El 534.Pp 535.It Pa examples/ 536various examples for users and programmers 537.It Pa games/ 538ASCII text files used by various games 539.It Pa groff_font/ 540device description file for device name 541.It Pa info/ 542GNU Info hypertext system 543.It Pa locale/ 544localization files; 545see 546.Xr setlocale 3 547.It Pa man/ 548manual pages 549.It Pa me/ 550macros for use with the me macro package; 551see 552.Xr me 7 553.It Pa misc/ 554miscellaneous system-wide ASCII text files 555.Bl -tag -width Fl -compact 556.It Pa fonts/ 557??? 558.It Pa termcap 559terminal characteristics database; 560see 561.Xr termcap 5 562.El 563.It Pa mk/ 564templates for make; 565see 566.Xr make 1 567.It Pa nls/ 568national language support files; 569see 570.Xr mklocale 1 571.It Pa security/ 572data files for security policies such as 573.Xr mac_lomac 4 574.It Pa sendmail/ 575.Xr sendmail 8 576configuration files 577.It Pa skel/ 578example 579.Pa .\& 580(dot) files for new accounts 581.It Pa snmp/ 582MIBs, example files and tree definitions for the SNMP daemon. 583.Bl -tag -width Fl -compact 584.It Pa defs/ 585Tree definition files for use with 586.Xr gensnmptree 1 587.It Pa mibs/ 588MIB files 589.El 590.It Pa syscons/ 591files used by syscons; 592see 593.Xr syscons 4 594.Bl -tag -width ".Pa scrnmaps/" -compact 595.It Pa fonts/ 596console fonts; 597see 598.Xr vidcontrol 1 599and 600.Xr vidfont 1 601.It Pa keymaps/ 602console keyboard maps; 603see 604.Xr kbdcontrol 1 605and 606.Xr kbdmap 1 607.It Pa scrnmaps/ 608console screen maps 609.El 610.It Pa tabset/ 611tab description files for a variety of terminals; used in 612the termcap file; 613see 614.Xr termcap 5 615.It Pa tmac/ 616text processing macros; 617see 618.Xr nroff 1 619and 620.Xr troff 1 621.It Pa vi/ 622localization support and utilities for 623.Xr vi 1 624.It Pa zoneinfo/ 625timezone configuration information; 626see 627.Xr tzfile 5 628.El 629.It Pa src/ 630.Bx , 631third-party, and/or local source files 632.Pp 633.Bl -tag -width ".Pa kerberos5/" -compact 634.It Pa bin/ 635source code for files in /bin 636.It Pa cddl/ 637Utilities covered by the Common Development and Distribution License 638.It Pa contrib/ 639source code for contributed software 640.It Pa crypto/ 641source code for contributed cryptography software 642.It Pa etc/ 643source code for files in /etc 644.It Pa games/ 645source code for files in /usr/games 646.It Pa gnu/ 647Utilities covered by the GNU General Public License 648.It Pa include/ 649source code for files in /usr/include 650.It Pa kerberos5/ 651build infrastructure for kerberos version 5 652.It Pa lib/ 653source code for files in /usr/lib 654.It Pa libexec/ 655source code for files in /usr/libexec 656.It Pa release/ 657files required to produce a 658.Fx 659release 660.It Pa sbin/ 661source code for files in /sbin 662.It Pa secure/ 663build directory for files in /usr/src/crypto 664.It Pa share/ 665source for files in /usr/share 666.It Pa sys/ 667kernel source code 668.It Pa tools/ 669tools used for maintenance and testing of 670.Fx 671.It Pa usr.bin/ 672source code for files in /usr/bin 673.It Pa usr.sbin/ 674source code for files in /usr/sbin 675.El 676.El 677.It Pa /var/ 678multi-purpose log, temporary, transient, and spool files 679.Pp 680.Bl -tag -width ".Pa preserve/" -compact 681.It Pa account/ 682system accounting files 683.Pp 684.Bl -tag -width Fl -compact 685.It Pa acct 686execution accounting file; 687see 688.Xr acct 5 689.El 690.Pp 691.It Pa at/ 692timed command scheduling files; 693see 694.Xr \&at 1 695.Bl -tag -width ".Pa preserve/" -compact 696.It Pa jobs/ 697directory containing job files 698.It Pa spool/ 699directory containing output spool files 700.El 701.Pp 702.It Pa backups/ 703miscellaneous backup files 704.It Pa crash/ 705default directory to store kernel crash dumps; see 706.Xr crash 8 707and 708.Xr savecore 8 709.It Pa cron/ 710files used by cron; 711see 712.Xr cron 8 713.Bl -tag -width ".Pa preserve/" -compact 714.It Pa tabs/ 715crontab files; 716see 717.Xr crontab 5 718.El 719.Pp 720.It Pa db/ 721miscellaneous automatically generated system-specific database files 722.It Pa empty/ 723empty directory for use by programs that need a specifically empty directory. 724Used for instance by 725.Xr sshd 8 726for privilege separation. 727.It Pa games/ 728miscellaneous game status and score files 729.It Pa heimdal/ 730kerberos server databases; see 731.Xr kdc 8 732.It Pa log/ 733miscellaneous system log files 734.Pp 735.Bl -tag -width Fl -compact 736.It Pa utx.lastlogin 737last login log; 738see 739.Xr getutxent 3 740.It Pa utx.log 741login/logout log; 742see 743.Xr getutxent 3 744.El 745.Pp 746.It Pa mail/ 747user mailbox files 748.It Pa msgs/ 749system messages database; 750see 751.Xr msgs 1 752.It Pa preserve/ 753temporary home of files preserved after an accidental death 754of an editor; 755see 756.Xr \&ex 1 757.It Pa quotas/ 758file system quota information files 759.It Pa run/ 760system information files describing various info about 761system since it was booted 762.Pp 763.Bl -tag -width Fl -compact 764.It Pa named/ 765writable by the 766.Dq bind 767user; see 768.Xr named 8 769.It Pa ppp/ 770writable by the 771.Dq network 772group for command connection sockets; see 773.Xr ppp 8 774.It Pa utx.active 775database of current users; 776see 777.Xr getutxent 3 778.El 779.Pp 780.It Pa rwho/ 781rwho data files; 782see 783.Xr rwhod 8 , 784.Xr rwho 1 , 785and 786.Xr ruptime 1 787.It Pa spool/ 788miscellaneous printer and mail system spooling directories 789.Pp 790.Bl -tag -width Fl -compact 791.It Pa clientmqueue/ 792undelivered submission mail queue; 793see 794.Xr sendmail 8 795.It Pa ftp/ 796commonly ~ftp; the anonymous ftp root directory 797.It Pa mqueue/ 798undelivered mail queue; 799see 800.Xr sendmail 8 801.It Pa output/ 802line printer spooling directories 803.El 804.Pp 805.It Pa tmp/ 806temporary files that are kept between system reboots 807.Bl -tag -width Fl -compact 808.It Pa vi.recover/ 809the directory where recovery files are stored 810.El 811.It Pa yp/ 812the NIS maps 813.El 814.El 815.Sh NOTES 816This manual page documents the default 817.Fx 818file system layout, but 819the actual hierarchy on a given system is defined at the system 820administrator's discretion. 821A well-maintained installation will include a customized version of 822this document. 823.Sh SEE ALSO 824.Xr apropos 1 , 825.Xr find 1 , 826.Xr finger 1 , 827.Xr grep 1 , 828.Xr ls 1 , 829.Xr whatis 1 , 830.Xr whereis 1 , 831.Xr which 1 , 832.Xr fd 4 , 833.Xr devfs 5 , 834.Xr fsck 8 835.Sh HISTORY 836A 837.Nm 838manual page appeared in 839.At v7 . 840