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