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 Li / 45root directory of the filesystem 46.It Li /bin/ 47user utilities fundamental to both single-user and multi-user environments 48.It Li /dev/ 49block and character device files 50.Pp 51.Bl -tag -width MAKEDEV -compact 52.It Li MAKEDEV 53script for creating device files; 54see 55.Xr MAKEDEV 8 56.It Li fd/ 57file descriptor files; 58see 59.Xr \&fd 4 60.El 61.It Li /etc/ 62system configuration files and scripts 63.Pp 64.Bl -tag -width "disklabels/" -compact 65.It Li defaults/ 66default system configuration files; 67see 68.Xr rc 8 69.It Li gnats/ 70gnats configuration files; 71see 72.Xr send-pr 1 73.It Li isdn/ 74isdn4bsd configuration files; 75see 76.Xr isdnd 8 77.It Li kerberosIV/ 78configuration files for the kerberos version IV; 79see 80.Xr kerberos 1 81.It Li localtime 82local timezone information; 83see 84.Xr ctime 3 85.It Li mail/ 86spam-filtering information 87.It Li mtree/ 88mtree configuration files; 89see 90.Xr mtree 8 91.It Li namedb/ 92named configuration files; 93see 94.Xr named 8 95.It Li periodic/ 96scripts that are run daily, weekly, and monthly, via 97.Xr cron 8 ; 98see 99.Xr periodic 8 100.It Li ppp/ 101.Xr ppp 8 102ppp configuration files; 103see 104.Xr ppp 8 105.It Li uucp/ 106uucp configuration files; 107see 108.Xr uucp 1 109.El 110.It Li /kernel 111pure kernel executable (the operating system loaded into memory 112at boot time). 113.It Li /modules/ 114loadable kernel modules; 115see 116.Xr kldstat 8 117.It Li /mnt/ 118empty directory commonly used by 119system administrators as a temporary mount point 120.It Li /proc/ 121process file system; 122see 123.Xr procfs 5 , 124.Xr mount_procfs 8 125.It Li /root/ 126root's HOME directory 127.It Li /sbin/ 128system programs and administration utilities 129fundamental to both single-user and multi-user environments 130.It Li /stand/ 131programs used in a standalone environment 132.It Li /tmp/ 133temporary files, usually a 134.Xr mfs 8 135memory-based filesystem (the contents 136of /tmp are usually NOT preserved across a system reboot) 137.It Li /usr/ 138contains the majority of user utilities and applications 139.Pp 140.Bl -tag -width "libdata/" -compact 141.It Li bin/ 142common utilities, programming tools, and applications 143.It Li games/ 144useful and semi-frivolous programs 145.It Li include/ 146standard C include files 147.Pp 148.Bl -tag -width "kerberosIV/" -compact 149.It Li arpa/ 150C include files for Internet service protocols 151.It Li g++/ 152GNU C++ include files 153.Bl -tag -width "kerberosIV/" -compact 154.It Li std/ 155GNU C++ libstdc++ include files 156.El 157.It Li isofs/ 158.Bl -tag -width "kerberosIV/" -compact 159.It Li cd9660/ 160iso9660 filesystem 161.El 162.It Li kerberosIV/ 163C include files for kerberos authentication package; 164see 165.Xr kerberos 1 166.It Li machine/ 167machine specific C include files 168.It Li msdosfs/ 169MS-DOS file system 170.It Li net/ 171misc network C include files 172.It Li netatalk/ 173Appletalk protocol 174.It Li netatm/ 175ATM include files; 176see 177.Xr atm 8 178.It Li netinet/ 179C include files for Internet standard protocols; 180see 181.Xr inet 4 182.It Li netipx/ 183IPX/SPX protocol stacks 184.It Li netkey/ 185kernel key-management service 186.It Li netns/ 187Xerox NS protocols 188.It Li nfs/ 189C include files for NFS (Network File System) 190.It Li objc/ 191Objective C include files 192.It Li pccard/ 193PC-CARD controllers 194.It Li posix4/ 195POSIX real-time extensions includes; 196see 197.Xr p1003_1b 9 198.It Li protocols/ 199C include files for Berkeley service protocols 200.It Li readline/ 201get a line from a user with editing; 202see 203.Xr readline 3 204.It Li rpc/ 205remote procedure calls; 206see 207.Xr rpc 3 208.It Li rpcsvc/ 209defintion of RPC service structures; see 210.Xr rpc 3 . 211.It Li security/ 212PAM; see 213.Xr pam 8 214.It Li ss/ 215MIT SIPB 216.Sq subsystem 217library, part of Kerberos IV. 218.It Li sys/ 219system C include files (kernel data structures) 220.\" .It Li tcl/ 221.\" Tcl language; 222.\" see 223.\" .Xr Tcl n 224.\" .Bl -tag -width "kerberosIV/" -compact 225.\" .It Li generic/ 226.\" ??? 227.\" .It Li unix/ 228.\" ??? 229.\" .El 230.It Li ufs/ 231C include files for UFS (The U-word File System) 232.Bl -tag -width "kerberosIV/" -compact 233.It Li ffs/ 234Fast filesystem 235.It Li mfs/ 236memory file system; 237see 238.Xr mount_mfs 8 239.It Li ufs/ 240UFS filesystem 241.El 242.It Li vm/ 243virtual memory; 244see 245.Xr vmstat 8 246.El 247.Pp 248.It Li lib/ 249archive libraries 250.Bl -tag -width Fl -compact 251.It Li compat/ 252shared libraries for compatibility 253.Bl -tag -width Fl -compact 254.It Li aout/ 255a.out backward compatibility libraries 256.El 257.El 258.Pp 259.It Li libdata/ 260misc. utility data files 261.Bl -tag -width Fl -compact 262.It Li gcc/ 263??? 264.It Li lint/ 265various prebuilt lint libraries; 266see 267.Xr lint 1 268.It Li msdosfs/ 269Chatacter set conversion tables 270.It Li perl/ 271.Bl -tag -width Fl -compact 272.It Li 5.00503/ 273contains Perl modules for Perl version 5.00503; 274see 275.Xr perl 1 276.El 277.It Li stallion/ 278holding the download firmware images 279.It Li tcl 280???; 281see 282.Xr Tcl n 283.El 284.Pp 285.It Li libexec/ 286system daemons & system utilities (executed by other programs) 287.Bl -tag -width Fl -compact 288.It Li aout/ 289utilities to manipulate a.out executables. 290.It Li elf/ 291utilities to manipulate ELF executables. 292.It Li lpr/ 293utilities and filters for LP print system; 294see 295.Xr lpr 1 296.It Li sm.bin/ 297restricted shell for sendmail; 298see 299.Xr smrsh 8 300.It Li uucp/ 301uucp utilities; 302see 303.Xr uucp 1 304.El 305.Pp 306.It Li local/ 307local executables, libraries, etc. 308.br 309Also used as the default destination for the 310.Tn FreeBSD 311ports framework. 312Within local/, the general layout sketched out by 313.Xr hier 7 314for /usr 315should be used. Exceptions are the man directory is directly under local/ 316rather than under local/share/. Ports documentation is in share/doc/<port>/ 317.It Li mdec/ 318boot programs; 319see 320.Xr disklabel 8 321.It Li obj/ 322architecture-specific target tree produced by building the /usr/src tree 323.It Li ports 324The 325.Tn FreeBSD 326ports collection (optional). 327.It Li sbin/ 328system daemons & system utilities (executed by users) 329.It Li share/ 330architecture-independent files 331.Pp 332.Bl -tag -width "calendar/" -compact 333.It Li calendar/ 334a variety of pre-fab calendar files; 335see 336.Xr calendar 1 337.It Li dict/ 338word lists; 339see 340.Xr look 1 341.Pp 342.Bl -tag -width Fl -compact 343.It Li words 344common words 345.It Li web2 346words from Webster's 2nd International 347.It Li papers/ 348reference databases; 349see 350.Xr refer 1 351.It Li special/ 352custom word lists; 353see 354.Xr spell 1 355.El 356.Pp 357.It Li doc/ 358misc documentation; 359src for most of the printed 360.Bx 361manuals (available 362from the 363.Tn USENIX 364association) 365.Bl -tag -width Fl -compact 366.It Li FAQ/ 367Frequently Asked Questions 368.It Li handbook/ 369.Tn FreeBSD 370Handbook 371.It Li papers/ 372UNIX Papers 373.It Li psd/ 374UNIX Programmer's Supplementary Documents 375.It Li smm/ 376UNIX System Manager's Manual 377.It Li usd/ 378UNIX User's Supplementary Documents 379.El 380.Pp 381.It Li examples/ 382various examples for users and programmers 383.It Li games/ 384ASCII text files used by various games 385.It Li groff_font/ 386device description file for device name 387.It Li info/ 388GNU Info hypertext system 389.It Li isdn/ 390ISDN 391.It Li libg++/ 392libg++'s genclass prototype/template class files 393.It Li locale/ 394internationalization files; 395see 396.Xr setlocale 3 397.It Li man/ 398manual pages 399.It Li me/ 400macros for use with the me macro package 401.It Li misc/ 402misc system-wide ASCII text files 403.Bl -tag -width Fl -compact 404.It Li fonts/ 405??? 406.It Li pcvtfonts/ 407pcvt fonts; 408see 409.Xr pcvt 4 410.It Li pkg_manage/ 411package manager help files; 412see 413.Xr pkg_manage 414.It Li termcap 415terminal characteristics database; 416see 417.Xr termcap 5 418.El 419.It Li mk/ 420templates for make; 421see 422.Xr make 1 423.It Li nls/ 424national language support files; 425see 426.Xr mklocale 1 427.It Li pcvt/ 428pcvt documentation and etc examples; 429see 430.Xr pcvt 4 431.It Li perl/ 432perl library files; 433see 434.Xr perl 1 435.It Li skel/ 436example . (dot) files for new accounts 437.It Li syscons/ 438console staff; 439see 440.Xr syscons 4 441.Bl -tag -width "scrnmaps/xx" -compact 442.It Li fonts/ 443console fonts; 444see 445.Xr vidcontrol 1 446and 447.Xr vidfont 1 448.It Li keymaps/ 449console keyboard maps; 450see 451.Xr kbdcontrol 1 452and 453.Xr kbdmap 1 454.It Li scrnmaps/ 455console screen maps 456.El 457.It Li tabset/ 458tab description files for a variety of terminals; used in 459the termcap file; 460see 461.Xr termcap 5 462.It Li tmac/ 463text processing macros; 464see 465.Xr nroff 1 466and 467.Xr troff 1 468.It Li vi/ 469localization support and utilities for 470.Xr vi 1 . 471.It Li zoneinfo/ 472timezone configuration information; 473see 474.Xr tzfile 5 475.El 476.It Li src/ 477BSD and/or local source files 478.Pp 479.Bl -tag -width "kerberosIV/" -compact 480.It Li bin/ 481src for files in /bin 482.It Li contrib/ 483src for file from contributed software 484.It Li crypto 485DES 486.It Li etc/ 487src for files in /etc 488.It Li games/ 489src for files in /usr/games 490.It Li gnu/ 491Utilities covered by the GNU Public License 492.It Li include/ 493src for files in /usr/include 494.It Li kerberosIV/ 495src for kerberos version IV 496.It Li lib/ 497src for files in /usr/lib 498.It Li libexec/ 499src for files in /usr/libexec 500.It Li release/ 501files required to produce a 502.Tn FreeBSD 503release 504.It Li sbin/ 505src for files in /sbin 506.It Li secure 507FreeSec sources 508.It Li share/ 509src for files in /usr/share 510.It Li sys/ 511kernel src files 512.It Li tools/ 513tools used for maintaince and testing of FreeBSD 514.It Li usr.bin/ 515src for files in /usr/bin 516.It Li usr.sbin/ 517src for files in /usr/sbin 518.El 519.Pp 520.It Li X11R6/ 521X11R6 distribution executables, libraries, etc (optional). 522.Bl -tag -width "include/" -compact 523.It Li bin/ 524X11R6 binaries (servers, utilities, local packages/ports). 525.It Li etc/ 526X11R6 configuration files and scripts. 527.It Li include/ 528X11R6 include files. 529.It Li lib/ 530X11R6 libraries. 531.It Li man/ 532X11R6 manual pages. 533.It Li share/ 534architecture independant files. 535.El 536.El 537.It Li /var/ 538multi-purpose log, temporary, transient, and spool files 539.Pp 540.Bl -tag -width "preserve/" -compact 541.It Li account/ 542system accounting files 543.Pp 544.Bl -tag -width Fl -compact 545.It Li acct 546execution accounting file; 547see 548.Xr acct 5 549.El 550.Pp 551.It Li at/ 552timed command scheduling files; 553see 554.Xr \&at 1 555.Bl -tag -width "preserve/" -compact 556.It Li jobs/ 557directory containing job files 558.It Li spool/ 559directory containing output spool files 560.El 561.Pp 562.It Li backups/ 563misc. backup files 564.It Li crash/ 565default drectory to store kernel crash dumps; see 566.Xr crash 8 567and 568.Xr savecore 8 . 569.It Li cron/ 570.Bl -tag -width "preserve/" -compact 571.It Li log 572cron log files; 573see 574.Xr cron 8 575.It Li tabs/ 576crontab files; 577see 578.Xr crontab 5 579.El 580.Pp 581.It Li db/ 582misc. automatically generated system-specific database files 583.It Li games/ 584misc. game status and score files 585.It Li log/ 586misc. system log files 587.Pp 588.Bl -tag -width Fl -compact 589.It Li wtmp 590login/logout log; 591see 592.Xr wtmp 5 593.El 594.Pp 595.It Li mail/ 596user mailbox files 597.It Li preserve/ 598temporary home of files preserved after an accidental death 599of an editor; 600see 601.Xr \&ex 1 602.It Li msgs/ 603system messages database; 604see 605.Xr msgs 1 606.It Li quotas/ 607filesystem quota information files 608.It Li run/ 609system information files describing various info about 610system since it was booted 611.Pp 612.Bl -tag -width Fl -compact 613.It Li utmp 614database of current users; 615see 616.Xr utmp 5 617.El 618.Pp 619.It Li rwho/ 620rwho data files; 621see 622.Xr rwhod 8 , 623.Xr rwho 1 , 624and 625.Xr ruptime 1 626.It Li spool/ 627misc. printer and mail system spooling directories 628.Pp 629.Bl -tag -width Fl -compact 630.It Li ftp/ 631commonly ~ftp; the anonymous ftp root directory 632.It Li mqueue/ 633undelivered mail queue; 634see 635.Xr sendmail 8 636.It Li output/ 637line printer spooling directories 638.It Li secretmail/ 639secretmail spool directory; 640see 641.Xr xget 1 642.It Li uucp/ 643uucp spool directory 644.It Li uucppublic/ 645commonly ~uucp; public uucp temporary directory 646.El 647.Pp 648.It Li tmp/ 649temporary files that are kept between system reboots 650.Bl -tag -width Fl -compact 651.It Li vi.recover/ 652the directory where recovery files are stored 653.El 654.It Li yp 655the NIS maps 656.El 657.El 658.Sh SEE ALSO 659.Xr apropos 1 , 660.Xr find 1 , 661.Xr finger 1 , 662.Xr grep 1 , 663.Xr ls 1 , 664.Xr whatis 1 , 665.Xr whereis 1 , 666.Xr which 1 , 667.Xr fsck 8 668.Sh HISTORY 669A 670.Nm hier 671manual page appeared in 672.At v7 . 673