Skip to content

Commit c767cc5

Browse files
committed
update manpage
1 parent 874ac9a commit c767cc5

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

man/run.1

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,51 @@
1-
.TH "RUNFILE\.SH" "1" "March 2025"
1+
.TH "RUNFILE\.SH" "1" "September 2025"
22
.SH "NAME"
33
\fBrunfile.sh Language-agnostic project task runner built on the ubiquitous Make.\fR
44
.SH DESCRIPTION
55
.br
66
Basic usage:
77
.RS 2
88
.nf
9-
$ run \-\-runfile\-help
9+
$ run \-\-help
1010

11-
· Usage · run ····················· Print list of all available tasks\.
12-
run [options] [task] ···· Run a task \.
13-
run [options] [action] ·· Run a Runfile/Makefile action\.
11+
· Usage · run ··················· Print list of all available tasks\.
12+
run [task] ············ Run a task\.
13+
run [task] [options] ·· Run a task with options available to task code\.
1414

15-
# \./Runfile syntax
16-
taskabc: # task description
15+
run \-\-[help|version|runfile|makefile|edit|new|alias] [options]
16+
run \-[h|v|r|m|e|n|a] ·· Actions for managing Runfiles; details below\.
17+
18+
# \./Runfile \-\- syntax primer
19+
taskabc: # Task description\.
1720
shell command for task abc
18-
taskxyz: taskabc # task description, taskxyz runs taskabc first just like Make would
21+
taskxyz: taskabc # Task description, taskxyz runs taskabc first just like Make would\.
1922
shell command for task xyz
20-
#^ whitespace doesn't matter; tabs, spaces, blank lines are all ok, or may be omitted
21-
22-
· Actions ·
23-
24-
\-h \-\-help \-\-usage ····· Print this usage documentation then exit\.
25-
\-v \-\-version ·········· Print current runfile\.sh version then exit\.
26-
\-\-runfile ············· Print contents of nearest Runfile \.
27-
\-\-makefile ············ Print contents of Makefile generated from nearest Runfile\.
28-
\-\-runfile\-edit ········ Open nearest Runfile with \\$EDITOR\.
29-
\-\-makefile\-edit ······· Open nearest Makefile with \\$EDITOR\.
30-
\-\-runfile\-create ······ Write template Runfile in current dir\.
31-
\-\-makefile\-create ····· Write generated Makefile in current dir\.
32-
\-\-runfile\-overwrite ··· Overwrite existing Runfile with template Runfile\.
33-
\-\-makefile\-overwrite ·· Overwrite existing Makefile with generated Makefile\.
34-
\-\-runfile\-aliases ····· Print command aliases for nearest Runfile \.
23+
#^ Unlike Make, whitespace doesn't matter; tabs, spaces, extra blank lines are all ok\.
3524

36-
· Options ·
25+
\-h \-\-help ··········· Print this usage documentation then exit\.
26+
\-v \-\-version ········ Print current runfile\.sh version then exit\.
27+
\-r \-\-runfile ········ Print contents of nearest Runfile \.
28+
\-m \-\-makefile ······· Print contents of Makefile generated from nearest Runfile\.
29+
\-m \-\-makefile TASK ·· Print contents of single task from generated Makefile\.
30+
\-e \-\-edit ··········· Open nearest Runfile with \\$EDITOR\.
31+
\-n \-\-new ············ Interactively create new Runfile in current dir\.
32+
\-a \-\-alias ·········· Show command aliases for nearest Runfile \.
33+
\-a \-\-alias FILENAME · Attempt to write/update aliases within shell config file\.
34+
\-\-eject ············· Generate Makefile from Runfile and write to current dir\.
3735

38-
\-\-runfile\-compact ···· Use "compact" formatting for Runfile when creating or printing\.
39-
\-\-runfile\-confirm ···· Always ask for confirmation before opening files with $EDITOR\.
40-
\-\-runfile\-noconfirm ·· Never ask for confirmation before opening files with $EDITOR\.
41-
\-\-runfile\-noedit ····· Never open files with $EDITOR\.
42-
\-\-runfile\-verbose ···· Print code line\-by\-line to terminal during task execution\.
43-
\-\-makefile\-compat ···· Disable all features not compatible with Make\.
36+
\-\-verbose ··········· Print code line\-by\-line to terminal during task execution\.
37+
\-\-compact ··········· Use "compact" formatting for Runfile when creating or printing\.
38+
\-\-compat ············ Disable all features not compatible with Make\.
39+
\-\-confirm ··········· Always ask for confirmation before opening files with \\$EDITOR\.
40+
\-\-noconfirm ········· Never ask for confirmation before opening files with \\$EDITOR\.
41+
\-\-noedit ············ Never open files with \\$EDITOR\.
42+
RUNFILE_VERBOSE=1 RUNFILE_COMPACT=1 RUNFILE_COMPAT=1 · All options may also be ·
43+
RUNFILE_CONFIRM=1 RUNFILE_NOCONFIRM=1 RUNFILE_NOEDIT=1 · provided as env variables ·
4444

45-
\-\-make\-dry\-run ·· Don't execute task code, just print line\-by\-line to terminal instead\.
46-
\-\-make\-* ········ Pass any argument directly to they underlying Make command
47-
· by prefixing the intended Make argument with "\-\-make\-"\.
48-
· For example, \-\-make\-dry\-run will pass \-\-dry\-run to Make\.
45+
\-\-make\-dry\-run ······ Don't execute task code, just print line\-by\-line to terminal\.
46+
\-\-make\-ARGUMENT ····· Pass any argument directly to they underlying Make command
47+
· by prefixing the intended Make argument with "\-\-make\-"\.
48+
· For example, \-\-make\-dry\-run will pass \-\-dry\-run to Make\.
4949
.fi
5050
.RE
5151
.SH Install

0 commit comments

Comments
 (0)