neue Version: 1.0.2v1.0.2

1 files changed, 61 insertions, 9 deletions

diff --git a/Make.8.in b/Make.8.in
index c852460..90345bb 100644
--- a/Make.8.in
+++ b/Make.8.in
@@ -4,12 +4,11 @@ Make \- somewhat more powerfull alternative to make
 .SH SYNOPSIS
 \fBMake [options]\fP
 .SH DESCRIPTION
-\fBMake\fP checks currentness of compiled files and compiles outdated ones as specified by
-regex-aware rules.
+\fBMake\fP checks currentness of compiled files and generates commands for compilation of outdated files as specified by regex-aware rules.
 .SH OPTIONS
 .TP
-.B "\-A, \-\-Ausgabe $Ausgabedatei"
-store commands in $Ausgabedatei
+.B "\-A, \-\-Ausgabe Ausgabedatei"
+store commands in \fIAusgabedatei\fP
 .TP
 .B "\-H, \-\-Hilfe"
 display help screen
@@ -17,17 +16,70 @@ display help screen
 .B "\-W, \-\-Watte"
 just print what would be done
 .TP
-.B "\-D, \-\-Datei $Machdatei"
-read rules from $Machdatei
+.B "\-D, \-\-Datei Machdatei"
+read rules from \fIMachdatei\fP
 .TP
-.B "\-P, \-\-Prüfsummen $Prüfsummendatei"
-read/store checksums in $Prüfsummendatei
+.B "\-P, \-\-Prüfsummen Prüfsummendatei"
+read/store checksums in \fIPrüfsummendatei\fP
 .TP
 .B "\-a, \-\-alleSummenErneuern"
 refresh all checksums
 .TP
 .B "\-u, \-\-unsicher"
-accept running jobs outside of directory of $Ausgabedatei or $Prüfsummendatei
+accept running jobs outside of directory of \fIAusgabedatei\fP or \fIPrüfsummendatei\fP
+.SH SYNTAX
+Empty lines and lines beginning with \fB#\fP are ignored.
+.PP
+The file starts with definition of files:
+.TP
+.B "/path/to/files"
+add these files to currentness control
+.TP
+.B "-r /path/to/files"
+recursively add these files and directories to currentness control
+.PP
+The rest of the file consists of compilation rules, each consisting of two consecutive lines:
+.TP
+The \fBfirst\fP line is a regex-aware rule for identifying dependencies and must not end on \fB;\fP.
+.TP
+.B "1>1 target:sourceRegEx"
+Each file matching \fIsourceRegEx\fP generates one \fItarget\fP.
+.TP
+.B "n>n target:sourceRegEx"
+All files matching \fIsourceRegEx\fP contribute simultanously in generating \fItarget\fP (possibly multiple files).
+.TP
+The \fBsecond\fP line contains commands to refresh the targets and must end on \fB;\fP.
+.SH SUBSTITUTIONS
+Some substitutions and macros are recognized:
+.TP
+.B "%nurmit'filePart'"
+only apply rule / consider source file if name of source file contains \fIfilePart\fP
+.TP
+.B "%nurohne'filePart'"
+opposite of \fB%nurmit'filePart'\fP
+.TP
+.B "%in"
+file name and path of source file
+.TP
+.B "%ifile"
+file name of source file
+.TP
+.B "%basename"
+file name of source file without extension(s)
+.TP
+.B "%basedir(number)"
+path to source file stripped by last \fInumber\fP directory components
+.TP
+.B "%basedir"
+path so source file.
+Identical to \fB%basedir(0)\fP.
+.TP
+.B "%BASEDIR"
+path to \fIMachdatei\fP
+.TP
+.B "%num'string'"
+last decimal number in \fIstring\fP.
+E.g. \fB%num'abc123def456ghi'\fP becomes \fB456\fP.
 .SH AUTHOR
 .nf
 Erich Eckner <opensource at eckner dot net>