summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLennart Poettering <lennart@poettering.net>2019-02-18 17:48:34 +0100
committerLennart Poettering <lennart@poettering.net>2019-02-20 18:31:18 +0100
commit25f77a4ba2c7a3c5b3e51371cb991fa8a482075f (patch)
treebe6bb74849ef8bf47c3feaee0efedf687d7a3f47
parentdocs: document semantics of /tmp and /var/tmp (diff)
downloadsystemd-25f77a4ba2c7a3c5b3e51371cb991fa8a482075f.tar.xz
systemd-25f77a4ba2c7a3c5b3e51371cb991fa8a482075f.zip
man,units: link up new documentation about temporary directories
-rw-r--r--man/file-hierarchy.xml66
-rw-r--r--units/tmp.mount3
2 files changed, 33 insertions, 36 deletions
diff --git a/man/file-hierarchy.xml b/man/file-hierarchy.xml
index 23ee17d36f..96915f877d 100644
--- a/man/file-hierarchy.xml
+++ b/man/file-hierarchy.xml
@@ -128,24 +128,22 @@
<varlistentry>
<term><filename>/tmp/</filename></term>
- <listitem><para>The place for small temporary files. This
- directory is usually mounted as a <literal>tmpfs</literal>
- instance, and should hence not be used for larger files. (Use
- <filename>/var/tmp/</filename> for larger files.) Since the
- directory is accessible to other users of the system, it is
- essential that this directory is only written to with the
- <citerefentry project='man-pages'><refentrytitle>mkstemp</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>mkdtemp</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- and related calls. This directory is usually flushed at
- boot-up. Also, files that are not accessed within a certain
- time are usually automatically deleted. If applications find
- the environment variable <varname>$TMPDIR</varname> set, they
- should prefer using the directory specified in it over
- directly referencing <filename>/tmp/</filename> (see
- <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
- and
+ <listitem><para>The place for small temporary files. This directory is usually mounted as a
+ <literal>tmpfs</literal> instance, and should hence not be used for larger files. (Use
+ <filename>/var/tmp/</filename> for larger files.) Since the directory is accessible to other users of
+ the system, it is essential that this directory is only written to with the <citerefentry
+ project='man-pages'><refentrytitle>mkstemp</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry
+ project='man-pages'><refentrytitle>mkdtemp</refentrytitle><manvolnum>3</manvolnum></citerefentry> and
+ related calls. This directory is usually flushed at boot-up. Also, files that are not accessed within
+ a certain time are usually automatically deleted. If applications find the environment variable
+ <varname>$TMPDIR</varname> set, they should prefer using the directory specified in it over directly
+ referencing <filename>/tmp/</filename> (see <citerefentry
+ project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> and
<ulink url="http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap08.html#tag_08_03">IEEE
- Std 1003.1</ulink> for details).</para></listitem>
+ Std 1003.1</ulink> for details). For further details about this directory, see <ulink
+ url="https://systemd.io/TEMPORARY_DIRECTORIES">Using /tmp/ And /var/tmp/
+ Safely</ulink>.</para></listitem>
</varlistentry>
</variablelist>
@@ -337,24 +335,22 @@
<varlistentry>
<term><filename>/var/tmp/</filename></term>
- <listitem><para>The place for larger and persistent temporary
- files. In contrast to <filename>/tmp/</filename>, this directory
- is usually mounted from a persistent physical file system and
- can thus accept larger files. (Use <filename>/tmp/</filename>
- for smaller files.) This directory is generally not flushed at
- boot-up, but time-based cleanup of files that have not been
- accessed for a certain time is applied. The same security
- restrictions as with <filename>/tmp/</filename> apply, and
- hence only
- <citerefentry project='man-pages'><refentrytitle>mkstemp</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
- <citerefentry project='man-pages'><refentrytitle>mkdtemp</refentrytitle><manvolnum>3</manvolnum></citerefentry>
- or similar calls should be used to make use of this directory.
- If applications find the environment variable
- <varname>$TMPDIR</varname> set, they should prefer using the
- directory specified in it over directly referencing
- <filename>/var/tmp/</filename> (see
- <citerefentry project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry>
- for details). </para></listitem>
+ <listitem><para>The place for larger and persistent temporary files. In contrast to
+ <filename>/tmp/</filename>, this directory is usually mounted from a persistent physical file system
+ and can thus accept larger files. (Use <filename>/tmp/</filename> for smaller files.) This directory
+ is generally not flushed at boot-up, but time-based cleanup of files that have not been accessed for
+ a certain time is applied. The same security restrictions as with <filename>/tmp/</filename> apply,
+ and hence only <citerefentry
+ project='man-pages'><refentrytitle>mkstemp</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
+ <citerefentry
+ project='man-pages'><refentrytitle>mkdtemp</refentrytitle><manvolnum>3</manvolnum></citerefentry> or
+ similar calls should be used to make use of this directory. If applications find the environment
+ variable <varname>$TMPDIR</varname> set, they should prefer using the directory specified in it over
+ directly referencing <filename>/var/tmp/</filename> (see <citerefentry
+ project='man-pages'><refentrytitle>environ</refentrytitle><manvolnum>7</manvolnum></citerefentry> for
+ details). For further details about this directory, see <ulink
+ url="https://systemd.io/TEMPORARY_DIRECTORIES">Using /tmp/ And /var/tmp/
+ Safely</ulink>.</para></listitem>
</varlistentry>
</variablelist>
diff --git a/units/tmp.mount b/units/tmp.mount
index 742d86385c..27bd0f235c 100644
--- a/units/tmp.mount
+++ b/units/tmp.mount
@@ -9,7 +9,8 @@
[Unit]
Description=Temporary Directory (/tmp)
-Documentation=man:hier(7)
+Documentation=https://systemd.io/TEMPORARY_DIRECTORIES
+Documentation=man:file-hierarchy(7)
Documentation=https://www.freedesktop.org/wiki/Software/systemd/APIFileSystems
ConditionPathIsSymbolicLink=!/tmp
DefaultDependencies=no