userinput
userinput — Data entered by the user.
Synopsis
userinput ::= ![[x]](figs/web/nav/delete.gif)
![[+]](figs/web/nav/right.gif)
![[-]](figs/web/nav/down.gif)
- Zero or more of:
- text
- Computer-output inlines
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Operating system inlines
- Technical inlines
- Ubiquitous inlines
- User-input inlines
Attributes
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.
Parents
These elements contain userinput: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, computeroutput, contrib, emphasis (db.emphasis), entry, firstterm (db.firstterm), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), link, literallayout, member, olink, orgdiv, para, phrase (db.phrase), primary, primaryie, programlisting, quote (db.quote), refdescriptor, refentrytitle, refname, refpurpose, remark, screen, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, userinput.
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.
See Also
Examples
<article xmlns='http://docbook.org/ns/docbook'>
<title>Example userinput</title>
<para>At the system prompt, enter <userinput>xyzzy</userinput> to gain
supervisor access to the system.
</para>
</article>
At the system prompt, enter xyzzy to gain
supervisor access to the system.