adds more documentation details the three check commands

Sat, 05 Aug 2017 10:12:12 +0200

author
Mike Becker <universe@uap-core.de>
date
Sat, 05 Aug 2017 10:12:12 +0200
changeset 277
ccef3f2bfe8e
parent 276
20a176d5a53e
child 278
c9096eb3554c

adds more documentation details the three check commands

docs/html/check-config.html file | annotate | diff | comparison | revisions
docs/html/check-repositories.html file | annotate | diff | comparison | revisions
docs/html/sync-check-config.html file | annotate | diff | comparison | revisions
docs/src/check-config.md file | annotate | diff | comparison | revisions
docs/src/check-repositories.md file | annotate | diff | comparison | revisions
docs/src/sync-check-config.md file | annotate | diff | comparison | revisions
--- 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>
--- 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>
--- 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>
--- 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
+
--- 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
+
--- 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
+

mercurial