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