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