Page Information:
|
Page Title:
Filesystem Hierarchy Standard</TITLE
></HEAD
></A
>Filesystem Hierarchy Standard</A
></H1
>Filesystem Hierarchy Standard Group</H3
>Edited by</H4
>Rusty Russell</H3
>Daniel Quinlan</H3
>Christopher Yeoh</H3
>Copyright © 1994-2004 Daniel Quinlan</P
>Copyright © 2001-2004 Paul 'Rusty' Russell</P
>Copyright © 2003-2004 Christopher Yeoh</P
></P
></A
>This standard consists of a set of requirements and guidelines for file
and directory placement under UNIX-like operating systems. The
guidelines are intended to support interoperability of applications,
system administration tools, development tools, and scripts as well as
greater uniformity of documentation for these systems.</P
></P
></DIV
></DIV
></P
></A
>All trademarks and copyrights are owned by their owners, unless
specifically noted otherwise. Use of a term in this document should not
be regarded as affecting the validity of any trademark or service
mark.</P
>Permission is granted to make and distribute verbatim copies of
this standard provided the copyright and this permission notice are
preserved on all copies.</P
>Permission is granted to copy and distribute modified versions of this
standard under the conditions for verbatim copying, provided also that
the title page is labeled as modified including a reference to the
original standard, provided that information on retrieving the original
standard is included, and provided that the entire resulting derived
work is distributed under the terms of a permission notice identical to
this one.</P
>Permission is granted to copy and distribute translations of this
standard into another language, under the above conditions for modified
versions, except that this permission notice may be stated in a
translation approved by the copyright holder.</P
></P
></DIV
></DIV
>Table of Contents</B
></DT
>1. Introduction</A
></DT
>Purpose</A
></DT
>Conventions</A
></DT
></DL
></DD
>2. The Filesystem</A
></DT
>3. The Root Filesystem</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
>/bin : Essential user command binaries (for use by all users)</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/boot : Static files of the boot loader</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/dev : Device files</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/etc : Host-specific system configuration</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
>/etc/opt : Configuration files for /opt</A
></DT
>/etc/X11 : Configuration for the X Window System (optional)</A
></DT
>/etc/sgml : Configuration files for SGML (optional)</A
></DT
>/etc/xml : Configuration files for XML (optional)</A
></DT
></DL
></DD
>/home : User home directories (optional)</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
></DL
></DD
>/lib : Essential shared libraries and kernel modules</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/lib<qual> : Alternate format essential shared libraries (optional)</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
></DL
></DD
>/media : Mount point for removeable media</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/mnt : Mount point for a temporarily mounted filesystem</A
></DT
>Purpose</A
></DT
></DL
></DD
>/opt : Add-on application software packages</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
></DL
></DD
>/root : Home directory for the root user (optional)</A
></DT
>Purpose</A
></DT
></DL
></DD
>/sbin : System binaries</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/srv : Data for services provided by this system</A
></DT
>Purpose</A
></DT
></DL
></DD
>/tmp : Temporary files</A
></DT
>Purpose</A
></DT
></DL
></DD
></DL
></DD
>4. The /usr Hierarchy</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
>/usr/X11R6 : X Window System, Version 11 Release 6 (optional)</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/usr/bin : Most user commands</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/usr/include : Directory for standard include files.</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/usr/lib : Libraries for programming and packages</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/usr/lib<qual> : Alternate format libraries (optional)</A
></DT
>Purpose</A
></DT
>/usr/local : Local hierarchy</A
></DT
></DL
></DD
>/usr/local/share</A
></DT
>/usr/sbin : Non-essential standard system binaries</A
></DT
>Purpose</A
></DT
></DL
></DD
>/usr/share : Architecture-independent data</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
>/usr/share/dict : Word lists (optional)</A
></DT
>/usr/share/man : Manual pages</A
></DT
>/usr/share/misc : Miscellaneous architecture-independent data</A
></DT
>/usr/share/sgml : SGML data (optional)</A
></DT
>/usr/share/xml : XML data (optional)</A
></DT
></DL
></DD
>/usr/src : Source code (optional)</A
></DT
>Purpose</A
></DT
></DL
></DD
></DL
></DD
>5. The /var Hierarchy</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
>/var/account : Process accounting logs (optional)</A
></DT
>Purpose</A
></DT
></DL
></DD
>/var/cache : Application cache data</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
>/var/cache/fonts : Locally-generated fonts (optional)</A
></DT
>/var/cache/man : Locally-formatted manual pages (optional)</A
></DT
></DL
></DD
>/var/crash : System crash dumps (optional)</A
></DT
>Purpose</A
></DT
></DL
></DD
>/var/games : Variable game data (optional)</A
></DT
>Purpose</A
></DT
></DL
></DD
>/var/lib : Variable state information</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
>Specific Options</A
></DT
>/var/lib/<editor> : Editor backup files and state (optional)</A
></DT
>/var/lib/hwclock : State directory for hwclock (optional)</A
></DT
>/var/lib/misc : Miscellaneous variable data</A
></DT
></DL
></DD
>/var/lock : Lock files</A
></DT
>Purpose</A
></DT
></DL
></DD
>/var/log : Log files and directories</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
></DL
></DD
>/var/mail : User mailbox files (optional)</A
></DT
>Purpose</A
></DT
></DL
></DD
>/var/opt : Variable data for /opt</A
></DT
>Purpose</A
></DT
></DL
></DD
>/var/run : Run-time variable data</A
></DT
>Purpose</A
></DT
>Requirements</A
></DT
></DL
></DD
>/var/spool : Application spool data</A
></DT
>Purpose</A
></DT
>Specific Options</A
></DT
>/var/spool/lpd : Line-printer daemon print queues (optional)</A
></DT
>/var/spool/rwho : Rwhod files (optional)</A
></DT
></DL
></DD
>/var/tmp : Temporary files preserved between system reboots</A
></DT
>Purpose</A
></DT
></DL
></DD
>/var/yp : Network Information Service (NIS) database files (optional)</A
></DT
>Purpose</A
></DT
></DL
></DD
></DL
></DD
>6. Operating System Specific Annex</A
></DT
>Linux</A
></DT
>/ : Root directory</A
></DT
>/bin : Essential user command binaries (for use by all users)</A
></DT
>/dev : Devices and special files</A
></DT
>/etc : Host-specific system configuration</A
></DT
>/lib64 and /lib32 : 64/32-bit libraries (architecture dependent)</A
></DT
>/proc : Kernel and process information virtual filesystem</A
></DT
>/sbin : Essential system binaries</A
></DT
>/usr/include : Header files included by C programs</A
></DT
>/usr/src : Source code</A
></DT
>/var/spool/cron : cron and at jobs</A
></DT
></DL
></DD
></DL
></DD
>7. Appendix</A
></DT
>The FHS mailing list</A
></DT
>Background of the FHS</A
></DT
>General Guidelines</A
></DT
>Scope</A
></DT
>Acknowledgments</A
></DT
>Contributors</A
></DT
></DL
></DD
></DL
></DIV
></A
>Chapter 1. Introduction</H1
>Purpose</A
></H2
>This standard enables:</P
></P
>Software to predict the location of installed files and
directories, and</P
></LI
>Users to predict the location of installed files and
directories.</P
></LI
></UL
>We do this by:</P
></P
>Specifying guiding principles for each area of the filesystem,</P
></LI
>Specifying the minimum files and directories required,</P
></LI
>Enumerating exceptions to the principles, and</P
></LI
>Enumerating specific cases where there has been historical conflict.</P
></LI
></UL
>The FHS document is used by:</P
></P
>Independent software suppliers to create applications which are FHS
compliant, and work with distributions which are FHS complaint,</P
></LI
>OS creators to provide systems which are FHS compliant, and</P
></LI
>Users to understand and maintain the FHS compliance of a system.</P
></LI
></UL
>The FHS document has a limited scope:</P
></P
>Local placement of local files is a local issue, so FHS does not
attempt to usurp system administrators.</P
></LI
>FHS addresses issues where file placements need to be coordinated
between multiple parties such as local sites, distributions,
applications, documentation, etc.</P
></LI
></UL
></DIV
>Conventions</A
></H2
>We recommend that you read a typeset version of this document rather
than the plain text version. In the typeset version, the names of files
and directories are displayed in a constant-width font.</P
>Components of filenames that vary are represented by a description
of the contents enclosed in "<</I
></SPAN
>" and
"></I
></SPAN
>" characters, <thus></I
></SPAN
>. Electronic mail addresses are also
enclosed in "<" and ">" but are shown in the usual
typeface.</P
>Optional components of filenames are enclosed in
"[</I
></SPAN
>" and "]</I
></SPAN
>" characters and may
be combined with the "<</I
></SPAN
>" and
"></I
></SPAN
>" convention. For example, if a filename is
allowed to occur either with or without an extension, it might be
represented by
<filename>[.<extension>]</I
></SPAN
>.</P
>Variable substrings of directory names and filenames are indicated
by "*</I
></SPAN
>".</P
>The sections of the text marked as
Rationale</I
></SPAN
> are explanatory and are
non-normative.</P
></DIV
></DIV
></A
>Chapter 2. The Filesystem</H1
>This standard assumes that the operating system underlying an
FHS-compliant file system supports the same basic security features
found in most UNIX filesystems.</P
>It is possible to define two independent distinctions among
files: shareable vs. unshareable and variable vs. static. In general,
files that differ in either of these respects should be located in
different directories. This makes it easy to store files with
different usage characteristics on different filesystems.</P
>"Shareable" files are those that can be stored on one host
and used on others. "Unshareable" files are those that are not
shareable. For example, the files in user home directories are
shareable whereas device lock files are not.</P
>"Static" files include binaries, libraries, documentation
files and other files that do not change without system administrator
intervention. "Variable" files are files that are not static.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Shareable files can be stored on one host and used on several
others. Typically, however, not all files in the filesystem
hierarchy are shareable and so each system has local storage
containing at least its unshareable files. It is convenient if all
the files a system requires that are stored on a foreign host can be
made available by mounting one or a few directories from the foreign
host.</P
>Static and variable files should be segregated because static
files, unlike variable files, can be stored on read-only media and
do not need to be backed up on the same schedule as variable
files.</P
>Historical UNIX-like filesystem hierarchies contained both
static and variable files under both /usr</TT
> and
/etc</TT
>. In order to realize the advantages
mentioned above, the /var</TT
> hierarchy was
created and all variable files were transferred from
/usr</TT
> to /var</TT
>.
Consequently /usr</TT
> can now be mounted read-only
(if it is a separate filesystem). Variable files have been
transferred from /etc</TT
> to
/var</TT
> over a longer period as technology has
permitted.</P
>Here is an example of a FHS-compliant system.
(Other FHS-compliant layouts are possible.)</P
></P
></A
></I
></SPAN
></TH
>shareable</TH
>unshareable</TH
></TR
></THEAD
>static</TD
>/usr</TD
>/etc</TD
></TR
> </TD
>/opt</TD
>/boot</TD
></TR
>variable</TD
>/var/mail</TD
>/var/run</TD
></TR
> </TD
>/var/spool/news</TD
>/var/lock</TD
></TR
></TBODY
></TABLE
></P
></DIV
></TD
></TR
></TABLE
></DIV
></DIV
></A
>Chapter 3. The Root Filesystem</H1
>Purpose</A
></H2
>The contents of the root filesystem must be adequate to boot,
restore, recover, and/or repair the system.</P
></P
>To boot a system, enough must be present on the root partition
to mount other filesystems. This includes utilities, configuration,
boot loader information, and other essential start-up data.
/usr</TT
>, /opt</TT
>, and
/var</TT
> are designed such that they may be located
on other partitions or filesystems.</P
></LI
>To enable recovery and/or repair of a system, those utilities
needed by an experienced maintainer to diagnose and reconstruct a
damaged system must be present on the root filesystem.</P
></LI
>To restore a system, those utilities needed to restore from
system backups (on floppy, tape, etc.) must be present on the root
filesystem.</P
></LI
></UL
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>The primary concern used to balance these considerations, which
favor placing many things on the root filesystem, is the goal of
keeping root as small as reasonably possible. For several reasons, it
is desirable to keep the root filesystem small:</P
></P
>It is occasionally mounted from very small media.</P
></LI
>The root filesystem contains many system-specific configuration
files. Possible examples include a kernel that is specific to the
system, a specific hostname, etc. This means that the root filesystem
isn't always shareable between networked systems. Keeping it small on
servers in networked systems minimizes the amount of lost space for
areas of unshareable files. It also allows workstations with smaller
local hard drives.</P
></LI
>While you may have the root filesystem on a large partition, and
may be able to fill it to your heart's content, there will be people
with smaller partitions. If you have more files installed, you may
find incompatibilities with other systems using root filesystems on
smaller partitions. If you are a developer then you may be turning
your assumption into a problem for a large number of users.</P
></LI
>Disk errors that corrupt data on the root filesystem are a
greater problem than errors on any other partition. A small root
filesystem is less prone to corruption as the result of a system
crash.</P
></LI
></UL
></TD
></TR
></TABLE
></DIV
>Applications must never create or require special files or
subdirectories in the root directory. Other locations in the FHS
hierarchy provide more than enough flexibility for any package.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>There are several reasons why creating a new subdirectory of
the root filesystem is prohibited:</P
></P
>It demands space on a root partition which the system
administrator may want kept small and simple for either performance or
security reasons.</P
></LI
>It evades whatever discipline the system administrator may have
set up for distributing standard file hierarchies across mountable
volumes.</P
></LI
></UL
>Distributions should not create new directories in the root
hierarchy without extremely careful consideration of the consequences
including for application portability.</P
></TD
></TR
></TABLE
></DIV
></DIV
>Requirements</A
></H2
>The following directories, or symbolic links to directories, are
required in /</TT
>.</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>bin</TT
></TD
>Essential command binaries</TD
></TR
>boot</TT
></TD
>Static files of the boot loader</TD
></TR
>dev</TT
></TD
>Device files</TD
></TR
>etc</TT
></TD
>Host-specific system configuration</TD
></TR
>lib</TT
></TD
>Essential shared libraries and kernel modules</TD
></TR
>media</TT
></TD
>Mount point for removeable media</TD
></TR
>mnt</TT
></TD
>Mount point for mounting a filesystem temporarily</TD
></TR
>opt</TT
></TD
>Add-on application software packages</TD
></TR
>sbin</TT
></TD
>Essential system binaries</TD
></TR
>srv</TT
></TD
>Data for services provided by this system</TD
></TR
>tmp</TT
></TD
>Temporary files</TD
></TR
>usr</TT
></TD
>Secondary hierarchy</TD
></TR
>var</TT
></TD
>Variable data</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Each directory listed above is specified in detail in separate
subsections below. /usr</TT
> and
/var</TT
> each have a complete section in this
document due to the complexity of those directories.</P
></DIV
>Specific Options</A
></H2
>The following directories, or symbolic links to directories,
must be in /</TT
>, if the corresponding subsystem is
installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>home</TT
></TD
>User home directories (optional)</TD
></TR
>lib<qual></TT
></TD
>Alternate format essential shared libraries (optional)</TD
></TR
>root</TT
></TD
>Home directory for the root user (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Each directory listed above is specified in detail in separate
subsections below.</P
></DIV
>/bin : Essential user command binaries (for use by all users)</A
></H2
>Purpose</A
></H3
>/bin</TT
> contains commands that may be used by
both the system administrator and by users, but which are required
when no other filesystems are mounted (e.g. in single user mode). It
may also contain commands which are used indirectly by scripts.
[1]</SPAN
></A
></P
></DIV
>Requirements</A
></H3
>There must be no subdirectories in
/bin</TT
>.</P
>The following commands, or symbolic links to commands, are
required in /bin</TT
>.</P
></P
></A
>Command</TH
>Description</TH
></TR
></THEAD
>cat</B
></TD
>Utility to concatenate files to standard output</TD
></TR
>chgrp</B
></TD
>Utility to change file group ownership</TD
></TR
>chmod</B
></TD
>Utility to change file access permissions</TD
></TR
>chown</B
></TD
>Utility to change file owner and group</TD
></TR
>cp</B
></TD
>Utility to copy files and directories</TD
></TR
>date</B
></TD
>Utility to print or set the system data and time</TD
></TR
>dd</B
></TD
>Utility to convert and copy a file</TD
></TR
>df</B
></TD
>Utility to report filesystem disk space usage</TD
></TR
>dmesg</B
></TD
>Utility to print or control the kernel message buffer</TD
></TR
>echo</B
></TD
>Utility to display a line of text</TD
></TR
>false</B
></TD
>Utility to do nothing, unsuccessfully</TD
></TR
>hostname</B
></TD
>Utility to show or set the system's host name</TD
></TR
>kill</B
></TD
>Utility to send signals to processes</TD
></TR
>ln</B
></TD
>Utility to make links between files</TD
></TR
>login</B
></TD
>Utility to begin a session on the system</TD
></TR
>ls</B
></TD
>Utility to list directory contents</TD
></TR
>mkdir</B
></TD
>Utility to make directories</TD
></TR
>mknod</B
></TD
>Utility to make block or character special files</TD
></TR
>more</B
></TD
>Utility to page through text</TD
></TR
>mount</B
></TD
>Utility to mount a filesystem</TD
></TR
>mv</B
></TD
>Utility to move/rename files</TD
></TR
>ps</B
></TD
>Utility to report process status</TD
></TR
>pwd</B
></TD
>Utility to print name of current working directory</TD
></TR
>rm</B
></TD
>Utility to remove files or directories</TD
></TR
>rmdir</B
></TD
>Utility to remove empty directories</TD
></TR
>sed</B
></TD
>The `sed' stream editor</TD
></TR
>sh</B
></TD
>The Bourne command shell</TD
></TR
>stty</B
></TD
>Utility to change and print terminal line settings</TD
></TR
>su</B
></TD
>Utility to change user ID</TD
></TR
>sync</B
></TD
>Utility to flush filesystem buffers</TD
></TR
>true</B
></TD
>Utility to do nothing, successfully</TD
></TR
>umount</B
></TD
>Utility to unmount file systems</TD
></TR
>uname</B
></TD
>Utility to print system information</TD
></TR
></TBODY
></TABLE
></P
></DIV
>If /bin/sh</B
> is not a true Bourne shell, it
must be a hard or symbolic link to the real shell command.</P
>The [</B
> and test</B
>
commands must be placed together in either /bin</TT
>
or /usr/bin</TT
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>For example bash behaves differently when called as
sh</B
> or bash</B
>. The use of a
symbolic link also allows users to easily see that
/bin/sh</B
> is not a true Bourne shell.</P
>The requirement for the [</B
> and
test</B
> commands to be included as binaries (even if
implemented internally by the shell) is shared with the POSIX.2
standard. </P
></TD
></TR
></TABLE
></DIV
></DIV
>Specific Options</A
></H3
>The following programs, or symbolic links to programs, must be
in /bin</TT
> if the corresponding subsystem is
installed:</P
></P
></A
>Command</TH
>Description</TH
></TR
></THEAD
>csh</B
></TD
>The C shell (optional)</TD
></TR
>ed</B
></TD
>The `ed' editor (optional)</TD
></TR
>tar</B
></TD
>The tar archiving utility (optional)</TD
></TR
>cpio</B
></TD
>The cpio archiving utility (optional)</TD
></TR
>gzip</B
></TD
>The GNU compression utility (optional)</TD
></TR
>gunzip</B
></TD
>The GNU uncompression utility (optional)</TD
></TR
>zcat</B
></TD
>The GNU uncompression utility (optional)</TD
></TR
>netstat</B
></TD
>The network statistics utility (optional)</TD
></TR
>ping</B
></TD
>The ICMP network test utility (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>If the gunzip</B
> and zcat</B
>
programs exist, they must be symbolic or hard links to
gzip. /bin/csh</B
> may be a symbolic link to
/bin/tcsh</B
> or
/usr/bin/tcsh</B
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>The tar, gzip and cpio commands have been added to make restoration of a
system possible (provided that /</TT
> is intact).</P
>Conversely, if no restoration from the root partition is ever
expected, then these binaries might be omitted (e.g., a ROM chip root,
mounting /usr</TT
> through NFS). If restoration of a
system is planned through the network, then ftp</B
>
or tftp</B
> (along with everything necessary to get
an ftp connection) must be available on the root partition. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/boot : Static files of the boot loader</A
></H2
>Purpose</A
></H3
>This directory contains everything required for the boot process
except configuration files not needed at boot time and the map
installer. Thus /boot stores data that is used before the kernel
begins executing user-mode programs. This may include saved master
boot sectors and sector map files.
[2]</SPAN
></A
> </P
></DIV
>Specific Options</A
></H3
>The operating system kernel must be located in either
/</TT
> or /boot</TT
>.
[3]</SPAN
></A
></P
></DIV
></DIV
>/dev : Device files</A
></H2
>Purpose</A
></H3
>The /dev</TT
> directory is the location of
special or device files.</P
></DIV
>Specific Options</A
></H3
>If it is possible that devices in /dev</TT
> will
need to be manually created, /dev</TT
> must contain a
command named MAKEDEV</TT
>, which can create devices
as needed. It may also contain a MAKEDEV.local</TT
>
for any local devices.</P
>If required, MAKEDEV</TT
> must have provisions
for creating any device that may be found on the system, not just
those that a particular implementation installs.</P
></DIV
></DIV
>/etc : Host-specific system configuration</A
></H2
>Purpose</A
></H3
>The /etc</TT
> hierarchy contains configuration
files. A "configuration file" is a local file used to control the
operation of a program; it must be static and cannot be an executable
binary.
[4]</SPAN
></A
></P
></DIV
>Requirements</A
></H3
>No binaries may be located under /etc</TT
>.
[5]</SPAN
></A
></P
>The following directories, or symbolic links to directories are
required in /etc</TT
>:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>opt</TD
>Configuration for /opt</TD
></TR
>X11</TD
>Configuration for the X Window system (optional)</TD
></TR
>sgml</TD
>Configuration for SGML (optional)</TD
></TR
>xml</TD
>Configuration for XML (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories must
be in /etc</TT
>, if the corresponding subsystem is
installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>opt</TD
>Configuration for /opt</TD
></TR
></TBODY
></TABLE
></P
></DIV
>The following files, or symbolic links to files, must be in
/etc</TT
> if the corresponding subsystem is
installed:
[6]</SPAN
></A
></P
></P
></A
>File</TH
>Description</TH
></TR
></THEAD
>csh.login</TT
></TD
>Systemwide initialization file for C shell logins (optional)</TD
></TR
>exports</TT
></TD
>NFS filesystem access control list (optional)</TD
></TR
>fstab</TT
></TD
>Static information about filesystems (optional)</TD
></TR
>ftpusers</TT
></TD
>FTP daemon user access control list (optional)</TD
></TR
>gateways</TT
></TD
>File which lists gateways for routed (optional)</TD
></TR
>gettydefs</TT
></TD
>Speed and terminal settings used by getty (optional)</TD
></TR
>group</TT
></TD
>User group file (optional)</TD
></TR
>host.conf</TT
></TD
>Resolver configuration file (optional)</TD
></TR
>hosts</TT
></TD
>Static information about host names (optional)</TD
></TR
>hosts.allow</TT
></TD
>Host access file for TCP wrappers (optional)</TD
></TR
>hosts.deny</TT
></TD
>Host access file for TCP wrappers (optional)</TD
></TR
>hosts.equiv</TT
></TD
>List of trusted hosts for rlogin, rsh, rcp (optional)</TD
></TR
>hosts.lpd</TT
></TD
>List of trusted hosts for lpd (optional)</TD
></TR
>inetd.conf</TT
></TD
>Configuration file for inetd (optional)</TD
></TR
>inittab</TT
></TD
>Configuration file for init (optional)</TD
></TR
>issue</TT
></TD
>Pre-login message and identification file (optional)</TD
></TR
>ld.so.conf</TT
></TD
>List of extra directories to search for shared libraries (optional)</TD
></TR
>motd</TT
></TD
>Post-login message of the day file (optional)</TD
></TR
>mtab</TT
></TD
>Dynamic information about filesystems (optional)</TD
></TR
>mtools.conf</TT
></TD
>Configuration file for mtools (optional)</TD
></TR
>networks</TT
></TD
>Static information about network names (optional)</TD
></TR
>passwd</TT
></TD
>The password file (optional)</TD
></TR
>printcap</TT
></TD
>The lpd printer capability database (optional)</TD
></TR
>profile</TT
></TD
>Systemwide initialization file for sh shell logins (optional)</TD
></TR
>protocols</TT
></TD
>IP protocol listing (optional)</TD
></TR
>resolv.conf</TT
></TD
>Resolver configuration file (optional)</TD
></TR
>rpc</TT
></TD
>RPC protocol listing (optional)</TD
></TR
>securetty</TT
></TD
>TTY access control for root login (optional)</TD
></TR
>services</TT
></TD
>Port names for network services (optional)</TD
></TR
>shells</TT
></TD
>Pathnames of valid login shells (optional)</TD
></TR
>syslog.conf</TT
></TD
>Configuration file for syslogd (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>mtab</TT
> does not fit the static nature of
/etc</TT
>: it is excepted for historical reasons.
[7]</SPAN
></A
> </P
></DIV
>/etc/opt : Configuration files for /opt</A
></H3
>Purpose</A
></H4
>Host-specific configuration files for add-on application
software packages must be installed within the directory
/etc/opt/<subdir></TT
>, where
<subdir></TT
> is the name of the subtree in
/opt</TT
> where the static data from that package is
stored.</P
></DIV
>Requirements</A
></H4
>No structure is imposed on the internal arrangement of
/etc/opt/<subdir></TT
>.</P
>If a configuration file must reside in a different location in
order for the package or system to function properly, it may be placed
in a location other than
/etc/opt/<subdir></TT
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Refer to the rationale for /opt</TT
>.</P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/etc/X11 : Configuration for the X Window System (optional)</A
></H3
>Purpose</A
></H4
>/etc/X11</I
></SPAN
> is the location for all X11
host-specific configuration. This directory is necessary to allow
local control if /usr</I
></SPAN
> is mounted read
only.</P
></DIV
>Specific Options</A
></H4
>The following files, or symbolic links to files, must be in
/etc/X11</TT
> if the corresponding subsystem is
installed:</P
></P
></A
>File</TH
>Description</TH
></TR
></THEAD
>Xconfig</TT
></TD
>The configuration file for early versions of XFree86 (optional)</TD
></TR
>XF86Config</TT
></TD
>The configuration file for XFree86 versions 3 and 4 (optional)</TD
></TR
>Xmodmap</TT
></TD
>Global X11 keyboard modification file (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Subdirectories of /etc/X11</TT
> may include
those for xdm</TT
> and for any other programs (some
window managers, for example) that need them.
[8]</SPAN
></A
>
We recommend that window managers with only one configuration file
which is a default .*wmrc</TT
> file must name it
system.*wmrc</TT
> (unless there is a widely-accepted
alternative name) and not use a subdirectory. Any window manager
subdirectories must be identically named to the actual window manager
binary.</P
></DIV
></DIV
>/etc/sgml : Configuration files for SGML (optional)</A
></H3
>Purpose</A
></H4
>Generic configuration files defining high-level parameters of
the SGML systems are installed here. Files with names
*.conf</TT
> indicate generic configuration files.
File with names *.cat</TT
> are the DTD-specific
centralized catalogs, containing references to all other catalogs
needed to use the given DTD. The super catalog file
catalog</TT
> references all the centralized
catalogs.</P
></DIV
></DIV
>/etc/xml : Configuration files for XML (optional)</A
></H3
>Purpose</A
></H4
>Generic configuration files defining high-level parameters of
the XML systems are installed here. Files with names
*.conf</TT
> indicate generic configuration files.
The super catalog file
catalog</TT
> references all the centralized
catalogs.</P
></DIV
></DIV
></DIV
>/home : User home directories (optional)</A
></H2
>Purpose</A
></H3
>/home</TT
> is a fairly standard concept, but it
is clearly a site-specific filesystem.
[9]</SPAN
></A
>
The setup will differ from host to host. Therefore, no program should
rely on this location.
[10]</SPAN
></A
> </P
></DIV
>Requirements</A
></H3
>User specific configuration files for applications are stored in the
user's home directory in a file that starts with the '.' character (a
"dot file"). If an application needs to create more than one dot file
then they should be placed in a subdirectory with a name starting with
a '.' character, (a "dot directory"). In this case the configuration
files should not start with the '.' character.
[11]</SPAN
></A
></P
></DIV
></DIV
>/lib : Essential shared libraries and kernel modules</A
></H2
>Purpose</A
></H3
>The /lib</TT
> directory contains those shared
library images needed to boot the system and run the commands in the
root filesystem, ie. by binaries in /bin</TT
> and
/sbin</TT
>.
[12]</SPAN
></A
></P
></DIV
>Requirements</A
></H3
>At least one of each of the following filename patterns are
required (they may be files, or symbolic links):</P
></P
></A
>File</TH
>Description</TH
></TR
></THEAD
>libc.so.*</TT
></TD
>The dynamically-linked C library (optional)</TD
></TR
>ld*</TT
></TD
>The execution time linker/loader (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>If a C preprocessor is installed, /lib/cpp</I
></SPAN
>
must be a reference to it, for historical reasons.
[13]</SPAN
></A
></P
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories,
must be in /lib</TT
>, if the corresponding subsystem
is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>modules</TT
></TD
>Loadable kernel modules (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
></DIV
>/lib<qual> : Alternate format essential shared libraries (optional)</A
></H2
>Purpose</A
></H3
>There may be one or more variants of the
/lib</TT
> directory on systems which support more than
one binary format requiring separate libraries.
[14]</SPAN
></A
></P
></DIV
>Requirements</A
></H3
>If one or more of these directories exist, the requirements for
their contents are the same as the normal /lib</TT
>
directory, except that /lib<qual>/cpp</TT
> is
not required.
[15]</SPAN
></A
></P
></DIV
></DIV
>/media : Mount point for removeable media</A
></H2
>Purpose</A
></H3
>This directory contains subdirectories which are used as mount
points for removeable media such as floppy disks, cdroms and zip
disks.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Historically there have been a number of other different places
used to mount removeable media such as /cdrom</TT
>,
/mnt</TT
> or /mnt/cdrom</TT
>. Placing
the mount points for all removeable media directly in the root
directory would potentially result in a large number of extra
directories in /</TT
>. Although the use of
subdirectories in /mnt</TT
> as a mount point has
recently been common, it conflicts with a much older tradition of
using /mnt</TT
> directly as a temporary mount point.</P
></TD
></TR
></TABLE
></DIV
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories,
must be in /media</TT
>, if the corresponding subsystem
is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>floppy</TT
></TD
>Floppy drive (optional)</TD
></TR
>cdrom</TT
></TD
>CD-ROM drive (optional)</TD
></TR
>cdrecorder</TT
></TD
>CD writer (optional)</TD
></TR
>zip</TT
></TD
>Zip drive (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>On systems where more than one device exists for mounting a
certain type of media, mount directories can be created by appending a
digit to the name of those available above starting with '0', but the
unqualified name must also exist.
[16]</SPAN
></A
> </P
></DIV
></DIV
>/mnt : Mount point for a temporarily mounted filesystem</A
></H2
>Purpose</A
></H3
>This directory is provided so that the system administrator may
temporarily mount a filesystem as needed. The content of this
directory is a local issue and should not affect the manner in which
any program is run.</P
>This directory must not be used by installation programs: a
suitable temporary directory not in use by the system must be used
instead.</P
></DIV
></DIV
>/opt : Add-on application software packages</A
></H2
>Purpose</A
></H3
>/opt</TT
> is reserved for the installation of
add-on application software packages.</P
>A package to be installed in /opt</TT
> must
locate its static files in a separate
/opt/<package></TT
> or
/opt/<provider></TT
> directory
tree, where <package></TT
> is a name that
describes the software package and
<provider></TT
> is the provider's LANANA
registered name.</P
></DIV
>Requirements</A
></H3
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
><package></TD
>Static package objects</TD
></TR
><provider></TD
>LANANA registered provider name</TD
></TR
></TBODY
></TABLE
></P
></DIV
>The directories /opt/bin</TT
>,
/opt/doc</TT
>, /opt/include</TT
>,
/opt/info</TT
>, /opt/lib</TT
>, and
/opt/man</TT
> are reserved for local system
administrator use. Packages may provide "front-end" files intended to
be placed in (by linking or copying) these reserved directories by the
local system administrator, but must function normally in the absence
of these reserved directories.</P
>Programs to be invoked by users must be located in the directory
/opt/<package>/bin</TT
> or under the
/opt/<provider></TT
> hierarchy. If the package
includes UNIX manual pages, they must be located in
/opt/<package>/share/man</TT
> or under the
/opt/<provider></TT
> hierarchy, and the same
substructure as /usr/share/man</TT
> must be
used.</P
>Package files that are variable (change in normal operation)
must be installed in /var/opt</TT
>. See the section
on /var/opt</TT
> for more information.</P
>Host-specific configuration files must be installed in
/etc/opt</TT
>. See the section on
/etc</TT
> for more information.</P
>No other package files may exist outside the
/opt</TT
>, /var/opt</TT
>, and
/etc/opt</TT
> hierarchies except for those package
files that must reside in specific locations within the filesystem
tree in order to function properly. For example, device lock files
must be placed in /var/lock</TT
> and devices must be
located in /dev</TT
>.</P
>Distributions may install software in /opt</TT
>,
but must not modify or delete software installed by the local system
administrator without the assent of the local system
administrator.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>The use of /opt</TT
> for add-on software is a
well-established practice in the UNIX community. The System V
Application Binary Interface [AT&T 1990], based on the System V
Interface Definition (Third Edition), provides for an
/opt</TT
> structure very similar to the one defined
here.</P
>The Intel Binary Compatibility Standard v. 2 (iBCS2) also
provides a similar structure for /opt</TT
>.</P
>Generally, all data required to support a package on a system
must be present within /opt/<package></TT
>,
including files intended to be copied into
/etc/opt/<package></TT
> and
/var/opt/<package></TT
> as well as reserved
directories in /opt</TT
>.</P
>The minor restrictions on distributions using
/opt</TT
> are necessary because conflicts are possible
between distribution-installed and locally-installed software,
especially in the case of fixed pathnames found in some binary
software.</P
>The structure of the directories below
/opt/<provider></TT
> is left up to the packager
of the software, though it is recommended that packages are installed
in /opt/<provider>/<package></TT
> and
follow a similar structure to the guidelines for
/opt/package</TT
>. A valid reason for diverging from
this structure is for support packages which may have files installed
in /opt/<provider>/lib</TT
> or
/opt/<provider>/bin</TT
>.</P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/root : Home directory for the root user (optional)</A
></H2
>Purpose</A
></H3
>The root account's home directory may be determined by developer
or local preference, but this is the recommended default
location.
[17]</SPAN
></A
></P
></DIV
></DIV
>/sbin : System binaries</A
></H2
>Purpose</A
></H3
>Utilities used for system administration (and other root-only
commands) are stored in /sbin</TT
>,
/usr/sbin</TT
>, and
/usr/local/sbin</TT
>. /sbin</TT
>
contains binaries essential for booting, restoring, recovering, and/or
repairing the system in addition to the binaries in
/bin</TT
>.
[18]</SPAN
></A
> Programs executed after
/usr</TT
> is known to be mounted (when there are no
problems) are generally placed into /usr/sbin</TT
>.
Locally-installed system administration programs should be placed into
/usr/local/sbin</TT
>.
[19]</SPAN
></A
></P
></DIV
>Requirements</A
></H3
>The following commands, or symbolic links to commands, are
required in /sbin</TT
>.</P
></P
></A
>Command</TH
>Description</TH
></TR
></THEAD
>shutdown</B
></TD
>Command to bring the system down.</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>Specific Options</A
></H3
>The following files, or symbolic links to files, must be in
/sbin</TT
> if the corresponding subsystem is
installed:</P
></P
></A
>Command</TH
>Description</TH
></TR
></THEAD
>fastboot</TT
></TD
>Reboot the system without checking the disks (optional)</TD
></TR
>fasthalt</TT
></TD
>Stop the system without checking the disks (optional)</TD
></TR
>fdisk</TT
></TD
>Partition table manipulator (optional)</TD
></TR
>fsck</TT
></TD
>File system check and repair utility (optional)</TD
></TR
>fsck.*</TT
></TD
>File system check and repair utility for a specific filesystem (optional)</TD
></TR
>getty</TT
></TD
>The getty program (optional)</TD
></TR
>halt</TT
></TD
>Command to stop the system (optional)</TD
></TR
>ifconfig</TT
></TD
>Configure a network interface (optional)</TD
></TR
>init</TT
></TD
>Initial process (optional)</TD
></TR
>mkfs</TT
></TD
>Command to build a filesystem (optional)</TD
></TR
>mkfs.*</TT
></TD
>Command to build a specific filesystem (optional)</TD
></TR
>mkswap</TT
></TD
>Command to set up a swap area (optional)</TD
></TR
>reboot</TT
></TD
>Command to reboot the system (optional)</TD
></TR
>route</TT
></TD
>IP routing table utility (optional)</TD
></TR
>swapon</TT
></TD
>Enable paging and swapping (optional)</TD
></TR
>swapoff</TT
></TD
>Disable paging and swapping (optional)</TD
></TR
>update</TT
></TD
>Daemon to periodically flush filesystem buffers (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
></DIV
>/srv : Data for services provided by this system</A
></H2
>Purpose</A
></H3
>/srv</TT
> contains site-specific data which is
served by this system.
</P
></TD
>Rationale</B
></TH
></TR
> </TD
>This main purpose of specifying this is so that users may find the
location of the data files for particular service, and so that
services which require a single tree for readonly data, writable data
and scripts (such as cgi scripts) can be reasonably placed. Data that
is only of interest to a specific user should go in that users' home
directory.</P
>The methodology used to name subdirectories of
/srv</TT
> is unspecified as there is currently no
consensus on how this should be done. One method for structuring data
under /srv</TT
> is by protocol,
eg. ftp</TT
>, rsync</TT
>,
www</TT
>, and cvs</TT
>. On large
systems it can be useful to structure /srv</TT
> by
administrative context, such as /srv/physics/www</TT
>,
/srv/compsci/cvs</TT
>, etc. This setup will differ
from host to host. Therefore, no program should rely on a specific
subdirectory structure of /srv</TT
> existing or data
necessarily being stored in /srv</TT
>. However
/srv</TT
> should always exist on FHS compliant systems
and should be used as the default location for such data.</P
>Distributions must take care not to remove locally placed files in
these directories without administrator permission.
[20]</SPAN
></A
></P
></TD
></TR
></TABLE
></DIV
> </P
></DIV
></DIV
>/tmp : Temporary files</A
></H2
>Purpose</A
></H3
>The /tmp</TT
> directory must be made available
for programs that require temporary files.</P
>Programs must not assume that any files or directories in
/tmp</TT
> are preserved between invocations of the
program.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>IEEE standard P1003.2 (POSIX, part 2) makes requirements that
are similar to the above section.</P
>Although data stored in /tmp</TT
> may be deleted
in a site-specific manner, it is recommended that files and
directories located in /tmp</TT
> be deleted whenever
the system is booted.</P
>FHS added this recommendation on the basis of historical
precedent and common practice, but did not make it a requirement
because system administration is not within the scope of this
standard. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
></DIV
></A
>Chapter 4. The /usr Hierarchy</H1
>Purpose</A
></H2
>/usr</TT
> is the second major section of the
filesystem. /usr</TT
> is shareable, read-only data.
That means that /usr</TT
> should be shareable between
various FHS-compliant hosts and must not be written to. Any
information that is host-specific or varies with time is stored
elsewhere.</P
>Large software packages must not use a direct subdirectory under
the /usr</TT
> hierarchy.</P
></DIV
>Requirements</A
></H2
>The following directories, or symbolic links to directories, are
required in /usr</TT
>.</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>bin</TT
></TD
>Most user commands</TD
></TR
>include</TT
></TD
>Header files included by C programs</TD
></TR
>lib</TT
></TD
>Libraries</TD
></TR
>local</TT
></TD
>Local hierarchy (empty after main installation)</TD
></TR
>sbin</TT
></TD
>Non-vital system binaries</TD
></TR
>share</TT
></TD
>Architecture-independent data</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>Specific Options</A
></H2
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>X11R6</TT
></TD
>XWindow System, version 11 release 6 (optional)</TD
></TR
>games</TT
></TD
>Games and educational binaries (optional)</TD
></TR
>lib<qual></TT
></TD
>Alternate Format Libraries (optional)</TD
></TR
>src</TT
></TD
>Source code (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>An exception is made for the X Window System because of
considerable precedent and widely-accepted practice.</P
>The following symbolic links to directories may be present. This
possibility is based on the need to preserve compatibility with older
systems until all implementations can be assumed to use the
/var</TT
> hierarchy.</P
> /usr/spool -> /var/spool
/usr/tmp -> /var/tmp
/usr/spool/locks -> /var/lock</PRE
></TD
></TR
></TABLE
>Once a system no longer requires any one of the above symbolic links,
the link may be removed, if desired.</P
></DIV
>/usr/X11R6 : X Window System, Version 11 Release 6 (optional)</A
></H2
>Purpose</A
></H3
>This hierarchy is reserved for the X Window System, version 11
release 6, and related files.</P
>To simplify matters and make XFree86 more compatible with the X
Window System on other systems, the following symbolic links must be
present if /usr/X11R6</TT
> exists:</P
> /usr/bin/X11 -> /usr/X11R6/bin
/usr/lib/X11 -> /usr/X11R6/lib/X11
/usr/include/X11 -> /usr/X11R6/include/X11</PRE
></TD
></TR
></TABLE
>In general, software must not be installed or managed via the above
symbolic links. They are intended for utilization by users only. The
difficulty is related to the release version of the X Window System —
in transitional periods, it is impossible to know what release of X11 is
in use.</P
></DIV
>Specific Options</A
></H3
>Host-specific data in /usr/X11R6/lib/X11</TT
> should be interpreted
as a demonstration file. Applications requiring information about the
current host must reference a configuration file in /etc/X11</TT
>,
which may be linked to a file in /usr/X11R6/lib</TT
>.
[21]</SPAN
></A
></P
></DIV
></DIV
>/usr/bin : Most user commands</A
></H2
>Purpose</A
></H3
>This is the primary directory of executable commands on the
system.</P
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories,
must be in /usr/bin</TT
>, if the corresponding
subsystem is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>mh</TT
></TD
>Commands for the MH mail handling system (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>/usr/bin/X11</TT
> must be a symlink to
/usr/X11R6/bin</TT
> if the latter exists.</P
>The following files, or symbolic links to files, must be in
/usr/bin</TT
>, if the corresponding subsystem is
installed:</P
></P
></A
>Command</TH
>Description</TH
></TR
></THEAD
>perl</B
></TD
>The Practical Extraction and Report Language (optional)</TD
></TR
>python</B
></TD
>The Python interpreted language (optional)</TD
></TR
>tclsh</B
></TD
>Simple shell containing Tcl interpreter (optional)</TD
></TR
>wish</B
></TD
>Simple Tcl/Tk windowing shell (optional)</TD
></TR
>expect</B
></TD
>Program for interactive dialog (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Because shell script interpreters (invoked with
#!<path></TT
> on the first line of a shell
script) cannot rely on a path, it is advantageous to standardize their
locations. The Bourne shell and C-shell interpreters are already
fixed in /bin</TT
>, but Perl, Python, and Tcl are
often found in many different places. They may be symlinks to the
physical location of the shell interpreters. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/usr/include : Directory for standard include files.</A
></H2
>Purpose</A
></H3
>This is where all of the system's general-use include files for the C
programming language should be placed.</P
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories,
must be in /usr/include</TT
>, if the corresponding
subsystem is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>bsd</TD
>BSD compatibility include files (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>The symbolic link /usr/include/X11</TT
> must
link to /usr/X11R6/include/X11</TT
> if the latter
exists.</P
></DIV
></DIV
>/usr/lib : Libraries for programming and packages</A
></H2
>Purpose</A
></H3
>/usr/lib</TT
> includes object files, libraries,
and internal binaries that are not intended to be executed directly by
users or shell scripts.
[22]</SPAN
></A
></P
>Applications may use a single subdirectory under
/usr/lib</TT
>. If an application uses a subdirectory,
all architecture-dependent data exclusively used by the application
must be placed within that subdirectory.
[23]</SPAN
></A
></P
></DIV
>Specific Options</A
></H3
>For historical reasons, /usr/lib/sendmail</B
>
must be a symbolic link to /usr/sbin/sendmail</B
> if
the latter exists.
[24]</SPAN
></A
></P
>If /lib/X11</TT
> exists,
/usr/lib/X11</TT
> must be a symbolic link to
/lib/X11</TT
>, or to whatever
/lib/X11</TT
> is a symbolic link to.
[25]</SPAN
></A
></P
></DIV
></DIV
>/usr/lib<qual> : Alternate format libraries (optional)</A
></H2
>Purpose</A
></H3
>/usr/lib<qual></TT
> performs the same role as /usr/lib</TT
> for an
alternate binary format, except that the symbolic links
/usr/lib<qual>/sendmail</TT
> and /usr/lib<qual>/X11</TT
> are not required.
[26]</SPAN
></A
></P
></DIV
>/usr/local : Local hierarchy</A
></H3
>Purpose</A
></H4
>The /usr/local</TT
> hierarchy is for use by the
system administrator when installing software locally. It needs to be
safe from being overwritten when the system software is updated. It
may be used for programs and data that are shareable amongst a group
of hosts, but not found in /usr</TT
>.</P
>Locally installed software must be placed within
/usr/local</TT
> rather than /usr</TT
>
unless it is being installed to replace or upgrade software in
/usr</TT
>.
[27]</SPAN
></A
></P
></DIV
>Requirements</A
></H4
>The following directories, or symbolic links to directories,
must be in /usr/local</TT
></P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>bin</TT
></TD
>Local binaries</TD
></TR
>etc</TT
></TD
>Host-specific system configuration for local binaries</TD
></TR
>games</TT
></TD
>Local game binaries</TD
></TR
>include</TT
></TD
>Local C header files</TD
></TR
>lib</TT
></TD
>Local libraries</TD
></TR
>man</TT
></TD
>Local online manuals</TD
></TR
>sbin</TT
></TD
>Local system binaries</TD
></TR
>share</TT
></TD
>Local architecture-independent hierarchy</TD
></TR
>src</TT
></TD
>Local source code</TD
></TR
></TBODY
></TABLE
></P
></DIV
>No other directories, except those listed below, may be in
/usr/local</TT
> after first installing a FHS-compliant
system.</P
></DIV
>Specific Options</A
></H4
>If directories /lib<qual></TT
> or
/usr/lib<qual></TT
> exist, the equivalent
directories must also exist in /usr/local</TT
>.</P
>/usr/local/etc</TT
> may be a symbolic link to
/etc/local</TT
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>The consistency of /usr/local/etc</TT
> is
beneficial to installers, and is already used in other systems. As
all of /usr/local</TT
> needs to be backed up to
reproduce a system, it introduces no additional maintenance overhead,
but a symlink to /etc/local</TT
> is suitable if
systems want alltheir configuration under one hierarchy.</P
>Note that /usr/etc</TT
> is still not allowed: programs
in /usr</TT
> should place configuration files in
/etc</TT
>.</P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
></DIV
>/usr/local/share</A
></H2
>The requirements for the contents of this directory are the same
as /usr/share</TT
>. The only additional constraint is
that /usr/local/share/man</TT
> and
/usr/local/man</TT
> directories must be synonomous
(usually this means that one of them must be a symbolic link).
[28]</SPAN
></A
></P
></DIV
>/usr/sbin : Non-essential standard system binaries</A
></H2
>Purpose</A
></H3
>This directory contains any non-essential binaries used
exclusively by the system administrator. System administration
programs that are required for system repair, system recovery,
mounting /usr</TT
>, or other essential functions must
be placed in /sbin</TT
> instead.
[29]</SPAN
></A
></P
></DIV
></DIV
>/usr/share : Architecture-independent data</A
></H2
>Purpose</A
></H3
>The /usr/share</TT
> hierarchy is for all
read-only architecture independent data files.
[30]</SPAN
></A
> </P
>This hierarchy is intended to be shareable among all
architecture platforms of a given OS; thus, for example, a site with
i386, Alpha, and PPC platforms might maintain a single
/usr/share</TT
> directory that is centrally-mounted.
Note, however, that /usr/share</TT
> is generally not
intended to be shared by different OSes or by different releases of
the same OS.</P
>Any program or package which contains or requires data that
doesn't need to be modified should store that data in
/usr/share</TT
> (or
/usr/local/share</TT
>, if installed locally). It is
recommended that a subdirectory be used in
/usr/share</TT
> for this purpose.</P
>Game data stored in /usr/share/games</TT
> must
be purely static data. Any modifiable files, such as score files,
game play logs, and so forth, should be placed in
/var/games</TT
>.</P
></DIV
>Requirements</A
></H3
>The following directories, or symbolic links to directories,
must be in /usr/share</TT
></P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>man</TT
></TD
>Online manuals</TD
></TR
>misc</TT
></TD
>Miscellaneous architecture-independent data</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories, must be in /usr/share</TT
>, if the corresponding
subsystem is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>dict</TT
></TD
>Word lists (optional)</TD
></TR
>doc</TT
></TD
>Miscellaneous documentation (optional)</TD
></TR
>games</TT
></TD
>Static data files for /usr/games (optional)</TD
></TR
>info</TT
></TD
>GNU Info system s primary directory (optional)</TD
></TR
>locale</TT
></TD
>Locale information (optional)</TD
></TR
>nls</TT
></TD
>Message catalogs for Native language support (optional)</TD
></TR
>sgml</TT
></TD
>SGML data (optional)</TD
></TR
>terminfo</TT
></TD
>Directories for terminfo database (optional)</TD
></TR
>tmac</TT
></TD
>troff macros not distributed with groff (optional)</TD
></TR
>xml</TT
></TD
>XML data (optional)</TD
></TR
>zoneinfo</TT
></TD
>Timezone information and configuration (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>It is recommended that application-specific,
architecture-independent directories be placed here. Such directories
include groff</B
>, perl</B
>,
ghostscript</B
>, texmf</B
>, and
kbd</B
> (Linux) or syscons</B
>
(BSD). They may, however, be placed in /usr/lib</TT
>
for backwards compatibility, at the distributor's discretion.
Similarly, a /usr/lib/games</TT
> hierarchy may be used
in addition to the /usr/share/games</TT
> hierarchy if
the distributor wishes to place some game data there.</P
></DIV
>/usr/share/dict : Word lists (optional)</A
></H3
>Purpose</A
></H4
>This directory is the home for word lists on the system;
Traditionally this directory contains only the English
words</TT
> file, which is used by
look(1)</B
> and various spelling programs.
words</TT
> may use either American or British
spelling.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>The reason that only word lists are located here is that they
are the only files common to all spell checkers.</P
></TD
></TR
></TABLE
></DIV
></DIV
>Specific Options</A
></H4
>The following files, or symbolic links to files, must be in
/usr/share/dict</TT
>, if the corresponding subsystem
is installed:</P
></P
></A
>File</TT
></TH
>Description</TH
></TR
></THEAD
>words</TT
></TD
>List of English words (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Sites that require both American and British spelling may link
words</TT
> to
­/usr/share/dict/american-english</TT
> or
­/usr/share/dict/british-english</TT
>.</P
>Word lists for other languages may be added using the English
name for that language, e.g.,
/usr/share/dict/french</TT
>,
/usr/share/dict/danish</TT
>, etc. These should, if
possible, use an ISO 8859 character set which is appropriate for the
language in question; if possible the Latin1 (ISO 8859-1) character
set should be used (this is often not possible).</P
>Other word lists must be included here, if present.</P
></DIV
></DIV
>/usr/share/man : Manual pages</A
></H3
>Purpose</A
></H4
>This section details the organization for manual pages
throughout the system, including /usr/share/man</TT
>.
Also refer to the section on
/var/cache/man</TT
>.</P
>The primary <mandir></TT
> of the system is
/usr/share/man</TT
>.
/usr/share/man</TT
> contains manual information for
commands and data under the /</TT
> and
/usr</TT
> filesystems.
[31]</SPAN
></A
></P
>Manual pages are stored in
<mandir>/<locale>/man<section>/<arch></TT
>.
An explanation of <mandir></TT
>,
<locale></TT
>,
<section></TT
>, and
<arch></TT
> is given below.</P
>A description of each section follows:</P
></P
>man1</TT
>: User programs
Manual pages that describe publicly accessible commands are contained in
this chapter. Most program documentation that a user will need to use
is located here.</P
></LI
>man2</TT
>: System calls
This section describes all of the system calls (requests for the
kernel to perform operations).</P
></LI
>man3</TT
>: Library functions and subroutines
Section 3 describes program library routines that are not direct calls
to kernel services. This and chapter 2 are only really of interest to
programmers.</P
></LI
>man4</TT
>: Special files
Section 4 describes the special files, related driver functions, and
networking support available in the system. Typically, this includes
the device files found in /dev</TT
> and the kernel interface to
networking protocol support.</P
></LI
>man5</TT
>: File formats
The formats for many data files are documented in the
section 5. This includes various include files, program output files,
and system files.</P
></LI
>man6</TT
>: Games
This chapter documents games, demos, and generally trivial programs.
Different people have various notions about how essential this is.</P
></LI
>man7</TT
>: Miscellaneous
Manual pages that are difficult to classify are designated as being
section 7. The troff and other text processing macro packages are found
here.</P
></LI
>man8</TT
>: System administration
Programs used by system administrators for system operation and
maintenance are documented here. Some of these programs are also
occasionally useful for normal users.</P
></LI
></UL
></DIV
>Specific Options</A
></H4
>The following directories, or symbolic links to directories,
must be in
/usr/share/<mandir>/<locale></TT
>, unless
they are empty:
[32]</SPAN
></A
></P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>man1</TT
></TD
>User programs (optional)</TD
></TR
>man2</TT
></TD
>System calls (optional)</TD
></TR
>man3</TT
></TD
>Library calls (optional)</TD
></TR
>man4</TT
></TD
>Special files (optional)</TD
></TR
>man5</TT
></TD
>File formats (optional)</TD
></TR
>man6</TT
></TD
>Games (optional)</TD
></TR
>man7</TT
></TD
>Miscellaneous (optional)</TD
></TR
>man8</TT
></TD
>System administration (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>The component <section></TT
> describes the
manual section.</P
>Provisions must be made in the structure of
/usr/share/man</TT
> to support manual pages which are
written in different (or multiple) languages. These provisions must
take into account the storage and reference of these manual pages.
Relevant factors include language (including geographical-based
differences), and character code set.</P
>This naming of language subdirectories of
/usr/share/man</TT
> is based on Appendix E of the
POSIX 1003.1 standard which describes the locale identification string
— the most well-accepted method to describe a cultural
environment. The <locale></TT
> string
is:</P
><language>[_<territory>][.<character-set>][,<version>]</TT
></P
>The <language></TT
> field must be taken
from ISO 639 (a code for the representation of names of languages).
It must be two characters wide and specified with lowercase letters
only.</P
>The <territory></TT
> field must be the
two-letter code of ISO 3166 (a specification of representations of
countries), if possible. (Most people are familiar with the
two-letter codes used for the country codes in email addresses.) It
must be two characters wide and specified with uppercase letters
only.
[33]</SPAN
></A
></P
>The <character-set></TT
> field must
represent the standard describing the character set. If the
­<character-set></TT
> field is just a
numeric specification, the number represents the number of the
international standard describing the character set. It is
recommended that this be a numeric representation if possible (ISO
standards, especially), not include additional punctuation symbols,
and that any letters be in lowercase.</P
>A parameter specifying a <version></TT
> of
the profile may be placed after the
­<character-set></TT
> field, delimited by a
comma. This may be used to discriminate between different cultural
needs; for instance, dictionary order versus a more systems-oriented
collating order. This standard recommends not using the
<version></TT
> field, unless it is
necessary.</P
>Systems which use a unique language and code set for all manual
pages may omit the <locale></TT
> substring and
store all manual pages in <mandir></TT
>. For
example, systems which only have English manual pages coded with
ASCII, may store manual pages (the
man<section></TT
> directories) directly in
/usr/share/man</TT
>. (That is the traditional
circumstance and arrangement, in fact.)</P
>Countries for which there is a well-accepted standard character
code set may omit the ­<character-set></TT
>
field, but it is strongly recommended that it be included, especially
for countries with several competing standards.</P
>Various examples:</P
></P
></A
>Language</TH
>Territory</TH
>Character Set</TH
>Directory</TH
></TR
></THEAD
>English</TD
>—</TD
>ASCII</TD
>/usr/share/man/en</TD
></TR
>English</TD
>United Kingdom</TD
>ISO 8859-15</TD
>/usr/share/man/en_GB</TD
></TR
>English</TD
>United States</TD
>ASCII</TD
>/usr/share/man/en_US</TD
></TR
>French</TD
>Canada</TD
>ISO 8859-1</TD
>/usr/share/man/fr_CA</TD
></TR
>French</TD
>France</TD
>ISO 8859-1</TD
>/usr/share/man/fr_FR</TD
></TR
>German</TD
>Germany</TD
>ISO 646</TD
>/usr/share/man/de_DE.646</TD
></TR
>German</TD
>Germany</TD
>ISO 6937</TD
>/usr/share/man/de_DE.6937</TD
></TR
>German</TD
>Germany</TD
>ISO 8859-1</TD
>/usr/share/man/de_DE.88591</TD
></TR
>German</TD
>Switzerland</TD
>ISO 646</TD
>/usr/share/man/de_CH.646</TD
></TR
>Japanese</TD
>Japan</TD
>JIS</TD
>/usr/share/man/ja_JP.jis</TD
></TR
>Japanese</TD
>Japan</TD
>SJIS</TD
>/usr/share/man/ja_JP.sjis</TD
></TR
>Japanese</TD
>Japan</TD
>UJIS (or EUC-J)</TD
>/usr/share/man/ja_JP.ujis</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Similarly, provision must be made for manual pages which are
architecture-dependent, such as documentation on device-drivers or
low-level system administration commands. These must be placed under
an <arch></TT
> directory in the appropriate
man<section></TT
> directory; for example, a man
page for the i386 ctrlaltdel(8) command might be placed in
/usr/share/man/<locale>/man8/i386/ctrlaltdel.8</TT
>.</P
>Manual pages for commands and data under
/usr/local</TT
> are stored in
/usr/local/man</TT
>. Manual pages for X11R6 are
stored in /usr/X11R6/man</TT
>. It follows that all
manual page hierarchies in the system must have the same structure as
/usr/share/man</TT
>.</P
>The cat page sections (cat<section></TT
>)
containing formatted manual page entries are also found within
subdirectories of <mandir>/<locale></TT
>,
but are not required nor may they be distributed in lieu of nroff
source manual pages.</P
>The numbered sections "1" through "8" are traditionally defined.
In general, the file name for manual pages located within a particular
section end with .<section></TT
>.</P
>In addition, some large sets of application-specific manual
pages have an additional suffix appended to the manual page filename.
For example, the MH mail handling system manual pages must have
mh</TT
> appended to all MH manuals. All X Window
System manual pages must have an x</TT
> appended to
the filename.</P
>The practice of placing various language manual pages in
appropriate subdirectories of /usr/share/man</TT
> also
applies to the other manual page hierarchies, such as
/usr/local/man</TT
> and
/usr/X11R6/man</TT
>. (This portion of the standard
also applies later in the section on the optional
/var/cache/man</TT
> structure.)</P
></DIV
></DIV
>/usr/share/misc : Miscellaneous architecture-independent data</A
></H3
>This directory contains miscellaneous architecture-independent
files which don't require a separate subdirectory under
/usr/share</TT
>.</P
>Specific Options</A
></H4
>The following files, or symbolic links to files, must be in
/usr/share/misc</TT
>, if the corresponding subsystem
is installed:</P
></P
></A
>File</TH
>Description</TH
></TR
></THEAD
>ascii</TT
></TD
>ASCII character set table (optional)</TD
></TR
>magic</TT
></TD
>Default list of magic numbers for the file command (optional)</TD
></TR
>termcap</TT
></TD
>Terminal capability database (optional)</TD
></TR
>termcap.db</TT
></TD
>Terminal capability database (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Other (application-specific) files may appear here, but a distributor
may place them in /usr/lib</TT
> at their discretion.
[34]</SPAN
></A
></P
></DIV
></DIV
>/usr/share/sgml : SGML data (optional)</A
></H3
>Purpose</A
></H4
>/usr/share/sgml</TT
> contains
architecture-independent files used by SGML applications, such
as ordinary catalogs (not the centralized ones, see
/etc/sgml</TT
>), DTDs, entities, or style
sheets.</P
></DIV
>Specific Options</A
></H4
>The following directories, or symbolic links to directories,
must be in /usr/share/sgml</TT
>, if the corresponding
subsystem is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>docbook</TT
></TD
>docbook DTD (optional)</TD
></TR
>tei</TT
></TD
>tei DTD (optional)</TD
></TR
>html</TT
></TD
>html DTD (optional)</TD
></TR
>mathml</TT
></TD
>mathml DTD (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Other files that are not specific to a given DTD may reside in
their own subdirectory.</P
></DIV
></DIV
>/usr/share/xml : XML data (optional)</A
></H3
>Purpose</A
></H4
>/usr/share/xml</TT
> contains
architecture-independent files used by XML applications, such
as ordinary catalogs (not the centralized ones, see
/etc/sgml</TT
>), DTDs, entities, or style
sheets.</P
></DIV
>Specific Options</A
></H4
>The following directories, or symbolic links to directories,
must be in /usr/share/xml</TT
>, if the corresponding
subsystem is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>docbook</TT
></TD
>docbook XML DTD (optional)</TD
></TR
>xhtml</TT
></TD
>XHTML DTD (optional)</TD
></TR
>mathml</TT
></TD
>MathML DTD (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
></DIV
></DIV
>/usr/src : Source code (optional)</A
></H2
>Purpose</A
></H3
>Source code may be place placed in this
subdirectory, only for reference purposes.
[35]</SPAN
></A
></P
></DIV
></DIV
></DIV
></A
>Chapter 5. The /var Hierarchy</H1
>Purpose</A
></H2
>/var</TT
> contains variable data files. This
includes spool directories and files, administrative and logging data,
and transient and temporary files.</P
>Some portions of /var</TT
> are not shareable
between different systems. For instance,
/var/log</TT
>, /var/lock</TT
>, and
/var/run</TT
>. Other portions may be shared, notably
/var/mail</TT
>, /var/cache/man</TT
>,
/var/cache/fonts</TT
>, and
/var/spool/news</TT
>.</P
>/var</TT
> is specified here in order to make it
possible to mount /usr</TT
> read-only. Everything
that once went into /usr</TT
> that is written to
during system operation (as opposed to installation and software
maintenance) must be in /var</TT
>.</P
>If /var</TT
> cannot be made a separate
partition, it is often preferable to move /var</TT
>
out of the root partition and into the /usr</TT
>
partition. (This is sometimes done to reduce the size of the root
partition or when space runs low in the root partition.) However,
/var</TT
> must not be linked to
/usr</TT
> because this makes separation of
/usr</TT
> and /var</TT
> more difficult
and is likely to create a naming conflict. Instead, link
/var</TT
> to /usr/var</TT
>.</P
>Applications must generally not add directories to the top level
of /var</TT
>. Such directories should only be added
if they have some system-wide implication, and in consultation with
the FHS mailing list.</P
></DIV
>Requirements</A
></H2
>The following directories, or symbolic links to directories, are
required in /var</TT
>.</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>cache</TT
></TD
>Application cache data</TD
></TR
>lib</TT
></TD
>Variable state information</TD
></TR
>local</TT
></TD
>Variable data for /usr/local</TD
></TR
>lock</TT
></TD
>Lock files</TD
></TR
>log</TT
></TD
>Log files and directories</TD
></TR
>opt</TT
></TD
>Variable data for /opt</TD
></TR
>run</TT
></TD
>Data relevant to running processes</TD
></TR
>spool</TT
></TD
>Application spool data</TD
></TR
>tmp</TT
></TD
>Temporary files preserved between system reboots</TD
></TR
></TBODY
></TABLE
></P
></DIV
>Several directories are `reserved' in the sense that they must
not be used arbitrarily by some new application, since they would
conflict with historical and/or local practice. They are:</P
> /var/backups
/var/cron
/var/msgs
/var/preserve</PRE
></TD
></TR
></TABLE
></DIV
>Specific Options</A
></H2
>The following directories, or symbolic links to directories,
must be in /var</TT
>, if the corresponding subsystem
is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>account</TT
></TD
>Process accounting logs (optional)</TD
></TR
>crash</TT
></TD
>System crash dumps (optional)</TD
></TR
>games</TT
></TD
>Variable game data (optional)</TD
></TR
>mail</TT
></TD
>User mailbox files (optional)</TD
></TR
>yp</TT
></TD
>Network Information Service (NIS) database files (optional)
</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>/var/account : Process accounting logs (optional)</A
></H2
>Purpose</A
></H3
>This directory holds the current active process accounting log
and the composite process usage data (as used in some UNIX-like
systems by lastcomm</B
> and
sa</B
>).</P
></DIV
></DIV
>/var/cache : Application cache data</A
></H2
>Purpose</A
></H3
>/var/cache</TT
> is intended for cached data from
applications. Such data is locally generated as a result of
time-consuming I/O or calculation. The application must be able to
regenerate or restore the data. Unlike
/var/spool</TT
>, the cached files can be deleted
without data loss. The data must remain valid between invocations of
the application and rebooting the system.</P
>Files located under /var/cache</TT
> may be
expired in an application specific manner, by the system
administrator, or both. The application must always be able to
recover from manual deletion of these files (generally because of a
disk space shortage). No other requirements are made on the data
format of the cache directories.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>The existence of a separate directory for cached data allows
system administrators to set different disk and backup policies from
other directories in /var</TT
>. </P
></TD
></TR
></TABLE
></DIV
></DIV
>Specific Options</A
></H3
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>fonts</TT
></TD
>Locally-generated fonts (optional)</TD
></TR
>man</TT
></TD
>Locally-formatted manual pages (optional)</TD
></TR
>www</TT
></TD
>WWW proxy or cache data (optional)</TD
></TR
><package></TT
></TD
>Package specific cache data (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>/var/cache/fonts : Locally-generated fonts (optional)</A
></H3
>Purpose</A
></H4
>The directory /var/cache/fonts</TT
> should be used to store any
dynamically-created fonts. In particular, all of the fonts which are
automatically generated by mktexpk</B
> must be located in
appropriately-named subdirectories of /var/cache/fonts</TT
>.
[36]</SPAN
></A
></P
></DIV
>Specific Options</A
></H4
>Other dynamically created fonts may also be placed in this tree,
under appropriately-named subdirectories of
/var/cache/fonts</TT
>.</P
></DIV
></DIV
>/var/cache/man : Locally-formatted manual pages (optional)</A
></H3
>Purpose</A
></H4
>This directory provides a standard location for sites that provide a
read-only /usr</TT
> partition, but wish to allow caching of
locally-formatted man pages. Sites that mount /usr</TT
> as writable
(e.g., single-user installations) may choose not to use
/var/cache/man</TT
> and may write formatted man pages into the
cat<section></TT
> directories in /usr/share/man</TT
> directly. We
recommend that most sites use one of the following options instead:</P
></P
>Preformat all manual pages alongside the unformatted versions.</P
></LI
>Allow no caching of formatted man pages, and require formatting to be
done each time a man page is brought up.</P
></LI
>Allow local caching of formatted man pages in /var/cache/man</TT
>.</P
></LI
></UL
>The structure of /var/cache/man</TT
> needs to
reflect both the fact of multiple man page hierarchies and the
possibility of multiple language support.</P
>Given an unformatted manual page that normally appears in
<path>/man/<locale>/man<section></TT
>,
the directory to place formatted man pages in is
/var/cache/man/<catpath>/<locale>/cat<section></TT
>,
where <catpath></TT
> is derived from
<path></TT
> by removing any leading
usr</TT
> and/or trailing share</TT
>
pathname components. (Note that the
<locale></TT
> component may be missing.)
[37]</SPAN
></A
></P
>Man pages written to /var/cache/man</TT
> may
eventually be transferred to the appropriate preformatted directories
in the source man</TT
> hierarchy or expired; likewise
formatted man pages in the source man</TT
> hierarchy
may be expired if they are not accessed for a period of time.</P
>If preformatted manual pages come with a system on read-only
media (a CD-ROM, for instance), they must be installed in the source
man</TT
> hierarchy
(e.g. /usr/share/man/cat<section></TT
>).
/var/cache/man</TT
> is reserved as a writable cache
for formatted manual pages.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Release 1.2 of the standard specified
/var/catman</TT
> for this hierarchy. The path has
been moved under /var/cache</TT
> to better reflect the
dynamic nature of the formatted man pages. The directory name has
been changed to man</TT
> to allow for enhancing the
hierarchy to include post-processed formats other than "cat", such as
PostScript, HTML, or DVI. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
></DIV
>/var/crash : System crash dumps (optional)</A
></H2
>Purpose</A
></H3
>This directory holds system crash dumps. As of the date of this
release of the standard, system crash dumps were not supported under
Linux but may be supported by other systems which may comply with the
FHS.</P
></DIV
></DIV
>/var/games : Variable game data (optional)</A
></H2
>Purpose</A
></H3
>Any variable data relating to games in /usr</TT
>
should be placed here. /var/games</TT
> should hold
the variable data previously found in /usr</TT
>;
static data, such as help text, level descriptions, and so on, must
remain elsewhere, such as
/usr/share/games</TT
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>/var/games</TT
> has been given a hierarchy of
its own, rather than leaving it merged in with the old
/var/lib</TT
> as in release 1.2. The separation
allows local control of backup strategies, permissions, and disk
usage, as well as allowing inter-host sharing and reducing clutter in
/var/lib</TT
>. Additionally,
/var/games</TT
> is the path traditionally used by BSD. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/var/lib : Variable state information</A
></H2
>Purpose</A
></H3
>This hierarchy holds state information pertaining to an
application or the system. State information is data that programs
modify while they run, and that pertains to one specific host. Users
must never need to modify files in /var/lib</TT
> to
configure a package's operation.</P
>State information is generally used to preserve the condition of
an application (or a group of inter-related applications) between
invocations and between different instances of the same application.
State information should generally remain valid after a reboot, should
not be logging output, and should not be spooled data.</P
>An application (or a group of inter-related applications) must
use a subdirectory of /var/lib</TT
> for its data.
There is one required subdirectory,
/var/lib/misc</TT
>, which is intended for state files
that don't need a subdirectory; the other subdirectories should only
be present if the application in question is included in the
distribution.
[38]</SPAN
></A
></P
>/var/lib/<name></TT
> is the location that
must be used for all distribution packaging support. Different
distributions may use different names, of course.</P
></DIV
>Requirements</A
></H3
>The following directories, or symbolic links to directories, are
required in /var/lib</TT
>:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>misc</TT
></TD
>Miscellaneous state data</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories, must be in /var/lib</TT
>, if the
corresponding subsystem is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
><editor></TD
>Editor backup files and state (optional)</TD
></TR
><pkgtool></TD
>Packaging support files (optional)</TD
></TR
><package></TD
>State data for packages and subsystems (optional)</TD
></TR
>hwclock</B
></TD
>State directory for hwclock (optional)</TD
></TR
>xdm</B
></TD
>X display manager variable data (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>/var/lib/<editor> : Editor backup files and state (optional)</A
></H3
>Purpose</A
></H4
>These directories contain saved files generated by any
unexpected termination of an editor (e.g., elvis</B
>,
jove</B
>, nvi</B
>).</P
>Other editors may not require a directory for crash-recovery
files, but may require a well-defined place to store other information
while the editor is running. This information should be stored in a
subdirectory under /var/lib</TT
> (for example, GNU
Emacs would place lock files in
/var/lib/emacs/lock</TT
>).</P
>Future editors may require additional state information beyond
crash-recovery files and lock files — this information should
also be placed under
/var/lib/<editor></TT
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Previous Linux releases, as well as all commercial vendors, use
/var/preserve</TT
> for vi or its clones. However,
each editor uses its own format for these crash-recovery files, so a
separate directory is needed for each editor.</P
>Editor-specific lock files are usually quite different from the
device or resource lock files that are stored in
/var/lock</TT
> and, hence, are stored under
/var/lib</TT
>. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/var/lib/hwclock : State directory for hwclock (optional)</A
></H3
>Purpose</A
></H4
>This directory contains the file
/var/lib/hwclock/adjtime</TT
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>In FHS 2.1, this file was /etc/adjtime</TT
>, but
as hwclock</B
> updates it, that was obviously
incorrect. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/var/lib/misc : Miscellaneous variable data</A
></H3
>Purpose</A
></H4
>This directory contains variable data not placed in a
subdirectory in /var/lib</TT
>. An attempt should be
made to use relatively unique names in this directory to avoid
namespace conflicts.
[39]</SPAN
></A
></P
></DIV
></DIV
></DIV
>/var/lock : Lock files</A
></H2
>Purpose</A
></H3
>Lock files should be stored within the
/var/lock</TT
> directory structure.</P
>Lock files for devices and other resources shared by multiple
applications, such as the serial device lock files that were
originally found in either /usr/spool/locks</TT
> or
/usr/spool/uucp</TT
>, must now be stored in
/var/lock</TT
>. The naming convention which must be
used is "LCK.." followed by the base name of the device. For example,
to lock /dev/ttyS0 the file "LCK..ttyS0" would be created.
[40]</SPAN
></A
></P
>The format used for the contents of such lock files must be the
HDB UUCP lock file format. The HDB format is to store the process
identifier (PID) as a ten byte ASCII decimal number, with a trailing
newline. For example, if process 1230 holds a lock file, it would
contain the eleven characters: space, space, space, space, space,
space, one, two, three, zero, and newline.</P
></DIV
></DIV
>/var/log : Log files and directories</A
></H2
>Purpose</A
></H3
>This directory contains miscellaneous log files. Most logs must
be written to this directory or an appropriate subdirectory.</P
></DIV
>Specific Options</A
></H3
>The following files, or symbolic links to files, must be in
/var/log</TT
>, if the corresponding subsystem is
installed:</P
></P
></A
>File</TH
>Description</TH
></TR
></THEAD
>lastlog</TT
></TD
>record of last login of each user</TD
></TR
>messages</TT
></TD
>system messages from syslogd</B
></TD
></TR
>wtmp</TT
></TD
>record of all logins and logouts</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
></DIV
>/var/mail : User mailbox files (optional)</A
></H2
>Purpose</A
></H3
>The mail spool must be accessible through
/var/mail</TT
> and the mail spool files must take the
form <username></TT
>.
[41]</SPAN
></A
></P
>User mailbox files in this location must be stored in the standard
UNIX mailbox format.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>The logical location for this directory was changed from
/var/spool/mail</TT
> in order to bring FHS in-line
with nearly every UNIX implementation. This change is important for
inter-operability since a single /var/mail</TT
> is
often shared between multiple hosts and multiple UNIX implementations
(despite NFS locking issues).</P
>It is important to note that there is no requirement to
physically move the mail spool to this location. However, programs
and header files must be changed to use
/var/mail</TT
>. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/var/opt : Variable data for /opt</A
></H2
>Purpose</A
></H3
>Variable data of the packages in /opt</TT
> must
be installed in /var/opt/<subdir></TT
>, where
<subdir></TT
> is the name of the subtree in
/opt</TT
> where the static data from an add-on
software package is stored, except where superseded by another file in
/etc</TT
>. No structure is imposed on the internal
arrangement of /var/opt/<subdir></TT
>.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Refer to the rationale for /opt</TT
>. </P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
>/var/run : Run-time variable data</A
></H2
>Purpose</A
></H3
>This directory contains system information data describing the
system since it was booted. Files under this directory must be
cleared (removed or truncated as appropriate) at the beginning of the
boot process. Programs may have a subdirectory of
/var/run</TT
>; this is encouraged for programs that
use more than one run-time file.
[42]</SPAN
></A
>
Process identifier (PID) files, which were originally placed in
/etc</TT
>, must be placed in
/var/run</TT
>. The naming convention for PID files is
<program-name>.pid</TT
>. For example, the
crond</B
> PID file is named
/var/run/crond.pid</TT
>.</P
></DIV
>Requirements</A
></H3
>The internal format of PID files remains unchanged. The file
must consist of the process identifier in ASCII-encoded decimal,
followed by a newline character. For example, if
crond</B
> was process number 25,
/var/run/crond.pid</TT
> would contain three
characters: two, five, and newline.</P
>Programs that read PID files should be somewhat flexible in what
they accept; i.e., they should ignore extra whitespace, leading
zeroes, absence of the trailing newline, or additional lines in the
PID file. Programs that create PID files should use the simple
specification located in the above paragraph.</P
>The utmp</TT
> file, which stores information
about who is currently using the system, is located in this
directory.</P
>System programs that maintain transient UNIX-domain sockets must place
them in this directory.</P
></DIV
></DIV
>/var/spool : Application spool data</A
></H2
>Purpose</A
></H3
>/var/spool</TT
> contains data which is awaiting
some kind of later processing. Data in
/var/spool</TT
> represents work to be done in the
future (by a program, user, or administrator); often data is deleted
after it has been processed.
[43]</SPAN
></A
></P
></DIV
>Specific Options</A
></H3
>The following directories, or symbolic links to directories,
must be in /var/spool</TT
>, if the corresponding
subsystem is installed:</P
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>lpd</TT
></TD
>Printer spool directory (optional)</TD
></TR
>mqueue</TT
></TD
>Outgoing mail queue (optional)</TD
></TR
>news</TT
></TD
>News spool directory (optional)</TD
></TR
>rwho</TT
></TD
>Rwhod files (optional)</TD
></TR
>uucp</TT
></TD
>Spool directory for UUCP (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
>/var/spool/lpd : Line-printer daemon print queues (optional)</A
></H3
>Purpose</A
></H4
>The lock file for lpd</B
>,
lpd.lock</TT
>, must be placed in
/var/spool/lpd</TT
>. It is suggested that the lock
file for each printer be placed in the spool directory for that
specific printer and named lock</TT
>.</P
></DIV
>Specific Options</A
></H4
></P
></A
>Directory</TH
>Description</TH
></TR
></THEAD
>printer</TT
></TD
>Spools for a specific printer (optional)</TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
></DIV
>/var/spool/rwho : Rwhod files (optional)</A
></H3
>Purpose</A
></H4
>This directory holds the rwhod</B
> information
for other systems on the local net.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>Some BSD releases use /var/rwho</TT
> for this
data; given its historical location in /var/spool</TT
>
on other systems and its approximate fit to the definition of
`spooled' data, this location was deemed more appropriate.</P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
></DIV
>/var/tmp : Temporary files preserved between system reboots</A
></H2
>Purpose</A
></H3
>The /var/tmp</TT
> directory is made available
for programs that require temporary files or directories that are
preserved between system reboots. Therefore, data stored in
/var/tmp</TT
> is more persistent than data in
/tmp</TT
>.</P
>Files and directories located in /var/tmp</TT
>
must not be deleted when the system is booted. Although data stored
in /var/tmp</TT
> is typically deleted in a
site-specific manner, it is recommended that deletions occur at a less
frequent interval than /tmp</TT
>.</P
></DIV
></DIV
>/var/yp : Network Information Service (NIS) database files (optional)</A
></H2
>Purpose</A
></H3
>Variable data for the Network Information Service (NIS),
formerly known as the Sun Yellow Pages (YP), must be placed in this
directory.</P
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>/var/yp</TT
> is the standard directory for NIS
(YP) data and is almost exclusively used in NIS documentation and
systems.
[44]</SPAN
></A
></P
></TD
></TR
></TABLE
></DIV
></DIV
></DIV
></DIV
></A
>Chapter 6. Operating System Specific Annex</H1
>This section is for additional requirements and recommendations
that only apply to a specific operating system. The material in this
section should never conflict with the base standard.</P
>Linux</A
></H2
>This is the annex for the Linux operating system.</P
>/ : Root directory</A
></H3
>On Linux systems, if the kernel is located in
/</TT
>, we recommend using the names
vmlinux</TT
> or vmlinuz</TT
>, which
have been used in recent Linux kernel source packages.</P
></DIV
>/bin : Essential user command binaries (for use by all users)</A
></H3
>Linux systems which require them place these additional files into
/bin</TT
>:</P
></P
>setserial</B
></P
></LI
></UL
></DIV
>/dev : Devices and special files</A
></H3
>The following devices must exist under /dev.
</P
>/dev/null</TT
></DT
>All data written to this device is discarded. A read from this device
will return an EOF condition.</P
></DD
>/dev/zero</TT
></DT
>This device is a source of zeroed out data. All data written to this
device is discarded. A read from this device will return as many bytes
containing the value zero as was requested.</P
></DD
>/dev/tty</TT
></DT
>This device is a synonym for the controlling terminal of a
process. Once this device is opened, all reads and writes will behave
as if the actual controlling terminal device had been opened.</P
></DD
></DL
></DIV
>
</P
></TD
>Rationale</B
></TH
></TR
> </TD
>Previous versions of the FHS had stricter requirements for
/dev</TT
>. Other devices may also exist in
/dev. Device names may exist as symbolic links to other device nodes
located in /dev or subdirectories of /dev. There is no requirement
concerning major/minor number values.</P
></TD
></TR
></TABLE
></DIV
> </P
></DIV
>/etc : Host-specific system configuration</A
></H3
>Linux systems which require them place these additional files into
/etc</TT
>.</P
></P
>lilo.conf</TT
></P
></LI
></UL
></DIV
>/lib64 and /lib32 : 64/32-bit libraries (architecture dependent)</A
></H3
> The 64-bit architectures PPC64, s390x, sparc64 and AMD64 must place
64-bit libraries in /lib64</TT
>, and 32-bit
(or 31-bit on s390) libraries in /lib</TT
>.</P
>The 64-bit architecture IA64 must place 64-bit libraries in
/lib</TT
>.
</P
></TD
>Rationale</B
></TH
></TR
> </TD
>This is a refinement of the general rules for
/lib<qual></TT
> and
/usr/lib<qual></TT
>. The architectures PPC64,
s390x, sparc64 and AMD64 support support both 32-bit (for s390 more
precise 31-bit) and 64-bit programs. Using lib</TT
>
for 32-bit binaries allows existing binaries from the 32-bit systems
to work without any changes: such binaries are expected to be numerous.
IA-64 uses a different scheme, reflecting the deprecation of 32-bit
binaries (and hence libraries) on that architecture.</P
></TD
></TR
></TABLE
></DIV
></P
></DIV
>/proc : Kernel and process information virtual filesystem</A
></H3
>The proc</TT
> filesystem is the de-facto
standard Linux method for handling process and system information,
rather than /dev/kmem</TT
> and other similar methods.
We strongly encourage this for the storage and retrieval of process
information as well as other kernel and memory information.</P
></DIV
>/sbin : Essential system binaries</A
></H3
>Linux systems place these additional files into /sbin</TT
>.</P
></P
>Second extended filesystem commands (optional):</P
></P
>badblocks</B
></P
></LI
>dumpe2fs</B
></P
></LI
>e2fsck</B
></P
></LI
>mke2fs</B
></P
></LI
>mklost+found</B
></P
></LI
>tune2fs</B
></P
></LI
></UL
></LI
>Boot-loader map installer (optional):</P
></P
>lilo</B
></P
></LI
></UL
></LI
></UL
>Optional files for /sbin:</P
></P
>Static binaries:</P
></P
>ldconfig</B
></P
></LI
>sln</B
></P
></LI
>ssync</B
></P
></LI
></UL
>Static ln</B
> (sln</B
>) and
static sync</B
> (ssync</B
>) are
useful when things go wrong. The primary use of
sln</B
> (to repair incorrect symlinks in
/lib</TT
> after a poorly orchestrated upgrade) is no
longer a major concern now that the ldconfig</B
>
program (usually located in /usr/sbin</TT
>) exists and
can act as a guiding hand in upgrading the dynamic libraries. Static
sync</B
> is useful in some emergency situations.
Note that these need not be statically linked versions of the standard
ln</B
> and sync</B
>, but may
be.</P
>The ldconfig</B
> binary is optional for
/sbin</TT
> since a site may choose to run
ldconfig</B
> at boot time, rather than only when
upgrading the shared libraries. (It's not clear whether or not it is
advantageous to run ldconfig</B
> on each boot.) Even
so, some people like ldconfig</B
> around for the
following (all too common) situation:</P
></P
>I've just removed /lib/<file></TT
>.</P
></LI
>I can't find out the name of the library because ls</B
> is
dynamically linked, I'm using a shell that doesn't have ls</B
>
built-in, and I don't know about using "echo *</B
>" as a
replacement.</P
></LI
>I have a static sln</B
>, but I don't know what to call the link.</P
></LI
></OL
></LI
>Miscellaneous:</P
></P
>ctrlaltdel</B
></P
></LI
>kbdrate</B
></P
></LI
></UL
>So as to cope with the fact that some keyboards come up with
such a high repeat rate as to be unusable,
kbdrate</B
> may be installed in
/sbin</TT
> on some systems.</P
>Since the default action in the kernel for the Ctrl-Alt-Del key
combination is an instant hard reboot, it is generally advisable to
disable the behavior before mounting the root filesystem in read-write
mode. Some init</B
> suites are able to disable
Ctrl-Alt-Del, but others may require the
ctrlaltdel</B
> program, which may be installed in
/sbin</TT
> on those systems.</P
></LI
></UL
></DIV
>/usr/include : Header files included by C programs</A
></H3
>These symbolic links are required if a C or C++ compiler is
installed and only for systems not based on glibc.</P
> /usr/include/asm -> /usr/src/linux/include/asm-<arch>
/usr/include/linux -> /usr/src/linux/include/linux</PRE
></TD
></TR
></TABLE
></DIV
>/usr/src : Source code</A
></H3
>For systems based on glibc, there are no specific guidelines for
this directory. For systems based on Linux libc revisions prior to
glibc, the following guidelines and rationale apply:</P
>The only source code that should be placed in a specific
location is the Linux kernel source code. It is located in
/usr/src/linux</TT
>.</P
>If a C or C++ compiler is installed, but the complete Linux
kernel source code is not installed, then the include files from the
kernel source code must be located in these directories:</P
> /usr/src/linux/include/asm-<arch>
/usr/src/linux/include/linux</PRE
></TD
></TR
></TABLE
><arch></TT
> is the name of the system
architecture.</P
></P
></TD
>Note</B
></TH
></TR
> </TD
> /usr/src/linux</TT
>
may be a symbolic link to a kernel source code tree.</P
></TD
></TR
></TABLE
></DIV
></P
></TD
>Rationale</B
></TH
></TR
> </TD
>It is important that the kernel include files be located in
/usr/src/linux</TT
> and not in
/usr/include</TT
> so there are no problems when system
administrators upgrade their kernel version for the first time. </P
></TD
></TR
></TABLE
></DIV
></DIV
>/var/spool/cron : cron and at jobs</A
></H3
>This directory contains the variable data for the
cron</B
> and at</B
> programs.</P
></DIV
></DIV
></DIV
></A
>Chapter 7. Appendix</H1
>The FHS mailing list</A
></H2
>The FHS mailing list is located at
<freestandards-fhs-discuss@lists.sourceforge.net>. You can
subscribe to the mailing list at this page https://sourceforge.net/projects/freestandards/</A
>.</P
>Thanks to Network Operations at the University of California at
San Diego who allowed us to use their excellent mailing list
server.</P
>As noted in the introduction, please do not send mail to the mailing
list without first contacting the FHS editor or a listed contributor.</P
></DIV
>Background of the FHS</A
></H2
>The process of developing a standard filesystem hierarchy began
in August 1993 with an effort to restructure the file and directory
structure of Linux. The FSSTND, a filesystem hierarchy standard
specific to the Linux operating system, was released on February 14,
1994. Subsequent revisions were released on October 9, 1994 and March
28, 1995.</P
>In early 1995, the goal of developing a more comprehensive
version of FSSTND to address not only Linux, but other UNIX-like
systems was adopted with the help of members of the BSD development
community. As a result, a concerted effort was made to focus on
issues that were general to UNIX-like systems. In recognition of this
widening of scope, the name of the standard was changed to Filesystem
Hierarchy Standard or FHS for short.</P
>Volunteers who have contributed extensively to this standard are
listed at the end of this document. This standard represents a
consensus view of those and other contributors.</P
></DIV
>General Guidelines</A
></H2
>Here are some of the guidelines that have been used in the development
of this standard:</P
></P
>Solve technical problems while limiting transitional difficulties.</P
></LI
>Make the specification reasonably stable.</P
></LI
>Gain the approval of distributors, developers, and other decision-makers
in relevant development groups and encourage their participation.</P
></LI
>Provide a standard that is attractive to the implementors of different
UNIX-like systems.</P
></LI
></UL
></DIV
>Scope</A
></H2
>This document specifies a standard filesystem hierarchy for FHS
filesystems by specifying the location of files and directories, and
the contents of some system files.</P
>This standard has been designed to be used by system
integrators, package developers, and system administrators in the
construction and maintenance of FHS compliant filesystems. It is
primarily intended to be a reference and is not a tutorial on how to
manage a conforming filesystem hierarchy.</P
>The FHS grew out of earlier work on FSSTND, a filesystem
organization standard for the Linux operating system. It builds on
FSSTND to address interoperability issues not just in the Linux
community but in a wider arena including 4.4BSD-based operating
systems. It incorporates lessons learned in the BSD world and
elsewhere about multi-architecture support and the demands of
heterogeneous networking.</P
>Although this standard is more comprehensive than previous
attempts at filesystem hierarchy standardization, periodic updates may
become necessary as requirements change in relation to emerging
technology. It is also possible that better solutions to the problems
addressed here will be discovered so that our solutions will no longer
be the best possible solutions. Supplementary drafts may be released
in addition to periodic updates to this document. However, a specific
goal is backwards compatibility from one release of this document to
the next.</P
>Comments related to this standard are welcome. Any comments or
suggestions for changes may be directed to the FHS editor (Daniel
Quinlan <quinlan@pathname.com>) or the FHS mailing list.
Typographical or grammatical comments should be directed to the FHS
editor.</P
>Before sending mail to the mailing list it is requested that you
first contact the FHS editor in order to avoid excessive re-discussion
of old topics.</P
>Questions about how to interpret items in this document may
occasionally arise. If you have need for a clarification, please
contact the FHS editor. Since this standard represents a consensus of
many participants, it is important to make certain that any
interpretation also represents their collective opinion. For this
reason it may not be possible to provide an immediate response unless
the inquiry has been the subject of previous discussion.</P
></DIV
>Acknowledgments</A
></H2
>The developers of the FHS wish to thank the developers, system
administrators, and users whose input was essential to this standard.
We wish to thank each of the contributors who helped to write,
compile, and compose this standard.</P
>The FHS Group also wishes to thank those Linux developers who
supported the FSSTND, the predecessor to this standard. If they
hadn't demonstrated that the FSSTND was beneficial, the FHS could
never have evolved.</P
></DIV
>Contributors</A
></H2
></P
></A
>Brandon S. Allbery</TD
><bsa@kf8nh.wariat.org></TD
></TR
>Keith Bostic</TD
><bostic@cs.berkeley.edu></TD
></TR
>Drew Eckhardt</TD
><drew@colorado.edu></TD
></TR
>Rik Faith</TD
><faith@cs.unc.edu></TD
></TR
>Stephen Harris</TD
><sweh@spuddy.mew.co.uk></TD
></TR
>Ian Jackson</TD
><ijackson@cus.cam.ac.uk></TD
></TR
>Andreas Jaeger</TD
><aj@suse.de></TD
></TR
>John A. Martin</TD
><jmartin@acm.org></TD
></TR
>Ian McCloghrie</TD
><ian@ucsd.edu></TD
></TR
>Chris Metcalf</TD
><metcalf@lcs.mit.edu></TD
></TR
>Ian Murdock</TD
><imurdock@debian.org></TD
></TR
>David C. Niemi</TD
><niemidc@clark.net></TD
></TR
>Daniel Quinlan</TD
><quinlan@pathname.com></TD
></TR
>Eric S. Raymond</TD
><esr@thyrsus.com></TD
></TR
>Rusty Russell</TD
><rusty@rustcorp.com.au></TD
></TR
>Mike Sangrey</TD
><mike@sojurn.lns.pa.us></TD
></TR
>David H. Silber</TD
><dhs@glowworm.firefly.com></TD
></TR
>Thomas Sippel-Dau</TD
><t.sippel-dau@ic.ac.uk></TD
></TR
>Theodore Ts'o</TD
><tytso@athena.mit.edu></TD
></TR
>Stephen Tweedie</TD
><sct@dcs.ed.ac.uk></TD
></TR
>Fred N. van Kempen</TD
><waltje@infomagic.com></TD
></TR
>Bernd Warken</TD
><bwarken@mayn.de></TD
></TR
>Christopher Yeoh</TD
><cyeoh@samba.org></TD
></TR
></TBODY
></TABLE
></P
></DIV
></DIV
></DIV
></DIV
>Notes</H3
>[1]</SPAN
></A
></TD
>Command binaries that are not essential enough to place into
/bin</TT
> must be placed in
/usr/bin</TT
>, instead. Items that are required only
by non-root users (the X Window System, chsh</TT
>,
etc.) are generally not essential enough to be placed into the root
partition.</P
></TD
></TR
>[2]</SPAN
></A
></TD
> Programs necessary to arrange for the boot loader to be
able to boot a file must be placed in /sbin</TT
>.
Configuration files for boot loaders must be placed in
/etc</TT
>.</P
>The GRUB bootloader reads its configurations file before
booting, so that must be placed in /boot</TT
>. However, it is a
configuration file, so should be in /etc</TT
>. The answer here is a
symbolic link such as /etc/grub/menu.lst</TT
> -> /boot/menu.lst</TT
>.</P
></TD
></TR
>[3]</SPAN
></A
></TD
>On some i386 machines, it may be necessary for
/boot</TT
> to be located on a separate partition
located completely below cylinder 1024 of the boot device due to
hardware constraints.</P
>Certain MIPS systems require a /boot</TT
>
partition that is a mounted MS-DOS filesystem or whatever other
filesystem type is accessible for the firmware. This may result in
restrictions with respect to usable filenames within
/boot</TT
> (only for affected systems).</P
></TD
></TR
>[4]</SPAN
></A
></TD
>The setup of command scripts invoked at boot time may resemble System
V, BSD or other models. Further specification in this area may be
added to a future version of this standard.</P
></TD
></TR
>[5]</SPAN
></A
></TD
>It is recommended that files be stored in subdirectories of
/etc</TT
> rather than directly in
/etc</TT
>.</P
></TD
></TR
>[6]</SPAN
></A
></TD
>Systems that use the shadow password suite will have additional
configuration files in /etc</TT
>
(/etc/shadow</TT
> and others) and programs in
/usr/sbin</TT
> (useradd</B
>,
usermod</B
>, and others).</P
></TD
></TR
>[7]</SPAN
></A
></TD
>On some Linux systems, this may be a symbolic link to
/proc/mounts</TT
>, in which case this exception is not
required.</P
></TD
></TR
>[8]</SPAN
></A
></TD
>/etc/X11/xdm</TT
> holds the configuration files for
xdm</TT
>. These are most of the files previously
found in /usr/lib/X11/xdm</TT
>. Some local variable
data for xdm</TT
> is stored in
/var/lib/xdm</TT
>.</P
></TD
></TR
>[9]</SPAN
></A
></TD
>Different people prefer to place user accounts in a variety of places.
This section describes only a suggested placement for user home
directories; nevertheless we recommend that all FHS-compliant
distributions use this as the default location for home
directories.</P
>On small systems, each user's directory is typically one of the
many subdirectories of /home</TT
> such as
/home/smith</TT
>, /home/torvalds</TT
>,
/home/operator</TT
>, etc. On large systems
(especially when the /home</TT
> directories are shared
amongst many hosts using NFS) it is useful to subdivide user home
directories. Subdivision may be accomplished by using subdirectories
such as /home/staff</TT
>,
/home/guests</TT
>,
/home/students</TT
>, etc.</P
></TD
></TR
>[10]</SPAN
></A
></TD
>If you want to find out a user's home directory, you should use the
getpwent(3)</TT
> library function rather than relying
on /etc/passwd</TT
> because user information may be
stored remotely using systems such as NIS.</P
></TD
></TR
>[11]</SPAN
></A
></TD
>It is recommended that apart from autosave and lock files programs
should refrain from creating non dot files or directories in a home
directory without user intervention.</P
></TD
></TR
>[12]</SPAN
></A
></TD
>Shared libraries that are only necessary for binaries in
/usr</TT
> (such as any X Window binaries) must not be
in /lib</TT
>. Only the shared libraries required to
run binaries in /bin</TT
> and
/sbin</TT
> may be here. In particular, the library
libm.so.*</TT
> may also be placed in
/usr/lib</TT
> if it is not required by anything in
/bin</TT
> or /sbin</TT
>.</P
></TD
></TR
>[13]</SPAN
></A
></TD
>The usual placement of this binary is /usr/bin/cpp</TT
>.</P
></TD
></TR
>[14]</SPAN
></A
></TD
>This is commonly used for 64-bit or 32-bit support on
systems which support multiple binary formats, but require libraries
of the same name. In this case, /lib32</TT
> and
/lib64</TT
> might be the library directories, and
/lib</TT
> a symlink to one of them.</P
></TD
></TR
>[15]</SPAN
></A
></TD
>/lib<qual>/cpp</TT
> is still permitted: this
allows the case where /lib</TT
> and
/lib<qual></TT
> are the same (one is a symbolic
link to the other). </P
></TD
></TR
>[16]</SPAN
></A
></TD
>A compliant implementation with two CDROM drives might have
/media/cdrom0</TT
> and
/media/cdrom1</TT
> with
/media/cdrom</TT
> a symlink to either of these.</P
></TD
></TR
>[17]</SPAN
></A
></TD
>If the home directory of the root account is not
stored on the root partition it will be necessary to make certain it
will default to /</TT
> if it can not be
located.</P
>We recommend against using the root account for tasks that can be
performed as an unprivileged user, and that it be used solely for system
administration. For this reason, we recommend that subdirectories for
mail and other applications not appear in the root account's home
directory, and that mail for administration roles such as root,
postmaster, and webmaster be forwarded to an appropriate user.</P
></TD
></TR
>[18]</SPAN
></A
></TD
>Originally, /sbin</TT
> binaries were kept in
/etc</TT
>. </P
></TD
></TR
>[19]</SPAN
></A
></TD
>Deciding what things go into
"sbin"</I
></SPAN
> directories is simple: if a normal (not a
system administrator) user will ever run it directly, then it must be
placed in one of the "bin"</I
></SPAN
> directories. Ordinary
users should not have to place any of the sbin</TT
>
directories in their path.</P
>For example, files such as chfn</B
> which users
only occasionally use must still be placed in
/usr/bin</TT
>. ping</B
>, although it
is absolutely necessary for root (network recovery and diagnosis) is
often used by users and must live in /bin</TT
> for
that reason.</P
>We recommend that users have read and execute permission for
everything in /sbin</TT
> except, perhaps, certain
setuid and setgid programs. The division between
/bin</TT
> and /sbin</TT
> was not
created for security reasons or to prevent users from seeing the
operating system, but to provide a good partition between binaries
that everyone uses and ones that are primarily used for administration
tasks. There is no inherent security advantage in making
/sbin</TT
> off-limits for users. </P
></TD
></TR
>[20]</SPAN
></A
></TD
>This is particularly important as these areas will often contain both
files initially installed by the distributor, and those added by the
administrator.</P
></TD
></TR
>[21]</SPAN
></A
></TD
>Examples of such configuration files include
Xconfig</TT
>, XF86Config</TT
>, or
system.twmrc</TT
>)</P
></TD
></TR
>[22]</SPAN
></A
></TD
> Miscellaneous
architecture-independent application-specific static files and
subdirectories must be placed in /usr/share</TT
>.</P
></TD
></TR
>[23]</SPAN
></A
></TD
> For example, the perl5</TT
> subdirectory for
Perl 5 modules and libraries.</P
></TD
></TR
>[24]</SPAN
></A
></TD
>Some executable commands such as makewhatis</B
> and
sendmail</B
> have also been traditionally placed in
/usr/lib</TT
>. makewhatis</B
> is an
internal binary and must be placed in a binary directory; users access
only catman</B
>. Newer sendmail</B
>
binaries are now placed by default in /usr/sbin</TT
>.
Additionally, systems using a sendmail</I
></SPAN
>-compatible
mail transfer agent must provide
/usr/sbin/sendmail</B
> as a symbolic link to the
appropriate executable. </P
></TD
></TR
>[25]</SPAN
></A
></TD
>Host-specific data for the X Window System must not be stored in
/usr/lib/X11</TT
>. Host-specific configuration files
such as Xconfig</TT
> or
XF86Config</TT
> must be stored in
/etc/X11</TT
>. This includes configuration data such
as system.twmrc</TT
> even if it is only made a
symbolic link to a more global configuration file (probably in
/usr/X11R6/lib/X11</TT
>).</P
></TD
></TR
>[26]</SPAN
></A
></TD
>The case where /usr/lib</TT
> and /usr/lib<qual></TT
> are the
same (one is a symbolic link to the other) these files and the
per-application subdirectories will exist.</P
></TD
></TR
>[27]</SPAN
></A
></TD
>Software placed in /</TT
> or
/usr</TT
> may be overwritten by system upgrades
(though we recommend that distributions do not overwrite data in
/etc</TT
> under these circumstances). For this
reason, local software must not be placed outside of
/usr/local</TT
> without good reason.</P
></TD
></TR
>[28]</SPAN
></A
></TD
>/usr/local/man</TT
> may be deprecated in future FHS
releases, so if all else is equal, making that one a symlink seems
sensible.</P
></TD
></TR
>[29]</SPAN
></A
></TD
>Locally installed system administration programs should be placed in
/usr/local/sbin</TT
>.</P
></P
></TD
></TR
>[30]</SPAN
></A
></TD
>Much of this data originally lived in /usr</TT
>
(man</TT
>, doc</TT
>) or
/usr/lib</TT
> (dict</TT
>,
terminfo</TT
>, zoneinfo</TT
>).</P
></TD
></TR
>[31]</SPAN
></A
></TD
>Obviously, there are no manual pages in /</TT
>
because they are not required at boot time nor are they required in
emergencies. Really.</P
></TD
></TR
>[32]</SPAN
></A
></TD
>For example, if /usr/local/man</TT
>
has no manual pages in section 4 (Devices), then
/usr/local/man/man4</TT
> may be omitted.</P
></TD
></TR
>[33]</SPAN
></A
></TD
> A major exception to this rule is the
United Kingdom, which is `GB' in the ISO 3166, but `UK' for most email
addresses.</P
></TD
></TR
>[34]</SPAN
></A
></TD
>Some such files include:
airport</TT
>, birthtoken</TT
>, eqnchar</TT
>, getopt</TT
>, gprof.callg</TT
>, gprof.flat</TT
>, inter.phone</TT
>, ipfw.samp.filters</TT
>,
ipfw.samp.scripts</TT
>, keycap.pcvt</TT
>, mail.help</TT
>, mail.tildehelp</TT
>, man.template</TT
>,
map3270</TT
>, mdoc.template</TT
>,
more.help</TT
>, na.phone</TT
>,
nslookup.help</TT
>, operator</TT
>,
scsi_modes</TT
>, sendmail.hf</TT
>,
style</TT
>, units.lib</TT
>,
vgrindefs</TT
>, vgrindefs.db</TT
>,
zipcodes</TT
> </P
></TD
></TR
>[35]</SPAN
></A
></TD
>Generally, source should not be built within this hierarchy.</P
></TD
></TR
>[36]</SPAN
></A
></TD
>This standard does not currently incorporate the TeX Directory
Structure (a document that describes the layout TeX files and
directories), but it may be useful reading. It is located at
ftp://ctan.tug.org/tex/</A
></P
></TD
></TR
>[37]</SPAN
></A
></TD
>For example, /usr/share/man/man1/ls.1</TT
> is
formatted into /var/cache/man/cat1/ls.1</TT
>, and
/usr/X11R6/man/<locale>/man3/XtClass.3x</TT
> into
/var/cache/man/X11R6/<locale>/cat3/XtClass.3x</TT
>.</P
></TD
></TR
>[38]</SPAN
></A
></TD
>An important difference between this version of this standard and
previous ones is that applications are now required to use a
subdirectory of /var/lib</TT
>. </P
></P
></TD
></TR
>[39]</SPAN
></A
></TD
>This hierarchy should contain files stored in
/var/db</TT
> in current BSD releases. These include
locate.database</TT
> and
mountdtab</TT
>, and the kernel symbol database(s).</P
></TD
></TR
>[40]</SPAN
></A
></TD
>Then, anything wishing to use /dev/ttyS0</TT
>
can read the lock file and act accordingly (all locks in
/var/lock</TT
> should be world-readable).</P
></TD
></TR
>[41]</SPAN
></A
></TD
>Note that /var/mail</TT
> may be a symbolic link to
another directory.</P
></TD
></TR
>[42]</SPAN
></A
></TD
>/var/run</TT
> should be unwritable for unprivileged
users (root or users running daemons); it is a major security problem
if any user can write in this directory.</P
></TD
></TR
>[43]</SPAN
></A
></TD
>UUCP lock files must be placed in /var/lock</TT
>. See
the above section on /var/lock</TT
>. </P
></TD
></TR
>[44]</SPAN
></A
></TD
>NIS should not be confused with Sun NIS+, which uses a different
directory, /var/nis</TT
>.</P
></TD
></TR
></TABLE
></BODY
></HTML
>
Page Description:
This Page is About:
|
