X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=elogind.git;a=blobdiff_plain;f=man%2Ffile-hierarchy.xml;h=a096359c8a586f1c2c6993f3f0c7831971ea865d;hp=b0d0e97ee745c66dffbadb18039fb8ab683964e8;hb=dc7f577501278633be6abb0600df8a21561f6640;hpb=9fc25924bef99b3bb522dff785fa56a8e886cb2f diff --git a/man/file-hierarchy.xml b/man/file-hierarchy.xml index b0d0e97ee..a096359c8 100644 --- a/man/file-hierarchy.xml +++ b/man/file-hierarchy.xml @@ -54,7 +54,7 @@ systemd1 system and service manager are organized based on a file system hierarchy inspired by UNIX, more - specificaly the hierarchy described in the File System Hierarchy specification and hier7. This @@ -74,12 +74,8 @@ root. Usually writable, but this is not required. Possibly a temporary file system (tmpfs). Not shared with - other hosts (unless read-only). The - administrator may create additional - top-level subdirectories in this tree, - if required and the name does not - conflict with any of the directories - listed below. + other hosts (unless read-only). + @@ -90,7 +86,7 @@ System Partition, also see systemd-boot-generator8. This directory is usually strictly local - the host, and should be considered + to the host, and should be considered read-only, except when a new kernel or boot loader is installed. This directory only exists on systems that @@ -124,9 +120,9 @@ system users. This directory and possibly the directories contained within it might only become available - or writable in late boot or even on - user login only. This directory might - be placed on limited-functionality + or writable in late boot or even only + after user authentication. This directory + might be placed on limited-functionality network file systems, hence applications should not assume the full set of file API is available on @@ -169,7 +165,7 @@ The place for small temporary files. This directory is usually mounted as - tmpfs instance, and + a tmpfs instance, and should hence not be used for larger files. (Use /var/tmp for @@ -206,7 +202,7 @@ for system packages to place runtime data in. This directory is flushed on boot, and generally writable for - priviliged programs + privileged programs only. Always writable. @@ -225,7 +221,7 @@ /run/user Contains per-user runtime directories, each usually - invidually mounted + individually mounted tmpfs instances. Always writable, flushed at each reboot and when the user logs @@ -282,29 +278,46 @@ /usr/lib - System libraries and - package-specific - data. - - - - /usr/lib64 - Secondary library - directory for placing 64bit versions - of system libraries in, if the primary - architecture of the system is 32bit, - and /usr/lib64 is - defined in the platform ABI. This - directory should not be used for - package-specific data, unless this - data requires 64bit-specific versions, - too. + Static vendor data + that is compatible with all + architectures (though not necessarily + architecture-independent). Note that + this includes internal + executables or other binaries that are + not regularly invoked from a + shell. Such binaries may be for any + architecture supported by the + system. Do not place public libraries + in this directory, use + $libdir (see + below), instead. + + + + $libdir + Location for placing + dynamic libraries in. The precise + location depends on the operating + system and the architecture, and is + sometimes + /usr/lib, + /use/lib64 or + /usr/lib/ + suffixed by an architecture + identifier. This directory should not + be used for package-specific data, + unless this data is + architecture-dependent, too. To query + $libdir for the + primary architecture of the system, + invoke + # pkg-config --variable=libdir systemd /usr/share Resources shared - betwen multiple packages, such as + between multiple packages, such as documentation, man pages, time zone information, fonts and other resources. Usually, the precise @@ -457,7 +470,7 @@ /dev The root directory for device nodes. Usually this directory - is mounted as + is mounted as a devtmpfs instance, but might be of a different type in sandboxed/containerized setups. This @@ -490,7 +503,7 @@ programs) or $XDG_RUNTIME_DIR (for user programs) instead of POSIX - shared memory segments, since they + shared memory segments, since those directories are not world-writable and hence not vulnerable to security-sensitive name @@ -568,23 +581,23 @@ This compatibility symlink points to /usr/lib, - ensuring that binaries referencing + ensuring that programs referencing this legacy path correctly find - their libraries. + their resources. /lib64 - This compatibility - symlink points to - /usr/lib64, + On some architecture + ABIs this compatibility symlink points + to $libdir, ensuring that binaries referencing this legacy path correctly find their - libraries. This symlink only exists on - architectures whose ABI requires a - 64bit version of the library - directory. + dynamic loader. This symlink only + exists on architectures whose ABI + places the dynamic loader in this + path. @@ -623,23 +636,19 @@ /usr/bin - Package executables that shall appear in the $PATH executable search path. It is not recommended to place internal binaries or binaries that are not commonly invoked from the shell in this directory, such as daemon binaries. As this directory is shared with most other packages of the system special care should be take to pick unique names for files placed here, that are unlikely to clash with other package's files. + Package executables that shall appear in the $PATH executable search path, compiled for the primary architecture of the operating system. It is not recommended to place internal binaries or binaries that are not commonly invoked from the shell in this directory, such as daemon binaries. As this directory is shared with most other packages of the system special care should be taken to pick unique names for files placed here, that are unlikely to clash with other package's files. - /usr/lib - Public shared libraries of the package, compiled for the primary architecture of the operating system. As above, be careful with using too generic names, and pick unique names for your libraries to place here to avoid name clashes. + $libdir + Public shared libraries of the package. As above, be careful with using too generic names, and pick unique names for your libraries to place here to avoid name clashes. /usr/lib/package - Private other vendor resources of the package, including private binaries and libraries, but also including any other kind of read-only vendor data. - - - /usr/lib64 - Public shared libraries of the package, compiled for the secondary, 64bit architecture, if this is part of the platform ABI of the architecture. + Private static vendor resources of the package, including private binaries and libraries, or any other kind of read-only vendor data. - /usr/lib64/package - Private other vendor resources of the package that are architecture-specific and cannot be shared between primary and secondary architectures. Note that this generally does not include private binaries since binaries of the primary architecture may generally be invoked from secondary architecture code just fine. + $libdir/package + Private other vendor resources of the package that are architecture-specific and cannot be shared between architectures. Note that this generally does not include private exectuables since binaries of a specific architecture may be freely invoked from any other supported system architecture. /usr/include/package @@ -647,7 +656,7 @@ /etc/package - System-specific configuration for the package. It is recommended to default to safe fallbacks if this configuration is missing, if this is possible. Alternatively, a tmpfiles.d5 fragment may be used to copy or symlink the necessary files and directores from /usr/share/factory during boot, via the L or C directives. + System-specific configuration for the package. It is recommended to default to safe fallbacks if this configuration is missing, if this is possible. Alternatively, a tmpfiles.d5 fragment may be used to copy or symlink the necessary files and directories from /usr/share/factory during boot, via the L or C directives. /run/package @@ -685,6 +694,7 @@ hier7, systemd-boot-generator8, sysctl.d5, + pkg-config1