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