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