]> git.xolatile.top Git - emil-bake.git/commitdiff
consistent option documentation v20240404
authorEmil Williams <emilemilemil@cock.li>
Sun, 7 Apr 2024 05:48:12 +0000 (05:48 +0000)
committerEmil Williams <emilemilemil@cock.li>
Sun, 7 Apr 2024 05:48:12 +0000 (05:48 +0000)
README
bake.1
bake.c

diff --git a/README b/README
index 6e21c8ca1577e74aa169ddbc0c5e34eb0f5baa05..fa0fc9801e0af688a7e9d8d2a3b687add4efaad9 100644 (file)
--- a/README
+++ b/README
@@ -60,7 +60,8 @@ before it is executed.
 
 Options must come as the first argument, and may be merged together, such as -xn.
 
- -h, --help: displays help message, similarly to empty input.
+ -v, --version: display versioning and licensing information.
+ -h, --help: display the help message, similarly to empty input.
  -n, --dry-run: DRYRUN, does NOT run anything!
  -x, --expunge: See above Expunge Extension section.
 
diff --git a/bake.1 b/bake.1
index 783c4d55102ca7336f3c9d917c66025de2789394..230cc2469cc4686f191530c1eeddd7cecc287788 100644 (file)
--- a/bake.1
+++ b/bake.1
@@ -20,7 +20,7 @@ please avoid its use.
 Options [Must always be put first, may be merged together]
 
 .HP
-.B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run
+.B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run, \-x \-\-expunge
 .PP
 Expansions
 
diff --git a/bake.c b/bake.c
index c6287c0ea34ad635633882a7c5b83a2559cafdb0..016d56f6d8e5645cfb9a0059ff1dff5728740d91 100644 (file)
--- a/bake.c
+++ b/bake.c
   "Use the format `" BOLD "@BAKE" RESET " cmd ...' within the target-file, this will execute the\n"   \
   "rest of line, or if found within the file, until the " BOLD "@STOP" RESET " marker.\n"             \
 
-#define DESC                                                                                \
-  "Options [Must always be put first, may be merged together]\n"                            \
-  "\t" DIM "-h --help" RESET", " BOLD "-n --dry-run" RESET ", " BOLD "-x --expunge\n" RESET \
-  "Expansions\n"                                                                            \
-  "\t" YELLOW "@FILENAME" RESET "  returns target-file                (abc.x.txt)\n"        \
-  "\t" YELLOW "@SHORT   " RESET "  returns target-file without suffix (^-> abc.x)\n"        \
-  "\t" YELLOW "@ARGS    " RESET "  returns " GREEN "arguments" RESET "\n"                   \
-  "Additional Features And Notes\n"                                                         \
-  "\t" YELLOW "@{" RESET BOLD "EXPUNGE_THIS_FILE" YELLOW "}" RESET                          \
-  " inline region to delete this or many files or directories,\n"                           \
-  "\tnon-recursive, only one file per block, removed from left to right. This has no\n"     \
-  "\tinfluence on the normal command execution.\n"                                          \
-  "\t" YELLOW "\\" RESET                                                                    \
-  "SPECIAL_NAME will result in SPECIAL_NAME in the executed shell command.\n"               \
+#define DESC                                                                            \
+  "Options [Must always be put first, may be merged together]\n"                        \
+  "\t" DIM "-v --version" RESET ", " DIM "-h --help" RESET ", "                         \
+  BOLD "-n --dry-run" RESET ", " BOLD "-x --expunge\n" RESET                            \
+  "Expansions\n"                                                                        \
+  "\t" YELLOW "@FILENAME" RESET "  returns target-file                (abc.x.txt)\n"    \
+  "\t" YELLOW "@SHORT   " RESET "  returns target-file without suffix (^-> abc.x)\n"    \
+  "\t" YELLOW "@ARGS    " RESET "  returns " GREEN "arguments" RESET "\n"               \
+  "Additional Features And Notes\n"                                                     \
+  "\t" YELLOW "@{" RESET BOLD "EXPUNGE_THIS_FILE" YELLOW "}" RESET                      \
+  " inline region to delete this or many files or directories,\n"                       \
+  "\tnon-recursive, only one file per block, removed from left to right. This has no\n" \
+  "\tinfluence on the normal command execution.\n"                                      \
+  "\t" YELLOW "\\" RESET                                                                \
+  "SPECIAL_NAME will result in SPECIAL_NAME in the executed shell command.\n"           \
   "Backslashing is applicable to all meaningful symbols in Bake, it is ignored otherwise."
 
 #define COPYRIGHT "2023 Emil Williams"