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