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