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