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