share/man/man7/hier.7

   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: src/share/man/man7/hier.7,v 1.29.2.17 2003/01/13 21:43:50 ceri Exp $
  34 .\"
  35 .Dd November 26, 2011
  36 .Dt HIER 7
  37 .Os
  38 .Sh NAME
  39 .Nm hier
  40 .Nd layout of filesystems
  41 .Sh DESCRIPTION
  42 A sketch of the filesystem hierarchy.
  43 .Bl -tag -width ".Pa /modules/"
  44 .It Pa /
  45 root directory of the filesystem
  46 .It Pa /bin/
  47 user utilities fundamental to both single-user and multi-user environments
  48 .It Pa /boot/
  49 programs and configuration files used during operating system bootstrap
  50 .Pp
  51 .Bl -tag -width ".Pa defaults/" -compact
  52 .It Pa defaults/
  53 default bootstrapping configuration files; see
  54 .Xr loader.conf 5
  55 .It Pa kernel
  56 pure kernel executable (the operating system loaded into memory
  57 at boot time).
  58 .It Pa modules/
  59 loadable kernel modules;
  60 see
  61 .Xr kldstat 8
  62 .El
  63 .It Pa /dev/
  64 block and character device files
  65 .Pp
  66 .Bl -tag -width ".Pa fd/" -compact
  67 .It Pa fd/
  68 file descriptor files;
  69 see
  70 .Xr \&fd 4
  71 .El
  72 .It Pa /etc/
  73 system configuration files and scripts
  74 .Pp
  75 .Bl -tag -width ".Pa bluetooth/" -compact
  76 .It Pa bluetooth/
  77 bluetooth configuration files
  78 .It Pa defaults/
  79 default system configuration files;
  80 see
  81 .Xr rc 8
  82 .It Pa dma/
  83 .Xr dma 8
  84 configuration files
  85 .\".It Pa firmware/
  86 .\"Firmware image files;
  87 .\"see
  88 .\".Xr firmware 9
  89 .It Pa isdn/
  90 isdn4bsd configuration files;
  91 see
  92 .Xr isdnd 8
  93 .It Pa localtime
  94 local timezone information;
  95 see
  96 .Xr ctime 3
  97 .It Pa mail/
  98 Sendmail control files
  99 .It Pa mtree/
 100 mtree configuration files;
 101 see
 102 .Xr mtree 8
 103 .It Pa pam.d/
 104 configuration files for the Pluggable Authentication Modules (PAM)
 105 library
 106 .It Pa periodic/
 107 scripts that are run daily, weekly, and monthly, via
 108 .Xr cron 8 ;
 109 see
 110 .Xr periodic 8
 111 .It Pa ppp/
 112 ppp configuration files;
 113 see
 114 .Xr ppp 8
 115 .It Pa rc.d/
 116 System and daemon startup/control scripts;
 117 see
 118 .Xr rc 8
 119 .It Pa ssh/
 120 OpenSSH configuration files;
 121 see
 122 .Xr ssh 1
 123 .It Pa ssl/
 124 OpenSSL configuration files
 125 .It Pa upgrade/
 126 Files relevant to system upgrades
 127 .It Pa uucp/
 128 uucp configuration files;
 129 see
 130 .Xr uucp 1
 131 .El
 132 .It Pa /home/
 133 HOME directories of non-root users
 134 .It Pa /mnt/
 135 empty directory commonly used by
 136 system administrators as a temporary mount point
 137 .It Pa /pfs/
 138 pseudo file system directory (on
 139 .Xr hammer 5
 140 root file systems)
 141 .It Pa /proc/
 142 process file system;
 143 see
 144 .Xr procfs 5 ,
 145 .Xr mount_procfs 8
 146 .It Pa /root/
 147 root's HOME directory
 148 .It Pa /sbin/
 149 system programs and administration utilities
 150 fundamental to both single-user and multi-user environments
 151 .It Pa /sys/
 152 the kernel's source code (usually a symbolic link to
 153 .Pa /usr/src/sys )
 154 .It Pa /tmp/
 155 temporary files that are not guaranteed to persist across system reboots
 156 .It Pa /usr/
 157 contains the majority of user utilities and applications
 158 .Pp
 159 .Bl -tag -width ".Pa libdata/" -compact
 160 .It Pa bin/
 161 common utilities, programming tools, and applications
 162 .It Pa games/
 163 useful and semi-frivolous programs
 164 .It Pa include/
 165 standard C include files
 166 .Pp
 167 .Bl -tag -width ".Pa libmilter/" -compact
 168 .It Pa arpa/
 169 C include files for Internet service protocols
 170 .It Pa c++/
 171 C++ include files
 172 .It Pa cam/
 173 C include files for the Common Access Methods Layer
 174 .Pp
 175 .Bl -tag -width ".Pa scsi/" -compact
 176 .It Pa scsi/
 177 The SCSI device on top of CAM
 178 .El
 179 .Pp
 180 .It Pa dev/
 181 C include files for programming various
 182 .Dx
 183 devices
 184 .It Pa emulation/
 185 Include Files for various emulation layers
 186 .It Pa fs/
 187 .Pp
 188 .Bl -tag -width ".Pa smbfs/" -compact
 189 .It Pa smbfs/
 190 SMB/CIFS filesystem
 191 .El
 192 .Pp
 193 .It Pa isofs/
 194 .Pp
 195 .Bl -tag -width ".Pa cd9660/" -compact
 196 .It Pa cd9660/
 197 iso9660 filesystem
 198 .El
 199 .Pp
 200 .It Pa libmilter/
 201 C include files for libmilter,
 202 the sendmail mail filter API
 203 .It Pa libprop/
 204 C include files for libprop
 205 .It Pa machine/
 206 machine-specific C include files
 207 .It Pa msdosfs/
 208 MS-DOS file system
 209 .It Pa net/
 210 misc network C include files
 211 .It Pa netatm/
 212 ATM include files;
 213 see
 214 .Xr atm 8
 215 .It Pa netinet/
 216 C include files for Internet standard protocols;
 217 see
 218 .Xr inet 4
 219 .It Pa netinet6/
 220 C include files for Internet protocol version 6;
 221 see
 222 .Xr inet6 4
 223 .It Pa netipx/
 224 IPX/SPX protocol stacks
 225 .It Pa netkey/
 226 kernel key-management service
 227 .It Pa netnatm/
 228 NATM include files;
 229 see
 230 .Xr natm 4
 231 .It Pa netsmb/
 232 SMB/CIFS requester
 233 .It Pa nfs/
 234 C include files for NFS (Network File System)
 235 .It Pa objc/
 236 Objective C include files
 237 .It Pa openssl/
 238 OpenSSL (Cryptography/SSL toolkit) headers
 239 .It Pa pcap/
 240 Packet Capture (libpcap) headers;
 241 see
 242 .Xr pcap 3
 243 .It Pa pccard/
 244 PC-CARD controllers
 245 .It Pa protocols/
 246 C include files for Berkeley service protocols
 247 .It Pa readline/
 248 get a line from a user, with editing;
 249 see
 250 .Xr readline 3
 251 .It Pa rpc/
 252 remote procedure calls;
 253 see
 254 .Xr rpc 3
 255 .It Pa rpcsvc/
 256 definition of RPC service structures; see
 257 .Xr rpc 3
 258 .It Pa security/
 259 PAM; see
 260 .Xr pam 8
 261 .It Pa sys/
 262 system C include files (kernel data structures)
 263 .It Pa ufs/
 264 C include files for UFS (The U-word File System)
 265 .Pp
 266 .Bl -tag -width ".Pa ffs/" -compact
 267 .It Pa ffs/
 268 Fast filesystem
 269 .It Pa mfs/
 270 memory file system;
 271 see
 272 .Xr mount_mfs 8
 273 .It Pa ufs/
 274 UFS filesystem
 275 .El
 276 .Pp
 277 .It Pa vm/
 278 virtual memory;
 279 see
 280 .Xr vmstat 8
 281 .El
 282 .Pp
 283 .It Pa lib/
 284 archive libraries
 285 .Pp
 286 .Bl -tag -width ".Pa compat/" -compact
 287 .It Pa aout/
 288 a.out archive libraries
 289 .It Pa compat/
 290 shared libraries for compatibility
 291 .Pp
 292 .Bl -tag -width ".Pa aout/" -compact
 293 .It Pa aout/
 294 a.out backward compatibility libraries
 295 .El
 296 .It Pa engines/
 297 OpenSSL dynamic engines
 298 .El
 299 .Pp
 300 .It Pa libdata/
 301 misc. utility data files
 302 .Pp
 303 .Bl -tag -width ".Pa stallion/" -compact
 304 .It Pa doscmd/
 305 files used by doscmd (drivers, fonts, etc.);
 306 see
 307 .Xr doscmd 1
 308 .Pp
 309 .Bl -tag -width ".Pa fonts/" -compact
 310 .It Pa fonts/
 311 fonts used by doscmd
 312 .El
 313 .Pp
 314 .It Pa lint/
 315 various prebuilt lint libraries;
 316 see
 317 .Xr lint 1
 318 .It Pa stallion/
 319 holds the download firmware images
 320 .El
 321 .Pp
 322 .It Pa libexec/
 323 system daemons & system utilities (executed by other programs)
 324 .Pp
 325 .Bl -tag -width ".Pa binutils221/" -compact
 326 .It Pa binutils221/
 327 .Pp
 328 .Bl -tag -width ".Pa ldscripts/" -compact
 329 .It Pa ldscripts/
 330 linker scripts;
 331 see
 332 .Xr ld 1
 333 .El
 334 .Pp
 335 .It Pa binutils222/
 336 .Pp
 337 .Bl -tag -width ".Pa ldscripts/" -compact
 338 .It Pa ldscripts/
 339 linker scripts;
 340 see
 341 .Xr ld 1
 342 .El
 343 .Pp
 344 .It Pa lpr/
 345 utilities and filters for LP print system;
 346 see
 347 .Xr lpr 1
 348 .It Pa sendmail/
 349 the sendmail binary;
 350 see
 351 .Xr mailwrapper 8
 352 and
 353 .Xr sendmail 8
 354 .It Pa sm.bin/
 355 restricted shell for sendmail;
 356 see
 357 .Xr smrsh 8
 358 .It Pa uucp/
 359 uucp utilities;
 360 see
 361 .Xr uucp 1
 362 .El
 363 .Pp
 364 .It Pa local/
 365 local executables, libraries, etc.
 366 Within
 367 .Pa local/ ,
 368 the general layout sketched out by
 369 .Xr hier 7
 370 for
 371 .Pa /usr
 372 should be used.
 373 Exceptions are the
 374 .Pa man/
 375 directory (directly under
 376 .Pa local/
 377 rather than under
 378 .Pa local/share/ ) ,
 379 documentation (in
 380 .Pa share/doc/<app>/ ) ,
 381 and
 382 .Pa /usr/local/etc
 383 .Pf ( mimics
 384 .Pa /etc ) .
 385 .It Pa obj/
 386 architecture-specific target tree produced by building the
 387 .Pa /usr/src
 388 tree
 389 .It Pa pkg/
 390 default destination directory for the
 391 .Xr pkgsrc 7
 392 collection.
 393 Within
 394 .Pa pkg/ ,
 395 the general layout sketched out by
 396 .Xr hier 7
 397 for
 398 .Pa /usr
 399 should be used.
 400 Exceptions are the
 401 .Pa man/
 402 directory (directly under
 403 .Pa pkg/
 404 rather than under
 405 .Pa pkg/share/ ) ,
 406 documentation (in
 407 .Pa share/doc/<pkg>/ ) ,
 408 and
 409 .Pa /usr/pkg/etc
 410 .Pf ( mimics
 411 .Pa /etc ) .
 412 .It Pa pkgsrc/
 413 The
 414 .Xr pkgsrc 7
 415 collection (optional).
 416 .It Pa sbin/
 417 system daemons & system utilities (executed by users)
 418 .It Pa share/
 419 architecture-independent files
 420 .Pp
 421 .Bl -tag -width ".Pa groff_font/" -compact
 422 .It Pa calendar/
 423 a variety of pre-fab calendar files;
 424 see
 425 .Xr calendar 1
 426 .It Pa dict/
 427 word lists;
 428 see
 429 .Xr look 1
 430 .Pp
 431 .Bl -tag -width ".Pa papers/" -compact
 432 .It Pa web2
 433 words from Webster's 2nd International
 434 .It Pa words
 435 common words
 436 .It Pa papers/
 437 reference databases;
 438 see
 439 .Xr refer 1
 440 .El
 441 .Pp
 442 .It Pa doc/
 443 miscellaneous documentation
 444 .Bl -tag -width ".Pa legal/" -compact
 445 .It Pa legal/
 446 License files for vendor supplied firmwares
 447 .El
 448 .Pp
 449 .It Pa examples/
 450 various examples for users and programmers
 451 .It Pa games/
 452 ASCII text files used by various games
 453 .It Pa groff_font/
 454 device description file for device name
 455 .It Pa i18n/
 456 internationalization databases; see
 457 .Xr iconv 3
 458 .It Pa info/
 459 GNU Info hypertext system
 460 .It Pa isdn/
 461 ISDN
 462 .It Pa libg++/
 463 libg++'s genclass prototype/template class files
 464 .It Pa locale/
 465 localization files;
 466 see
 467 .Xr setlocale 3
 468 .It Pa man/
 469 manual pages
 470 .It Pa me/
 471 macros for use with the me macro package;
 472 see
 473 .Xr me 7
 474 .It Pa misc/
 475 misc system-wide ASCII text files
 476 .Pp
 477 .Bl -tag -width ".Pa termcap" -compact
 478 .It Pa termcap
 479 terminal characteristics database;
 480 see
 481 .Xr termcap 5
 482 .El
 483 .Pp
 484 .It Pa mk/
 485 templates for make;
 486 see
 487 .Xr make 1
 488 .It Pa nls/
 489 national language support files;
 490 see
 491 .Xr mklocale 1
 492 .It Pa openssl/
 493 .Pp
 494 .Bl -tag -width ".Pa man/" -compact
 495 .It Pa man/
 496 OpenSSL manual pages
 497 .El
 498 .Pp
 499 .It Pa sendmail/
 500 sendmail configuration files;
 501 see
 502 .Xr sendmail 8
 503 .It Pa skel/
 504 example . (dot) files for new accounts
 505 .It Pa syscons/
 506 files used by
 507 .Xr syscons 4
 508 .Pp
 509 .Bl -tag -width ".Pa scrnmaps/" -compact
 510 .It Pa fonts/
 511 console fonts;
 512 see
 513 .Xr vidcontrol 1
 514 and
 515 .Xr vidfont 1
 516 .It Pa keymaps/
 517 console keyboard maps;
 518 see
 519 .Xr kbdcontrol 1
 520 and
 521 .Xr kbdmap 1
 522 .It Pa scrnmaps/
 523 console screen maps
 524 .El
 525 .Pp
 526 .It Pa tabset/
 527 tab description files for a variety of terminals; used in
 528 the termcap file;
 529 see
 530 .Xr termcap 5
 531 .It Pa tmac/
 532 text processing macros;
 533 see
 534 .Xr nroff 1
 535 and
 536 .Xr troff 1
 537 .It Pa vi/
 538 localization support and utilities for
 539 .Xr vi 1
 540 .It Pa zoneinfo/
 541 timezone configuration information;
 542 see
 543 .Xr tzfile 5
 544 .El
 545 .Pp
 546 .It Pa src/
 547 .Bx ,
 548 third-party, and/or local source files
 549 .Pp
 550 .Bl -tag -width ".Pa nrelease/" -compact
 551 .It Pa bin/
 552 source code for files in
 553 .Pa /bin
 554 .It Pa contrib/
 555 source code for contributed software
 556 .It Pa crypto/
 557 source code for contributed cryptography software
 558 .It Pa etc/
 559 source code for files in
 560 .Pa /etc
 561 .It Pa games/
 562 source code for files in
 563 .Pa /usr/games
 564 .It Pa gnu/
 565 Utilities covered by the GNU General Public License
 566 .It Pa include/
 567 source code for files in
 568 .Pa /usr/include
 569 .It Pa lib/
 570 source code for files in
 571 .Pa /usr/lib
 572 .It Pa libexec/
 573 source code for files in
 574 .Pa /usr/libexec
 575 .It Pa nrelease/
 576 files required to produce a
 577 .Dx
 578 release
 579 .It Pa sbin/
 580 source code for files in
 581 .Pa /sbin
 582 .It Pa secure/
 583 build directory for files in
 584 .Pa /usr/src/crypto
 585 .It Pa share/
 586 source for files in
 587 .Pa /usr/share
 588 .It Pa sys/
 589 kernel source code
 590 .It Pa tools/
 591 tools used for maintenance and testing of
 592 .Dx
 593 .It Pa usr.bin/
 594 source code for files in
 595 .Pa /usr/bin
 596 .It Pa usr.sbin/
 597 source code for files in
 598 .Pa /usr/sbin
 599 .El
 600 .El
 601 .It Pa /var/
 602 multi-purpose log, temporary, transient, and spool files
 603 .Pp
 604 .Bl -tag -width ".Pa preserve/" -compact
 605 .It Pa account/
 606 system accounting files
 607 .Pp
 608 .Bl -tag -width ".Pa acct" -compact
 609 .It Pa acct
 610 execution accounting file;
 611 see
 612 .Xr acct 5
 613 .El
 614 .Pp
 615 .It Pa at/
 616 timed command scheduling files;
 617 see
 618 .Xr \&at 1
 619 .Pp
 620 .Bl -tag -width ".Pa spool/" -compact
 621 .It Pa jobs/
 622 directory containing job files
 623 .It Pa spool/
 624 directory containing output spool files
 625 .El
 626 .Pp
 627 .It Pa backups/
 628 misc. backup files
 629 .It Pa crash/
 630 default directory to store kernel crash dumps; see
 631 .Xr crash 8
 632 and
 633 .Xr savecore 8
 634 .It Pa cron/
 635 files used by cron;
 636 see
 637 .Xr cron 8
 638 .Pp
 639 .Bl -tag -width ".Pa tabs/" -compact
 640 .It Pa tabs/
 641 crontab files;
 642 see
 643 .Xr crontab 5
 644 .El
 645 .Pp
 646 .It Pa db/
 647 misc. automatically generated system-specific database files
 648 .It Pa empty/
 649 empty directory used by
 650 .Xr sshd 8
 651 for privilege separation
 652 .It Pa games/
 653 misc. game status and score files
 654 .It Pa hammer/
 655 per PFS (pseudo file system) snapshots directory for
 656 .Xr hammer 5
 657 file systems
 658 .It Pa log/
 659 misc. system log files
 660 .Pp
 661 .Bl -tag -width ".Pa wtmp" -compact
 662 .It Pa wtmp
 663 login/logout log;
 664 see
 665 .Xr wtmp 5
 666 .El
 667 .Pp
 668 .It Pa mail/
 669 user mailbox files
 670 .It Pa msgs/
 671 system messages database;
 672 see
 673 .Xr msgs 1
 674 .It Pa preserve/
 675 temporary home of files preserved after an accidental death
 676 of an editor;
 677 see
 678 .Xr \&ex 1
 679 .It Pa quotas/
 680 filesystem quota information files
 681 .It Pa run/
 682 system information files describing various info about
 683 system since it was booted
 684 .Pp
 685 .Bl -tag -width ".Pa ppp/" -compact
 686 .It Pa ppp/
 687 writable by the
 688 .Dq network
 689 group for command connection sockets; see
 690 .Xr ppp 8
 691 .It Pa utmp
 692 database of current users;
 693 see
 694 .Xr utmp 5
 695 .El
 696 .Pp
 697 .It Pa rwho/
 698 rwho data files;
 699 see
 700 .Xr rwhod 8 ,
 701 .Xr rwho 1 ,
 702 and
 703 .Xr ruptime 1
 704 .It Pa spool/
 705 misc. printer and mail system spooling directories
 706 .Pp
 707 .Bl -tag -width ".Pa clientmqueue/" -compact
 708 .It Pa clientmqueue/
 709 undelivered submission mail queue;
 710 see
 711 .Xr sendmail 8
 712 .It Pa dma/
 713 undelivered mail queue;
 714 see
 715 .Xr dma 8
 716 .It Pa ftp/
 717 commonly
 718 .Pa ~ftp ;
 719 the anonymous ftp root directory
 720 .It Pa mqueue/
 721 undelivered mail queue;
 722 see
 723 .Xr sendmail 8
 724 .It Pa output/
 725 line printer spooling directories
 726 .It Pa uucp/
 727 uucp spool directory
 728 .It Pa uucppublic/
 729 commonly
 730 .Pa ~uucp ;
 731 public uucp temporary directory
 732 .El
 733 .Pp
 734 .It Pa tmp/
 735 temporary files that are kept between system reboots
 736 .Pp
 737 .Bl -tag -width ".Pa vi.recover/" -compact
 738 .It Pa vi.recover/
 739 the directory where recovery files are stored
 740 .El
 741 .Pp
 742 .It Pa yp/
 743 the NIS maps
 744 .El
 745 .El
 746 .Sh NOTES
 747 This manual page documents the default
 748 .Dx
 749 filesystem layout, but
 750 the actual hierarchy on a given system is defined at the system
 751 administrator's discretion.
 752 A well-maintained installation will include a customized version of
 753 this document.
 754 .Sh SEE ALSO
 755 .Xr apropos 1 ,
 756 .Xr find 1 ,
 757 .Xr finger 1 ,
 758 .Xr grep 1 ,
 759 .Xr ls 1 ,
 760 .Xr whatis 1 ,
 761 .Xr whereis 1 ,
 762 .Xr which 1 ,
 763 .Xr fsck 8
 764 .Sh HISTORY
 765 A
 766 .Nm
 767 manual page appeared in
 768 .At v7 .