.Dd September 9, 1995 .Os FreeBSD 2.1 .Dt SGMLFMT 1 .Sh NAME .Nm sgmlfmt .Nd Formats SGML files tagged according to the linuxdoc DTD. .Sh SYNOPSIS .Nm .Fl f Ar format .Op Fl links .Op Fl ssi .Op Fl i Ar name ... .Ar file .Sh DESCRIPTION The .Nm command reads SGML files tagged according to the linuxdoc DTD, validates them using the .Xr sgmls 1 parser and then converts them to the specified output format. The input file must include the following document type declaration before any uncommented text: .Bd -literal -offset indent .Ed .Pp Options for .Nm include the following: .Bl -tag -width Ds .It Fl f Ar format Determines the output format which can be one of the following: .Bl -tag -width Ds .It Ar ascii Generates a single output file with the extension .Pa .ascii suitable for viewing on an ASCII terminal. .It Ar html Generates a set of linked HTML files suitable for use with an HTML browser. A top level file, .Pa file.html , contains the title, author, date, abstract and brief table of contents for the document. A file .Pa file_toc.html contains a complete table of contents. A series of files named .Pa file1.html , .Pa file2.html ... .Pa filen.html contain the actual text of the document. .It Ar koi8-r Generates a single output file with the extension .Pa .koi8-r suitable for viewing on an terminal supporting the KOI8-R character encoding. .It Ar latex Generates a single output file with the extension .Pa .latex suitable for processing with LaTeX. Note that the LaTeX style file .Pa /usr/share/sgml/FreeBSD/linuxdoc.sty must be accessible to LaTeX for correct processing. .It Ar latin1 Generates a single output file with the extension .Pa .latin1 suitable for viewing on an terminal supporting the ISO8859-1 character encoding. .It Ar ps Generates a single output file with the extension .Pa .ps suitable for printing or display on a PostScript compatible device. .It Ar roff Generates a single output file with the extension .Pa .roff suitable processing with .Xr groff 1 . This is actually an intermediate conversion used by the .Fl f Ar ascii , .Fl f Ar latin1 , .Fl f Ar koi8-r , and .Fl f Ar ps format options. .El .It Fl i Ar name Pretend that .Dl occurs at the start of the document type declaration subset in the document entity. Since repeated definitions of an entity are ignored, this definition will take precedence over any other definitions of this entity in the document type declaration. Multiple .Fl i options are allowed. If the declaration replaces the reserved name INCLUDE then the new reserved name will be the replacement text of the entity. Typically the document type declaration will contain .Dl and will use .Li %name; in the status keyword specification of a marked section declaration. In this case the effect of the option will be to cause the marked section not to be ignored. .It Fl links When used with the .Fl f Ar html option, for each .Li