envar

envar — A software environment variable.

Synopsis

envar ::=

Zero or more of:
- text
- replaceable
- Graphic inlines
  - inlinemediaobject
- Indexing inlines
  - indexterm (db.indexterm.endofrange)
  - indexterm (db.indexterm.singular)
  - indexterm (db.indexterm.startofrange)
- Linking inlines
- Ubiquitous inlines
  - abbrev
  - acronym
  - alt
  - anchor
  - annotation
  - biblioref
  - coref
  - date
  - emphasis (db._emphasis)
  - firstterm (db._firstterm)
  - footnote
  - footnoteref
  - foreignphrase (db._foreignphrase)
  - glossterm (db._glossterm)
  - indexterm (db.indexterm.endofrange)
  - indexterm (db.indexterm.singular)
  - indexterm (db.indexterm.startofrange)
  - inlinemediaobject
  - link
  - olink
  - phrase (db._phrase)
  - quote (db._quote)
  - remark
  - subscript
  - superscript
  - trademark
  - wordasword
  - xref

Attributes

Common linking attributes.

None.

Description

An envar is an “environment variable.” Environment variables are used most often in the UNIX, DOS, and Windows environments.

Processing expectations

Formatted inline.

Attributes

Common linking attributes.

any attribute: Any attribute in any other explicit namespace

Parents

These elements contain envar: bridgehead, caption (db.html.caption), citation, citetitle, classsynopsisinfo, computeroutput, contrib, emphasis (db.emphasis), entry, enumitemdescription, firstterm (db.firstterm), funcsynopsisinfo, glosssee, glossseealso, glossterm (db.glossterm), link, literallayout, member, meta (db.meta.content), 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, synopsisinfo, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocentry, userinput.

Children

The following elements occur in envar: text, abbrev, acronym, alt, anchor, annotation, biblioref, coref, date, emphasis (db._emphasis), firstterm (db._firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), glossterm (db._glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlinemediaobject, link, olink, phrase (db._phrase), quote (db._quote), remark, replaceable, subscript, superscript, trademark, wordasword, xref.

Examples

1 |<article xmlns='http://docbook.org/ns/docbook'>
  |<title>Example envar</title>
  | 
  |<para>In order to translate public identifiers into local system identifiers,
5 |<application>Jade</application> and <application>SP</application> read the catalog files
  |pointed to by <envar>SGML_CATALOG_FILES</envar>.
  |</para>
  | 
  |</article>

In order to translate public identifiers into local system identifiers, Jade and SP read the catalog files pointed to by SGML_CATALOG_FILES.