O'Reilly logo

DocBook 5: The Definitive Guide by Richard L. Hamilton, Norman Walsh

Stay ahead with the world's most comprehensive technology and business learning platform.

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, tutorials, and more.

Start Free Trial

No credit card required

Name

filename — The name of a file

Synopsis

filename ::= (text | phrase db._phrase | replaceable | Graphic inlines | Indexing inlines | Linking inlines | Ubiquitous inlines)*

Attribute synopsis

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

See Also

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

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>

With Safari, you learn the way you learn best. Get unlimited access to videos, live online training, learning paths, books, interactive tutorials, and more.

Start Free Trial

No credit card required