summaryrefslogtreecommitdiff
path: root/man/systemd-tmpfiles-setup.service.html
blob: fc2ea0b1191b0749012bd177f7c044a1a5b95442 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>systemd-tmpfiles</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
    a.headerlink {
      color: #c60f0f;
      font-size: 0.8em;
      padding: 0 4px 0 4px;
      text-decoration: none;
      visibility: hidden;
    }

    a.headerlink:hover {
      background-color: #c60f0f;
      color: white;
    }

    h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
      visibility: visible;
    }
  </style><a href="index.html">Index </a>·
  <a href="systemd.directives.html">Directives </a>·
  <a href="../python-systemd/index.html">Python </a>·

  <span style="float:right">systemd 221</span><hr><div class="refentry"><a name="systemd-tmpfiles"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>systemd-tmpfiles, systemd-tmpfiles-setup.service, systemd-tmpfiles-setup-dev.service, systemd-tmpfiles-clean.service, systemd-tmpfiles-clean.timer — Creates, deletes and cleans up volatile
    and temporary files and directories</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">systemd-tmpfiles</code>  [OPTIONS...] [<em class="replaceable"><code>CONFIGFILE</code></em>...]</p></div><p><code class="filename">systemd-tmpfiles-setup.service</code></p><p><code class="filename">systemd-tmpfiles-setup-dev.service</code></p><p><code class="filename">systemd-tmpfiles-clean.service</code></p><p><code class="filename">systemd-tmpfiles-clean.timer</code></p></div><div class="refsect1"><a name="idm47480562208528"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p><span class="command"><strong>systemd-tmpfiles</strong></span> creates, deletes, and
    cleans up volatile and temporary files and directories, based on
    the configuration file format and location specified in
    <a href="tmpfiles.d.html"><span class="citerefentry"><span class="refentrytitle">tmpfiles.d</span>(5)</span></a>.
    </p><p>If invoked with no arguments, it applies all directives from
    all configuration files. If one or more filenames are passed on
    the command line, only the directives in these files are applied.
    If only the basename of a configuration file is specified, all
    configuration directories as specified in
    <a href="tmpfiles.d.html"><span class="citerefentry"><span class="refentrytitle">tmpfiles.d</span>(5)</span></a>
    are searched for a matching file.</p></div><div class="refsect1"><a name="idm47480562204448"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt id="--create"><span class="term"><code class="option">--create</code></span><a class="headerlink" title="Permalink to this term" href="#--create">¶</a></dt><dd><p>If this option is passed, all files and
        directories marked with
        <code class="varname">f</code>,
        <code class="varname">F</code>,
        <code class="varname">w</code>,
        <code class="varname">d</code>,
        <code class="varname">D</code>,
        <code class="varname">v</code>,
        <code class="varname">p</code>,
        <code class="varname">L</code>,
        <code class="varname">c</code>,
        <code class="varname">b</code>,
        <code class="varname">m</code>
        in the configuration files are created or written to. Files
        and directories marked with
        <code class="varname">z</code>,
        <code class="varname">Z</code>,
        <code class="varname">t</code>,
        <code class="varname">T</code>,
        <code class="varname">a</code>, and
        <code class="varname">A</code> have their ownership, access mode and
        security labels set. </p></dd><dt id="--clean"><span class="term"><code class="option">--clean</code></span><a class="headerlink" title="Permalink to this term" href="#--clean">¶</a></dt><dd><p>If this option is passed, all files and
        directories with an age parameter configured will be cleaned
        up.</p></dd><dt id="--remove"><span class="term"><code class="option">--remove</code></span><a class="headerlink" title="Permalink to this term" href="#--remove">¶</a></dt><dd><p>If this option is passed, the contents of
        directories marked with <code class="varname">D</code> or
        <code class="varname">R</code>, and files or directories themselves
        marked with <code class="varname">r</code> or <code class="varname">R</code> are
        removed.</p></dd><dt id="--boot"><span class="term"><code class="option">--boot</code></span><a class="headerlink" title="Permalink to this term" href="#--boot">¶</a></dt><dd><p>Also execute lines with an exclamation mark.
        </p></dd><dt id="--prefix=path"><span class="term"><code class="option">--prefix=<em class="replaceable"><code>path</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--prefix=path">¶</a></dt><dd><p>Only apply rules with paths that start with
        the specified prefix. This option can be specified multiple
        times.</p></dd><dt id="--exclude-prefix=path"><span class="term"><code class="option">--exclude-prefix=<em class="replaceable"><code>path</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--exclude-prefix=path">¶</a></dt><dd><p>Ignore rules with paths that start with the
        specified prefix. This option can be specified multiple
        times.</p></dd><dt id="--root=root"><span class="term"><code class="option">--root=<em class="replaceable"><code>root</code></em></code></span><a class="headerlink" title="Permalink to this term" href="#--root=root">¶</a></dt><dd><p>Takes a directory path as an argument. All
        paths will be prefixed with the given alternate
        <em class="replaceable"><code>root</code></em> path, including config search
        paths. </p></dd><dt id="-h"><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span><a class="headerlink" title="Permalink to this term" href="#-h">¶</a></dt><dd><p><a name="help-text"></a>Print a short help text and exit.
    </p></dd><dt id="--version"><span class="term"><code class="option">--version</code></span><a class="headerlink" title="Permalink to this term" href="#--version">¶</a></dt><dd><p><a name="version-text"></a>Print a short version string and exit.</p></dd></dl></div><p>It is possible to combine <code class="option">--create</code>,
    <code class="option">--clean</code>, and <code class="option">--remove</code> in one
    invocation. For example, during boot the following command line is
    executed to ensure that all temporary and volatile directories are
    removed and created according to the configuration file:</p><pre class="programlisting">systemd-tmpfiles --remove --create</pre></div><div class="refsect1"><a name="idm47480562179104"></a><h2 id="Unprivileged --cleanup operation">Unprivileged --cleanup operation<a class="headerlink" title="Permalink to this headline" href="#Unprivileged%20--cleanup%20operation">¶</a></h2><p><span class="command"><strong>systemd-tmpfiles</strong></span> tries to avoid changing
    the access and modification times on the directories it accesses,
    which requires <code class="constant">CAP_ADMIN</code> privileges. When
    running as non-root, directories which are checked for files to
    clean up will have their access time bumped, which might prevent
    their cleanup.
    </p></div><div class="refsect1"><a name="idm47480562176752"></a><h2 id="Exit status">Exit status<a class="headerlink" title="Permalink to this headline" href="#Exit%20status">¶</a></h2><p>On success, 0 is returned, a non-zero failure code
    otherwise.</p></div><div class="refsect1"><a name="idm47480562175600"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
      <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>,
      <a href="tmpfiles.d.html"><span class="citerefentry"><span class="refentrytitle">tmpfiles.d</span>(5)</span></a>
    </p></div></div></body></html>