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 September 13, 2006 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 /stand/ 187programs used in a standalone environment 188.It Pa /tmp/ 189temporary files that are not guaranteed to persist across system reboots 190.It Pa /usr/ 191contains the majority of user utilities and applications 192.Pp 193.Bl -tag -width ".Pa libdata/" -compact 194.It Pa bin/ 195common utilities, programming tools, and applications 196.It Pa compat/ 197files needed to support binary compatibility with other operating systems, 198such as Linux 199(created by 200.Xr sysinstall 8 ) 201.It Pa games/ 202useful and semi-frivolous programs 203.It Pa include/ 204standard C include files 205.Pp 206.Bl -tag -width ".Pa kerberos5/" -compact 207.It Pa altq/ 208C include files for alternate queueing 209.It Pa arpa/ 210C include files for Internet service protocols 211.It Pa bsnmp/ 212C include files for the SNMP daemon 213.It Pa c++/ 214C++ include files 215.It Pa cam/ 216C include files for the Common Access Methods Layer 217.Bl -tag -width ".Pa kerberos5/" -compact 218.It Pa scsi/ 219The SCSI device on top of CAM 220.El 221.It Pa dev/ 222C include files for programming various 223.Fx 224devices 225.Bl -tag -width ".Pa kerberos5/" -compact 226.It Pa ic/ 227Various header files describing driver- and bus-independent 228hardware circuits 229.It Pa ofw/ 230Open Firmware support 231.It Pa pbio/ 2328255 PPI cards; 233see 234.Xr pbio 4 235.It Pa ppbus/ 236The parallel port bus; 237see 238.Xr ppbus 4 239.It Pa usb/ 240The USB subsystem 241.It Pa utopia/ 242Physical chip driver for ATM interfaces; 243see 244.Xr utopia 4 245.It Pa wi/ 246The 247.Xr wi 4 248WaveLAN driver 249.El 250.It Pa fs/ 251.Bl -tag -width ".Pa kerberos5/" -compact 252.It Pa fdescfs/ 253per-process file descriptors file system 254.It Pa fifofs/ 255.St -p1003.1 256FIFOs file system 257.It Pa msdosfs/ 258MS-DOS file system 259.It Pa ntfs/ 260NTFS file system 261.It Pa nullfs/ 262loopback file system 263.It Pa nwfs/ 264NetWare file system 265.It Pa portalfs/ 266portal file system 267.It Pa procfs/ 268process file system 269.It Pa smbfs/ 270SMB/CIFS file system 271.It Pa udf/ 272UDF file system 273.It Pa umapfs/ 274alternate uid/gid mappings file system 275.It Pa unionfs 276union file system 277.El 278.It Pa geom/ 279GEOM framework 280.Bl -tag -width ".Pa kerberos5/" -compact 281.It Pa concat/ 282CONCAT GEOM class 283.It Pa gate/ 284GATE GEOM class 285.It Pa mirror/ 286MIRROR GEOM class 287.It Pa nop/ 288NOP GEOM class 289.It Pa raid3/ 290RAID3 GEOM class 291.It Pa stripe/ 292STRIPE GEOM class 293.El 294.Pp 295.It Pa isc/ 296ISC utility library libisc include files 297.It Pa isofs/ 298.Bl -tag -width ".Pa kerberos5/" -compact 299.It Pa cd9660/ 300iso9660 file system 301.El 302.It Pa libmilter/ 303C include files for libmilter, 304the 305.Xr sendmail 8 306mail filter API 307.It Pa machine/ 308machine-specific C include files 309.It Pa net/ 310miscellaneous network C include files 311.It Pa netatalk/ 312Appletalk protocol 313.It Pa netatm/ 314ATM include files; 315see 316.Xr atm 8 317.It Pa netinet/ 318C include files for Internet standard protocols; 319see 320.Xr inet 4 321.It Pa netinet6/ 322C include files for Internet protocol version 6; 323see 324.Xr inet6 4 325.It Pa netipx/ 326IPX/SPX protocol stacks 327.It Pa netkey/ 328kernel key-management service 329.It Pa netnatm/ 330NATM include files; 331see 332.Xr natm 4 333.Bl -tag -width ".Pa kerberos5/" -compact 334.It Pa api/ 335include files for the signalling API 336.It Pa msg/ 337include files that describe signalling messages and 338declare associated functions 339.It Pa saal/ 340include files for the signalling AAL layer 341.It Pa sig/ 342include files for the UNI signalling protocol 343.El 344.It Pa netsmb/ 345SMB/CIFS requester 346.It Pa nfs/ 347C include files for NFS (Network File System) 348.It Pa objc/ 349Objective C include files 350.It Pa openssl/ 351OpenSSL (Cryptography/SSL toolkit) headers 352.It Pa pccard/ 353PC-CARD controllers 354.It Pa posix4/ 355POSIX real-time extensions includes; 356see 357.Xr p1003_1b 9 358.It Pa protocols/ 359C include files for Berkeley service protocols 360.It Pa readline/ 361get a line from a user, with editing; 362see 363.Xr readline 3 364.It Pa rpc/ 365remote procedure calls; 366see 367.Xr rpc 3 368.It Pa rpcsvc/ 369definition of RPC service structures; see 370.Xr rpc 3 371.It Pa security/ 372PAM; see 373.Xr pam 8 374.It Pa sys/ 375system C include files (kernel data structures) 376.\" .It Pa tcl/ 377.\" Tcl language; 378.\" see 379.\" .Xr Tcl n 380.\" .Bl -tag -width ".Pa kerberos5/" -compact 381.\" .It Pa generic/ 382.\" ??? 383.\" .It Pa unix/ 384.\" ??? 385.\" .El 386.It Pa ufs/ 387C include files for UFS (The U-word File System) 388.Bl -tag -width ".Pa kerberos5/" -compact 389.It Pa ffs/ 390Fast file system 391.It Pa ufs/ 392UFS file system 393.El 394.It Pa vm/ 395virtual memory; 396see 397.Xr vmstat 8 398.El 399.Pp 400.It Pa lib/ 401shared and archive 402.Xr ar 1 Ns -type 403libraries 404.Bl -tag -width Fl -compact 405.It Pa aout/ 406a.out archive libraries 407.It Pa compat/ 408shared libraries for compatibility 409.Bl -tag -width Fl -compact 410.It Pa aout/ 411a.out backward compatibility libraries 412.El 413.It Pa dtrace/ 414DTrace library scripts 415.It Pa engines/ 416OpenSSL (Cryptography/SSL toolkit) dynamically loadable engines 417.El 418.Pp 419.It Pa libdata/ 420miscellaneous utility data files 421.Bl -tag -width Fl -compact 422.It Pa gcc/ 423.Xr gcc 1 424configuration data 425.It Pa ldscripts/ 426linker scripts; 427see 428.Xr ld 1 429.It Pa lint/ 430various prebuilt lint libraries; 431see 432.Xr lint 1 433.El 434.Pp 435.It Pa libexec/ 436system daemons & system utilities (executed by other programs) 437.Bl -tag -width Fl -compact 438.It Pa aout/ 439utilities to manipulate a.out executables 440.It Pa elf/ 441utilities to manipulate ELF executables 442.It Pa lpr/ 443utilities and filters for LP print system; 444see 445.Xr lpr 1 446.It Pa sendmail/ 447the 448.Xr sendmail 8 449binary; 450see 451.Xr mailwrapper 8 452.It Pa sm.bin/ 453restricted shell for 454.Xr sendmail 8 ; 455see 456.Xr smrsh 8 457.El 458.Pp 459.It Pa local/ 460local executables, libraries, etc. 461Also used as the default destination for the 462.Fx 463ports framework. 464Within local/, the general layout sketched out by 465.Nm 466for /usr 467should be used. 468Exceptions are the man directory (directly under local/ 469rather than under local/share/), ports documentation (in share/doc/<port>/), 470and /usr/local/etc (mimics /etc). 471.It Pa obj/ 472architecture-specific target tree produced by building the /usr/src tree 473.It Pa ports/ 474The 475.Fx 476ports collection (optional). 477.It Pa sbin/ 478system daemons & system utilities (executed by users) 479.It Pa share/ 480architecture-independent files 481.Pp 482.Bl -tag -width ".Pa calendar/" -compact 483.It Pa calendar/ 484a variety of pre-fab calendar files; 485see 486.Xr calendar 1 487.It Pa dict/ 488word lists; 489see 490.Xr look 1 491.Pp 492.Bl -tag -width Fl -compact 493.It Pa freebsd 494.Fx Ns -specific 495terms, proper names, and jargon 496.It Pa words 497common words 498.It Pa web2 499words from Webster's 2nd International 500.It Pa papers/ 501reference databases; 502see 503.Xr refer 1 504.El 505.Pp 506.It Pa doc/ 507miscellaneous documentation; 508source for most of the printed 509.Bx 510manuals (available 511from the 512.Tn USENIX 513association) 514.Bl -tag -width Fl -compact 515.It Pa FAQ/ 516Frequently Asked Questions 517.It Pa IPv6/ 518implementation notes for IPv6 519.It Pa bind/ 520documents pertaining to BIND (the Berkeley Internet Name Domain) 521.It Pa es/ 522Spanish translations of documents in /usr/share/doc 523.It Pa handbook/ 524.Fx 525Handbook 526.It Pa ja/ 527Japanese translations of documents in /usr/share/doc 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