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