DocBook 5.1: The Definitive Guide  (Version 1.5.3 for DocBook 5.1)

filename

filename — The name of a file.

Synopsis

filename ::= [-]

Attributes

Common attributes and common linking attributes.

Additional attributes:

  • class (enumeration)
    • “devicefile”
    • “directory”
    • “extension”
    • “headerfile”
    • “libraryfile”
    • “partition”
    • “symlink”
  • path

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.

Attributes

Common attributes and common linking attributes.

class

Identifies the class of filename

Enumerated values:
“devicefile”

A device

“directory”

A directory

“extension”

A filename extension

“headerfile”

A header file (as for a programming language)

“libraryfile”

A library file

“partition”

A partition (as of a hard disk)

“symlink”

A symbolic link

path

Specifies the path of the filename

Children

The following elements occur in filename: 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

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example filename</title>

<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>

</article>

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