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$
  34 .\"
  35 .Dd June 5, 1993
  36 .Dt HIER 7
  37 .Os
  38 .Sh NAME
  39 .Nm hier
  40 .Nd layout of filesystems
  41 .Sh DESCRIPTION
  42 A sketch of the filesystem hierarchy.
  43 .Bl -tag -width "/stand/"
  44 .It Li /
  45 root directory of the filesystem
  46 .It Li /bin/
  47 user utilities fundamental to both single-user and multi-user environments
  48 .It Li /dev/
  49 block and character device files
  50 .Pp
  51 .Bl -tag -width MAKEDEV -compact
  52 .It Li MAKEDEV
  53 script for creating device files;
  54 see
  55 .Xr MAKEDEV 8
  56 .It Li fd/
  57 file descriptor files;
  58 see
  59 .Xr \&fd 4
  60 .El
  61 .It Li /etc/
  62 system configuration files and scripts
  63 .Pp
  64 .Bl -tag -width "disklabels/" -compact
  65 .It Li defaults/
  66 default system configuration files;
  67 see
  68 .Xr rc 8
  69 .It Li gnats/
  70 gnats configuration files;
  71 see
  72 .Xr send-pr 1
  73 .It Li isdn/
  74 isdn4bsd configuration files;
  75 see
  76 .Xr isdnd 8
  77 .It Li kerberosIV/
  78 configuration files for the kerberos version IV;
  79 see
  80 .Xr kerberos 1
  81 .It Li localtime
  82 local timezone information;
  83 see
  84 .Xr ctime 3
  85 .It Li mail/
  86 spam-filtering information
  87 .It Li mtree/
  88 mtree configuration files;
  89 see
  90 .Xr mtree 8
  91 .It Li namedb/
  92 named configuration files;
  93 see
  94 .Xr named 8
  95 .It Li periodic/
  96 scripts that are run daily, weekly, and monthly, via
  97 .Xr cron 8 ;
  98 see
  99 .Xr periodic 8
 100 .It Li ppp/
 101 .Xr ppp 8
 102 ppp configuration files;
 103 see
 104 .Xr ppp 8
 105 .It Li uucp/
 106 uucp configuration files;
 107 see
 108 .Xr uucp 1
 109 .El
 110 .It Li /kernel
 111 pure kernel executable (the operating system loaded into memory
 112 at boot time).
 113 .It Li /modules/
 114 loadable kernel modules;
 115 see
 116 .Xr kldstat 8
 117 .It Li /mnt/
 118 empty directory commonly used by
 119 system administrators as a temporary mount point
 120 .It Li /proc/
 121 process file system;
 122 see
 123 .Xr procfs 5 ,
 124 .Xr mount_procfs 8
 125 .It Li /root/
 126 root's HOME directory
 127 .It Li /sbin/
 128 system programs and administration utilities
 129 fundamental to both single-user and multi-user environments
 130 .It Li /stand/
 131 programs used in a standalone environment
 132 .It Li /tmp/
 133 temporary files, usually a
 134 .Xr mfs 8
 135 memory-based filesystem (the contents
 136 of /tmp are usually NOT preserved across a system reboot)
 137 .It Li /usr/
 138 contains the majority of user utilities and applications
 139 .Pp
 140 .Bl -tag -width "libdata/" -compact
 141 .It Li bin/
 142 common utilities, programming tools, and applications
 143 .It Li games/
 144 useful and semi-frivolous programs
 145 .It Li include/
 146 standard C include files
 147 .Pp
 148 .Bl -tag -width "kerberosIV/" -compact
 149 .It Li arpa/
 150 C include files for Internet service protocols
 151 .It Li g++/
 152 GNU C++ include files
 153 .Bl -tag -width "kerberosIV/" -compact
 154 .It Li std/
 155 GNU C++ libstdc++ include files
 156 .El
 157 .It Li isofs/
 158 .Bl -tag -width "kerberosIV/" -compact
 159 .It Li cd9660/
 160 iso9660 filesystem
 161 .El
 162 .It Li kerberosIV/
 163 C include files for kerberos authentication package;
 164 see
 165 .Xr kerberos 1
 166 .It Li machine/
 167 machine specific C include files
 168 .It Li msdosfs/
 169 MS-DOS file system
 170 .It Li net/
 171 misc network C include files
 172 .It Li netatalk/
 173 Appletalk protocol
 174 .It Li netatm/
 175 ATM include files;
 176 see
 177 .Xr atm 8
 178 .It Li netinet/
 179 C include files for Internet standard protocols;
 180 see
 181 .Xr inet 4
 182 .It Li netipx/
 183 IPX/SPX protocol stacks
 184 .It Li netkey/
 185 kernel key-management service
 186 .It Li netns/
 187 Xerox NS protocols
 188 .It Li nfs/
 189 C include files for NFS (Network File System)
 190 .It Li objc/
 191 Objective C include files
 192 .It Li pccard/
 193 PC-CARD controllers
 194 .It Li posix4/
 195 POSIX real-time extensions includes;
 196 see
 197 .Xr p1003_1b 9
 198 .It Li protocols/
 199 C include files for Berkeley service protocols
 200 .It Li readline/
 201 get a line from a user with editing;
 202 see
 203 .Xr readline 3
 204 .It Li rpc/
 205 remote procedure calls;
 206 see
 207 .Xr rpc 3
 208 .It Li rpcsvc/
 209 defintion of RPC service structures; see
 210 .Xr rpc 3 .
 211 .It Li security/
 212 PAM; see
 213 .Xr pam 8
 214 .It Li ss/
 215 MIT SIPB
 216 .Sq subsystem
 217 library, part of Kerberos IV.
 218 .It Li sys/
 219 system C include files (kernel data structures)
 220 .\" .It Li tcl/
 221 .\" Tcl language;
 222 .\" see
 223 .\" .Xr Tcl n
 224 .\" .Bl -tag -width "kerberosIV/" -compact
 225 .\" .It Li generic/
 226 .\" ???
 227 .\" .It Li unix/
 228 .\" ???
 229 .\" .El
 230 .It Li ufs/
 231 C include files for UFS (The U-word File System)
 232 .Bl -tag -width "kerberosIV/" -compact
 233 .It Li ffs/
 234 Fast filesystem
 235 .It Li mfs/
 236 memory file system;
 237 see
 238 .Xr mount_mfs 8
 239 .It Li ufs/
 240 UFS filesystem
 241 .El
 242 .It Li vm/
 243 virtual memory;
 244 see
 245 .Xr vmstat 8
 246 .El
 247 .Pp
 248 .It Li lib/
 249 archive libraries
 250 .Bl -tag -width Fl -compact
 251 .It Li compat/
 252 shared libraries for compatibility
 253 .Bl -tag -width Fl -compact
 254 .It Li aout/
 255 a.out backward compatibility libraries
 256 .El
 257 .El
 258 .Pp
 259 .It Li libdata/
 260 misc. utility data files
 261 .Bl -tag -width Fl -compact
 262 .It Li gcc/
 263 ???
 264 .It Li lint/
 265 various prebuilt lint libraries;
 266 see
 267 .Xr lint 1
 268 .It Li msdosfs/
 269 Chatacter set conversion tables
 270 .It Li perl/
 271 .Bl -tag -width Fl -compact
 272 .It Li 5.00503/
 273 contains Perl modules for Perl version 5.00503;
 274 see
 275 .Xr perl 1
 276 .El
 277 .It Li stallion/
 278 holding the download firmware images
 279 .It Li tcl
 280 ???;
 281 see
 282 .Xr Tcl n
 283 .El
 284 .Pp
 285 .It Li libexec/
 286 system daemons & system utilities (executed by other programs)
 287 .Bl -tag -width Fl -compact
 288 .It Li aout/
 289 utilities to manipulate a.out executables.
 290 .It Li elf/
 291 utilities to manipulate ELF executables.
 292 .It Li lpr/
 293 utilities and filters for LP print system;
 294 see
 295 .Xr lpr 1
 296 .It Li sm.bin/
 297 restricted shell for sendmail;
 298 see
 299 .Xr smrsh 8
 300 .It Li uucp/
 301 uucp utilities;
 302 see
 303 .Xr uucp 1
 304 .El
 305 .Pp
 306 .It Li local/
 307 local executables, libraries, etc.
 308 .br
 309 Also used as the default destination for the
 310 .Tn FreeBSD
 311 ports framework.
 312 Within local/, the general layout sketched out by
 313 .Xr hier 7
 314 for /usr
 315 should be used.  Exceptions are the man directory is directly under local/
 316 rather than under local/share/.  Ports documentation is in share/doc/<port>/
 317 .It Li mdec/
 318 boot programs;
 319 see
 320 .Xr disklabel 8
 321 .It Li obj/
 322 architecture-specific target tree produced by building the /usr/src tree
 323 .It Li ports
 324 The
 325 .Tn FreeBSD
 326 ports collection (optional).
 327 .It Li sbin/
 328 system daemons & system utilities (executed by users)
 329 .It Li share/
 330 architecture-independent files
 331 .Pp
 332 .Bl -tag -width "calendar/" -compact
 333 .It Li calendar/
 334 a variety of pre-fab calendar files;
 335 see
 336 .Xr calendar 1
 337 .It Li dict/
 338 word lists;
 339 see
 340 .Xr look 1
 341 .Pp
 342 .Bl -tag -width Fl -compact
 343 .It Li words
 344 common words
 345 .It Li web2
 346 words from Webster's 2nd International
 347 .It Li papers/
 348 reference databases;
 349 see
 350 .Xr refer 1
 351 .It Li special/
 352 custom word lists;
 353 see
 354 .Xr spell 1
 355 .El
 356 .Pp
 357 .It Li doc/
 358 misc documentation;
 359 src for most of the printed
 360 .Bx
 361 manuals (available
 362 from the
 363 .Tn USENIX
 364 association)
 365 .Bl -tag -width Fl -compact
 366 .It Li FAQ/
 367 Frequently Asked Questions
 368 .It Li handbook/
 369 .Tn FreeBSD
 370 Handbook
 371 .It Li papers/
 372 UNIX Papers
 373 .It Li psd/
 374 UNIX Programmer's Supplementary Documents
 375 .It Li smm/
 376 UNIX System Manager's Manual
 377 .It Li usd/
 378 UNIX User's Supplementary Documents
 379 .El
 380 .Pp
 381 .It Li examples/
 382 various examples for users and programmers
 383 .It Li games/
 384 ASCII text files used by various games
 385 .It Li groff_font/
 386 device description file for device name
 387 .It Li info/
 388 GNU Info hypertext system
 389 .It Li isdn/
 390 ISDN
 391 .It Li libg++/
 392 libg++'s genclass prototype/template class files
 393 .It Li locale/
 394 internationalization files;
 395 see
 396 .Xr setlocale 3
 397 .It Li man/
 398 manual pages
 399 .It Li me/
 400 macros for use with the me macro package
 401 .It Li misc/
 402 misc system-wide ASCII text files
 403 .Bl -tag -width Fl -compact
 404 .It Li fonts/
 405 ???
 406 .It Li pcvtfonts/
 407 pcvt fonts;
 408 see
 409 .Xr pcvt 4
 410 .It Li pkg_manage/
 411 package manager help files;
 412 see
 413 .Xr pkg_manage
 414 .It Li termcap
 415 terminal characteristics database;
 416 see
 417 .Xr termcap 5
 418 .El
 419 .It Li mk/
 420 templates for make;
 421 see
 422 .Xr make 1
 423 .It Li nls/
 424 national language support files;
 425 see
 426 .Xr mklocale 1
 427 .It Li pcvt/
 428 pcvt documentation and etc examples;
 429 see
 430 .Xr pcvt 4
 431 .It Li perl/
 432 perl library files;
 433 see
 434 .Xr perl 1
 435 .It Li skel/
 436 example . (dot) files for new accounts
 437 .It Li syscons/
 438 console staff;
 439 see
 440 .Xr syscons 4
 441 .Bl -tag -width "scrnmaps/xx" -compact
 442 .It Li fonts/
 443 console fonts;
 444 see
 445 .Xr vidcontrol 1
 446 and
 447 .Xr vidfont 1
 448 .It Li keymaps/
 449 console keyboard maps;
 450 see
 451 .Xr kbdcontrol 1
 452 and
 453 .Xr kbdmap 1
 454 .It Li scrnmaps/
 455 console screen maps
 456 .El
 457 .It Li tabset/
 458 tab description files for a variety of terminals; used in
 459 the termcap file;
 460 see
 461 .Xr termcap 5
 462 .It Li tmac/
 463 text processing macros;
 464 see
 465 .Xr nroff 1
 466 and
 467 .Xr troff 1
 468 .It Li vi/
 469 localization support and utilities for
 470 .Xr vi 1 .
 471 .It Li zoneinfo/
 472 timezone configuration information;
 473 see
 474 .Xr tzfile 5
 475 .El
 476 .It Li src/
 477 BSD and/or local source files
 478 .Pp
 479 .Bl -tag -width "kerberosIV/" -compact
 480 .It Li bin/
 481 src for files in /bin
 482 .It Li contrib/
 483 src for file from contributed software
 484 .It Li crypto
 485 DES
 486 .It Li etc/
 487 src for files in /etc
 488 .It Li games/
 489 src for files in /usr/games
 490 .It Li gnu/
 491 Utilities covered by the GNU Public License
 492 .It Li include/
 493 src for files in /usr/include
 494 .It Li kerberosIV/
 495 src for kerberos version IV
 496 .It Li lib/
 497 src for files in /usr/lib
 498 .It Li libexec/
 499 src for files in /usr/libexec
 500 .It Li release/
 501 files required to produce a
 502 .Tn FreeBSD
 503 release
 504 .It Li sbin/
 505 src for files in /sbin
 506 .It Li secure
 507 FreeSec sources
 508 .It Li share/
 509 src for files in /usr/share
 510 .It Li sys/
 511 kernel src files
 512 .It Li tools/
 513 tools used for maintaince and testing of FreeBSD
 514 .It Li usr.bin/
 515 src for files in /usr/bin
 516 .It Li usr.sbin/
 517 src for files in /usr/sbin
 518 .El
 519 .Pp
 520 .It Li X11R6/
 521 X11R6 distribution executables, libraries, etc (optional).
 522 .Bl -tag -width "include/" -compact
 523 .It Li bin/
 524 X11R6 binaries (servers, utilities, local packages/ports).
 525 .It Li etc/
 526 X11R6 configuration files and scripts.
 527 .It Li include/
 528 X11R6 include files.
 529 .It Li lib/
 530 X11R6 libraries.
 531 .It Li man/
 532 X11R6 manual pages.
 533 .It Li share/
 534 architecture independant files.
 535 .El
 536 .El
 537 .It Li /var/
 538 multi-purpose log, temporary, transient, and spool files
 539 .Pp
 540 .Bl -tag -width "preserve/" -compact
 541 .It Li account/
 542 system accounting files
 543 .Pp
 544 .Bl -tag -width Fl -compact
 545 .It Li acct
 546 execution accounting file;
 547 see
 548 .Xr acct 5
 549 .El
 550 .Pp
 551 .It Li at/
 552 timed command scheduling files;
 553 see
 554 .Xr \&at 1
 555 .Bl -tag -width "preserve/" -compact
 556 .It Li jobs/
 557 directory containing job files
 558 .It Li spool/
 559 directory containing output spool files
 560 .El
 561 .Pp
 562 .It Li backups/
 563 misc. backup files
 564 .It Li crash/
 565 default drectory to store kernel crash dumps; see
 566 .Xr crash 8
 567 and
 568 .Xr savecore 8 .
 569 .It Li cron/
 570 .Bl -tag -width "preserve/" -compact
 571 .It Li log
 572 cron log files;
 573 see
 574 .Xr cron 8
 575 .It Li tabs/
 576 crontab files;
 577 see
 578 .Xr crontab 5
 579 .El
 580 .Pp
 581 .It Li db/
 582 misc. automatically generated system-specific database files
 583 .It Li games/
 584 misc. game status and score files
 585 .It Li log/
 586 misc. system log files
 587 .Pp
 588 .Bl -tag -width Fl -compact
 589 .It Li wtmp
 590 login/logout log;
 591 see
 592 .Xr wtmp 5
 593 .El
 594 .Pp
 595 .It Li mail/
 596 user mailbox files
 597 .It Li preserve/
 598 temporary home of files preserved after an accidental death
 599 of an editor;
 600 see
 601 .Xr \&ex 1
 602 .It Li msgs/
 603 system messages database;
 604 see
 605 .Xr msgs 1
 606 .It Li quotas/
 607 filesystem quota information files
 608 .It Li run/
 609 system information files describing various info about
 610 system since it was booted
 611 .Pp
 612 .Bl -tag -width Fl -compact
 613 .It Li utmp
 614 database of current users;
 615 see
 616 .Xr utmp 5
 617 .El
 618 .Pp
 619 .It Li rwho/
 620 rwho data files;
 621 see
 622 .Xr rwhod 8 ,
 623 .Xr rwho 1 ,
 624 and
 625 .Xr ruptime 1
 626 .It Li spool/
 627 misc. printer and mail system spooling directories
 628 .Pp
 629 .Bl -tag -width Fl -compact
 630 .It Li ftp/
 631 commonly ~ftp; the anonymous ftp root directory
 632 .It Li mqueue/
 633 undelivered mail queue;
 634 see
 635 .Xr sendmail 8
 636 .It Li output/
 637 line printer spooling directories
 638 .It Li secretmail/
 639 secretmail spool directory;
 640 see
 641 .Xr xget 1
 642 .It Li uucp/
 643 uucp spool directory
 644 .It Li uucppublic/
 645 commonly ~uucp; public uucp temporary directory
 646 .El
 647 .Pp
 648 .It Li tmp/
 649 temporary files that are kept between system reboots
 650 .Bl -tag -width Fl -compact
 651 .It Li vi.recover/
 652 the directory where recovery files are stored
 653 .El
 654 .It Li yp
 655 the NIS maps
 656 .El
 657 .El
 658 .Sh SEE ALSO
 659 .Xr apropos 1 ,
 660 .Xr find 1 ,
 661 .Xr finger 1 ,
 662 .Xr grep 1 ,
 663 .Xr ls 1 ,
 664 .Xr whatis 1 ,
 665 .Xr whereis 1 ,
 666 .Xr which 1 ,
 667 .Xr fsck 8
 668 .Sh HISTORY
 669 A
 670 .Nm hier
 671 manual page appeared in
 672 .At v7 .