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