Simplified DocBook: The Definitive Guide  (Version 0.9.1 for Simplified DocBook 5.1)

filename

filename — The name of a file.

Synopsis

filename ::= [x]  [+]

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

Parents

These elements contain filename: caption (db.html.caption), citetitle, computeroutput, emphasis, entry, link, literallayout, orgdiv, para, phrase (db.phrase), programlisting, quote, subtitle, td, term, th, title, titleabbrev, userinput.

Children

The following elements occur in filename: text, inlinemediaobject, phrase (db._phrase), replaceable, subscript, superscript.

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.