emil/bake
1
0
Fork 0
forked from bake/bake
Code Issues Pull Requests Releases Wiki Activity

consistent option documentation

Browse Source
This commit is contained in:
Chad C. Starz 2024-04-07 05:48:12 +00:00
parent 3b64702955
commit 282de09301
No known key found for this signature in database
GPG Key ID: CEEBC9208C287297
3 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README
View File

@ -60,7 +60,8 @@ before it is executed.
Options must come as the first argument, and may be merged together, such as -xn. 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! -n, --dry-run: DRYRUN, does NOT run anything!
-x, --expunge: See above Expunge Extension section. -x, --expunge: See above Expunge Extension section.

2
bake.1
View File

@ -20,7 +20,7 @@ please avoid its use.
Options [Must always be put first, may be merged together] Options [Must always be put first, may be merged together]
.HP .HP
.B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run .B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run, \-x \-\-expunge
.PP .PP
Expansions Expansions

29
bake.c
View File

@ -39,20 +39,21 @@
"Use the format `" BOLD "@BAKE" RESET " cmd ...' within the target-file, this will execute the\n" \ "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" \ "rest of line, or if found within the file, until the " BOLD "@STOP" RESET " marker.\n" \
#define DESC \ #define DESC \
"Options [Must always be put first, may be merged together]\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 \ "\t" DIM "-v --version" RESET ", " DIM "-h --help" RESET ", " \
"Expansions\n" \ BOLD "-n --dry-run" RESET ", " BOLD "-x --expunge\n" RESET \
"\t" YELLOW "@FILENAME" RESET " returns target-file (abc.x.txt)\n" \ "Expansions\n" \
"\t" YELLOW "@SHORT " RESET " returns target-file without suffix (^-> abc.x)\n" \ "\t" YELLOW "@FILENAME" RESET " returns target-file (abc.x.txt)\n" \
"\t" YELLOW "@ARGS " RESET " returns " GREEN "arguments" RESET "\n" \ "\t" YELLOW "@SHORT " RESET " returns target-file without suffix (^-> abc.x)\n" \
"Additional Features And Notes\n" \ "\t" YELLOW "@ARGS " RESET " returns " GREEN "arguments" RESET "\n" \
"\t" YELLOW "@{" RESET BOLD "EXPUNGE_THIS_FILE" YELLOW "}" RESET \ "Additional Features And Notes\n" \
" inline region to delete this or many files or directories,\n" \ "\t" YELLOW "@{" RESET BOLD "EXPUNGE_THIS_FILE" YELLOW "}" RESET \
"\tnon-recursive, only one file per block, removed from left to right. This has no\n" \ " inline region to delete this or many files or directories,\n" \
"\tinfluence on the normal command execution.\n" \ "\tnon-recursive, only one file per block, removed from left to right. This has no\n" \
"\t" YELLOW "\\" RESET \ "\tinfluence on the normal command execution.\n" \
"SPECIAL_NAME will result in SPECIAL_NAME in the executed shell command.\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." "Backslashing is applicable to all meaningful symbols in Bake, it is ignored otherwise."
#define COPYRIGHT "2023 Emil Williams" #define COPYRIGHT "2023 Emil Williams"