Difference between revisions of "The /usr Hierarchy"
(→= /usr/lib32 : 32-bit libraries (optional)) |
m (→Requirements: wikifying the table) |
||
| (10 intermediate revisions by one user not shown) | |||
| Line 5: | Line 5: | ||
The following directories, or symbolic links to directories, are required in /usr. | The following directories, or symbolic links to directories, are required in /usr. | ||
| − | + | {| {{Table}} | |
| − | Directory Description | + | !Directory |
| − | bin Most user commands | + | !Description |
| − | include Header files included by C programs | + | |- |
| − | lib Libraries | + | |bin |
| − | local Local hierarchy (empty after main installation) | + | |Most user commands |
| − | sbin Non-vital system binaries | + | |- |
| − | share Architecture-independent data | + | |include |
| + | |Header files included by C programs | ||
| + | |- | ||
| + | |lib | ||
| + | |Libraries | ||
| + | |- | ||
| + | |local | ||
| + | |Local hierarchy (empty after main installation) | ||
| + | |- | ||
| + | |sbin | ||
| + | |Non-vital system binaries | ||
| + | |- | ||
| + | |share | ||
| + | |Architecture-independent data | ||
| + | |} | ||
== Specific Options == | == Specific Options == | ||
| Line 75: | Line 89: | ||
== /usr/lib : Libraries for programming and packages == | == /usr/lib : Libraries for programming and packages == | ||
| − | /usr/lib includes object files, libraries, and internal binaries that are not intended to be executed directly by users or shell scripts. <ref>Miscellaneous architecture-independent application-specific static files and subdirectories must be placed in /usr/share.</ref> On 64-bit multilib systems, /usr/lib is | + | /usr/lib includes object files, libraries, and internal binaries that are not intended to be executed directly by users or shell scripts. <ref>Miscellaneous architecture-independent application-specific static files and subdirectories must be placed in /usr/share.</ref> On 64-bit multilib systems, /usr/lib is a symbolic link (see below.) |
| + | |||
| + | === /usr/lib64: 64-bit libraries (optional) === | ||
| + | |||
| + | On 64-bit multilib systems, /usr/lib64 contains 64-bit libraries, and /usr/lib is a symlink pointing to "lib64". | ||
=== /usr/lib32 : 32-bit libraries (optional) === | === /usr/lib32 : 32-bit libraries (optional) === | ||
| Line 83: | Line 101: | ||
Applications may use a single subdirectory under /usr/lib. If an application uses a subdirectory, all architecture-dependent data exclusively used by the application must be placed within that subdirectory. <ref>For example, the perl5 subdirectory for Perl 5 modules and libraries.</ref> | Applications may use a single subdirectory under /usr/lib. If an application uses a subdirectory, all architecture-dependent data exclusively used by the application must be placed within that subdirectory. <ref>For example, the perl5 subdirectory for Perl 5 modules and libraries.</ref> | ||
| − | === /usr/lib | + | === /usr/lib/locale === |
| − | === /usr/lib | + | The /usr/lib/locale directory contains runtime locale data that is used directly by programs, and is generated by the locale-gen command. This command uses settings in /etc/locale.gen to determine what runtime locale data to generate. The data in /usr/lib/locale can always be regenerated using locale-gen, assuming that the source files in /usr/share/locale still exist. Therefore, it's recommended that future versions of Funtoo Linux reconfigure glibc to move this data to /var/lib/locale or /var/cache/locale instead. |
| + | |||
| + | === /usr/lib/gconv === | ||
| + | |||
| + | This directory contains support libraries for the glibc iconv() text encoding/character set conversion function. The "iconvconfig" can be used to generate an optional cache file that is also stored in this directory. | ||
=== Specific Options === | === Specific Options === | ||
| Line 91: | Line 113: | ||
For historical reasons, /usr/lib/sendmail must be a symbolic link to /usr/sbin/sendmail if the latter exists. <ref>Some executable commands such as makewhatis and sendmail have also been traditionally placed in /usr/lib. makewhatis is an internal binary and must be placed in a binary directory; users access only catman. Newer sendmail binaries are now placed by default in /usr/sbin. Additionally, systems using a sendmail-compatible mail transfer agent must provide /usr/sbin/sendmail as a symbolic link to the appropriate executable.</ref> | For historical reasons, /usr/lib/sendmail must be a symbolic link to /usr/sbin/sendmail if the latter exists. <ref>Some executable commands such as makewhatis and sendmail have also been traditionally placed in /usr/lib. makewhatis is an internal binary and must be placed in a binary directory; users access only catman. Newer sendmail binaries are now placed by default in /usr/sbin. Additionally, systems using a sendmail-compatible mail transfer agent must provide /usr/sbin/sendmail as a symbolic link to the appropriate executable.</ref> | ||
| − | |||
| − | |||
| − | |||
== /usr/local : Local hierarchy == | == /usr/local : Local hierarchy == | ||
| Line 121: | Line 140: | ||
: Local source code | : Local source code | ||
| − | |||
| − | |||
| − | |||
== /usr/sbin : Non-essential standard system binaries == | == /usr/sbin : Non-essential standard system binaries == | ||
| Line 171: | Line 187: | ||
It is recommended that application-specific, architecture-independent directories be placed here. Such directories include groff, perl, ghostscript, texmf, and kbd (Linux) or syscons (BSD). They may, however, be placed in /usr/lib for backwards compatibility, at the distributor's discretion. Similarly, a /usr/lib/games hierarchy may be used in addition to the /usr/share/games hierarchy if the distributor wishes to place some game data there. | It is recommended that application-specific, architecture-independent directories be placed here. Such directories include groff, perl, ghostscript, texmf, and kbd (Linux) or syscons (BSD). They may, however, be placed in /usr/lib for backwards compatibility, at the distributor's discretion. Similarly, a /usr/lib/games hierarchy may be used in addition to the /usr/share/games hierarchy if the distributor wishes to place some game data there. | ||
| − | == /usr/share/dict : Word lists (optional) == | + | === /usr/share/dict : Word lists (optional) === |
This directory is the home for word lists on the system; Traditionally this directory contains only the English words file, which is used by look(1) and various spelling programs. words may use either American or British spelling. | This directory is the home for word lists on the system; Traditionally this directory contains only the English words file, which is used by look(1) and various spelling programs. words may use either American or British spelling. | ||
| Line 191: | Line 207: | ||
Other word lists must be included here, if present. | Other word lists must be included here, if present. | ||
| − | == /usr/share/man : Manual pages == | + | |
| + | === /usr/share/man : Manual pages === | ||
This section details the organization for manual pages throughout the system, including /usr/share/man. Also refer to the section on /var/cache/man. | This section details the organization for manual pages throughout the system, including /usr/share/man. Also refer to the section on /var/cache/man. | ||
| Line 272: | Line 289: | ||
The practice of placing various language manual pages in appropriate subdirectories of /usr/share/man also applies to the other manual page hierarchies, such as /usr/local/man and /usr/X11R6/man. (This portion of the standard also applies later in the section on the optional /var/cache/man structure.) | The practice of placing various language manual pages in appropriate subdirectories of /usr/share/man also applies to the other manual page hierarchies, such as /usr/local/man and /usr/X11R6/man. (This portion of the standard also applies later in the section on the optional /var/cache/man structure.) | ||
| − | == /usr/share/misc : Miscellaneous architecture-independent data == | + | === /usr/share/misc : Miscellaneous architecture-independent data === |
This directory contains miscellaneous architecture-independent files which don't require a separate subdirectory under /usr/share. | This directory contains miscellaneous architecture-independent files which don't require a separate subdirectory under /usr/share. | ||
| Line 286: | Line 303: | ||
Other (application-specific) files may appear here, but a distributor may place them in /usr/lib at their discretion. <ref>Some such files include: airport, birthtoken, eqnchar, getopt, gprof.callg, gprof.flat, inter.phone, ipfw.samp.filters, ipfw.samp.scripts, keycap.pcvt, mail.help, mail.tildehelp, man.template, map3270, mdoc.template, more.help, na.phone, nslookup.help, operator, scsi_modes, sendmail.hf, style, units.lib, vgrindefs, vgrindefs.db, zipcodes</ref> | Other (application-specific) files may appear here, but a distributor may place them in /usr/lib at their discretion. <ref>Some such files include: airport, birthtoken, eqnchar, getopt, gprof.callg, gprof.flat, inter.phone, ipfw.samp.filters, ipfw.samp.scripts, keycap.pcvt, mail.help, mail.tildehelp, man.template, map3270, mdoc.template, more.help, na.phone, nslookup.help, operator, scsi_modes, sendmail.hf, style, units.lib, vgrindefs, vgrindefs.db, zipcodes</ref> | ||
| − | == /usr/share/sgml : SGML data (optional) == | + | |
| + | === /usr/share/sgml : SGML data (optional) === | ||
/usr/share/sgml contains architecture-independent files used by SGML applications, such as ordinary catalogs (not the centralized ones, see /etc/sgml), DTDs, entities, or style sheets. | /usr/share/sgml contains architecture-independent files used by SGML applications, such as ordinary catalogs (not the centralized ones, see /etc/sgml), DTDs, entities, or style sheets. | ||
| Line 300: | Line 318: | ||
Other files that are not specific to a given DTD may reside in their own subdirectory. | Other files that are not specific to a given DTD may reside in their own subdirectory. | ||
| − | == /usr/share/xml : XML data (optional) == | + | |
| + | === /usr/share/xml : XML data (optional) === | ||
/usr/share/xml contains architecture-independent files used by XML applications, such as ordinary catalogs (not the centralized ones, see /etc/sgml), DTDs, entities, or style sheets. | /usr/share/xml contains architecture-independent files used by XML applications, such as ordinary catalogs (not the centralized ones, see /etc/sgml), DTDs, entities, or style sheets. | ||
Latest revision as of 00:18, 17 November 2010
/usr is the second major section of the filesystem. /usr is shareable, read-only data. That means that /usr 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.
Large software packages must not use a direct subdirectory under the /usr hierarchy.
[edit] Requirements
The following directories, or symbolic links to directories, are required in /usr.
| Directory | Description |
|---|---|
| bin | Most user commands |
| include | Header files included by C programs |
| lib | Libraries |
| local | Local hierarchy (empty after main installation) |
| sbin | Non-vital system binaries |
| share | Architecture-independent data |
[edit] Specific Options
Directory Description X11R6 XWindow System, version 11 release 6 (optional) games Games and educational binaries (optional) lib<qual> Alternate Format Libraries (optional) src Source code (optional)
An exception is made for the X Window System because of considerable precedent and widely-accepted practice.
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 hierarchy.
/usr/spool -> /var/spool /usr/tmp -> /var/tmp /usr/spool/locks -> /var/lock
Once a system no longer requires any one of the above symbolic links, the link may be removed, if desired.
[edit] /usr/X11R6 : X Window System, Version 11 Release 6 (optional)
This hierarchy is reserved for the X Window System, version 11 release 6, and related files.
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 exists:
/usr/bin/X11 -> /usr/X11R6/bin /usr/lib/X11 -> /usr/X11R6/lib/X11 /usr/include/X11 -> /usr/X11R6/include/X11
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.
[edit] Specific Options
Host-specific data in /usr/X11R6/lib/X11 should be interpreted as a demonstration file. Applications requiring information about the current host must reference a configuration file in /etc/X11, which may be linked to a file in /usr/X11R6/lib. [1]
[edit] /usr/bin : Most user commands
This is the primary directory of executable commands on the system.
[edit] Specific Options
The following files, or symbolic links to files, must be in /usr/bin, if the corresponding subsystem is installed:
- perl
- The Practical Extraction and Report Language (stage3)
- python
- The Python interpreted language (stage3)
- tclsh
- Simple shell containing Tcl interpreter (optional)
- wish
- Simple Tcl/Tk windowing shell (optional)
- expect
- Program for interactive dialog (optional)
- ruby
- Ruby (optional)
Rationale: Because shell script interpreters (invoked with #!<path> 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, but Perl, Python, and Tcl are often found in many different places. They may be symlinks to the physical location of the shell interpreters.
[edit] /usr/include : Directory for standard include files.
This is where all of the system's general-use include files for the C programming language should be placed. Core include files are installed here as part of the sys-libs/glibc and sys-kernel/linux-headers packages, although other ebuilds can install their header files in this directory as well.
The /usr/include/X11 stores X-related include files.
[edit] /usr/lib : Libraries for programming and packages
/usr/lib includes object files, libraries, and internal binaries that are not intended to be executed directly by users or shell scripts. [2] On 64-bit multilib systems, /usr/lib is a symbolic link (see below.)
[edit] /usr/lib64: 64-bit libraries (optional)
On 64-bit multilib systems, /usr/lib64 contains 64-bit libraries, and /usr/lib is a symlink pointing to "lib64".
[edit] /usr/lib32 : 32-bit libraries (optional)
On 64-bit mulitlib systems, /usr/lib32 contains 32-bit libraries.
Applications may use a single subdirectory under /usr/lib. If an application uses a subdirectory, all architecture-dependent data exclusively used by the application must be placed within that subdirectory. [3]
[edit] /usr/lib/locale
The /usr/lib/locale directory contains runtime locale data that is used directly by programs, and is generated by the locale-gen command. This command uses settings in /etc/locale.gen to determine what runtime locale data to generate. The data in /usr/lib/locale can always be regenerated using locale-gen, assuming that the source files in /usr/share/locale still exist. Therefore, it's recommended that future versions of Funtoo Linux reconfigure glibc to move this data to /var/lib/locale or /var/cache/locale instead.
[edit] /usr/lib/gconv
This directory contains support libraries for the glibc iconv() text encoding/character set conversion function. The "iconvconfig" can be used to generate an optional cache file that is also stored in this directory.
[edit] Specific Options
For historical reasons, /usr/lib/sendmail must be a symbolic link to /usr/sbin/sendmail if the latter exists. [4]
[edit] /usr/local : Local hierarchy
The /usr/local hierarchy is for use by the system administrator when installing software manually, without using Portage. It may be used for programs and data that are shareable amongst a group of hosts, but not found in /usr. Typically, /etc is used to store configuration files for these programs, as it is generally not necessary to have an independent /usr/local/etc.
Locally installed software must be placed within /usr/local rather than /usr unless it is being installed to replace or upgrade software in /usr.
[edit] Requirements
The following directories, or symbolic links to directories, are typically found in /usr/local:
- bin
- Local binaries
- games
- Local game binaries
- include
- Local C header files
- lib
- Local libraries
- man
- Local online manuals
- sbin
- Local system binaries
- share
- Local architecture-independent hierarchy
- src
- Local source code
[edit] /usr/sbin : Non-essential standard system binaries
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, or other essential functions must be placed in /sbin instead. [5]
[edit]
The /usr/share hierarchy is for all read-only architecture independent data files. [6]
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 directory that is centrally-mounted. Note, however, that /usr/share is generally not intended to be shared by different OSes or by different releases of the same OS.
Any program or package which contains or requires data that doesn't need to be modified should store that data in /usr/share (or /usr/local/share, if installed locally). It is recommended that a subdirectory be used in /usr/share for this purpose.
Game data stored in /usr/share/games must be purely static data. Any modifiable files, such as score files, game play logs, and so forth, should be placed in /var/games.
[edit]
The /usr/share/locale hierarchy stores GNU message catalog (.mo) files that contain application messages in alternate locales/languages. Applications may install .mo files into this directory tree as well.
[edit]
The /usr/share/zoneinfo contains time zone data, and is populated by the sys-libs/timezone-data ebuild.
[edit]
[edit] Requirements
The following directories, or symbolic links to directories, must be in /usr/share
Directory Description man Online manuals misc Miscellaneous architecture-independent data
[edit] Specific Options
The following directories, or symbolic links to directories, must be in /usr/share, if the corresponding subsystem is installed:
Directory Description dict Word lists (optional) doc Miscellaneous documentation (optional) games Static data files for /usr/games (optional) nls Message catalogs for Native language support (optional) sgml SGML data (optional) terminfo Directories for terminfo database (optional) tmac troff macros not distributed with groff (optional) xml XML data (optional)
It is recommended that application-specific, architecture-independent directories be placed here. Such directories include groff, perl, ghostscript, texmf, and kbd (Linux) or syscons (BSD). They may, however, be placed in /usr/lib for backwards compatibility, at the distributor's discretion. Similarly, a /usr/lib/games hierarchy may be used in addition to the /usr/share/games hierarchy if the distributor wishes to place some game data there.
[edit]
This directory is the home for word lists on the system; Traditionally this directory contains only the English words file, which is used by look(1) and various spelling programs. words may use either American or British spelling.
Tip Rationale
The reason that only word lists are located here is that they are the only files common to all spell checkers.
[edit] Specific Options
The following files, or symbolic links to files, must be in /usr/share/dict, if the corresponding subsystem is installed:
File Description words List of English words (optional)
Sites that require both American and British spelling may link words to /usr/share/dict/american-english or /usr/share/dict/british-english.
Word lists for other languages may be added using the English name for that language, e.g., /usr/share/dict/french, /usr/share/dict/danish, 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).
Other word lists must be included here, if present.
[edit]
This section details the organization for manual pages throughout the system, including /usr/share/man. Also refer to the section on /var/cache/man.
The primary <mandir> of the system is /usr/share/man. /usr/share/man contains manual information for commands and data under the / and /usr filesystems. [7]
Manual pages are stored in <mandir>/<locale>/man
Cite error: <ref> tags exist, but no <references/> tag was found
