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