aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org>2018-10-17 22:48:50 +0300
committerSergey Poznyakoff <gray@gnu.org>2018-10-17 22:48:50 +0300
commit0ae2a7c27bde705231ad00cd2f7e5a6f6ac6a09c (patch)
tree1bed0d6e6b721ebb96a64e5a18a61ac03627d2e2 /README
parentcb0361313d0510e8c60f5d4d84938508cf9a1ae2 (diff)
downloadm4kwargs-0ae2a7c27bde705231ad00cd2f7e5a6f6ac6a09c.tar.gz
m4kwargs-0ae2a7c27bde705231ad00cd2f7e5a6f6ac6a09c.tar.bz2
Update docs
Diffstat (limited to 'README')
-rw-r--r--README14
1 files changed, 7 insertions, 7 deletions
diff --git a/README b/README
index 9d80496..79b6397 100644
--- a/README
+++ b/README
@@ -4,7 +4,7 @@ M4KWARGS - keyword argument support for m4 macros
M4kwargs is a macro package that implements keyword arguments for
m4 macros. The implementation relies on the patsubst builtin, which
is available at least in GNU m4 and in FreeBSD m4. This package
-has been tested on these two implementations.
+has been tested with these two implementations.
Installation
============
@@ -16,7 +16,7 @@ for the contact information.
To install the package, run "make install". The name of the installation
target directory is described in Makefile terms as
- $(DESTDIR)$(PREFIX)/$(M4DIR)
+ $(DESTDIR)$(PREFIX)/share/$(M4DIR)
Default values for these variables are:
@@ -31,7 +31,7 @@ make command line. E.g. to install to /usr/share/m4, do
Another noteworthy installation variable is BRACKETQUOTES. By default, m4kwargs
assumes standard m4 quotes (`'). You can change them to [] when installing the
-package by supplying BRACKETQUOTES=1:
+package by declaring BRACKETQUOTES=1:
make install BRACKETQUOTES=1
@@ -48,8 +48,8 @@ Include the file kwargs.m4 at the top of your source file:
This will do the following:
-1. Check if m4 has the patsubst builtin. If not, an error message will be
-printed and m4 will terminate with exit status 1.
+1. Check if m4 provides the patsubst builtin. If not, an error message will
+be printed and m4 will terminate with exit status 1.
2. Check if second argument to patsubst is a basic or extended regular
expression.
3. Prefix all built-in m4 identifiers with m4_. Note to GNU m4 users:
@@ -191,8 +191,8 @@ KWARGS_POP()
KWARGS_DUP()
Push current keyword arguments on stack and retain their definitions.
- This can be used to augment keyword arguments with new settings. To
- restore previous arguments, use KWARGS_POP. Normal usage pattern is:
+ This can be used to augment or override keyword arguments. To
+ restore previous arguments, use KWARGS_POP. The normal usage pattern is:
KWARGS_PUSH()
KWARGS_ASGN($@)

Return to:

Send suggestions and report system problems to the System administrator.