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