filename

$Revision: 1.3 $

$Date: 2002/06/12 11:18:10 $

filename — The name of a file

Synopsis

Mixed Content Model

filename ::=
(#PCDATA|link|olink|ulink|action|application|classname|methodname|
 interfacename|exceptionname|ooclass|oointerface|ooexception|
 command|computeroutput|database|email|envar|errorcode|errorname|
 errortype|errortext|filename|function|guibutton|guiicon|guilabel|
 guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode|
 keycombo|keysym|literal|code|constant|markup|medialabel|
 menuchoice|mousebutton|option|optional|parameter|prompt|property|
 replaceable|returnvalue|sgmltag|structfield|structname|symbol|
 systemitem|uri|token|type|userinput|varname|nonterminal|anchor|
 remark|subscript|superscript|inlinegraphic|inlinemediaobject|
 indexterm|beginpage)*

Attributes

Common attributes

Name

Type

Default

pathCDATANone
moreinfo
Enumeration:
none
refentry
"none"
class
Enumeration:
devicefile
directory
extension
headerfile
libraryfile
partition
symlink
None

Description

A Filename is the name of a file on a local or network disk. It may be a simple name or may include a path or other elements specific to the operating system.

Processing expectations

Formatted inline. The MoreInfo attribute can help generate a link or query to retrieve additional information.

Future Changes

The content model of Filename will be constrained to (#PCDATA | Replaceable | InlineGraphic) in DocBook V4.0.

Future Changes

Filename extensions can be explicitly identified with the extension class value.

Attributes

class

Class allows the author to identify particular kinds of files.

moreinfo

If MoreInfo is set to RefEntry, it implies that a RefEntry exists which further describes the Filename.

path

Path contains the search path, possibly in a system or application specific form, on which the file can be found.

See Also

application, computeroutput, database, envar, hardware, medialabel, productname, prompt, systemitem, userinput.

Examples

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
The symbolic constants for error numbers are defined in
<filename class='headerfile'>errno.h</filename> in
<filename class='directory'>/usr/include/sys</filename>.
</para>

The symbolic constants for error numbers are defined in errno.h in /usr/include/sys.

For additional examples, see also constant, errorcode, keycap, keycode, keysym, literal, variablelist.