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