# This is an example comment in a file mark-up And this would be a line of code in the example file.
m4
, or some processor I wrote)
and is marked-up in-line. For example an attribute named "HUE"
would look like HUE
.
halt
.
-o
.
param
.
This is the same markup used to an option specification, for example
make
's recipe file under -f
is given as makefile
.
make
recipe files, so I've
had to give the macros in a makefile
special
markup. The common "CFLAGS" macro is given as CFLAGS
.
make
's macros
and shell environment variables we mark the latter with a different
markup.
The "PATH" environment variable is marked as PATH
.
shutdown
.
/dev/null
. This is not always
included, when it is clear that every element in a list must be
a filename.
make
's makefile
,
rdist
's distfile
contains macros that might be mistaken for shell variables.
I mark these with INTO
.
scp
target.
The commercial at (@
) is placed between theuser
andhost
parameters asuser
@
host
.
This would run sudo rm -rf /usr, which is not what we want to happen.
$Id: code.html,v 1.4 2010/08/13 17:33:34 ksb Exp $