filename

filename — The name of a file

Synopsis

Mixed Content Model

filename ::=
(#PCDATA|link|olink|ulink|action|application|classname|methodname|
 interfacename|exceptionname|ooclass|oointerface|ooexception|
 package|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
path	CDATA	None
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.

Parents

These elements contain filename: action, application, attribution, bibliomisc, bridgehead, citation, citetitle, classsynopsisinfo, code, command, computeroutput, database, emphasis, entry, filename, firstterm, foreignphrase, funcparams, funcsynopsisinfo, function, glosssee, glossseealso, glossterm, hardware, interfacename, keycap, lineannotation, link, literal, literallayout, lotentry, member, msgaud, olink, option, optional, para, parameter, phrase, primary, primaryie, productname, programlisting, property, quote, refdescriptor, refentrytitle, refname, refpurpose, remark, screen, screeninfo, secondary, secondaryie, see, seealso, seealsoie, seeie, seg, segtitle, simpara, subtitle, synopsis, systemitem, td, term, termdef, tertiary, tertiaryie, th, title, titleabbrev, tocback, tocentry, tocfront, trademark, ulink, userinput.

Children

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

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.