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