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