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