texinfo: Useful Highlighting

Indicating

@code

Back to Software Index

9.1.1 Highlighting Commands are Useful
--------------------------------------

The commands serve a variety of purposes:

'@code{SAMPLE-CODE}'
     Indicate text that is a literal example of a piece of a program.
     Note: @code.

'@kbd{KEYBOARD-CHARACTERS}'
     Indicate keyboard input.  Note: @kbd.

'@key{KEY-NAME}'
     Indicate the conventional name for a key on a keyboard.  Note:
     @key.

'@samp{TEXT}'
     Indicate text that is a literal example of a sequence of
     characters.  Note: @samp.

'@verb{TEXT}'
     Write a verbatim sequence of characters.  Note: @verb.

'@var{METASYNTACTIC-VARIABLE}'
     Indicate a metasyntactic variable.  Note: @var.

'@env{ENVIRONMENT-VARIABLE}'
     Indicate an environment variable.  Note: @env.

'@file{FILE-NAME}'
     Indicate the name of a file.  Note: @file.

'@command{COMMAND-NAME}'
     Indicate the name of a command.  Note: @command.

'@option{OPTION}'
     Indicate a command-line option.  Note: @option.

'@dfn{TERM}'
     Indicate the introductory or defining use of a term.  Note: @dfn.

'@cite{REFERENCE}'
     Indicate the name of a book.  Note: @cite.

'@abbr{ABBREVIATION}'
     Indicate an abbreviation, such as 'Comput.'.

'@acronym{ACRONYM}'
     Indicate an acronym.  Note: @acronym.

'@indicateurl{UNIFORM-RESOURCE-LOCATOR}'
     Indicate an example (that is, nonfunctional) uniform resource
     locator.  Note: @indicateurl.  (Use '@url' (Note: @url) for
     live urls.)

'@email{EMAIL-ADDRESS[, DISPLAYED-TEXT]}'
     Indicate an electronic mail address.  Note: @email.