HALF ECHO LEARN / REFERENCE COLLECTION

v262.2

man/systemctl.xml

165,112 bytesGit mode 100644Download original fileLGPL-2.1-or-later

Git blob: b67a7efabcd07f37520a1232e63e3e99dd654150

Lines 3001–3119 of 3,119

      <xi:include href="user-system-options.xml" xpointer="capsule" />
 
      <xi:include href="standard-options.xml" xpointer="no-ask-password" />
      <xi:include href="standard-options.xml" xpointer="no-pager" />
      <xi:include href="standard-options.xml" xpointer="legend" />
      <xi:include href="standard-options.xml" xpointer="help" />
      <xi:include href="standard-options.xml" xpointer="version" />
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>Exit status</title>
 
    <para>On success, 0 is returned, a non-zero failure code otherwise.</para>
 
    <para><command>systemctl</command> uses the return codes defined by LSB, as defined in
    <ulink url="http://refspecs.linuxbase.org/LSB_3.0.0/LSB-PDA/LSB-PDA/iniscrptact.html">LSB 3.0.0</ulink>.
    </para>
 
    <table>
      <title>LSB return codes</title>
 
      <tgroup cols='3'>
        <thead>
          <row>
            <entry>Value</entry>
            <entry>Description in LSB</entry>
            <entry>Use in systemd</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry><constant>0</constant></entry>
            <entry>"program is running or service is OK"</entry>
            <entry>unit is active</entry>
          </row>
          <row>
            <entry><constant>1</constant></entry>
            <entry>"program is dead and <filename>/var/run</filename> pid file exists"</entry>
            <entry>unit <emphasis>not</emphasis> failed (used by <command>is-failed</command>)</entry>
          </row>
          <row>
            <entry><constant>2</constant></entry>
            <entry>"program is dead and <filename>/var/lock</filename> lock file exists"</entry>
            <entry>unused</entry>
          </row>
          <row>
            <entry><constant>3</constant></entry>
            <entry>"program is not running"</entry>
            <entry>unit is not active</entry>
          </row>
          <row>
            <entry><constant>4</constant></entry>
            <entry>"program or service status is unknown"</entry>
            <entry>no such unit</entry>
          </row>
        </tbody>
      </tgroup>
    </table>
 
    <para>The mapping of LSB service states to systemd unit states is imperfect, so it is better to
    not rely on those return values but to look for specific unit states and substates instead.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Environment</title>
 
    <variablelist class='environment-variables'>
      <varlistentry>
        <term><varname>$SYSTEMD_EDITOR</varname></term>
 
        <listitem><para>Editor to use when editing units; overrides
        <varname>$EDITOR</varname> and <varname>$VISUAL</varname>. If neither
        <varname>$SYSTEMD_EDITOR</varname> nor <varname>$EDITOR</varname> nor
        <varname>$VISUAL</varname> are present or if it is set to an empty
        string or if their execution failed, systemctl will try to execute well
        known editors in this order:
        <citerefentry project='die-net'><refentrytitle>editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
        <citerefentry project='die-net'><refentrytitle>nano</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
        <citerefentry project='die-net'><refentrytitle>vim</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
        <citerefentry project='die-net'><refentrytitle>vi</refentrytitle><manvolnum>1</manvolnum></citerefentry>.
        </para>
 
        <xi:include href="version-info.xml" xpointer="v218"/></listitem>
      </varlistentry>
      <xi:include href="common-variables.xml" xpointer="log-level"/>
      <xi:include href="common-variables.xml" xpointer="log-color"/>
      <xi:include href="common-variables.xml" xpointer="log-time"/>
      <xi:include href="common-variables.xml" xpointer="log-location"/>
      <xi:include href="common-variables.xml" xpointer="log-target"/>
      <xi:include href="common-variables.xml" xpointer="pager"/>
      <xi:include href="common-variables.xml" xpointer="less"/>
      <xi:include href="common-variables.xml" xpointer="lesscharset"/>
      <xi:include href="common-variables.xml" xpointer="lesssecure"/>
      <xi:include href="common-variables.xml" xpointer="colors"/>
      <xi:include href="common-variables.xml" xpointer="urlify"/>
    </variablelist>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
    <para><simplelist type="inline">
      <member><citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>journalctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>loginctl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.resource-control</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
      <member><citerefentry project='man-pages'><refentrytitle>wall</refentrytitle><manvolnum>1</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.preset</refentrytitle><manvolnum>5</manvolnum></citerefentry></member>
      <member><citerefentry><refentrytitle>systemd.generator</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
      <member><citerefentry project='man-pages'><refentrytitle>glob</refentrytitle><manvolnum>7</manvolnum></citerefentry></member>
    </simplelist></para>
  </refsect1>
 
</refentry>