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