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