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