userinput

userinput — Data entered by the user.

Synopsis

userinput ::=

Description

The userinput element identifies words or phrases that the user is expected to provide as input to a computer program.

Note that userinput is not a verbatim environment, but an inline.

Processing expectations

Formatted inline. Often presented in a fixed-width font.

Attributes

Common linking attributes.

any attribute

Any attribute in any other explicit namespace

Children

The following elements occur in userinput: text, abbrev, accel, acronym, alt, anchor, annotation, biblioref, co, code, command, computeroutput, constant, coref, date, email, emphasis (db._emphasis), envar, filename, firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), guibutton, guiicon, guilabel, guimenu, guimenuitem, guisubmenu, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, keycap, keycode, keycombo, keysym, link, literal, markup, menuchoice, mousebutton, nonterminal, olink, option, optional, package, parameter, phrase (db._phrase), prompt, property, quote (db._quote), remark, replaceable, shortcut, subscript, superscript, symbol, systemitem, tag, termdef, token, trademark, uri, userinput, wordasword, xref.

Examples

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example userinput</title>
  | 
  |<para>At the system prompt, enter <userinput>xyzzy</userinput> to gain
5 |supervisor access to the system.
  |</para>
  | 
  |</article>

At the system prompt, enter xyzzy to gain supervisor access to the system.