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