filename

$Revision: 1.3 $

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

filename — The name of a file

Synopsis

Mixed Content Model

filename ::=
(#PCDATA|replaceable|inlinemediaobject)*

Attributes

Common attributes

Name

Type

Default

pathCDATANone
moreinfo

Enumeration:

none
refentry
"none"
class

Enumeration:

devicefile
directory
headerfile
libraryfile
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.

Children

The following elements occur in filename: inlinemediaobject, replaceable.

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

computeroutput, 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 literal, variablelist.