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 pcap/
 249 Packet Capture (libpcap) headers;
 250 see
 251 .Xr pcap 3
 252 .It Pa pccard/
 253 PC-CARD controllers
 254 .It Pa protocols/
 255 C include files for Berkeley service protocols
 256 .It Pa readline/
 257 get a line from a user, with editing;
 258 see
 259 .Xr readline 3
 260 .It Pa rpc/
 261 remote procedure calls;
 262 see
 263 .Xr rpc 3
 264 .It Pa rpcsvc/
 265 definition of RPC service structures; see
 266 .Xr rpc 3
 267 .It Pa security/
 268 PAM; see
 269 .Xr pam 8
 270 .It Pa sys/
 271 system C include files (kernel data structures)
 272 .It Pa ufs/
 273 C include files for UFS (The U-word File System)
 274 .Pp
 275 .Bl -tag -width ".Pa ffs/" -compact
 276 .It Pa ffs/
 277 Fast filesystem
 278 .It Pa mfs/
 279 memory file system;
 280 see
 281 .Xr mount_mfs 8
 282 .It Pa ufs/
 283 UFS filesystem
 284 .El
 285 .Pp
 286 .It Pa vm/
 287 virtual memory;
 288 see
 289 .Xr vmstat 8
 290 .El
 291 .Pp
 292 .It Pa lib/
 293 archive libraries
 294 .Pp
 295 .Bl -tag -width ".Pa compat/" -compact
 296 .It Pa aout/
 297 a.out archive libraries
 298 .It Pa compat/
 299 shared libraries for compatibility
 300 .Pp
 301 .Bl -tag -width ".Pa aout/" -compact
 302 .It Pa aout/
 303 a.out backward compatibility libraries
 304 .El
 305 .El
 306 .Pp
 307 .It Pa libdata/
 308 misc. utility data files
 309 .Pp
 310 .Bl -tag -width ".Pa stallion/" -compact
 311 .It Pa doscmd/
 312 files used by doscmd (drivers, fonts, etc.);
 313 see
 314 .Xr doscmd 1
 315 .Pp
 316 .Bl -tag -width ".Pa fonts/" -compact
 317 .It Pa fonts/
 318 fonts used by doscmd
 319 .El
 320 .Pp
 321 .It Pa lint/
 322 various prebuilt lint libraries;
 323 see
 324 .Xr lint 1
 325 .It Pa msdosfs/
 326 Character set conversion tables
 327 .It Pa stallion/
 328 holds the download firmware images
 329 .El
 330 .Pp
 331 .It Pa libexec/
 332 system daemons & system utilities (executed by other programs)
 333 .Pp
 334 .Bl -tag -width ".Pa binutils217/" -compact
 335 .It Pa binutils217/
 336 .Pp
 337 .Bl -tag -width ".Pa ldscripts/" -compact
 338 .It Pa ldscripts/
 339 linker scripts;
 340 see
 341 .Xr ld 1
 342 .El
 343 .Pp
 344 .It Pa lpr/
 345 utilities and filters for LP print system;
 346 see
 347 .Xr lpr 1
 348 .It Pa sendmail/
 349 the sendmail binary;
 350 see
 351 .Xr mailwrapper 8
 352 and
 353 .Xr sendmail 8
 354 .It Pa sm.bin/
 355 restricted shell for sendmail;
 356 see
 357 .Xr smrsh 8
 358 .It Pa uucp/
 359 uucp utilities;
 360 see
 361 .Xr uucp 1
 362 .El
 363 .Pp
 364 .It Pa local/
 365 local executables, libraries, etc.
 366 Within
 367 .Pa local/ ,
 368 the general layout sketched out by
 369 .Xr hier 7
 370 for
 371 .Pa /usr
 372 should be used.
 373 Exceptions are the
 374 .Pa man/
 375 directory (directly under
 376 .Pa local/
 377 rather than under
 378 .Pa local/share/ ) ,
 379 documentation (in
 380 .Pa share/doc/<app>/ ) ,
 381 and
 382 .Pa /usr/local/etc
 383 .Pf ( mimics
 384 .Pa /etc ) .
 385 .It Pa obj/
 386 architecture-specific target tree produced by building the
 387 .Pa /usr/src
 388 tree
 389 .It Pa pkg/
 390 default destination directory for the
 391 .Xr pkgsrc 7
 392 collection.
 393 Within
 394 .Pa pkg/ ,
 395 the general layout sketched out by
 396 .Xr hier 7
 397 for
 398 .Pa /usr
 399 should be used.
 400 Exceptions are the
 401 .Pa man/
 402 directory (directly under
 403 .Pa pkg/
 404 rather than under
 405 .Pa pkg/share/ ) ,
 406 documentation (in
 407 .Pa share/doc/<pkg>/ ) ,
 408 and
 409 .Pa /usr/pkg/etc
 410 .Pf ( mimics
 411 .Pa /etc ) .
 412 .It Pa pkgsrc/
 413 The
 414 .Xr pkgsrc 7
 415 collection (optional).
 416 .It Pa sbin/
 417 system daemons & system utilities (executed by users)
 418 .It Pa share/
 419 architecture-independent files
 420 .Pp
 421 .Bl -tag -width ".Pa groff_font/" -compact
 422 .It Pa calendar/
 423 a variety of pre-fab calendar files;
 424 see
 425 .Xr calendar 1
 426 .It Pa dict/
 427 word lists;
 428 see
 429 .Xr look 1
 430 .Pp
 431 .Bl -tag -width ".Pa papers/" -compact
 432 .It Pa web2
 433 words from Webster's 2nd International
 434 .It Pa words
 435 common words
 436 .It Pa papers/
 437 reference databases;
 438 see
 439 .Xr refer 1
 440 .El
 441 .Pp
 442 .It Pa examples/
 443 various examples for users and programmers
 444 .It Pa games/
 445 ASCII text files used by various games
 446 .It Pa groff_font/
 447 device description file for device name
 448 .It Pa i18n/
 449 internationalization databases; see
 450 .Xr iconv 3
 451 .It Pa info/
 452 GNU Info hypertext system
 453 .It Pa isdn/
 454 ISDN
 455 .It Pa libg++/
 456 libg++'s genclass prototype/template class files
 457 .It Pa locale/
 458 localization files;
 459 see
 460 .Xr setlocale 3
 461 .It Pa man/
 462 manual pages
 463 .It Pa me/
 464 macros for use with the me macro package;
 465 see
 466 .Xr me 7
 467 .It Pa misc/
 468 misc system-wide ASCII text files
 469 .Pp
 470 .Bl -tag -width ".Pa termcap" -compact
 471 .It Pa termcap
 472 terminal characteristics database;
 473 see
 474 .Xr termcap 5
 475 .El
 476 .Pp
 477 .It Pa mk/
 478 templates for make;
 479 see
 480 .Xr make 1
 481 .It Pa nls/
 482 national language support files;
 483 see
 484 .Xr mklocale 1
 485 .It Pa openssl/
 486 .Pp
 487 .Bl -tag -width ".Pa man/" -compact
 488 .It Pa man/
 489 OpenSSL manual pages
 490 .El
 491 .Pp
 492 .It Pa sendmail/
 493 sendmail configuration files;
 494 see
 495 .Xr sendmail 8
 496 .It Pa skel/
 497 example . (dot) files for new accounts
 498 .It Pa syscons/
 499 files used by
 500 .Xr syscons 4
 501 .Pp
 502 .Bl -tag -width ".Pa scrnmaps/" -compact
 503 .It Pa fonts/
 504 console fonts;
 505 see
 506 .Xr vidcontrol 1
 507 and
 508 .Xr vidfont 1
 509 .It Pa keymaps/
 510 console keyboard maps;
 511 see
 512 .Xr kbdcontrol 1
 513 and
 514 .Xr kbdmap 1
 515 .It Pa scrnmaps/
 516 console screen maps
 517 .El
 518 .Pp
 519 .It Pa tabset/
 520 tab description files for a variety of terminals; used in
 521 the termcap file;
 522 see
 523 .Xr termcap 5
 524 .It Pa tmac/
 525 text processing macros;
 526 see
 527 .Xr nroff 1
 528 and
 529 .Xr troff 1
 530 .It Pa vi/
 531 localization support and utilities for
 532 .Xr vi 1
 533 .It Pa zoneinfo/
 534 timezone configuration information;
 535 see
 536 .Xr tzfile 5
 537 .El
 538 .Pp
 539 .It Pa src/
 540 .Bx ,
 541 third-party, and/or local source files
 542 .Pp
 543 .Bl -tag -width ".Pa kerberos5/" -compact
 544 .It Pa bin/
 545 source code for files in
 546 .Pa /bin
 547 .It Pa contrib/
 548 source code for contributed software
 549 .It Pa crypto/
 550 source code for contributed cryptography software
 551 .It Pa etc/
 552 source code for files in
 553 .Pa /etc
 554 .It Pa games/
 555 source code for files in
 556 .Pa /usr/games
 557 .It Pa gnu/
 558 Utilities covered by the GNU General Public License
 559 .It Pa include/
 560 source code for files in
 561 .Pa /usr/include
 562 .It Pa kerberos5/
 563 source code for kerberos version 5
 564 .It Pa lib/
 565 source code for files in
 566 .Pa /usr/lib
 567 .It Pa libexec/
 568 source code for files in
 569 .Pa /usr/libexec
 570 .It Pa nrelease/
 571 files required to produce a
 572 .Dx
 573 release
 574 .It Pa sbin/
 575 source code for files in
 576 .Pa /sbin
 577 .It Pa secure/
 578 build directory for files in
 579 .Pa /usr/src/crypto
 580 .It Pa share/
 581 source for files in
 582 .Pa /usr/share
 583 .It Pa sys/
 584 kernel source code
 585 .It Pa tools/
 586 tools used for maintenance and testing of
 587 .Dx
 588 .It Pa usr.bin/
 589 source code for files in
 590 .Pa /usr/bin
 591 .It Pa usr.sbin/
 592 source code for files in
 593 .Pa /usr/sbin
 594 .El
 595 .El
 596 .It Pa /var/
 597 multi-purpose log, temporary, transient, and spool files
 598 .Pp
 599 .Bl -tag -width ".Pa preserve/" -compact
 600 .It Pa account/
 601 system accounting files
 602 .Pp
 603 .Bl -tag -width ".Pa acct" -compact
 604 .It Pa acct
 605 execution accounting file;
 606 see
 607 .Xr acct 5
 608 .El
 609 .Pp
 610 .It Pa at/
 611 timed command scheduling files;
 612 see
 613 .Xr \&at 1
 614 .Pp
 615 .Bl -tag -width ".Pa spool/" -compact
 616 .It Pa jobs/
 617 directory containing job files
 618 .It Pa spool/
 619 directory containing output spool files
 620 .El
 621 .Pp
 622 .It Pa backups/
 623 misc. backup files
 624 .It Pa crash/
 625 default directory to store kernel crash dumps; see
 626 .Xr crash 8
 627 and
 628 .Xr savecore 8
 629 .It Pa cron/
 630 files used by cron;
 631 see
 632 .Xr cron 8
 633 .Pp
 634 .Bl -tag -width ".Pa tabs/" -compact
 635 .It Pa tabs/
 636 crontab files;
 637 see
 638 .Xr crontab 5
 639 .El
 640 .Pp
 641 .It Pa db/
 642 misc. automatically generated system-specific database files
 643 .It Pa empty/
 644 empty directory used by
 645 .Xr sshd 8
 646 for privilege separation
 647 .It Pa games/
 648 misc. game status and score files
 649 .It Pa heimdal/
 650 kerberos server databases; see
 651 .Xr kdc 8
 652 .It Pa log/
 653 misc. system log files
 654 .Pp
 655 .Bl -tag -width ".Pa wtmp" -compact
 656 .It Pa wtmp
 657 login/logout log;
 658 see
 659 .Xr wtmp 5
 660 .El
 661 .Pp
 662 .It Pa mail/
 663 user mailbox files
 664 .It Pa msgs/
 665 system messages database;
 666 see
 667 .Xr msgs 1
 668 .It Pa preserve/
 669 temporary home of files preserved after an accidental death
 670 of an editor;
 671 see
 672 .Xr \&ex 1
 673 .It Pa quotas/
 674 filesystem quota information files
 675 .It Pa run/
 676 system information files describing various info about
 677 system since it was booted
 678 .Pp
 679 .Bl -tag -width ".Pa ppp/" -compact
 680 .It Pa ppp/
 681 writable by the
 682 .Dq network
 683 group for command connection sockets; see
 684 .Xr ppp 8
 685 .It Pa utmp
 686 database of current users;
 687 see
 688 .Xr utmp 5
 689 .El
 690 .Pp
 691 .It Pa rwho/
 692 rwho data files;
 693 see
 694 .Xr rwhod 8 ,
 695 .Xr rwho 1 ,
 696 and
 697 .Xr ruptime 1
 698 .It Pa spool/
 699 misc. printer and mail system spooling directories
 700 .Pp
 701 .Bl -tag -width ".Pa clientmqueue/" -compact
 702 .It Pa clientmqueue/
 703 undelivered submission mail queue;
 704 see
 705 .Xr sendmail 8
 706 .It Pa dma/
 707 undelivered mail queue;
 708 see
 709 .Xr dma 8
 710 .It Pa ftp/
 711 commonly
 712 .Pa ~ftp ;
 713 the anonymous ftp root directory
 714 .It Pa mqueue/
 715 undelivered mail queue;
 716 see
 717 .Xr sendmail 8
 718 .It Pa output/
 719 line printer spooling directories
 720 .It Pa uucp/
 721 uucp spool directory
 722 .It Pa uucppublic/
 723 commonly
 724 .Pa ~uucp ;
 725 public uucp temporary directory
 726 .El
 727 .Pp
 728 .It Pa tmp/
 729 temporary files that are kept between system reboots
 730 .Pp
 731 .Bl -tag -width ".Pa vi.recover/" -compact
 732 .It Pa vi.recover/
 733 the directory where recovery files are stored
 734 .El
 735 .Pp
 736 .It Pa yp/
 737 the NIS maps
 738 .El
 739 .El
 740 .Sh NOTES
 741 This manual page documents the default
 742 .Dx
 743 filesystem layout, but
 744 the actual hierarchy on a given system is defined at the system
 745 administrator's discretion.
 746 A well-maintained installation will include a customized version of
 747 this document.
 748 .Sh SEE ALSO
 749 .Xr apropos 1 ,
 750 .Xr find 1 ,
 751 .Xr finger 1 ,
 752 .Xr grep 1 ,
 753 .Xr ls 1 ,
 754 .Xr whatis 1 ,
 755 .Xr whereis 1 ,
 756 .Xr which 1 ,
 757 .Xr fsck 8
 758 .Sh HISTORY
 759 A
 760 .Nm
 761 manual page appeared in
 762 .At v7 .