.Dd January 17, 1997
.Dt SGMLFMT 1
.\"0 .Sh NAME
.Sh 名前
.Nm sgmlfmt
.\"0 .Nd Formats SGML files tagged according to the linuxdoc DTD.
.Nd linuxdoc DTD でタグ付けされた SGML ファイルを整形する
.\"0 .Sh SYNOPSIS
.Sh 書式
.Nm
.\"0 .Fl f Ar format
.Fl f Ar フォーマット
.\"0 .Op Fl links
.Op Fl links
.\"0 .Op Fl i Ar name ...
.Op Fl i Ar 名前 ...
.\"0 .Op Fl e Ar encoding
.Op Fl e Ar エンコーディング
.\"0 .Op Fl hdr Ar file
.Op Fl hdr Ar ファイル
.\"0 .Op Fl ftr Ar file
.Op Fl ftr Ar ファイル
.Op Fl n
.Op Fl b
.\"0 .Ar file
.Ar ファイル
.\"0 .Sh DESCRIPTION
.Sh 説明
.\"0 The
.\"0 .Nm
.\"0 command reads SGML files tagged according to the linuxdoc DTD,
.\"0 validates them using the
.\"0 .Xr sgmls 1
.\"0 parser and then converts them to the specified output format.
.Nm
コマンドは linuxdoc DTD でタグ付けされた SGML ファイルを読み、
.Xr sgmls 1
パーザを使って構文チェック(validate)を行い、指定された出力
形式に変換する。
.\"0 The input file must include the following document type
.\"0 declaration before any uncommented text:
入力ファイル内では、コメントアウトされていないテキストが
現われる前に以下の文書型定義(DTD, document type declaration)
を書かなければならない:
.Bd -literal -offset indent
<!DOCTYPE linuxdoc PUBLIC "-//FreeBSD//DTD linuxdoc//EN">
.Ed
.Pp
.\"0 Options for
.\"0 .Nm
.\"0 include the following:
.Nm
で使えるオプションを以下に示す:
.Bl -tag -width Ds
.\"0 .It Fl f Ar format
.It Fl f Ar フォーマット
.\"0 Determines the output format which can be one of the following:
出力フォーマットを指定する。フォーマットは以下のいずれかである:
.Bl -tag -width Ds
.It Ar ascii
.\"0 Generates a single output file with the extension 
.\"0 .Pa .ascii
.\"0 suitable for viewing on an ASCII terminal. 
拡張子
.Pa .ascii
を持つファイルを 1 つ生成する。この形式は ASCII 端末で読む時に
使うとよい。
.It Ar html
.\"0 Generates a set of linked HTML files suitable for use with an
.\"0 HTML browser.  A top level file,
.\"0 .Pa file.html ,
.\"0 contains the title, author, date, abstract and brief table of
.\"0 contents for the document.  A file
.\"0 .Pa file_toc.html
.\"0 contains a complete table of contents.  A series of files named
.\"0 .Pa file1.html ,
.\"0 .Pa file2.html ...
.\"0 .Pa filen.html
.\"0 contain the actual text of the document.
互いにリンクされた HTML 群を生成する。この形式は HTML ブラウザ
で見るためのものである。トップレベルのファイルは
.Pa file.html
であり、文書のタイトル、著者、日付、概要、簡単な目次を含む。
実際のテキストは
.Pa file1.html ,
.Pa file2.html ...
.Pa filen.html
という名前で作られる一連のファイルに文書に含まれる。
.It Ar koi8-r
.\"0 Generates a single output file with the extension 
.\"0 .Pa .koi8-r
.\"0 suitable for viewing on an terminal supporting the KOI8-R
.\"0 character encoding. 
拡張子
.Pa .koi8-r
を持つファイルを 1 つ生成する。この形式は、文字エンコーディング
KOI8-R に対応している端末で読む時に使うとよい。
.It Ar latex
.\"0 Generates a single output file with the extension
.\"0 .Pa .latex
.\"0 suitable for processing with LaTeX.
拡張子
.Pa .latex
を持つファイルを 1 つ生成する。この形式は LaTeX で処理するためのもので
ある。
.It Ar latin1
.\"0 Generates a single output file with the extension 
.\"0 .Pa .latin1
.\"0 suitable for viewing on an terminal supporting the ISO8859-1
.\"0 character encoding. 
拡張子
.Pa .latin1
を持つファイルを 1 つ生成する。この形式は、文字エンコーディング
ISO8859-1 に対応している端末で読む時に使うとよい。
.It Ar nippon
.\"0 Generates a single output file with the extension 
.\"0 .Pa .euc-jp
.\"0 suitable for viewing on an terminal supporting the euc-jp
.\"0 character encoding. 
拡張子
.Pa .euc-jp
を持つファイルを 1 つ生成する。この形式は、文字エンコーディング
euc-jp に対応している端末で読む時に使うとよい。
.It Ar ps
.\"0 Generates a single output file with the extension 
.\"0 .Pa .ps
.\"0 suitable for printing or display on a PostScript compatible device.
拡張子
.Pa .ps
を持つファイルを 1 つ生成する。この形式は、PostScript 互換デバイスで
表示または印刷を行う時に使うとよい。
.It Ar roff
.\"0 Generates a single output file with the extension
.\"0 .Pa .roff
.\"0 suitable processing with
.\"0 .Xr groff 1 .
拡張子
.Pa .roff
を持つファイルを 1 つ生成する。この形式は
.Xr groff 1
で処理するためのものである。
.\"0 This is actually an intermediate conversion used by the
.\"0 .Fl f Ar ascii ,
.\"0 .Fl f Ar latin1 ,
.\"0 .Fl f Ar koi8-r ,
.\"0 and
.\"0 .Fl f Ar ps
.\"0 format options.
この形式は実際には整形オプション
.Fl f Ar ascii ,
.Fl f Ar latin1 ,
.Fl f Ar koi8-r ,
.Fl f Ar euc-jp ,
.Fl f Ar ps
による変換の途中で使われる。
.El
.\" .It Fl e Ar encoding
.It Fl e Ar エンコーディング
.\"0 When used with the
.\"0 .Fl f Ar html
.\"0 output format, this specifies the document encoding recorded in
.\"0 the <HEAD> element of the generated HTML files.  The default is
.\"0 iso-8859-1.
出力フォーマット
.Fl f Ar html
と組み合わせて使うと、このオプションは生成される HTML ファイルの
<HEAD> 要素に記録される文書のエンコーディングを指定する。
デフォルト値は iso-8859-1 である。
.\" .It Fl i Ar name
.It Fl i Ar 名前 (name)
.\"0 Pretend that
.\"0 .Dl <!ENTITY % name "INCLUDE">
.\"0 occurs at the start of the document type declaration subset in
.\"0 the document entity.  Since repeated definitions of an entity are
.\"0 ignored, this definition will take precedence over any other
.\"0 definitions of this entity in the document type declaration.
文書エンティティ内における文書型定義のサブセットの最初の部分に
.Dl <!ENTITY % name "INCLUDE">
が現われたかのように扱う。エンティティの定義を繰り返しても無視されるので、
この定義は文書型定義におけるこのエンティティの他のどの定義よりも優先さ
れる。
.\"0 Multiple 
.\"0 .Fl i
.\"0 options are allowed.  If the declaration replaces the reserved
.\"0 name INCLUDE then the new reserved name will be the replacement
.\"0 text of the entity.  Typically the document type declaration will
.\"0 contain
.\"0 .Dl <!ENTITY % name "IGNORE">
.\"0 and will use 
.\"0 .Li %name; 
.\"0 in the status keyword specification of a
.\"0 marked section declaration.  In this case the effect of the
.\"0 option will be to cause the marked section not to be ignored.
.Fl i
オプションは複数個指定してもよい。予約名 INCLUDE が宣言によって置き換え
られた場合には、その新しい予約名がテキスト置き換えのエンティティとなる。
普通は文書型定義には
.Dl <!ENTITY % name "IGNORE">
が含まれ、マークされたセクション宣言の状態キーワード指定では
.Li %name;
が使われる。この場合、このオプションの効果により、
マークされたセクションは無視されなくなる。
.It Fl links
.\"0 When used with the
.\"0 .Fl f Ar html
.\"0 option, this option generates a shell script named
.\"0 .Pa file.ln .
.Fl f Ar html
オプションと組み合わせて使うと、このオプションは
.Pa file.ln
という名前のシェルスクリプトを生成する。
.\"0 For each 
.\"0 .Li <label id="foo">
.\"0 in the document source,
.\"0 .Pa file.ln
.\"0 generates a symbolic link
.\"0 .Pa foo.html
.\"0 pointing to the numbered
.\"0 .Pa .html
.\"0 file containing the reference.  Since the number of the file
.\"0 containing a particular section can change when a document
.\"0 is modified, this provides a convenient hook by which separate
.\"0 documents can provide links into another document without the
.\"0 links becoming invalid when the target document is modified.
ソース文書中のそれぞれの
.Li <label id="foo">
について、
.Pa file.ln
はシンボリックリンク
.Pa foo.html
を生成する。このシンボリックリンクは参照されているラベルを含んでいる
.Pa .html
ファイル(番号付き)を指す。あるセクションを含むファイルの番号は
文書の変更に伴って変わることがあるが、このオプションをフックとして
使えば、対象の文書が変更された時にリンクが不正にならないようにしつつ
別の文書にリンクを張ることが容易にできる。
.\"0 When creating a symbolic link, any occurrence of a slash (/) in label 
.\"0 is replaced with percent (%), while any occurrence of a space is replaced
.\"0 with an underscore (_).
シンボリックリンクを作る時には、ラベル内に現われたスラッシュ(/)は
全てパーセント記号(%)に置き換えられる。また、現われた空白は全て
アンダースコア(_)に置き換えられる。
.\" .It Fl hdr Ar file
.It Fl hdr Ar ファイル
.\" .It Fl ftr Ar file
.It Fl ftr Ar ファイル
.\"0 When used with the
.\"0 .Fl f Ar html
.\"0 option, the contents of the specified files will be inserted into
.\"0 the generated HTML files at the top (
.\"0 .Fl hdr )
.\"0 and bottom (
.\"0 .Fl ftr )
.\"0 of the page.
.Fl f Ar html
オプションと組み合わせて使うと、指定されたファイルの内容が
生成された HTML ファイルのページ先頭(
.Fl hdr )
またはページ末尾(
.Fl ftr )
に挿入される。
.It Fl n
.\"0 no page break for text conversion (ascii, latin1, koi8-r, and euc-jp).
テキスト変換(ascii, latin1, koi8-r, euc-jp)時にページ区切りを入れない。
.It Fl b
.\"0 use
.\"0 .Dl "col -bx"
.\"0 instead of
.\"0 .Dl "col"
.\"0 to format the text conversion.
テキスト変換の際に
.Dl "col"
でなく
.Dl "col -bx"
を使う。
.br
( "-f nippon" または "-e euc-jp" を指定すると、
自動的にこのオプションが追加される。)
.El
.Pp
.\"0 If the input file name ends with
.\"0 .Pa .sgml ,
.\"0 the extension may be omitted on the command line.
入力ファイル名が
.Pa .sgml
で終わる場合は、コマンドラインでの拡張子は省略できる。
.\"0 In all cases, the output files are created in the current working
.\"0 directory.
どんな場合でも、出力ファイルはカレント作業ディレクトリに作られる。
.\"0 .Sh FILES
.Sh ファイル
.Pa /usr/local/share/sgml/transpec
.\"0 - directory containing translation specification files for
.\"0 .Xr instant 1 .
- 
.Xr instant 1
のための変換指定ファイルが置かれているディレクトリ。
.\"0 .Sh SEE ALSO
.Sh 関連項目
.Xr groff 1 ,
.Xr instant 1 ,
.Xr sgmls 1 ,
.Xr transpec 5
.\"0 .Sh AUTHORS
.Sh 著者
.\"0 The
.\"0 .Nm
.\"0 command was written by John Fieber
.\"0 .Aq jfieber@FreeBSD.org .
.Nm
コマンドを最初に書いたのは
John Fieber
.Aq jfieber@FreeBSD.org
である。
.\"0 The linuxdoc DTD was written by Matt Welsh
.\"0 .Aq mdw@cs.cornell.edu 
.\"0 and based on the Qwertz DTD written by Tom Gordon
.\"0 .Aq thomas.gordon@gmd.de .
linuxdoc DTD は
Matt Welsh
.Aq mdw@cs.cornell.edu 
が書いた。これは Tom Gordon 
.Aq thomas.gordon@gmd.de
が書いた Qwertz DTD をベースにしている。
