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