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