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 prop/
 247 C include files for libprop
 248 .It Pa protocols/
 249 C include files for Berkeley service protocols
 250 .It Pa readline/
 251 get a line from a user, with editing;
 252 see
 253 .Xr readline 3
 254 .It Pa rpc/
 255 remote procedure calls;
 256 see
 257 .Xr rpc 3
 258 .It Pa rpcsvc/
 259 definition of RPC service structures; see
 260 .Xr rpc 3
 261 .It Pa security/
 262 PAM; see
 263 .Xr pam 8
 264 .It Pa sys/
 265 system C include files (kernel data structures)
 266 .It Pa ufs/
 267 C include files for UFS (The U-word File System)
 268 .Pp
 269 .Bl -tag -width ".Pa ffs/" -compact
 270 .It Pa ffs/
 271 Fast filesystem
 272 .It Pa mfs/
 273 memory file system;
 274 see
 275 .Xr mount_mfs 8
 276 .It Pa ufs/
 277 UFS filesystem
 278 .El
 279 .Pp
 280 .It Pa vm/
 281 virtual memory;
 282 see
 283 .Xr vmstat 8
 284 .El
 285 .Pp
 286 .It Pa lib/
 287 archive libraries
 288 .Pp
 289 .Bl -tag -width ".Pa compat/" -compact
 290 .It Pa aout/
 291 a.out archive libraries
 292 .It Pa compat/
 293 shared libraries for compatibility
 294 .Pp
 295 .Bl -tag -width ".Pa aout/" -compact
 296 .It Pa aout/
 297 a.out backward compatibility libraries
 298 .El
 299 .El
 300 .Pp
 301 .It Pa libdata/
 302 misc. utility data files
 303 .Pp
 304 .Bl -tag -width ".Pa stallion/" -compact
 305 .It Pa doscmd/
 306 files used by doscmd (drivers, fonts, etc.);
 307 see
 308 .Xr doscmd 1
 309 .Pp
 310 .Bl -tag -width ".Pa fonts/" -compact
 311 .It Pa fonts/
 312 fonts used by doscmd
 313 .El
 314 .Pp
 315 .It Pa lint/
 316 various prebuilt lint libraries;
 317 see
 318 .Xr lint 1
 319 .It Pa msdosfs/
 320 Character set conversion tables
 321 .It Pa stallion/
 322 holds the download firmware images
 323 .El
 324 .Pp
 325 .It Pa libexec/
 326 system daemons & system utilities (executed by other programs)
 327 .Pp
 328 .Bl -tag -width ".Pa binutils217/" -compact
 329 .It Pa binutils217/
 330 .Pp
 331 .Bl -tag -width ".Pa ldscripts/" -compact
 332 .It Pa ldscripts/
 333 linker scripts;
 334 see
 335 .Xr ld 1
 336 .El
 337 .Pp
 338 .It Pa lpr/
 339 utilities and filters for LP print system;
 340 see
 341 .Xr lpr 1
 342 .It Pa sendmail/
 343 the sendmail binary;
 344 see
 345 .Xr mailwrapper 8
 346 and
 347 .Xr sendmail 8
 348 .It Pa sm.bin/
 349 restricted shell for sendmail;
 350 see
 351 .Xr smrsh 8
 352 .It Pa uucp/
 353 uucp utilities;
 354 see
 355 .Xr uucp 1
 356 .El
 357 .Pp
 358 .It Pa local/
 359 local executables, libraries, etc.
 360 Within
 361 .Pa local/ ,
 362 the general layout sketched out by
 363 .Xr hier 7
 364 for
 365 .Pa /usr
 366 should be used.
 367 Exceptions are the
 368 .Pa man/
 369 directory (directly under
 370 .Pa local/
 371 rather than under
 372 .Pa local/share/ ) ,
 373 documentation (in
 374 .Pa share/doc/<app>/ ) ,
 375 and
 376 .Pa /usr/local/etc
 377 .Pf ( mimics
 378 .Pa /etc ) .
 379 .It Pa obj/
 380 architecture-specific target tree produced by building the
 381 .Pa /usr/src
 382 tree
 383 .It Pa pkg/
 384 default destination directory for the
 385 .Xr pkgsrc 7
 386 collection.
 387 Within
 388 .Pa pkg/ ,
 389 the general layout sketched out by
 390 .Xr hier 7
 391 for
 392 .Pa /usr
 393 should be used.
 394 Exceptions are the
 395 .Pa man/
 396 directory (directly under
 397 .Pa pkg/
 398 rather than under
 399 .Pa pkg/share/ ) ,
 400 documentation (in
 401 .Pa share/doc/<pkg>/ ) ,
 402 and
 403 .Pa /usr/pkg/etc
 404 .Pf ( mimics
 405 .Pa /etc ) .
 406 .It Pa pkgsrc/
 407 The
 408 .Xr pkgsrc 7
 409 collection (optional).
 410 .It Pa sbin/
 411 system daemons & system utilities (executed by users)
 412 .It Pa share/
 413 architecture-independent files
 414 .Pp
 415 .Bl -tag -width ".Pa groff_font/" -compact
 416 .It Pa calendar/
 417 a variety of pre-fab calendar files;
 418 see
 419 .Xr calendar 1
 420 .It Pa dict/
 421 word lists;
 422 see
 423 .Xr look 1
 424 .Pp
 425 .Bl -tag -width ".Pa papers/" -compact
 426 .It Pa web2
 427 words from Webster's 2nd International
 428 .It Pa words
 429 common words
 430 .It Pa papers/
 431 reference databases;
 432 see
 433 .Xr refer 1
 434 .El
 435 .Pp
 436 .It Pa examples/
 437 various examples for users and programmers
 438 .It Pa games/
 439 ASCII text files used by various games
 440 .It Pa groff_font/
 441 device description file for device name
 442 .It Pa i18n/
 443 internationalization databases; see
 444 .Xr iconv 3
 445 .It Pa info/
 446 GNU Info hypertext system
 447 .It Pa isdn/
 448 ISDN
 449 .It Pa libg++/
 450 libg++'s genclass prototype/template class files
 451 .It Pa locale/
 452 localization files;
 453 see
 454 .Xr setlocale 3
 455 .It Pa man/
 456 manual pages
 457 .It Pa me/
 458 macros for use with the me macro package;
 459 see
 460 .Xr me 7
 461 .It Pa misc/
 462 misc system-wide ASCII text files
 463 .Pp
 464 .Bl -tag -width ".Pa termcap" -compact
 465 .It Pa termcap
 466 terminal characteristics database;
 467 see
 468 .Xr termcap 5
 469 .El
 470 .Pp
 471 .It Pa mk/
 472 templates for make;
 473 see
 474 .Xr make 1
 475 .It Pa nls/
 476 national language support files;
 477 see
 478 .Xr mklocale 1
 479 .It Pa openssl/
 480 .Pp
 481 .Bl -tag -width ".Pa man/" -compact
 482 .It Pa man/
 483 OpenSSL manual pages
 484 .El
 485 .Pp
 486 .It Pa sendmail/
 487 sendmail configuration files;
 488 see
 489 .Xr sendmail 8
 490 .It Pa skel/
 491 example . (dot) files for new accounts
 492 .It Pa syscons/
 493 files used by
 494 .Xr syscons 4
 495 .Pp
 496 .Bl -tag -width ".Pa scrnmaps/" -compact
 497 .It Pa fonts/
 498 console fonts;
 499 see
 500 .Xr vidcontrol 1
 501 and
 502 .Xr vidfont 1
 503 .It Pa keymaps/
 504 console keyboard maps;
 505 see
 506 .Xr kbdcontrol 1
 507 and
 508 .Xr kbdmap 1
 509 .It Pa scrnmaps/
 510 console screen maps
 511 .El
 512 .Pp
 513 .It Pa tabset/
 514 tab description files for a variety of terminals; used in
 515 the termcap file;
 516 see
 517 .Xr termcap 5
 518 .It Pa tmac/
 519 text processing macros;
 520 see
 521 .Xr nroff 1
 522 and
 523 .Xr troff 1
 524 .It Pa vi/
 525 localization support and utilities for
 526 .Xr vi 1
 527 .It Pa zoneinfo/
 528 timezone configuration information;
 529 see
 530 .Xr tzfile 5
 531 .El
 532 .Pp
 533 .It Pa src/
 534 .Bx ,
 535 third-party, and/or local source files
 536 .Pp
 537 .Bl -tag -width ".Pa nrelease/" -compact
 538 .It Pa bin/
 539 source code for files in
 540 .Pa /bin
 541 .It Pa contrib/
 542 source code for contributed software
 543 .It Pa crypto/
 544 source code for contributed cryptography software
 545 .It Pa etc/
 546 source code for files in
 547 .Pa /etc
 548 .It Pa games/
 549 source code for files in
 550 .Pa /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
 555 .Pa /usr/include
 556 .It Pa lib/
 557 source code for files in
 558 .Pa /usr/lib
 559 .It Pa libexec/
 560 source code for files in
 561 .Pa /usr/libexec
 562 .It Pa nrelease/
 563 files required to produce a
 564 .Dx
 565 release
 566 .It Pa sbin/
 567 source code for files in
 568 .Pa /sbin
 569 .It Pa secure/
 570 build directory for files in
 571 .Pa /usr/src/crypto
 572 .It Pa share/
 573 source for files in
 574 .Pa /usr/share
 575 .It Pa sys/
 576 kernel source code
 577 .It Pa tools/
 578 tools used for maintenance and testing of
 579 .Dx
 580 .It Pa usr.bin/
 581 source code for files in
 582 .Pa /usr/bin
 583 .It Pa usr.sbin/
 584 source code for files in
 585 .Pa /usr/sbin
 586 .El
 587 .El
 588 .It Pa /var/
 589 multi-purpose log, temporary, transient, and spool files
 590 .Pp
 591 .Bl -tag -width ".Pa preserve/" -compact
 592 .It Pa account/
 593 system accounting files
 594 .Pp
 595 .Bl -tag -width ".Pa acct" -compact
 596 .It Pa acct
 597 execution accounting file;
 598 see
 599 .Xr acct 5
 600 .El
 601 .Pp
 602 .It Pa at/
 603 timed command scheduling files;
 604 see
 605 .Xr \&at 1
 606 .Pp
 607 .Bl -tag -width ".Pa spool/" -compact
 608 .It Pa jobs/
 609 directory containing job files
 610 .It Pa spool/
 611 directory containing output spool files
 612 .El
 613 .Pp
 614 .It Pa backups/
 615 misc. backup files
 616 .It Pa crash/
 617 default directory to store kernel crash dumps; see
 618 .Xr crash 8
 619 and
 620 .Xr savecore 8
 621 .It Pa cron/
 622 files used by cron;
 623 see
 624 .Xr cron 8
 625 .Pp
 626 .Bl -tag -width ".Pa tabs/" -compact
 627 .It Pa tabs/
 628 crontab files;
 629 see
 630 .Xr crontab 5
 631 .El
 632 .Pp
 633 .It Pa db/
 634 misc. automatically generated system-specific database files
 635 .It Pa empty/
 636 empty directory used by
 637 .Xr sshd 8
 638 for privilege separation
 639 .It Pa games/
 640 misc. game status and score files
 641 .It Pa log/
 642 misc. system log files
 643 .Pp
 644 .Bl -tag -width ".Pa wtmp" -compact
 645 .It Pa wtmp
 646 login/logout log;
 647 see
 648 .Xr wtmp 5
 649 .El
 650 .Pp
 651 .It Pa mail/
 652 user mailbox files
 653 .It Pa msgs/
 654 system messages database;
 655 see
 656 .Xr msgs 1
 657 .It Pa preserve/
 658 temporary home of files preserved after an accidental death
 659 of an editor;
 660 see
 661 .Xr \&ex 1
 662 .It Pa quotas/
 663 filesystem quota information files
 664 .It Pa run/
 665 system information files describing various info about
 666 system since it was booted
 667 .Pp
 668 .Bl -tag -width ".Pa ppp/" -compact
 669 .It Pa ppp/
 670 writable by the
 671 .Dq network
 672 group for command connection sockets; see
 673 .Xr ppp 8
 674 .It Pa utmp
 675 database of current users;
 676 see
 677 .Xr utmp 5
 678 .El
 679 .Pp
 680 .It Pa rwho/
 681 rwho data files;
 682 see
 683 .Xr rwhod 8 ,
 684 .Xr rwho 1 ,
 685 and
 686 .Xr ruptime 1
 687 .It Pa spool/
 688 misc. printer and mail system spooling directories
 689 .Pp
 690 .Bl -tag -width ".Pa clientmqueue/" -compact
 691 .It Pa clientmqueue/
 692 undelivered submission mail queue;
 693 see
 694 .Xr sendmail 8
 695 .It Pa dma/
 696 undelivered mail queue;
 697 see
 698 .Xr dma 8
 699 .It Pa ftp/
 700 commonly
 701 .Pa ~ftp ;
 702 the anonymous ftp root directory
 703 .It Pa mqueue/
 704 undelivered mail queue;
 705 see
 706 .Xr sendmail 8
 707 .It Pa output/
 708 line printer spooling directories
 709 .It Pa uucp/
 710 uucp spool directory
 711 .It Pa uucppublic/
 712 commonly
 713 .Pa ~uucp ;
 714 public uucp temporary directory
 715 .El
 716 .Pp
 717 .It Pa tmp/
 718 temporary files that are kept between system reboots
 719 .Pp
 720 .Bl -tag -width ".Pa vi.recover/" -compact
 721 .It Pa vi.recover/
 722 the directory where recovery files are stored
 723 .El
 724 .Pp
 725 .It Pa yp/
 726 the NIS maps
 727 .El
 728 .El
 729 .Sh NOTES
 730 This manual page documents the default
 731 .Dx
 732 filesystem layout, but
 733 the actual hierarchy on a given system is defined at the system
 734 administrator's discretion.
 735 A well-maintained installation will include a customized version of
 736 this document.
 737 .Sh SEE ALSO
 738 .Xr apropos 1 ,
 739 .Xr find 1 ,
 740 .Xr finger 1 ,
 741 .Xr grep 1 ,
 742 .Xr ls 1 ,
 743 .Xr whatis 1 ,
 744 .Xr whereis 1 ,
 745 .Xr which 1 ,
 746 .Xr fsck 8
 747 .Sh HISTORY
 748 A
 749 .Nm
 750 manual page appeared in
 751 .At v7 .