userinput
userinput — Data entered by the user.
Synopsis
- Zero or more of:
- text
- Computer-output inlines
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
email
envar
filename
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
literal
markup
nonterminal
olink
option
optional
package
parameter
prompt
property
remark
replaceable
subscript
superscript
symbol
systemitem
tag
termdef
token
uri
userinput
xref
- Graphic inlines
- GUI inlines
- Indexing inlines
- Keyboard inlines
- Linking inlines
- Markup inlines
- Operating system inlines
- Technical inlines
- Ubiquitous inlines
alt
anchor
annotation
biblioref
indexterm
(db.indexterm.endofrange)indexterm
(db.indexterm.singular)indexterm
(db.indexterm.startofrange)inlinemediaobject
link
olink
remark
subscript
superscript
xref
- User-input inlines
accel
alt
anchor
annotation
biblioref
co
code
command
computeroutput
constant
email
envar
filename
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
prompt
property
remark
replaceable
shortcut
subscript
superscript
symbol
systemitem
tag
termdef
token
uri
userinput
xref
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.
This element occurs in 51 elements.
This element contains 53 elements.
See Also
computeroutput
, constant
, envar
, filename
, lineannotation
, literal
, literallayout
, markup
, option
, optional
, parameter
, programlisting
, prompt
, replaceable
, screen
, screenshot
, synopsis
, systemitem
, tag
, varname
Examples
1 <article xmlns='http://docbook.org/ns/docbook'> 2 <title>Example userinput</title> 4 <para>At the system prompt, enter <userinput>xyzzy</userinput> to gain supervisor access to the system. 6 </para> 8 </article>
At the system prompt, enter xyzzy
to gain
supervisor access to the system.