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