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