Suppose I would like to document the Unix mv command. How can I markup the 
two filenames as parts that have to be replaced? There are several 
conventions, like: use all caps (mv FILE1 FILE2) or use angle brackets (mv 
<file1> <file2>). To me, this is nothing more than a compromise, since all 
those characters (caps, <, and >) could also be part of the command; they 
are valid characters on the command line. Modern display solutions (like a 
webbrowser) provide a much better way, namely typographic conventions, 
e.g., we markup parts to be replaced in italics. This is a proper way to do 
it since it introduces a real meta level.

So how to encode the italics solution in Asciidoc?

It turns out that a listings block, which I normally would use, does not 
allow to use italics. My current solutions are:

To rename a file, use the +mv+ command:

+mv _FILE1_ _FILE2_+

Or, to avoid a new paragraph:

To rename a file, use the +mv+ command: +
+mv _FILE1_ _FILE2_+

Any comments or suggestions on this?

-- 
You received this message because you are subscribed to the Google Groups 
"asciidoc" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/asciidoc.
For more options, visit https://groups.google.com/d/optout.

Reply via email to