systemd-verify.xml revision 0e8415f2e5c42e87ca3b7a96138675f64696cb7a
<?xml version='1.0'?> <!--*-nxml-*-->
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
<!--
This file is part of systemd.
Copyright 2014 Zbigniew Jędrzejewski-Szmek
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
systemd is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with systemd; If not, see <http://www.gnu.org/licenses/>.
-->
<refentry id="systemd-verify"
xmlns:xi="http://www.w3.org/2001/XInclude">
<refentryinfo>
<title>systemd-verify</title>
<productname>systemd</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Zbigniew</firstname>
<surname>Jędrzejewski-Szmek</surname>
<email>zbyszek@in.waw.pl</email>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>systemd-verify</refentrytitle>
<manvolnum>1</manvolnum>
</refmeta>
<refnamediv>
<refname>systemd-verify</refname>
<refpurpose>Check unit file validity</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>systemd-verify</command>
<arg choice="opt" rep="repeat">OPTIONS</arg>
<arg choice="opt" rep="repeat">FILES</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para><filename>systemd-verify</filename> will load unit files and
potentially print warnings if any errors are detected. Files
specified on the command line will be loaded, but also any other
units referenced by them.</para>
<para>This command works by prepending the directories for all
command line arguments at the beginning of the unit load path.
This means that all units files found in those directories will
be used in preference to the unit files found in the standard
locations, even if not listed explicitly.</para>
<para>The following errors are currently detected:</para>
<itemizedlist>
<listitem><para>unknown sections and directives,
</para></listitem>
<listitem><para>missing dependencies which are required to start
the given unit,</para></listitem>
<listitem><para>man pages listed in
<varname>Documentation=</varname> which are not found in the
system,</para></listitem>
<listitem><para>commands listed in <varname>ExecStart=</varname>
and similar which are not found in the system or not executable.
</para></listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--no-man</option></term>
<listitem><para>Do not invoke man to verify the existence
of man pages listen in <varname>Documentation=</varname>.
</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Exit status</title>
<para>On success, 0 is returned, a non-zero failure
code otherwise.</para>
</refsect1>
<refsect1>
<title>Examples</title>
<example>
<title>Misspelt directives</title>
<programlisting>$ cat /user.slice
[Unit]
WhatIsThis=11
Documentation=man:systemd.nosuchfile(7)
Requires=different.service
[Service]
Desription=x
$ systemd-verify /user.slice
[/user.slice:9] Unknown lvalue 'WhatIsThis' in section 'Unit'
[/user.slice:13] Unknown section 'Service'. Ignoring.
Error: org.freedesktop.systemd1.LoadFailed: Unit different.service failed to load: No such file or directory.
Failed to create user.slice/start: Invalid argument
user.slice: man systemd.nosuchfile(7) command failed with code 16
</programlisting>
</example>
<example>
<title>Missing service units</title>
==> /a.socket <==
[Socket]
ListenStream=100
==> /b.socket <==
[Socket]
ListenStream=100
Accept=yes
Service b@0.service not loaded, b.socket cannot be started.
</programlisting>
</example>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemctl</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>systemd.directives</refentrytitle><manvolnum>7</manvolnum></citerefentry>
</para>
</refsect1>
</refentry>