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