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