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.10 2007/05/12 21:27:31 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 pkgsrc collection.
 362 Within
 363 .Pa pkg/ ,
 364 the general layout sketched out by
 365 .Xr hier 7
 366 for
 367 .Pa /usr
 368 should be used.  Exceptions are the man directory (directly under
 369 .Pa pkg/
 370 rather than under
 371 .Pa pkg/share/ ) ,
 372 documentation (in
 373 .Pa share/doc/<pkg>/ ) ,
 374 and
 375 .Pa /usr/pkg/etc
 376 .Pf ( mimics
 377 .Pa /etc ) .
 378 .It Pa pkgsrc/
 379 The
 380 .Nx
 381 pkgsrc collection (optional).
 382 .It Pa sbin/
 383 system daemons & system utilities (executed by users)
 384 .It Pa share/
 385 architecture-independent files
 386 .Pp
 387 .Bl -tag -width ".It Pa groff_font/" -compact
 388 .It Pa calendar/
 389 a variety of pre-fab calendar files;
 390 see
 391 .Xr calendar 1
 392 .It Pa dict/
 393 word lists;
 394 see
 395 .Xr look 1
 396 .Pp
 397 .Bl -tag -width ".It Pa papers/" -compact
 398 .It Pa web2
 399 words from Webster's 2nd International
 400 .It Pa words
 401 common words
 402 .It Pa papers/
 403 reference databases;
 404 see
 405 .Xr refer 1
 406 .El
 407 .Pp
 408 .It Pa doc/
 409 miscellaneous documentation;
 410 .Pp
 411 .Bl -tag -width ".It Pa handbook/" -compact
 412 .It Pa handbook/
 413 A copy of the handbook
 414 .El
 415 .Pp
 416 .It Pa examples/
 417 various examples for users and programmers
 418 .It Pa games/
 419 ASCII text files used by various games
 420 .It Pa groff_font/
 421 device description file for device name
 422 .It Pa info/
 423 GNU Info hypertext system
 424 .It Pa isdn/
 425 ISDN
 426 .It Pa libg++/
 427 libg++'s genclass prototype/template class files
 428 .It Pa locale/
 429 localization files;
 430 see
 431 .Xr setlocale 3
 432 .It Pa man/
 433 manual pages
 434 .It Pa me/
 435 macros for use with the me macro package;
 436 see
 437 .Xr me 7
 438 .It Pa misc/
 439 misc system-wide ASCII text files
 440 .Pp
 441 .Bl -tag -width ".It Pa termcap" -compact
 442 .It Pa termcap
 443 terminal characteristics database;
 444 see
 445 .Xr termcap 5
 446 .El
 447 .Pp
 448 .It Pa mk/
 449 templates for make;
 450 see
 451 .Xr make 1
 452 .It Pa nls/
 453 national language support files;
 454 see
 455 .Xr mklocale 1
 456 .It Pa sendmail/
 457 sendmail configuration files;
 458 see
 459 .Xr sendmail 8
 460 .It Pa skel/
 461 example . (dot) files for new accounts
 462 .It Pa syscons/
 463 files used by syscons;
 464 see
 465 .Xr syscons 4
 466 .Pp
 467 .Bl -tag -width ".It Pa scrnmaps/" -compact
 468 .It Pa fonts/
 469 console fonts;
 470 see
 471 .Xr vidcontrol 1
 472 and
 473 .Xr vidfont 1
 474 .It Pa keymaps/
 475 console keyboard maps;
 476 see
 477 .Xr kbdcontrol 1
 478 and
 479 .Xr kbdmap 1
 480 .It Pa scrnmaps/
 481 console screen maps
 482 .El
 483 .Pp
 484 .It Pa tabset/
 485 tab description files for a variety of terminals; used in
 486 the termcap file;
 487 see
 488 .Xr termcap 5
 489 .It Pa tmac/
 490 text processing macros;
 491 see
 492 .Xr nroff 1
 493 and
 494 .Xr troff 1
 495 .It Pa vi/
 496 localization support and utilities for
 497 .Xr vi 1
 498 .It Pa zoneinfo/
 499 timezone configuration information;
 500 see
 501 .Xr tzfile 5
 502 .El
 503 .Pp
 504 .It Pa src/
 505 .Bx ,
 506 third-party, and/or local source files
 507 .Pp
 508 .Bl -tag -width ".It Pa kerberos5/" -compact
 509 .It Pa bin/
 510 source code for files in
 511 .Pa /bin
 512 .It Pa contrib/
 513 source code for contributed software
 514 .It Pa crypto/
 515 source code for contributed cryptography software
 516 .It Pa etc/
 517 source code for files in
 518 .Pa /etc
 519 .It Pa games/
 520 source code for files in
 521 .Pa /usr/games
 522 .It Pa gnu/
 523 Utilities covered by the GNU General Public License
 524 .It Pa include/
 525 source code for files in
 526 .Pa /usr/include
 527 .It Pa kerberos5/
 528 source code for kerberos version 5
 529 .It Pa lib/
 530 source code for files in
 531 .Pa /usr/lib
 532 .It Pa libexec/
 533 source code for files in
 534 .Pa /usr/libexec
 535 .It Pa nrelease/
 536 files required to produce a
 537 .Dx
 538 release
 539 .It Pa sbin/
 540 source code for files in
 541 .Pa /sbin
 542 .It Pa secure/
 543 build directory for files in
 544 .Pa /usr/src/crypto
 545 .It Pa share/
 546 source for files in
 547 .Pa /usr/share
 548 .It Pa sys/
 549 kernel source code
 550 .It Pa tools/
 551 tools used for maintenance and testing of
 552 .Dx
 553 .It Pa usr.bin/
 554 source code for files in
 555 .Pa /usr/bin
 556 .It Pa usr.sbin/
 557 source code for files in
 558 .Pa /usr/sbin
 559 .El
 560 .El
 561 .It Pa /var/
 562 multi-purpose log, temporary, transient, and spool files
 563 .Pp
 564 .Bl -tag -width ".It Pa preserve/" -compact
 565 .It Pa account/
 566 system accounting files
 567 .Pp
 568 .Bl -tag -width ".It Pa acct" -compact
 569 .It Pa acct
 570 execution accounting file;
 571 see
 572 .Xr acct 5
 573 .El
 574 .Pp
 575 .It Pa at/
 576 timed command scheduling files;
 577 see
 578 .Xr \&at 1
 579 .Pp
 580 .Bl -tag -width ".It Pa spool/" -compact
 581 .It Pa jobs/
 582 directory containing job files
 583 .It Pa spool/
 584 directory containing output spool files
 585 .El
 586 .Pp
 587 .It Pa backups/
 588 misc. backup files
 589 .It Pa crash/
 590 default directory to store kernel crash dumps; see
 591 .Xr crash 8
 592 and
 593 .Xr savecore 8
 594 .It Pa cron/
 595 files used by cron;
 596 see
 597 .Xr cron 8
 598 .Pp
 599 .Bl -tag -width ".It Pa tabs/" -compact
 600 .It Pa tabs/
 601 crontab files;
 602 see
 603 .Xr crontab 5
 604 .El
 605 .Pp
 606 .It Pa db/
 607 misc. automatically generated system-specific database files
 608 .It Pa empty/
 609 empty directory used by
 610 .Xr sshd 8
 611 for privilege separation
 612 .It Pa games/
 613 misc. game status and score files
 614 .It Pa heimdal/
 615 kerberos server databases; see
 616 .Xr kdc 8
 617 .It Pa log/
 618 misc. system log files
 619 .Pp
 620 .Bl -tag -width ".It Pa wtmp" -compact
 621 .It Pa wtmp
 622 login/logout log;
 623 see
 624 .Xr wtmp 5
 625 .El
 626 .Pp
 627 .It Pa mail/
 628 user mailbox files
 629 .It Pa msgs/
 630 system messages database;
 631 see
 632 .Xr msgs 1
 633 .It Pa preserve/
 634 temporary home of files preserved after an accidental death
 635 of an editor;
 636 see
 637 .Xr \&ex 1
 638 .It Pa quotas/
 639 filesystem quota information files
 640 .It Pa run/
 641 system information files describing various info about
 642 system since it was booted
 643 .Pp
 644 .Bl -tag -width ".It Pa ppp/" -compact
 645 .It Pa ppp/
 646 writable by the
 647 .Dq network
 648 group for command connection sockets; see
 649 .Xr ppp 8
 650 .It Pa utmp
 651 database of current users;
 652 see
 653 .Xr utmp 5
 654 .El
 655 .Pp
 656 .It Pa rwho/
 657 rwho data files;
 658 see
 659 .Xr rwhod 8 ,
 660 .Xr rwho 1 ,
 661 and
 662 .Xr ruptime 1
 663 .It Pa spool/
 664 misc. printer and mail system spooling directories
 665 .Pp
 666 .Bl -tag -width ".It Pa clientmqueue/" -compact
 667 .It Pa clientmqueue/
 668 undelivered submission mail queue;
 669 see
 670 .Xr sendmail 8
 671 .It Pa ftp/
 672 commonly
 673 .Pa ~ftp ;
 674 the anonymous ftp root directory
 675 .It Pa mqueue/
 676 undelivered mail queue;
 677 see
 678 .Xr sendmail 8
 679 .It Pa output/
 680 line printer spooling directories
 681 .It Pa uucp/
 682 uucp spool directory
 683 .It Pa uucppublic/
 684 commonly
 685 .Pa ~uucp ;
 686 public uucp temporary directory
 687 .El
 688 .Pp
 689 .It Pa tmp/
 690 temporary files that are kept between system reboots
 691 .Pp
 692 .Bl -tag -width ".It Pa vi.recover/" -compact
 693 .It Pa vi.recover/
 694 the directory where recovery files are stored
 695 .El
 696 .Pp
 697 .It Pa yp/
 698 the NIS maps
 699 .El
 700 .El
 701 .Sh NOTES
 702 This manual page documents the default
 703 .Dx
 704 filesystem layout, but
 705 the actual hierarchy on a given system is defined at the system
 706 administrator's discretion.
 707 A well-maintained installation will include a customized version of
 708 this document.
 709 .Sh SEE ALSO
 710 .Xr apropos 1 ,
 711 .Xr find 1 ,
 712 .Xr finger 1 ,
 713 .Xr grep 1 ,
 714 .Xr ls 1 ,
 715 .Xr whatis 1 ,
 716 .Xr whereis 1 ,
 717 .Xr which 1 ,
 718 .Xr fsck 8
 719 .Sh HISTORY
 720 A
 721 .Nm
 722 manual page appeared in
 723 .At v7 .