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