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.23 2008/02/03 18:02:42 swildner Exp $
  35 .\"
  36 .Dd February 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 .El
  57 .It Pa /dev/
  58 block and character device files
  59 .Pp
  60 .Bl -tag -width ".Pa MAKEDEV" -compact
  61 .It Pa MAKEDEV
  62 script for creating device files;
  63 see
  64 .Xr MAKEDEV 8
  65 .It Pa fd/
  66 file descriptor files;
  67 see
  68 .Xr \&fd 4
  69 .El
  70 .It Pa /etc/
  71 system configuration files and scripts
  72 .Pp
  73 .Bl -tag -width ".Pa bluetooth/" -compact
  74 .It Pa bluetooth/
  75 bluetooth configuration files
  76 .It Pa defaults/
  77 default system configuration files;
  78 see
  79 .Xr rc 8
  80 .It Pa dma/
  81 .Xr dma 8
  82 configuration files
  83 .It Pa firmware/
  84 Firmware image files;
  85 see
  86 .Xr firmware 9
  87 .It Pa isdn/
  88 isdn4bsd configuration files;
  89 see
  90 .Xr isdnd 8
  91 .It Pa localtime
  92 local timezone information;
  93 see
  94 .Xr ctime 3
  95 .It Pa mail/
  96 Sendmail control files
  97 .It Pa mtree/
  98 mtree configuration files;
  99 see
 100 .Xr mtree 8
 101 .It Pa namedb/
 102 named configuration files;
 103 see
 104 .Xr named 8
 105 .It Pa pam.d/
 106 configuration files for the Pluggable Authentication Modules (PAM)
 107 library
 108 .It Pa periodic/
 109 scripts that are run daily, weekly, and monthly, via
 110 .Xr cron 8 ;
 111 see
 112 .Xr periodic 8
 113 .It Pa ppp/
 114 ppp configuration files;
 115 see
 116 .Xr ppp 8
 117 .It Pa rc.d/
 118 System and daemon startup/control scripts;
 119 see
 120 .Xr rc 8
 121 .It Pa ssh/
 122 OpenSSH configuration files;
 123 see
 124 .Xr ssh 1
 125 .It Pa ssl/
 126 OpenSSL configuration files
 127 .It Pa upgrade/
 128 Files relevant to system upgrades
 129 .It Pa uucp/
 130 uucp configuration files;
 131 see
 132 .Xr uucp 1
 133 .El
 134 .It Pa /home/
 135 HOME directories of non-root users
 136 .It Pa /kernel
 137 pure kernel executable (the operating system loaded into memory
 138 at boot time).
 139 .It Pa /mnt/
 140 empty directory commonly used by
 141 system administrators as a temporary mount point
 142 .It Pa /modules/
 143 loadable kernel modules;
 144 see
 145 .Xr kldstat 8
 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.  Exceptions are the man directory (directly under
 369 .Pa local/
 370 rather than under
 371 .Pa local/share/ ) ,
 372 documentation (in
 373 .Pa share/doc/<app>/ ) ,
 374 and
 375 .Pa /usr/local/etc
 376 .Pf ( mimics
 377 .Pa /etc ) .
 378 .It Pa obj/
 379 architecture-specific target tree produced by building the
 380 .Pa /usr/src
 381 tree
 382 .It Pa pkg/
 383 default destination directory for the
 384 .Xr pkgsrc 7
 385 collection.
 386 Within
 387 .Pa pkg/ ,
 388 the general layout sketched out by
 389 .Xr hier 7
 390 for
 391 .Pa /usr
 392 should be used.  Exceptions are the man directory (directly under
 393 .Pa pkg/
 394 rather than under
 395 .Pa pkg/share/ ) ,
 396 documentation (in
 397 .Pa share/doc/<pkg>/ ) ,
 398 and
 399 .Pa /usr/pkg/etc
 400 .Pf ( mimics
 401 .Pa /etc ) .
 402 .It Pa pkgsrc/
 403 The
 404 .Xr pkgsrc 7
 405 collection (optional).
 406 .It Pa sbin/
 407 system daemons & system utilities (executed by users)
 408 .It Pa share/
 409 architecture-independent files
 410 .Pp
 411 .Bl -tag -width ".Pa groff_font/" -compact
 412 .It Pa calendar/
 413 a variety of pre-fab calendar files;
 414 see
 415 .Xr calendar 1
 416 .It Pa dict/
 417 word lists;
 418 see
 419 .Xr look 1
 420 .Pp
 421 .Bl -tag -width ".Pa papers/" -compact
 422 .It Pa web2
 423 words from Webster's 2nd International
 424 .It Pa words
 425 common words
 426 .It Pa papers/
 427 reference databases;
 428 see
 429 .Xr refer 1
 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 isdn/
 444 ISDN
 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 tmac/
 515 text processing macros;
 516 see
 517 .Xr nroff 1
 518 and
 519 .Xr troff 1
 520 .It Pa vi/
 521 localization support and utilities for
 522 .Xr vi 1
 523 .It Pa zoneinfo/
 524 timezone configuration information;
 525 see
 526 .Xr tzfile 5
 527 .El
 528 .Pp
 529 .It Pa src/
 530 .Bx ,
 531 third-party, and/or local source files
 532 .Pp
 533 .Bl -tag -width ".Pa kerberos5/" -compact
 534 .It Pa bin/
 535 source code for files in
 536 .Pa /bin
 537 .It Pa contrib/
 538 source code for contributed software
 539 .It Pa crypto/
 540 source code for contributed cryptography software
 541 .It Pa etc/
 542 source code for files in
 543 .Pa /etc
 544 .It Pa games/
 545 source code for files in
 546 .Pa /usr/games
 547 .It Pa gnu/
 548 Utilities covered by the GNU General Public License
 549 .It Pa include/
 550 source code for files in
 551 .Pa /usr/include
 552 .It Pa kerberos5/
 553 source code for kerberos version 5
 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 heimdal/
 640 kerberos server databases; see
 641 .Xr kdc 8
 642 .It Pa log/
 643 misc. system log files
 644 .Pp
 645 .Bl -tag -width ".Pa wtmp" -compact
 646 .It Pa wtmp
 647 login/logout log;
 648 see
 649 .Xr wtmp 5
 650 .El
 651 .Pp
 652 .It Pa mail/
 653 user mailbox files
 654 .It Pa msgs/
 655 system messages database;
 656 see
 657 .Xr msgs 1
 658 .It Pa preserve/
 659 temporary home of files preserved after an accidental death
 660 of an editor;
 661 see
 662 .Xr \&ex 1
 663 .It Pa quotas/
 664 filesystem quota information files
 665 .It Pa run/
 666 system information files describing various info about
 667 system since it was booted
 668 .Pp
 669 .Bl -tag -width ".Pa ppp/" -compact
 670 .It Pa ppp/
 671 writable by the
 672 .Dq network
 673 group for command connection sockets; see
 674 .Xr ppp 8
 675 .It Pa utmp
 676 database of current users;
 677 see
 678 .Xr utmp 5
 679 .El
 680 .Pp
 681 .It Pa rwho/
 682 rwho data files;
 683 see
 684 .Xr rwhod 8 ,
 685 .Xr rwho 1 ,
 686 and
 687 .Xr ruptime 1
 688 .It Pa spool/
 689 misc. printer and mail system spooling directories
 690 .Pp
 691 .Bl -tag -width ".Pa clientmqueue/" -compact
 692 .It Pa clientmqueue/
 693 undelivered submission mail queue;
 694 see
 695 .Xr sendmail 8
 696 .It Pa dma/
 697 undelivered mail queue;
 698 see
 699 .Xr dma 8
 700 .It Pa ftp/
 701 commonly
 702 .Pa ~ftp ;
 703 the anonymous ftp root directory
 704 .It Pa mqueue/
 705 undelivered mail queue;
 706 see
 707 .Xr sendmail 8
 708 .It Pa output/
 709 line printer spooling directories
 710 .It Pa uucp/
 711 uucp spool directory
 712 .It Pa uucppublic/
 713 commonly
 714 .Pa ~uucp ;
 715 public uucp temporary directory
 716 .El
 717 .Pp
 718 .It Pa tmp/
 719 temporary files that are kept between system reboots
 720 .Pp
 721 .Bl -tag -width ".Pa vi.recover/" -compact
 722 .It Pa vi.recover/
 723 the directory where recovery files are stored
 724 .El
 725 .Pp
 726 .It Pa yp/
 727 the NIS maps
 728 .El
 729 .El
 730 .Sh NOTES
 731 This manual page documents the default
 732 .Dx
 733 filesystem layout, but
 734 the actual hierarchy on a given system is defined at the system
 735 administrator's discretion.
 736 A well-maintained installation will include a customized version of
 737 this document.
 738 .Sh SEE ALSO
 739 .Xr apropos 1 ,
 740 .Xr find 1 ,
 741 .Xr finger 1 ,
 742 .Xr grep 1 ,
 743 .Xr ls 1 ,
 744 .Xr whatis 1 ,
 745 .Xr whereis 1 ,
 746 .Xr which 1 ,
 747 .Xr fsck 8
 748 .Sh HISTORY
 749 A
 750 .Nm
 751 manual page appeared in
 752 .At v7 .