# HG changeset patch
# User Mike Becker <universe@uap-core.de>
# Date 1501920732 -7200
# Node ID ccef3f2bfe8e05c054e28619473403a80485528f
# Parent  20a176d5a53ecf85bbae2aa71ad0eb5a97b6bed2
adds more documentation details the three check commands

diff -r 20a176d5a53e -r ccef3f2bfe8e docs/html/check-config.html
--- a/docs/html/check-config.html	Sat Aug 05 09:56:51 2017 +0200
+++ b/docs/html/check-config.html	Sat Aug 05 10:12:12 2017 +0200
@@ -65,7 +65,8 @@
 <!-- begin content -->
 <div class="content">
 <h1 id="dav-check-config">dav check-config</h1>
-<p>Validates the config.xml file. If the config is ok, it prints <code>Configuration OK.</code> on stdout and returns 0, otherwise it prints an error message on stderr and returns 1.</p>
+<p>Validates the config.xml file. If the config is ok, it prints <code>Configuration OK.</code> to stdout and returns 0, otherwise it prints an error message to stderr and returns 1.</p>
+<p><strong>Command alias:</strong> check</p>
 </div>
 <!-- end content -->
 </body>
diff -r 20a176d5a53e -r ccef3f2bfe8e docs/html/check-repositories.html
--- a/docs/html/check-repositories.html	Sat Aug 05 09:56:51 2017 +0200
+++ b/docs/html/check-repositories.html	Sat Aug 05 10:12:12 2017 +0200
@@ -65,7 +65,8 @@
 <!-- begin content -->
 <div class="content">
 <h1 id="dav-sync-check-repositories">dav-sync check-repositories</h1>
-<p>Checks if every repository used by sync-directories is configured and available.</p>
+<p>Checks if every repository used by sync-directories is configured and available. This command outputs the status for each repository. It returns zero when all repositories are all available and non-zero otherwise.</p>
+<p><strong>Command alias:</strong> check-repos</p>
 </div>
 <!-- end content -->
 </body>
diff -r 20a176d5a53e -r ccef3f2bfe8e docs/html/sync-check-config.html
--- a/docs/html/sync-check-config.html	Sat Aug 05 09:56:51 2017 +0200
+++ b/docs/html/sync-check-config.html	Sat Aug 05 10:12:12 2017 +0200
@@ -65,7 +65,8 @@
 <!-- begin content -->
 <div class="content">
 <h1 id="dav-sync-check-config">dav-sync check-config</h1>
-<p>Validates the sync.xml file. If the config is ok, it prints Configuration OK. on stdout and returns 0, otherwise it prints an error message on stderr and returns 1.</p>
+<p>Validates the sync.xml file. If the configuration is OK, it prints <code>Configuration OK.</code> to stdout and returns 0, otherwise it prints an error message to stderr and returns 1.</p>
+<p><strong>Command alias:</strong> check</p>
 </div>
 <!-- end content -->
 </body>
diff -r 20a176d5a53e -r ccef3f2bfe8e docs/src/check-config.md
--- a/docs/src/check-config.md	Sat Aug 05 09:56:51 2017 +0200
+++ b/docs/src/check-config.md	Sat Aug 05 10:12:12 2017 +0200
@@ -1,4 +1,7 @@
 dav check-config
 ================
 
-Validates the config.xml file. If the config is ok, it prints `Configuration OK.` on stdout and returns 0, otherwise it prints an error message on stderr and returns 1.
+Validates the config.xml file. If the config is ok, it prints `Configuration OK.` to stdout and returns 0, otherwise it prints an error message to stderr and returns 1.
+
+**Command alias:** check
+
diff -r 20a176d5a53e -r ccef3f2bfe8e docs/src/check-repositories.md
--- a/docs/src/check-repositories.md	Sat Aug 05 09:56:51 2017 +0200
+++ b/docs/src/check-repositories.md	Sat Aug 05 10:12:12 2017 +0200
@@ -2,3 +2,8 @@
 ===========================
 
 Checks if every repository used by sync-directories is configured and available.
+This command outputs the status for each repository.
+It returns zero when all repositories are all available and non-zero otherwise.
+
+**Command alias:** check-repos
+
diff -r 20a176d5a53e -r ccef3f2bfe8e docs/src/sync-check-config.md
--- a/docs/src/sync-check-config.md	Sat Aug 05 09:56:51 2017 +0200
+++ b/docs/src/sync-check-config.md	Sat Aug 05 10:12:12 2017 +0200
@@ -1,4 +1,7 @@
 dav-sync check-config
 =====================
 
-Validates the sync.xml file. If the config is ok, it prints Configuration OK. on stdout and returns 0, otherwise it prints an error message on stderr and returns 1.
+Validates the sync.xml file. If the configuration is OK, it prints `Configuration OK.` to stdout and returns 0, otherwise it prints an error message to stderr and returns 1.
+
+**Command alias:** check
+