Section 4.15 Consoles
Subsection 4.15.1 Content and Placement of Consoles
A
<console>
is a transcript of an interactive session in a terminal or console at a command-line. It is a sequence of the following elements, in this order, possibly repeated many times as a group: <input>
, and <output>
. The <output>
is optional. The content of these two elements is treated as verbatim text (see Section 3.16), subject to all the exceptions for exceptional characters (see Section 3.14). A @prompt
attribute on the <input>
can be supplied to provide a system prompt distinct from the actual commands. The default prompt is a dollar sign followed by a space. If it is more convenient @prompt
may be supplied on the <console>
, to be used in each enclosed <input>
. If you do not want any prompts at all, just use an empty value for @prompt
.A
<console>
may be wrapped in a <listing>
, see Section 4.20. This will behave similar to a <figure>
, with the <caption>
displayed below, and a number assigned. So, in particular, if your program is important enough to cross-reference, it is an enclosing <listing>
that serves as the target.