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