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