bake/bake.1

60 lines
1.6 KiB
Groff
Raw Normal View History

2024-03-02 05:30:29 -05:00
.TH BAKE "1" "March 2024" "bake 20240302" "User Commands"
2024-02-26 23:19:55 -05:00
.SH NAME
.B bake
\- file embeddable scripts
.SH SYNOPSIS
.B bake
[option] target\-file [\fBarguments\fP ...]
.SH DESCRIPTION
2024-03-24 16:33:57 -04:00
Use the format \fB@BAKE\fP cmd ... within the target\-file, this will execute the
2024-02-26 23:19:55 -05:00
rest of line, or until the first \fB@STOP\fR marker.
This format may be embedded within \fBbinary files\fP, or any file where no unwanted preceding
instance of
.B @BAKE
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]
.HP
.B \-v \-\-version, \-h \-\-help, \-n \-\-dry\-run
.PP
Expansions
These will expand to their counterpart statically first thing.
These may only be inserted inside of markers.
.TP
.B $@
returns target\-file (abc.x.txt)
.TP
.B $*
returns target\-file without suffix (abc.x.txt \-> abc.x)
.TP
.B $+
returns
.B arguments
2024-04-06 19:59:15 -04:00
.PP
Additional Features And Notes
\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.
\\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.
2024-02-26 23:19:55 -05:00
.SH EXAMPLE
.\" SRC BEGIN (example.c)
.EX
// example.c
// @BAKE cc $@ -o $*
#include <stdio.h>
int main (void) {
printf("Hello.");
}
.EE
.SH COPYRIGHT
.PP
Licensed under the GNU Public License version 3 only, see <https://www.gnu.org/licenses/gpl\-3.0\-standalone.html>.