Ever burned a cake?
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

60 line
1.6KB

  1. .TH BAKE "1" "March 2024" "bake 20240408" "User Commands"
  2. .SH NAME
  3. .B bake
  4. \- file embeddable scripts
  5. .SH SYNOPSIS
  6. .B bake
  7. [option] target\-file [\fBarguments\fP ...]
  8. .SH DESCRIPTION
  9. Use the format \fB@BAKE\fP cmd ... within the target\-file, this will execute the
  10. rest of line, or until the first \fB@STOP\fR marker.
  11. This format may be embedded within \fBbinary files\fP, or any file where no unwanted preceding
  12. instance of
  13. .B @BAKE
  14. appears.
  15. \fBShake\fP does not support some features of \fBBake\fP, such as \fB@STOP\fP or \fBbinary files\fP,
  16. please avoid its use.
  17. Options [Must always be put first, may be merged together]
  18. .HP
  19. .B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run, \-x \-\-expunge
  20. .PP
  21. Expansions
  22. These will expand to their counterpart statically first thing.
  23. These may only be inserted inside of markers.
  24. .TP
  25. .B @FILENAME, $@
  26. returns target\-file (abc.x.txt)
  27. .TP
  28. .B @SHORT, $*
  29. returns target\-file without suffix (abc.x.txt \-> abc.x)
  30. .TP
  31. .B @ARGS, $+
  32. returns
  33. .B arguments
  34. .PP
  35. Additional Features And Notes
  36. \fB@{\fPEXPUNGE_THIS_FILE\fB}\fP is a inline block to delete files or directories, non-recursive, only one file per block, removed from left to right. Has no influence on the normal command execution.
  37. \\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.
  38. .SH EXAMPLE
  39. .\" SRC BEGIN (example.c)
  40. .EX
  41. // example.c
  42. // @BAKE cc $@ -o $*
  43. #include <stdio.h>
  44. int main (void) {
  45. printf("Hello.");
  46. }
  47. .EE
  48. .SH COPYRIGHT
  49. .PP
  50. Licensed under the GNU Public License version 3 only, see <https://www.gnu.org/licenses/gpl\-3.0\-standalone.html>.