bake/bake.1

65 lines
1.6 KiB
Groff
Raw Normal View History

.TH BAKE "1" "August 2024" "bake 20240804" "User Commands"
2024-02-26 23:19:55 -05:00
.SH NAME
.B bake
\- file embeddable scripts
.SH SYNOPSIS
.B bake
[\-chln] [\-s <n>] <FILENAME> [ARGS...]
2024-02-26 23:19:55 -05:00
.SH DESCRIPTION
bake is a simple tool meant to execute embedded shell commands within
any file. It executes with /bin/sh the command after a "\fB@BAKE\fP " to
the end of the line (a UNIX newline: '\fB\\n\fP').
2024-02-26 23:19:55 -05:00
This format may be embedded within \fBbinary files\fP, or any file where no unwanted preceding
instance of \fB@BAKE\fP appears.
2024-02-26 23:19:55 -05:00
It roots the shell execution in the directory of the given file.
2024-02-26 23:19:55 -05:00
Options must always be put first, and short options may be merged together.
2024-02-26 23:19:55 -05:00
.HP
\fB\-c \-\-color\fP, \-h \-\-help, \fB\-n \-\-dry\-run\fP, \fB\-l \-\-list\fP, \fB\-s \-\-select\fP <\fBn\fP>
2024-02-26 23:19:55 -05:00
.PP
Macros
All macros can be exempted by prefixing them with a backslash,
which'll be subtracted in the expansion. multi-line commands may be
done by a leading backslash, which are NOT subtracted.
2024-02-26 23:19:55 -05:00
These macros will expand to their counterpart before execution.
2024-02-26 23:19:55 -05:00
.TP
.B @FILENAME, @NAME, $@
returns target\-file (abc.x.txt)
2024-02-26 23:19:55 -05:00
.TP
.B @SHORT, $*
2024-02-26 23:19:55 -05:00
returns target\-file without suffix (abc.x.txt \-> abc.x)
.TP
.B @ARGS, $+
2024-02-26 23:19:55 -05:00
returns
.B arguments
.TP
.B @LINE
returns the line number
2024-04-06 19:59:15 -04:00
.PP
Additional Features And Notes
Shell execution may be disabled with the \fB-n\fP or \fB--dry-run\fP option.
Colors may be disabled with the \fB-c\fP or \fB--color\fP option.
2024-04-06 19:59:15 -04:00
2024-02-26 23:19:55 -05:00
.SH EXAMPLE
.\" SRC BEGIN (example.c)
.EX
// example.c @BAKE cc -o @SHORT @NAME @ARGS
2024-02-26 23:19:55 -05:00
#include <stdio.h>
int main (void) {
puts("Hello.");
return 0;
2024-02-26 23:19:55 -05:00
}
.EE
.SH COPYRIGHT
.PP
Licensed under the public domain.