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