[rs-commit] r68 - /redwax-tool/trunk/redwax-tool.c

[rs-commit at redwax.eu]

Author: minfrin at redwax.eu
Date: Wed Nov 24 17:01:10 2021
New Revision: 68

Log:
Document return codes, provide initial example.

Modified:
    redwax-tool/trunk/redwax-tool.c

Modified: redwax-tool/trunk/redwax-tool.c
==============================================================================
--- redwax-tool/trunk/redwax-tool.c	(original)
+++ redwax-tool/trunk/redwax-tool.c	Wed Nov 24 17:01:10 2021
@@ -299,13 +299,20 @@
 
     apr_file_printf(out,
             "RETURN VALUE\n"
-            "  The redwax tool returns a non zero exit code if the configuration cannot\n"
-            "  be read.\n"
+            "  The redwax tool returns the following values.\n"
+            "\n"
+            "  - 0: We completed our task successfully.\n"
+            "  - 1: We failed to initialise.\n"
+            "  - 2: The command line options were not valid.\n"
+            "  - 3: No certificates were passed through the filter.\n"
             "\n"
             "EXAMPLES\n"
-            "  In this example, do things with the stuffs.\n"
+            "  In this example, we read all PEM files matching the wildcard, we pass\n"
+            "  all certificates through the filter, then we write chain certificates\n"
+            "  only to the file intermediates.pem in PEM format.\n"
             "\n"
-            "\t~$ redwax-tool\n"
+            "\t~$ redwax-tool --pem-in *.pem --filter passthrough --chain-out \n"
+            "\t\t--pem-out intermediates.pem\n"
             "\n"
             "AUTHOR\n"
             "  Graham Leggett <minfrin at sharp.fm>\n");