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