@claRef(TEXT)

Insert text into paragraph which refers to a command line argument.

The following parameters are recognized:

TEXT

Text to be displayed (like: "-rdir @nstDataDir()").

This macro is intended to be used when one wants to refer to a particular command line argument (or set of command line arguments) within a paragraph of text. DO NOT add any additional text decorations, styles or formatting when using this macro!

Example of using the macro:

@p("If you specify @claRef("--mode remove") on the
command line, the entire application will be removed from the system
(include @claRef("--verbose") to see details).")

Assuming the com.ccg.macros.at.All class is within your CLASSPATH and the config/html.at macros file has been generated (Hint: run make atmacros in the wui directory), a developer should be able to run the above example by copy/pasting from below:

[root@probe root]# java com.ccg.macros.at.All <<EOF
@include("config/html.at",,"d")
@p("If you specify @claRef("--mode remove") on the
command line, the entire application will be removed from the system
(include @claRef("--verbose") to see details).")
EOF

This macro is defined as:

\"@htmlEntity("span","@param(0)","@htmlAttr("class","claRef")")\"