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