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