DocBook: The Definitive Guide
PrevVersion 1.0.3.Next

EnVar

Name

EnVar -- A software environment variable

Synopsis

Mixed Content Model

EnVar ::=
((#PCDATA|Replaceable|InlineGraphic|InlineMediaObject|IndexTerm)+)

Attributes

Common attributes

Tag Minimization

Both the start- and end-tags are required for this element.

Parameter Entities

%cptr.char.mix;%ndxterm.char.mix;%para.char.mix;
%programlisting.content;%refinline.char.mix;%refname.char.mix;
%screen.content;%tbl.entry.mdl;%tech.char.class;
%title.char.mix;

Description

EnVar is an environment variable used most often for the UNIX, DOS, or Windows environments.

Processing expectations

Formatted inline.

Parents

These elements contain EnVar: Action, Application, Attribution, BiblioMisc, BridgeHead, Citation, CiteTitle, Command, Comment, ComputerOutput, Database, Emphasis, entry, Filename, ForeignPhrase, FuncParams, FuncSynopsisInfo, Function, GlossSee, GlossSeeAlso, GlossTerm, Hardware, Interface, InterfaceDefinition, KeyCap, LineAnnotation, Link, Literal, LiteralLayout, LoTentry, Member, MsgAud, OLink, Option, Optional, Para, Parameter, Phrase, Primary, PrimaryIE, ProductName, ProgramListing, Property, Quote, RefDescriptor, RefEntryTitle, RefName, RefPurpose, Screen, ScreenInfo, Secondary, SecondaryIE, See, SeeAlso, SeeAlsoIE, SeeIE, Seg, SegTitle, SimPara, Subtitle, Synopsis, SystemItem, Term, Tertiary, TertiaryIE, Title, TitleAbbrev, ToCback, ToCentry, ToCfront, Trademark, ULink, UserInput.

Children

The following elements occur in EnVar: IndexTerm, InlineGraphic, InlineMediaObject, Replaceable.

In some contexts, the following elements are allowed anywhere: BeginPage, IndexTerm.

In some contexts, the following elements are excluded: IndexTerm.

See Also

ComputerOutput, Filename, Prompt, SystemItem, UserInput

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
<para>
In order to translate public identifiers into local system identifiers,
<application>Jade</> and <application>SP</> read the catalog files
pointed to by <envar>SGML_CATALOG_FILES</envar>.
</para>

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

PrevHomeNext
entrytblUpEpigraph

Copyright © 1999 O'Reilly & Associates, Inc. All rights reserved.