documentation is important

and usually comes as an afterthought
I nearly forgot to add this basic information for general usability
Imagine this not being a general requirement for all software

diff --git a/README b/README
index a882f07fd454e6cd5ba532b8cedaabab5b2e41ae..6e21c8ca1577e74aa169ddbc0c5e34eb0f5baa05 100644 (file)
--- a/README
+++ b/README
@@ -44,16 +44,25 @@ are still supported, avoid these in the future.
 They are most useful for a template command, such as:
  @BAKE cc @FILENAME -o @SHORT @ARGS
 
-Backslash, while otherwise ignored, will be respected at the end of the line
-to concatenate lines together or if added to before any of listed macros will
-yield the unfettered text.
+Backslash, while otherwise ignored, will be respected at the end of the line to
+concatenate lines together or if added to before any of listed macros will yield
+the unfettered text. \SPECIAL_NAME will result in SPECIAL_NAME in the executed
+shell command. Backslashes are applicable to all symbols used by Bake, they are
+ignored otherwise.
+
+--- Expunge Extension ---
+
+Removes any singular file or directory non recursively defined within @{...},
+this has no effect on the normal processing of the statement and is macro'd out
+before it is executed.
 
 --- Options ---
 
-only one option may be in use at a time, and must come as the first argument.
+Options must come as the first argument, and may be merged together, such as -xn.
 
  -h, --help: displays help message, similarly to empty input.
  -n, --dry-run: DRYRUN, does NOT run anything!
+ -x, --expunge: See above Expunge Extension section.
 
 --- Shake ---
 

diff --git a/bake.1 b/bake.1
index 143320add3f9101ad7a7679b7170d13138a971b5..783c4d55102ca7336f3c9d917c66025de2789394 100644 (file)
--- a/bake.1
+++ b/bake.1
@@ -17,7 +17,7 @@ appears.
 \fBShake\fP does not support some features of \fBBake\fP, such as \fB@STOP\fP or \fBbinary files\fP,
 please avoid its use.
 
-Options [Only one, Must always be put first]
+Options [Must always be put first, may be merged together]
 
 .HP
 .B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run
@@ -27,13 +27,13 @@ Expansions
 These will expand to their counterpart statically first thing.
 These may only be inserted inside of markers.
 .TP
-.B $@
+.B @FILENAME, $@
 returns target\-file                (abc.x.txt)
 .TP
-.B $*
+.B @SHORT, $*
 returns target\-file without suffix (abc.x.txt \-> abc.x)
 .TP
-.B $+
+.B @ARGS, $+
 returns
 .B arguments
 

diff --git a/bake.c b/bake.c
index 1b9372d5aa7cbb9645944484c8669cb9bee7e13f..c6287c0ea34ad635633882a7c5b83a2559cafdb0 100644 (file)
--- a/bake.c
+++ b/bake.c
@@ -40,7 +40,7 @@
   "rest of line, or if found within the file, until the " BOLD "@STOP" RESET " marker.\n"             \
 
 #define DESC                                                                                \
-  "Options [Must always be first]\n"                                                        \
+  "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"        \