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