aboutsummaryrefslogtreecommitdiffstats
path: root/doc/nasmdoc.src
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2017-04-24 14:21:43 -0700
committerH. Peter Anvin <hpa@zytor.com>2017-04-24 14:21:43 -0700
commit3ddaa86ba2cfb019683fd1c0f474c80d85fceb89 (patch)
tree6c7dc0906726000a1b0964c98c2aca656f29f36e /doc/nasmdoc.src
parentf268b97a8e7d8be9b7b4ef4092092396f3720047 (diff)
downloadnasm-3ddaa86ba2cfb019683fd1c0f474c80d85fceb89.tar.gz
nasm-3ddaa86ba2cfb019683fd1c0f474c80d85fceb89.tar.xz
nasm-3ddaa86ba2cfb019683fd1c0f474c80d85fceb89.zip
doc: make the %! (environment variable) construct a little clearer
Make the %! construct a little more clear. Signed-off-by: H. Peter Anvin <hpa@zytor.com>
Diffstat (limited to 'doc/nasmdoc.src')
-rw-r--r--doc/nasmdoc.src10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/nasmdoc.src b/doc/nasmdoc.src
index 1dfb021d..cd979f37 100644
--- a/doc/nasmdoc.src
+++ b/doc/nasmdoc.src
@@ -3706,16 +3706,16 @@ all file name and line numbers relative to the values specified
therein.
-\S{getenv} \i\c{%!}\c{<env>}: Read an environment variable.
+\S{getenv} \i\c{%!}\e{variable}: Read an Environment Variable.
-The \c{%!<env>} directive makes it possible to read the value of an
+The \c{%!}\e{variable} directive makes it possible to read the value of an
environment variable at assembly time. This could, for example, be used
to store the contents of an environment variable into a string, which
could be used at some other point in your code.
-For example, suppose that you have an environment variable \c{FOO}, and
-you want the contents of \c{FOO} to be embedded in your program. You
-could do that as follows:
+For example, suppose that you have an environment variable \c{FOO},
+and you want the contents of \c{FOO} to be embedded in your program as
+a quoted string. You could do that as follows:
\c %defstr FOO %!FOO