From 0e8415f2e5c42e87ca3b7a96138675f64696cb7a Mon Sep 17 00:00:00 2001 From: =?utf8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Sun, 20 Jul 2014 19:28:58 -0400 Subject: [PATCH] man: add systemd-verify(1) --- Makefile-man.am | 2 + man/systemd-journal-remote.xml | 21 +--- man/systemd-verify.xml | 174 +++++++++++++++++++++++++++++++++ man/systemd.unit.xml | 1 + src/verify/verify.c | 4 +- 5 files changed, 184 insertions(+), 18 deletions(-) create mode 100644 man/systemd-verify.xml diff --git a/Makefile-man.am b/Makefile-man.am index 4339e5022..5cc308152 100644 --- a/Makefile-man.am +++ b/Makefile-man.am @@ -92,6 +92,7 @@ MANPAGES += \ man/systemd-udevd.service.8 \ man/systemd-update-done.service.8 \ man/systemd-update-utmp.service.8 \ + man/systemd-verify.1 \ man/systemd.1 \ man/systemd.automount.5 \ man/systemd.device.5 \ @@ -1658,6 +1659,7 @@ EXTRA_DIST += \ man/systemd-update-utmp.service.xml \ man/systemd-user-sessions.service.xml \ man/systemd-vconsole-setup.service.xml \ + man/systemd-verify.xml \ man/systemd.automount.xml \ man/systemd.device.xml \ man/systemd.directives.xml \ diff --git a/man/systemd-journal-remote.xml b/man/systemd-journal-remote.xml index 4065ced14..b470e2c9b 100644 --- a/man/systemd-journal-remote.xml +++ b/man/systemd-journal-remote.xml @@ -21,7 +21,8 @@ You should have received a copy of the GNU Lesser General Public License along with systemd; If not, see . --> - + systemd-journal-remote @@ -234,21 +235,6 @@ along with systemd; If not, see . The following options are understood: - - - - - Print a short help - text and exit. - - - - - - Print a short version - string and exit. - - @@ -293,6 +279,9 @@ along with systemd; If not, see . --getter='wget --header="Accept: application/vnd.fdo.journal" -O- https://some.host:19531/' + + + diff --git a/man/systemd-verify.xml b/man/systemd-verify.xml new file mode 100644 index 000000000..128032e7c --- /dev/null +++ b/man/systemd-verify.xml @@ -0,0 +1,174 @@ + + + + + + + + + systemd-verify + systemd + + + + Developer + Zbigniew + Jędrzejewski-Szmek + zbyszek@in.waw.pl + + + + + + systemd-verify + 1 + + + + systemd-verify + Check unit file validity + + + + + systemd-verify + OPTIONS + FILES + + + + + Description + + systemd-verify 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. + + 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. + + The following errors are currently detected: + + unknown sections and directives, + + + missing dependencies which are required to start + the given unit, + + man pages listed in + Documentation= which are not found in the + system, + + commands listed in ExecStart= + and similar which are not found in the system or not executable. + + + + + + Options + + The following options are understood: + + + + + + Do not invoke man to verify the existence + of man pages listen in Documentation=. + + + + + + + + + + + + + Exit status + + On success, 0 is returned, a non-zero failure + code otherwise. + + + + Examples + + + Misspelt directives + + $ 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 + + + + + Missing service units + + $ tail ./a.socket ./b.socket +==> ./a.socket <== +[Socket] +ListenStream=100 + +==> ./b.socket <== +[Socket] +ListenStream=100 +Accept=yes + +$ systemd-verify ./a.socket ./b.socket +Service a.service not loaded, a.socket cannot be started. +Service b@0.service not loaded, b.socket cannot be started. + + + + + + + See Also + + systemd8, + systemctl1, + systemd.unit5, + systemd.directives7 + + + diff --git a/man/systemd.unit.xml b/man/systemd.unit.xml index dd3a4a7cd..dc5e385ac 100644 --- a/man/systemd.unit.xml +++ b/man/systemd.unit.xml @@ -1513,6 +1513,7 @@ systemd.scope5, systemd.slice5, systemd.time7, + systemd-verify1, capabilities7, systemd.directives7, uname1 diff --git a/src/verify/verify.c b/src/verify/verify.c index cad79ecf4..c1a3da8d1 100644 --- a/src/verify/verify.c +++ b/src/verify/verify.c @@ -278,8 +278,8 @@ static void help(void) { "Check if unit files can be correctly loaded.\n\n" " -h --help Show this help\n" " --version Show package version\n" - " --system Connect to system manager\n" - " --user Connect to user service manager\n" + " --system Test system units\n" + " --user Test user units\n" " --no-man Do not check for existence of man pages\n" , program_invocation_short_name); } -- 2.30.2