1 .\" $NetBSD: hier.7,v 1.89 2009/12/05 16:29:11 pooka Exp $
3 .\" Copyright (c) 1990, 1993, 1994
4 .\" The Regents of the University of California. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of the University nor the names of its contributors
15 .\" may be used to endorse or promote products derived from this software
16 .\" without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" @(#)hier.7 8.5 (Berkeley) 6/1/94
37 .Nd layout of filesystems
39 An outline of the filesystem hierarchy.
41 Naming is very important.
44 System relies on filename conventions for much of its power as a system.
45 The following file system layout describes generally where things are
46 and what they are, with references to other man pages for more detailed
49 Not all files will be in every system.
51 .Bl -tag -width "/altroot/"
53 root directory of the system
55 system copyright notice, most often put on
61 alternate root filesystem, in case of disaster
63 .\" home directories mount point; see
66 utilities used in both single and multi-user environments
68 second-stage boot loader(s) for some platforms; see
71 empty directory commonly used by
72 system administrators as a temporary mount point for CD devices
73 for ISO-9660 file systems
75 block, character and other special device files
77 .Bl -tag -width "MAKEDEV" -compact
79 script for creating device files;
83 the computer's console device
85 system swap space; see
88 file descriptor files;
92 kernel logging device; see
95 kernel virtual memory device; see
99 domain datagram log socket; see
102 kernel physical memory device; see
108 mount point for the pseudo-terminal device file system; see
113 file descriptor files;
117 process' controlling terminal device; see
128 system configuration files and scripts
130 .Bl -tag -width "master.passwd" -compact
132 configuration files for
135 files backed up by the security script
143 system-wide scripts for
146 script run each day by
149 configuration file for
154 default configuration files read by various
158 disk description file, see
161 dungeon master configuration; see
167 filesystem export information; see
170 filesystem information; see
184 terminal configuration database; see
187 group permissions file; see
190 host name database backup for
195 trusted machines with equivalent user ID's
197 trusted machines with printing privileges
199 Internet server configuration file; see
202 configuration files for the kerberos version V;
206 local timezone information;
210 configuration files for
213 .Bl -tag -width "sendmail.*" -compact
218 configuration information
221 system-wide initialization script for
224 configuration file for
229 Main password file, readable only by root; see
232 optional file containing
234 variables, read by pkgsrc and the system sources.
236 script run each month by
239 configuration file for
244 system message of the day
246 mtree configuration files;
251 named configuration files and databases;
258 network startup script
260 network name data base; see
263 World readable password file generated from master.passwd; see
267 remote host phone number data base; see
270 system printer configuration; see
273 protocol name database; see
276 database form of passwd file; see
279 master system startup script invoked by
284 configuration file for system startup and shutdown scripts; see
287 directory containing per-subsystem startup and shutdown scripts; see
290 locally editable system startup script
292 master system shutdown script invoked by
297 remote host description file; see
300 daily (in)security script run by
303 configuration file for
308 service name data base; see
311 list of permitted shells; see
315 login/logout scripts; see
318 database form of master.passwd file; see
322 configuration file; see
325 terminal type database; see
328 terminal initialization information; see
331 UUCP configuration files; see
336 script run each week by
339 configuration file for
345 mount point for the automounter; see
348 mount point for the kern file system; see
351 dynamic linked libraries used by dynamic linked programs
356 that cannot rely upon
360 system utilities (such as the dynamic linker) required by programs
361 and libraries that cannot rely upon
365 empty directory commonly used by
366 system administrators as a temporary mount point
368 pure kernel executable (the operating system loaded into memory
371 mount point for the process file system; see
374 statically linked rescue tools, for use in system recovery
376 home directory for the super-user
378 .Bl -tag -width ".profile" -compact
380 super-user start-up file
382 super-user start-up file
384 super-user start-up file
386 super-user id mapping between machines
389 system programs and administration utilities
390 used in both single-user and multi-user environments
392 programs used in a standalone environment
394 temporary files, usually a
396 memory-based filesystem (the contents of
400 preserved across a system reboot)
402 contains the majority of the system utilities and files
404 .Bl -tag -width "libdata/" -compact
410 .Bl -tag -width "include/" -compact
420 common utilities, programming tools, and applications
424 standard C include files
426 .Bl -tag -width "protocols/" -compact
428 include files for Internet service protocols
430 include files for the Automated Testing Framework; see
433 include files for the C++ compiler
435 machine specific include files
438 C include files for AppleTalk protocols
439 miscellaneous network include files;
443 include files for Internet standard protocols; see
446 include files for Internet protocol version 6; see
449 include files for ISO standard protocols; see
452 include files for secret key management, used for security protocols; see
455 C include files for native mode ATM
457 C include files for NFS (Network File System)
459 C include files for Berkeley service protocols
461 system C include files (kernel data structures)
463 C include files for UFS (The U-word File System)
467 archive, profiled, position independent archive, and shared libraries
469 miscellaneous utility data files
471 system daemons \*[Am] system utilities (executed by other programs)
473 .Bl -tag -width "uucp/" -compact
475 UUCP binaries and scripts (historically placed; to be moved)
481 architecture-specific target tree produced by building the
483 tree; normally a symbolic link or mounted filesystem
485 packages maintained by groups other than the
489 .Bl -tag -width "include/" -compact
493 contributed include files
495 contributed libraries
497 contributed data files
501 contributed system utilities
505 build descriptions ("packages") for the
509 .Bl -tag -width "distfilesX" -compact
511 Where unchanged source archives are fetched to/stored
513 Where compiled binary packages are stored
516 There are also several other subdirectories which contain packages of
517 a certain category, e.g., archivers, graphics, ...
520 system daemons and system utilities (normally executed by the super-user)
522 architecture-independent text files
524 .Bl -tag -width "calendar/" -compact
526 a variety of calendar files; see
535 .Bl -tag -width "special/" -compact
539 words of Webster's 2nd International
551 miscellaneous documentation; source for most of the printed
558 text files used by various games
560 internationalization databases; see
563 locale databases and gettext message catalogs; see
568 formatted manual pages
570 macros for use with the
574 miscellaneous system-wide text files
576 .Bl -tag -width "termcap" -compact
578 terminal characteristics database;
587 macros for use with the
591 message catalogs; see
594 sample initialization files for new user accounts
596 tab description files for a variety of terminals, used in
601 text processing macros;
607 timezone configuration information;
614 for information on how to run them
619 and local source files
621 .Bl -tag -width "domestic/" -compact
623 source for utilities/files in
626 sources shared between kernel and userland
628 cryptographic source, which may have import or export restrictions
632 source code, referenced by other parts of the source tree
634 tools and data-files for making distributions
636 documentation about the source tree (i.e., about the tree, not about
637 how to use the built software.)
639 source (usually example files) for files in
642 source for programs from external third parties
645 is the not the primary maintainer),
646 grouped by license, and then products per license
648 .Bl -tag -width "bsd/" -compact
650 BSD (or equivalent) licensed software,
652 .Dq advertising clause
656 source for utilities/files in
659 source for programs covered by the
666 source for libraries in
669 source for utilities/files in
672 various regression tests
674 source/makefiles for /rescue
676 source for utilities/files in
682 .Bl -tag -width "doc/" -compact
685 .Bl -tag -width "papers/" -compact
687 source for various Berkeley technical papers
689 source for Programmer's Supplementary Documents
691 source for System Manager's Manual
693 source for User's Supplementary Documents
700 .Bl -tag -width "gdbscripts/" -compact
702 architecture-specific support
704 .Bl -tag -width "ews4800mips/" -compact
706 Acorn Archimedes, A-series and R-series systems
708 Acorn RiscPC/A7000 and VLSI RC7500
710 Algorithmics Ltd. MIPS evaluations boards
714 Computers with x86_64 capable CPUs
716 Commodore Amiga and MacroSystem DraCo
718 PowerPC based Amiga boards
720 MIPS-based machines following the Advanced RISC Computing spec
722 ARM processor general support
724 Atari TT030, Falcon and Hades
728 Chalice Technology's CATS and Intel's EBSA-285 evaluation boards
730 CES FIC8234 VME processor board
732 Cobalt Networks' MIPS-based Microserver
734 Sega Dreamcast game console
736 ARM based evaluation boards
738 MIPS based evaluation boards
740 PowerPC based evaluation boards and appliances
742 SH3/SH4 based evaluation boards
744 NEC's MIPS based EWS4800 workstations
746 Hewlett-Packard 9000/300 and 400 680x0-based workstations
748 Hewlett-Packard 9000/700 HPPA based workstations
750 StrongARM based WinCE PDA machines
752 MIPS based WinCE PDA machines
754 Hitachi SH3/4 based WinCE PDA machines
756 HPPA processor general support
758 80x86-based IBM PCs and clones
760 IBM Network Station 1000
762 Castle Technology's Iyonix ARM based PCs
764 Omron Tateishi Electric's 680x0-based LUNA workstations
766 680x0 processor general support
768 Apple Macintosh with 68k CPU
770 Apple Power Macintosh and clones
772 MIPS processor general support
774 MIPS Computer Systems Inc. family of workstations and servers
776 Brains Inc. SH3 based mmEye multimedia server
778 Motorola MVME 680x0-based SBCs
780 Motorola PowerPC VME SBCs
782 StrongARM based NetWinder machines
784 Sony's 680x0-based NEWS workstations
786 Sony's MIPS-based NEWS workstations
788 NeXT 68k "black" hardware
790 Open Firmware PowerPC workstations
792 Digital MIPS-based DECstations and DECsystems
794 PowerPC processor support
796 PReP (PowerPC Reference Platform) and CHRP machines
798 Motorola Sandpoint reference platform
800 Broadcom/SiByte evaluation boards
802 Silicon Graphics' MIPS-based workstations
804 SH3/SH4 processor general support
806 Digital DNARD ("Shark")
808 Sun Microsystems SPARC (32-bit) and UltraSPARC (in 32-bit mode)
810 Sun Microsystems UltraSPARC (in native 64-bit mode)
812 Sun Microsystems 68010-based Sun 2 architecture
814 Sun Microsystems 68020/68030-based Sun 3/3x architecture
816 680x0-based Sun architecture general support
820 Sharp X680x0 680x0-based workstations
822 General support for PC/AT compatibles with ia32 or x86_64 CPUs
824 The Xen virtual machine monitor
826 Sharp C3x00 Arm based PDA
830 kernel compatibility modules directory
832 .Bl -tag -width "ossaudio/" -compact
834 common compatibility routines, old
845 support for 68000 HP-UX binaries
847 support for Intel Binary binaries
849 support for Linux binaries; see
852 support for 4KB page 68000 binaries
856 32-bit binaries on 64 bit platforms with compatible CPU families
867 support for OSS audio
879 support for System V Release 4 binaries; see
886 support for older VAX binaries that started on a 1 KB boundary
890 architecture independent configuration directory
892 cryptographic kernel source, which may have import or export restrictions
896 architecture independent device support
898 miscellaneous file systems
899 .Bl -tag -width "filecorefs/" -compact
901 AmigaDOS file-system support; see
904 support for the ISO-9660 filesystem; see
907 support for the Acorn RISC OS filecore filesystem; see
914 NTFS filesystem support; see
917 pseudo-terminal device filesystem; see
920 SMB/CIFS filesystem support; see
923 union file system; see
927 support for accessing kernel structures from within the debugger
930 support for kernel debugging over the network
933 support for the high kernel (system calls)
937 .Bl -tag -width "libkern/" -compact
939 C library routines used in the kernel
941 machine independent stand alone kernel library
947 miscellaneous file systems
949 .Bl -tag -width "deadfs/" -compact
951 kernel only dead file system
953 file descriptor file system; see
958 kernel only generic file system
960 kernel namespace file system; see
963 loop back file system; see
966 overlay file system; see
969 process file system; see
972 kernel only special file system
974 kernel trickle sync algorithm
976 user and group re-mapping file system; see
981 miscellaneous networking support
983 AppleTalk networking support
985 IP networking support
987 IPv6 networking support
989 ISO networking support
991 Key database for IPsec networking support
993 ATM networking support
997 kernel standalone support
999 kernel (and system) include files
1001 local filesystem support
1003 .Bl -tag -width "ffs/" -compact
1005 the Berkeley Fast File System
1007 the log-structured file system
1009 the in-memory file system
1016 UVM virtual memory system
1019 source for test programs in
1022 source for utilities/files in
1025 source for utilities/files in
1029 multi-purpose log, temporary, transient, and spool files
1031 .Bl -tag -width "preserve/" -compact
1033 system accounting files
1035 .Bl -tag -width "acct" -compact
1037 execution accounting file;
1043 timed command scheduling files;
1047 miscellaneous backup files, largely of files found in
1050 home directories of applications which are run in a
1054 system crash dumps; see
1057 scheduled commands configuration files; see
1060 miscellaneous automatically generated system-specific database files,
1061 and persistent files used in the maintenance of third party software.
1063 .Bl -tag -width "monthly.out" -compact
1065 default location for metadata related to third party software
1069 for more details of the
1071 Packages Collection, or pkgsrc.
1075 miscellaneous game status and log files
1077 Kerberos 5 KDC database; see
1080 miscellaneous system log files
1082 .Bl -tag -width "monthly.out" -compact
1087 output of the last run of the
1097 system last time logged in log; see
1100 printer daemon error logs; see
1106 general system information log
1108 output of the last run of the
1112 sensitive security information log
1120 output of the last run of the
1130 user system mailboxes
1132 system messages; see
1134 .\" since we use nvi (now called vi) this isn't the place any more, is it?
1136 temporary home of files preserved after an accidental death of
1141 filesystem quota information
1143 system information files, rebuilt after each reboot
1145 .Bl -tag -width "utmp" -compact
1147 database of current users; see
1152 rwho data files; see
1158 miscellaneous printer and mail system spooling directories
1160 .Bl -tag -width "uucppublic/" -compact
1164 the anonymous ftp root directory; see
1167 sendmail mail queue;
1171 Network news archival and spooling directories
1173 printer spooling directories
1179 uucp spool directory
1183 the uucp public temporary directory; see
1188 temporary files that are not discarded between system reboots
1190 .Bl -tag -width "vi.recover/" -compact
1192 recovery directory for new
1197 Databases and configuration for the NIS (YP) system; see
1210 manual page appeared in