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