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 netipx/
 224 IPX/SPX protocol stacks
 225 .It Pa netkey/
 226 kernel key-management service
 227 .It Pa netnatm/
 228 NATM include files;
 229 see
 230 .Xr natm 4
 231 .It Pa netsmb/
 232 SMB/CIFS requester
 233 .It Pa nfs/
 234 C include files for NFS (Network File System)
 235 .It Pa openssl/
 236 OpenSSL (Cryptography/SSL toolkit) headers
 237 .It Pa pcap/
 238 Packet Capture (libpcap) headers;
 239 see
 240 .Xr pcap 3
 241 .It Pa pccard/
 242 PC-CARD controllers
 243 .It Pa protocols/
 244 C include files for Berkeley service protocols
 245 .It Pa readline/
 246 get a line from a user, with editing;
 247 see
 248 .Xr readline 3
 249 .It Pa rpc/
 250 remote procedure calls;
 251 see
 252 .Xr rpc 3
 253 .It Pa rpcsvc/
 254 definition of RPC service structures; see
 255 .Xr rpc 3
 256 .It Pa security/
 257 PAM; see
 258 .Xr pam 8
 259 .It Pa sys/
 260 system C include files (kernel data structures)
 261 .It Pa ufs/
 262 C include files for UFS (The U-word File System)
 263 .Pp
 264 .Bl -tag -width ".Pa ffs/" -compact
 265 .It Pa ffs/
 266 Fast filesystem
 267 .It Pa mfs/
 268 memory file system;
 269 see
 270 .Xr mount_mfs 8
 271 .It Pa ufs/
 272 UFS filesystem
 273 .El
 274 .Pp
 275 .It Pa vm/
 276 virtual memory;
 277 see
 278 .Xr vmstat 8
 279 .El
 280 .Pp
 281 .It Pa lib/
 282 archive libraries
 283 .Pp
 284 .Bl -tag -width ".Pa compat/" -compact
 285 .It Pa aout/
 286 a.out archive libraries
 287 .It Pa compat/
 288 shared libraries for compatibility
 289 .Pp
 290 .Bl -tag -width ".Pa aout/" -compact
 291 .It Pa aout/
 292 a.out backward compatibility libraries
 293 .El
 294 .It Pa engines/
 295 OpenSSL dynamic engines
 296 .El
 297 .Pp
 298 .It Pa libdata/
 299 misc. utility data files
 300 .It Pa libexec/
 301 system daemons & system utilities (executed by other programs)
 302 .Pp
 303 .Bl -tag -width ".Pa binutils222/" -compact
 304 .It Pa binutils222/
 305 .Pp
 306 .Bl -tag -width ".Pa ldscripts/" -compact
 307 .It Pa ldscripts/
 308 linker scripts;
 309 see
 310 .Xr ld 1
 311 .El
 312 .Pp
 313 .It Pa binutils224/
 314 .Pp
 315 .Bl -tag -width ".Pa ldscripts/" -compact
 316 .It Pa ldscripts/
 317 linker scripts;
 318 see
 319 .Xr ld 1
 320 .El
 321 .Pp
 322 .It Pa lpr/
 323 utilities and filters for LP print system;
 324 see
 325 .Xr lpr 1
 326 .It Pa sendmail/
 327 the sendmail binary;
 328 see
 329 .Xr mailwrapper 8
 330 and
 331 .Xr sendmail 8
 332 .It Pa sm.bin/
 333 restricted shell for sendmail;
 334 see
 335 .Xr smrsh 8
 336 .It Pa uucp/
 337 uucp utilities;
 338 see
 339 .Xr uucp 1
 340 .El
 341 .Pp
 342 .It Pa local/
 343 local executables, libraries, etc.
 344 Also used as the default destination for the
 345 .Dx
 346 .Xr dports 7
 347 framework.
 348 Within
 349 .Pa local/ ,
 350 the general layout sketched out by
 351 .Nm
 352 for
 353 .Pa /usr
 354 should be used.
 355 Exceptions are the
 356 .Pa man
 357 directory
 358 .Po directly under
 359 .Pa local/
 360 rather than under
 361 .Pa local/share/ Ns Pc ,
 362 ports documentation
 363 .Po in
 364 .Pa share/doc/<port>/ Ns Pc ,
 365 and
 366 .Pa /usr/local/etc
 367 .Po mimics
 368 .Pa /etc Ns Pc .
 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 .Pp
 429 .Bl -tag -width ".Pa legal/" -compact
 430 .It Pa legal/
 431 License files for vendor supplied firmware
 432 .El
 433 .Pp
 434 .It Pa examples/
 435 various examples for users and programmers
 436 .It Pa games/
 437 ASCII text files used by various games
 438 .It Pa groff_font/
 439 device description file for device name
 440 .It Pa i18n/
 441 internationalization databases; see
 442 .Xr iconv 3
 443 .It Pa info/
 444 GNU Info hypertext system
 445 .It Pa libg++/
 446 libg++'s genclass prototype/template class files
 447 .It Pa locale/
 448 localization files;
 449 see
 450 .Xr setlocale 3
 451 .It Pa man/
 452 manual pages
 453 .It Pa me/
 454 macros for use with the me macro package;
 455 see
 456 .Xr me 7
 457 .It Pa misc/
 458 misc system-wide ASCII text files
 459 .Pp
 460 .Bl -tag -width ".Pa termcap" -compact
 461 .It Pa termcap
 462 terminal characteristics database;
 463 see
 464 .Xr termcap 5
 465 .El
 466 .Pp
 467 .It Pa mk/
 468 templates for make;
 469 see
 470 .Xr make 1
 471 .It Pa nls/
 472 national language support files;
 473 see
 474 .Xr mklocale 1
 475 .It Pa openssl/
 476 .Pp
 477 .Bl -tag -width ".Pa man/" -compact
 478 .It Pa man/
 479 OpenSSL manual pages
 480 .El
 481 .Pp
 482 .It Pa sendmail/
 483 sendmail configuration files;
 484 see
 485 .Xr sendmail 8
 486 .It Pa skel/
 487 example . (dot) files for new accounts
 488 .It Pa syscons/
 489 files used by
 490 .Xr syscons 4
 491 .Pp
 492 .Bl -tag -width ".Pa scrnmaps/" -compact
 493 .It Pa fonts/
 494 console fonts;
 495 see
 496 .Xr vidcontrol 1
 497 and
 498 .Xr vidfont 1
 499 .It Pa keymaps/
 500 console keyboard maps;
 501 see
 502 .Xr kbdcontrol 1
 503 and
 504 .Xr kbdmap 1
 505 .It Pa scrnmaps/
 506 console screen maps
 507 .El
 508 .Pp
 509 .It Pa tabset/
 510 tab description files for a variety of terminals; used in
 511 the termcap file;
 512 see
 513 .Xr termcap 5
 514 .It Pa terminfo/
 515 compiled
 516 .Xr terminfo 5
 517 database files
 518 .It Pa tmac/
 519 text processing macros;
 520 see
 521 .Xr nroff 1
 522 and
 523 .Xr troff 1
 524 .It Pa vi/
 525 localization support and utilities for
 526 .Xr vi 1
 527 .It Pa zoneinfo/
 528 timezone configuration information;
 529 see
 530 .Xr tzfile 5
 531 .El
 532 .Pp
 533 .It Pa src/
 534 .Bx ,
 535 third-party, and/or local source files
 536 .Pp
 537 .Bl -tag -width ".Pa nrelease/" -compact
 538 .It Pa bin/
 539 source code for files in
 540 .Pa /bin
 541 .It Pa contrib/
 542 source code for contributed software
 543 .It Pa crypto/
 544 source code for contributed cryptography software
 545 .It Pa etc/
 546 source code for files in
 547 .Pa /etc
 548 .It Pa games/
 549 source code for files in
 550 .Pa /usr/games
 551 .It Pa gnu/
 552 Utilities covered by the GNU General Public License
 553 .It Pa include/
 554 source code for files in
 555 .Pa /usr/include
 556 .It Pa lib/
 557 source code for files in
 558 .Pa /usr/lib
 559 .It Pa libexec/
 560 source code for files in
 561 .Pa /usr/libexec
 562 .It Pa nrelease/
 563 files required to produce a
 564 .Dx
 565 release
 566 .It Pa sbin/
 567 source code for files in
 568 .Pa /sbin
 569 .It Pa secure/
 570 build directory for files in
 571 .Pa /usr/src/crypto
 572 .It Pa share/
 573 source for files in
 574 .Pa /usr/share
 575 .It Pa sys/
 576 kernel source code
 577 .It Pa tools/
 578 tools used for maintenance and testing of
 579 .Dx
 580 .It Pa usr.bin/
 581 source code for files in
 582 .Pa /usr/bin
 583 .It Pa usr.sbin/
 584 source code for files in
 585 .Pa /usr/sbin
 586 .El
 587 .El
 588 .It Pa /var/
 589 multi-purpose log, temporary, transient, and spool files
 590 .Pp
 591 .Bl -tag -width ".Pa preserve/" -compact
 592 .It Pa account/
 593 system accounting files
 594 .Pp
 595 .Bl -tag -width ".Pa acct" -compact
 596 .It Pa acct
 597 execution accounting file;
 598 see
 599 .Xr acct 5
 600 .El
 601 .Pp
 602 .It Pa at/
 603 timed command scheduling files;
 604 see
 605 .Xr \&at 1
 606 .Pp
 607 .Bl -tag -width ".Pa spool/" -compact
 608 .It Pa jobs/
 609 directory containing job files
 610 .It Pa spool/
 611 directory containing output spool files
 612 .El
 613 .Pp
 614 .It Pa backups/
 615 misc. backup files
 616 .It Pa crash/
 617 default directory to store kernel crash dumps; see
 618 .Xr crash 8
 619 and
 620 .Xr savecore 8
 621 .It Pa cron/
 622 files used by cron;
 623 see
 624 .Xr cron 8
 625 .Pp
 626 .Bl -tag -width ".Pa tabs/" -compact
 627 .It Pa tabs/
 628 crontab files;
 629 see
 630 .Xr crontab 5
 631 .El
 632 .Pp
 633 .It Pa db/
 634 misc. automatically generated system-specific database files
 635 .It Pa empty/
 636 empty directory used by
 637 .Xr sshd 8
 638 for privilege separation
 639 .It Pa games/
 640 misc. game status and score files
 641 .It Pa hammer/
 642 per PFS (pseudo file system) snapshots directory for
 643 .Xr hammer 5
 644 file systems
 645 .It Pa log/
 646 misc. system log files
 647 .Pp
 648 .Bl -tag -width ".Pa wtmp" -compact
 649 .It Pa wtmp
 650 login/logout log;
 651 see
 652 .Xr wtmp 5
 653 .El
 654 .Pp
 655 .It Pa mail/
 656 user mailbox files
 657 .It Pa msgs/
 658 system messages database;
 659 see
 660 .Xr msgs 1
 661 .It Pa preserve/
 662 temporary home of files preserved after an accidental death
 663 of an editor;
 664 see
 665 .Xr \&ex 1
 666 .It Pa quotas/
 667 filesystem quota information files
 668 .It Pa run/
 669 system information files describing various info about
 670 system since it was booted
 671 .Pp
 672 .Bl -tag -width ".Pa ppp/" -compact
 673 .It Pa ppp/
 674 writable by the
 675 .Dq network
 676 group for command connection sockets; see
 677 .Xr ppp 8
 678 .It Pa utmp
 679 database of current users;
 680 see
 681 .Xr utmp 5
 682 .El
 683 .Pp
 684 .It Pa rwho/
 685 rwho data files;
 686 see
 687 .Xr rwhod 8 ,
 688 .Xr rwho 1 ,
 689 and
 690 .Xr ruptime 1
 691 .It Pa spool/
 692 misc. printer and mail system spooling directories
 693 .Pp
 694 .Bl -tag -width ".Pa clientmqueue/" -compact
 695 .It Pa clientmqueue/
 696 undelivered submission mail queue;
 697 see
 698 .Xr sendmail 8
 699 .It Pa dma/
 700 undelivered mail queue;
 701 see
 702 .Xr dma 8
 703 .It Pa ftp/
 704 commonly
 705 .Pa ~ftp ;
 706 the anonymous ftp root directory
 707 .It Pa mqueue/
 708 undelivered mail queue;
 709 see
 710 .Xr sendmail 8
 711 .It Pa output/
 712 line printer spooling directories
 713 .It Pa uucp/
 714 uucp spool directory
 715 .It Pa uucppublic/
 716 commonly
 717 .Pa ~uucp ;
 718 public uucp temporary directory
 719 .El
 720 .Pp
 721 .It Pa tmp/
 722 temporary files that are kept between system reboots
 723 .Pp
 724 .Bl -tag -width ".Pa vi.recover/" -compact
 725 .It Pa vi.recover/
 726 the directory where recovery files are stored
 727 .El
 728 .Pp
 729 .It Pa yp/
 730 the NIS maps
 731 .El
 732 .El
 733 .Sh NOTES
 734 This manual page documents the default
 735 .Dx
 736 filesystem layout, but
 737 the actual hierarchy on a given system is defined at the system
 738 administrator's discretion.
 739 A well-maintained installation will include a customized version of
 740 this document.
 741 .Sh SEE ALSO
 742 .Xr apropos 1 ,
 743 .Xr find 1 ,
 744 .Xr finger 1 ,
 745 .Xr grep 1 ,
 746 .Xr ls 1 ,
 747 .Xr whatis 1 ,
 748 .Xr whereis 1 ,
 749 .Xr which 1 ,
 750 .Xr fsck 8
 751 .Sh HISTORY
 752 A
 753 .Nm
 754 manual page appeared in
 755 .At v7 .