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.25 2008/09/06 10:25:04 thomas 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 man directory (directly under
 397 .Pa pkg/
 398 rather than under
 399 .Pa pkg/share/ ) ,
 400 documentation (in
 401 .Pa share/doc/<pkg>/ ) ,
 402 and
 403 .Pa /usr/pkg/etc
 404 .Pf ( mimics
 405 .Pa /etc ) .
 406 .It Pa pkgsrc/
 407 The
 408 .Xr pkgsrc 7
 409 collection (optional).
 410 .It Pa sbin/
 411 system daemons & system utilities (executed by users)
 412 .It Pa share/
 413 architecture-independent files
 414 .Pp
 415 .Bl -tag -width ".Pa groff_font/" -compact
 416 .It Pa calendar/
 417 a variety of pre-fab calendar files;
 418 see
 419 .Xr calendar 1
 420 .It Pa dict/
 421 word lists;
 422 see
 423 .Xr look 1
 424 .Pp
 425 .Bl -tag -width ".Pa papers/" -compact
 426 .It Pa web2
 427 words from Webster's 2nd International
 428 .It Pa words
 429 common words
 430 .It Pa papers/
 431 reference databases;
 432 see
 433 .Xr refer 1
 434 .El
 435 .Pp
 436 .It Pa examples/
 437 various examples for users and programmers
 438 .It Pa games/
 439 ASCII text files used by various games
 440 .It Pa groff_font/
 441 device description file for device name
 442 .It Pa i18n/
 443 internationalization databases; see
 444 .Xr iconv 3
 445 .It Pa info/
 446 GNU Info hypertext system
 447 .It Pa isdn/
 448 ISDN
 449 .It Pa libg++/
 450 libg++'s genclass prototype/template class files
 451 .It Pa locale/
 452 localization files;
 453 see
 454 .Xr setlocale 3
 455 .It Pa man/
 456 manual pages
 457 .It Pa me/
 458 macros for use with the me macro package;
 459 see
 460 .Xr me 7
 461 .It Pa misc/
 462 misc system-wide ASCII text files
 463 .Pp
 464 .Bl -tag -width ".Pa termcap" -compact
 465 .It Pa termcap
 466 terminal characteristics database;
 467 see
 468 .Xr termcap 5
 469 .El
 470 .Pp
 471 .It Pa mk/
 472 templates for make;
 473 see
 474 .Xr make 1
 475 .It Pa nls/
 476 national language support files;
 477 see
 478 .Xr mklocale 1
 479 .It Pa openssl/
 480 .Pp
 481 .Bl -tag -width ".Pa man/" -compact
 482 .It Pa man/
 483 OpenSSL manual pages
 484 .El
 485 .Pp
 486 .It Pa sendmail/
 487 sendmail configuration files;
 488 see
 489 .Xr sendmail 8
 490 .It Pa skel/
 491 example . (dot) files for new accounts
 492 .It Pa syscons/
 493 files used by
 494 .Xr syscons 4
 495 .Pp
 496 .Bl -tag -width ".Pa scrnmaps/" -compact
 497 .It Pa fonts/
 498 console fonts;
 499 see
 500 .Xr vidcontrol 1
 501 and
 502 .Xr vidfont 1
 503 .It Pa keymaps/
 504 console keyboard maps;
 505 see
 506 .Xr kbdcontrol 1
 507 and
 508 .Xr kbdmap 1
 509 .It Pa scrnmaps/
 510 console screen maps
 511 .El
 512 .Pp
 513 .It Pa tabset/
 514 tab description files for a variety of terminals; used in
 515 the termcap file;
 516 see
 517 .Xr termcap 5
 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 kerberos5/" -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 kerberos5/
 557 source code for kerberos version 5
 558 .It Pa lib/
 559 source code for files in
 560 .Pa /usr/lib
 561 .It Pa libexec/
 562 source code for files in
 563 .Pa /usr/libexec
 564 .It Pa nrelease/
 565 files required to produce a
 566 .Dx
 567 release
 568 .It Pa sbin/
 569 source code for files in
 570 .Pa /sbin
 571 .It Pa secure/
 572 build directory for files in
 573 .Pa /usr/src/crypto
 574 .It Pa share/
 575 source for files in
 576 .Pa /usr/share
 577 .It Pa sys/
 578 kernel source code
 579 .It Pa tools/
 580 tools used for maintenance and testing of
 581 .Dx
 582 .It Pa usr.bin/
 583 source code for files in
 584 .Pa /usr/bin
 585 .It Pa usr.sbin/
 586 source code for files in
 587 .Pa /usr/sbin
 588 .El
 589 .El
 590 .It Pa /var/
 591 multi-purpose log, temporary, transient, and spool files
 592 .Pp
 593 .Bl -tag -width ".Pa preserve/" -compact
 594 .It Pa account/
 595 system accounting files
 596 .Pp
 597 .Bl -tag -width ".Pa acct" -compact
 598 .It Pa acct
 599 execution accounting file;
 600 see
 601 .Xr acct 5
 602 .El
 603 .Pp
 604 .It Pa at/
 605 timed command scheduling files;
 606 see
 607 .Xr \&at 1
 608 .Pp
 609 .Bl -tag -width ".Pa spool/" -compact
 610 .It Pa jobs/
 611 directory containing job files
 612 .It Pa spool/
 613 directory containing output spool files
 614 .El
 615 .Pp
 616 .It Pa backups/
 617 misc. backup files
 618 .It Pa crash/
 619 default directory to store kernel crash dumps; see
 620 .Xr crash 8
 621 and
 622 .Xr savecore 8
 623 .It Pa cron/
 624 files used by cron;
 625 see
 626 .Xr cron 8
 627 .Pp
 628 .Bl -tag -width ".Pa tabs/" -compact
 629 .It Pa tabs/
 630 crontab files;
 631 see
 632 .Xr crontab 5
 633 .El
 634 .Pp
 635 .It Pa db/
 636 misc. automatically generated system-specific database files
 637 .It Pa empty/
 638 empty directory used by
 639 .Xr sshd 8
 640 for privilege separation
 641 .It Pa games/
 642 misc. game status and score files
 643 .It Pa heimdal/
 644 kerberos server databases; see
 645 .Xr kdc 8
 646 .It Pa log/
 647 misc. system log files
 648 .Pp
 649 .Bl -tag -width ".Pa wtmp" -compact
 650 .It Pa wtmp
 651 login/logout log;
 652 see
 653 .Xr wtmp 5
 654 .El
 655 .Pp
 656 .It Pa mail/
 657 user mailbox files
 658 .It Pa msgs/
 659 system messages database;
 660 see
 661 .Xr msgs 1
 662 .It Pa preserve/
 663 temporary home of files preserved after an accidental death
 664 of an editor;
 665 see
 666 .Xr \&ex 1
 667 .It Pa quotas/
 668 filesystem quota information files
 669 .It Pa run/
 670 system information files describing various info about
 671 system since it was booted
 672 .Pp
 673 .Bl -tag -width ".Pa ppp/" -compact
 674 .It Pa ppp/
 675 writable by the
 676 .Dq network
 677 group for command connection sockets; see
 678 .Xr ppp 8
 679 .It Pa utmp
 680 database of current users;
 681 see
 682 .Xr utmp 5
 683 .El
 684 .Pp
 685 .It Pa rwho/
 686 rwho data files;
 687 see
 688 .Xr rwhod 8 ,
 689 .Xr rwho 1 ,
 690 and
 691 .Xr ruptime 1
 692 .It Pa spool/
 693 misc. printer and mail system spooling directories
 694 .Pp
 695 .Bl -tag -width ".Pa clientmqueue/" -compact
 696 .It Pa clientmqueue/
 697 undelivered submission mail queue;
 698 see
 699 .Xr sendmail 8
 700 .It Pa dma/
 701 undelivered mail queue;
 702 see
 703 .Xr dma 8
 704 .It Pa ftp/
 705 commonly
 706 .Pa ~ftp ;
 707 the anonymous ftp root directory
 708 .It Pa mqueue/
 709 undelivered mail queue;
 710 see
 711 .Xr sendmail 8
 712 .It Pa output/
 713 line printer spooling directories
 714 .It Pa uucp/
 715 uucp spool directory
 716 .It Pa uucppublic/
 717 commonly
 718 .Pa ~uucp ;
 719 public uucp temporary directory
 720 .El
 721 .Pp
 722 .It Pa tmp/
 723 temporary files that are kept between system reboots
 724 .Pp
 725 .Bl -tag -width ".Pa vi.recover/" -compact
 726 .It Pa vi.recover/
 727 the directory where recovery files are stored
 728 .El
 729 .Pp
 730 .It Pa yp/
 731 the NIS maps
 732 .El
 733 .El
 734 .Sh NOTES
 735 This manual page documents the default
 736 .Dx
 737 filesystem layout, but
 738 the actual hierarchy on a given system is defined at the system
 739 administrator's discretion.
 740 A well-maintained installation will include a customized version of
 741 this document.
 742 .Sh SEE ALSO
 743 .Xr apropos 1 ,
 744 .Xr find 1 ,
 745 .Xr finger 1 ,
 746 .Xr grep 1 ,
 747 .Xr ls 1 ,
 748 .Xr whatis 1 ,
 749 .Xr whereis 1 ,
 750 .Xr which 1 ,
 751 .Xr fsck 8
 752 .Sh HISTORY
 753 A
 754 .Nm
 755 manual page appeared in
 756 .At v7 .