summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarius Vollmer <mvo@zagadka.de>2002-03-24 14:12:07 +0000
committerMarius Vollmer <mvo@zagadka.de>2002-03-24 14:12:07 +0000
commit033aa07c016786b1b2a2b52cb7bc9ec85b4ccee4 (patch)
tree48f0860c26f23316bcb61042732bce805812e1e1
parente2bd68e02c5dc542ce52d152b8cacdd8a2d56270 (diff)
downloadguile-033aa07c016786b1b2a2b52cb7bc9ec85b4ccee4.tar.gz
Updated to reflect changes to the guile-snarf tool.
-rw-r--r--doc/ref/tools.texi10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/ref/tools.texi b/doc/ref/tools.texi
index e27cc0fc7..061e34477 100644
--- a/doc/ref/tools.texi
+++ b/doc/ref/tools.texi
@@ -75,9 +75,10 @@ Usage: guile-snarf [-d | -D] [-o OUTFILE] INFILE [CPP-OPTIONS ...]
What @code{guile-snarf} does:
Process INFILE using the C pre-processor and some other programs.
-Write output to a file, named OUTFILE if specified, or STEM.x if
-INFILE looks like STEM.c and no OUTFILE is specified. Ignore
-lines from the input matching grep(1) regular expression:
+Write output to a file named OUTFILE or to the standard output when no
+OUTFILE has been specified or when OUTFILE is @code{-}. When writing
+to a file, ignore lines from the input matching the following grep(1)
+regular expression:
@example
^#include ".*OUTFILE"
@@ -93,6 +94,9 @@ do the same thing but signal error and exit with non-zero status.
If env var CPP is set, use its value instead of the C pre-processor
determined at Guile configure-time.
+During snarfing, the pre-processor macro @code{SCM_MAGIC_SNARFER} is
+defined.
+
@xref{Macros guile-snarf recognizes}, for a list of the special (some would
say magic) cpp macros you can use, including the list of deprecated macros.