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