222 lines
13 KiB
Plaintext
222 lines
13 KiB
Plaintext
<!-- $XConsortium: ch06.sgm /main/9 1996/08/26 10:45:30 rws $ -->
|
|
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
|
|
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
|
|
<!-- (c) Copyright 1995 International Business Machines Corp. -->
|
|
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
|
|
<!-- (c) Copyright 1995 Novell, Inc. -->
|
|
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
|
|
<!-- (c) Copyright 1995 Hitachi. -->
|
|
<chapter id="HRDC.CmdS.div.1">
|
|
<title id="HRDC.CmdS.mkr.1">コマンドの要約</title>
|
|
<para>この章では、ヘルプ・コマンドが端末ウィンドウで手動で実行されるときに使用可能なコマンド行オプションを要約します。
|
|
</para>
|
|
<sect1 id="HRDC.CmdS.div.2">
|
|
<title>ヘルプ・システム・コマンド</title>
|
|
<para>ヘルプ・システムが提供するデスクトップのアクションとデータ型により、ヘルプ・ファイルのアイコンをクリックするかメニュー項目を選択すると、実行時のヘルプ・ファイルをコンパイルしたり表示することができます。しかし、特定のコマンド・オプションを選択する場合、端末エミュレータで手動でコマンドを入力するか、新しいアクションを作成しなければなりません。
|
|
</para>
|
|
<para>ヘルプのアクションとデータ型は、<filename>/usr/dt/appconfig/types/</filename><symbol role="Variable">lang</symbol> ディレクトリにある２つのファイル <filename>dthelp.dt</filename> および <filename>dtdocbook.dt</filename> に定義されています。
|
|
</para>
|
|
<para>ここで要約されているコマンドは、次のとおりです。</para>
|
|
<informaltable>
|
|
<tgroup cols="2" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="145*">
|
|
<colspec align="left" colwidth="383*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>dtDocBook</command></para></entry>
|
|
<entry align="left" valign="top"><para>DocBook のソース・ファイルを実行ファイルにコンパイルします。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>dthelpview</command></para></entry>
|
|
<entry align="left" valign="top"><para>ヘルプ・ボリューム、ヘルプ・トピック、テキスト・ファイルまたはマニュアル・ページを表示します。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>dthelpgen</command></para></entry>
|
|
<entry align="left" valign="top"><para>各ファミリ・ファイルのエントリが入っている新しいヘルプ・ボリューム <filename>index.hv</filename> にヘルプ・ファミリ・ファイルを格納します。
|
|
</para></entry></row></tbody></tgroup></informaltable>
|
|
</sect1>
|
|
<sect1 id="HRDC.CmdS.div.3">
|
|
<title id="HRDC.CmdS.mkr.2">DocBook ファイルの処理 (dtdocbook)</title>
|
|
<para>DocBook ソフトウェアは、<command>dtdocbook</command> コマンドで起動され、DocBook のソース・ファイルを実行時のヘルプ・ファイルにコンパイルします。<symbol role="Variable">volume</symbol><filename>.sgm</filename> ファイルがあるディレクトリで <command>dtdocbook</command> を実行してください。
|
|
</para>
|
|
<sect2 id="HRDC.CmdS.div.4">
|
|
<title>コマンド形式</title>
|
|
<programlisting>dtdocbook [command-options] volume</programlisting>
|
|
<para><symbol role="Variable">command-options</symbol> は、<symbol role="Variable">volume</symbol> 名の後に入力されるオプションです。</para>
|
|
</sect2>
|
|
<sect2 id="HRDC.CmdS.div.5">
|
|
<title>コマンド・オプション</title>
|
|
<informaltable>
|
|
<tgroup cols="2" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="116*">
|
|
<colspec align="left" colwidth="412*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-c</command></para></entry>
|
|
<entry align="left" valign="top"><para>既存の SDL ファイルを圧縮します。入力ファイルの拡張子は、“<filename>.sdl</filename>” であることを仮定します。</para></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-d</command></para></entry>
|
|
<entry align="left" valign="top"><para>既存の SDL ファイルを伸張します。入力ファイルの拡張子は、“<filename>.sdl</filename>” であることを仮定します。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-h</command></para></entry>
|
|
<entry align="left" valign="top"><para>(ヘルプ) <command>dtdocbook</command> コマンドの形式およびオプションのリストを、標準出力に表示します。
|
|
</para></entry>
|
|
</row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-l</command></para></entry>
|
|
<entry align="left" valign="top"><para>ログを <filename>basename.log</filename> に出力します。</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-m</command></para></entry>
|
|
<entry align="left" valign="top"><para>(マップ) 追加の SDATA および／または文字のマッピング・ファイルを追加します。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-o</command> <filename>file</filename></para></entry>
|
|
<entry align="left" valign="top"><para><filename>file</filename> を出力ファイル名として使用します。ファイル名に拡張子を付けてはいけません。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-r</command></para></entry>
|
|
<entry align="left" valign="top"><para>すべての中間ファイルおよび出力ファイルを削除します。それらが存在しない場合でも、通知はしません。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-u</command></para></entry>
|
|
<entry align="left" valign="top"><para>(非圧縮) 翻訳中、出力ファイルの圧縮を行いません。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-v</command></para></entry>
|
|
<entry align="left" valign="top"><para>(饒舌) <command>dtdocbook</command> の処理中にパーサのメッセージを生成、表示します。
|
|
</para></entry>
|
|
</row></tbody></tgroup></informaltable>
|
|
<para><command>-c</command> オプションが指定され、ファイルがすでに圧縮されている場合は、ファイルは伸張されてから、再度圧縮されます。この処理は、圧縮された SDL ファイルの統合性を検証する手段として有用です。
|
|
</para>
|
|
<para><command>-d</command> オプションが指定され、ファイルがすでに伸張されている場合は、再度の解析、すべての前計算の実行が行われ、ファイルは再度書き込まれます。この処理は、SDL ファイルの統合性を検証する手段として有用です。また、たとえば SDL ファイルを直接編集したことによって、再計算が必要になったとき、個々のヘルプ・トピックのバイト・オフセットを含む目次の再計算を強制的に実行させる場合にも有用です。
|
|
</para>
|
|
<sect3 id="HRDC.CmdS.div.7">
|
|
<title>関連項目</title>
|
|
<itemizedlist remap="Bullet1"><listitem><para><xref role="HeadingAndPage"
|
|
linkend="HRDC.CrHV.mkr.2"></para>
|
|
</listitem><listitem><para><xref role="HeadingAndPage" linkend="HRDC.Inst.mkr.5">
|
|
</para>
|
|
</listitem><listitem><para><xref role="HeadingAndPage" linkend="HRDC.CrHV.mkr.6"></para>
|
|
</listitem><listitem><para><filename moreinfo="RefEntry">dtdocbook</filename>(1)
|
|
マニュアル・ページ</para>
|
|
</listitem></itemizedlist>
|
|
</sect3>
|
|
</sect2>
|
|
</sect1>
|
|
<sect1 id="HRDC.CmdS.div.8">
|
|
<title id="HRDC.CmdS.mkr.4">ヘルプ・トピックの表示 (dthelpview)</title>
|
|
<para><command>dthelpview</command> コマンドは、ヘルプ・ボリューム、個々のヘルプ・トピック、テキスト・ファイル、またはマニュアル・ページを表示するために使用できます。
|
|
</para>
|
|
<sect2 id="HRDC.CmdS.div.9">
|
|
<title>コマンド形式</title>
|
|
<para>ヘルプビューを起動するには、次のようにいくつかの方法があります。</para>
|
|
<itemizedlist><listitem><para><command>dthelpview -helpVolume <symbol role="Variable">volume</symbol> [ -locationId <symbol role="Variable">id</symbol> ]</command>
|
|
</para>
|
|
</listitem><listitem><para><command>dthelpview -man</command></para>
|
|
</listitem><listitem><para><command>dthelpview -manPage</command> <symbol role="Variable">man</symbol></para>
|
|
</listitem><listitem><para><command>dthelpview -file</command> <symbol role="Variable">filename</symbol></para>
|
|
</listitem></itemizedlist>
|
|
<para>オプションの機能を次に示します。</para>
|
|
<informaltable>
|
|
<tgroup cols="2" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="188*">
|
|
<colspec align="left" colwidth="340*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-helpVolume</command> <symbol role="Variable">volume</symbol></para></entry>
|
|
<entry align="left" valign="top"><para>表示したい <symbol role="Variable">volume</symbol><filename>.sdl</filename> ファイルの名前を指定します。ボリュームが現在のディレクトリになく、<emphasis>かつ</emphasis>、ボリュームが登録されていない場合はパス名が必要です。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-locationId</command> <symbol role="Variable">id</symbol></para></entry>
|
|
<entry align="left" valign="top"><para>IDを指定します。<command>dthelpview</command> は、<symbol role="Variable">id</symbol> が入っているトピックを表示します。IDを指定しない場合、ヘルプビューはデフォルトとして <filename>_hometopic</filename> を使用します。</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-man</command></para></entry>
|
|
<entry align="left" valign="top"><para>表示するマニュアル・ページを要求するダイアログを表示してから、要求されたマニュアル・ページを表示します。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-manPage</command> <symbol role="Variable">man</symbol></para></entry>
|
|
<entry align="left" valign="top"><para>特定のマニュアル・ページが表示されるように指定します。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-file</command> <symbol role="Variable">filename</symbol></para></entry>
|
|
<entry align="left" valign="top"><para>特定のテキスト・ファイルが表示されるように指定します。
|
|
</para></entry></row></tbody></tgroup></informaltable>
|
|
<para>デフォルトの <symbol role="Variable">volume</symbol> と <symbol role="Variable">id</symbol> は <command>dthelpview</command> の app-defaults ファイルである <filename>/usr/dt/app-defaults/C/Dthelpview</filename> に設定できます。
|
|
</para>
|
|
<sect3 id="HRDC.CmdS.div.10">
|
|
<title>関連項目</title>
|
|
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.9">
|
|
</para>
|
|
</listitem><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.CrHV.mkr.6"></para>
|
|
</listitem><listitem><para><command>dthelpview</command>(1) マニュアル・ページ</para>
|
|
</listitem></itemizedlist>
|
|
</sect3>
|
|
</sect2>
|
|
</sect1>
|
|
<sect1 id="HRDC.CmdS.div.11">
|
|
<title id="HRDC.CmdS.mkr.5">索引ボリュームの生成 (dthelpgen)</title>
|
|
<para><command>dthelpgen</command> ユーティリティは、フロントパネルのヘルプ・ビューアを使用してシステムに登録されたヘルプ・ボリュームを表示できるようにする特殊なヘルプ・ボリュームを作成します。フロントパネルの[ヘルプ・ビューア]コントロールを最初にクリックすると、<command>dthelpgen</command> は自動的に実行されます。ヘルプ検索パス・ディレクトリ（ローカルな、またはネットワーク化されたディレクトリ）を検索してヘルプ・ファミリ・ファイルを位置付け、次にユーザの <filename>HomeDirectory/.dt/help/$DTUSERSESSION</filename> ディレクトリに 索引ボリューム (<filename>index.hv</filename>) を作成します。一度作成されると、ボリュームは次のアクションのいずれかに応じて更新されます。
|
|
</para>
|
|
<itemizedlist><listitem><para>ファミリ・ファイルまたはヘルプ・ボリュームの追加、削除、または変更
|
|
</para>
|
|
</listitem><listitem><para><systemitem class="environvar">LANG</systemitem> 環境変数の変更</para>
|
|
</listitem><listitem><para><literal>ReloadApps</literal> アクションの起動</para>
|
|
</listitem><listitem><para>端末エミュレータ上での <command>dthelpgen</command> の手動による実行
|
|
</para>
|
|
</listitem></itemizedlist>
|
|
<para>索引ボリュームは、フロントパネルの[ヘルプ・ビューア]コントロールをクリックすると表示されます。または、<command>dthelpview</command> を手動で実行し、次のコマンド行で示されているように索引ボリューム名を指定することができます。
|
|
</para>
|
|
<programlisting>dthelpview -h index.hv</programlisting>
|
|
<sect2 id="HRDC.CmdS.div.12">
|
|
<title>コマンド形式</title>
|
|
<programlisting>dthelpgen -dir [<symbol role="Variable">options</symbol>]
|
|
</programlisting>
|
|
<para>オプションの機能を次に示します。</para>
|
|
<informaltable>
|
|
<tgroup cols="2" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="100*">
|
|
<colspec align="left" colwidth="356*">
|
|
<tbody>
|
|
<row>
|
|
<entry><para><command>-dir</command></para></entry>
|
|
<entry><para>索引ボリュームと中間ファイルを格納するディレクトリを指定します。これは、必須のパラメータです。
|
|
</para></entry></row></tbody>
|
|
</tgroup></informaltable>
|
|
</sect2>
|
|
<sect2 id="HRDC.CmdS.div.13">
|
|
<title>オプション</title>
|
|
<informaltable>
|
|
<tgroup cols="2" colsep="0" rowsep="0">
|
|
<colspec align="left" colwidth="167*">
|
|
<colspec align="left" colwidth="361*">
|
|
<tbody>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-generate</command></para></entry>
|
|
<entry align="left" valign="top"><para>システム上のファミリ・ファイルとヘルプ・ボリュームが変更されていない場合でも新しい索引ヘルプ・ボリュームが作成されるように指定します。
|
|
</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-file</command> <symbol role="Variable">basename</symbol></para></entry>
|
|
<entry align="left" valign="top"><para><command>dthelpgen</command> が作成したヘルプ・ボリュームと中間ファイルの名前を指定します。デフォルトの名前は <filename>index.hv</filename> です。</para></entry></row>
|
|
<row>
|
|
<entry align="left" valign="top"><para><command>-lang</command></para></entry>
|
|
<entry align="left" valign="top"><para>どの言語ディレクトリのヘルプ・ファミリとヘルプ・ボリュームを検索するかを指定します。<command>-lang</command> オプションを設定すると、<systemitem class="environvar">LANG</systemitem> 環境変数の現在値よりも優先されます。
|
|
</para></entry>
|
|
</row></tbody></tgroup><?Pub Caret></informaltable>
|
|
<note>
|
|
<para>索引ボリュームがヘルプ・ウィンドウに表示されている間に <command>dthelpgen</command> を実行する場合、ウィンドウを閉じてから索引ボリュームをもう一度開いてください。
|
|
</para>
|
|
</note>
|
|
<sect3 id="HRDC.CmdS.div.14">
|
|
<title>関連項目</title>
|
|
<itemizedlist><listitem><para><xref role="SecTitleAndPageNum" linkend="HRDC.Inst.mkr.9"></para>
|
|
</listitem><listitem><para><command moreinfo="RefEntry">dthelpgen</command>(1)
|
|
マニュアル・ページ</para>
|
|
</listitem></itemizedlist>
|
|
</sect3>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
<!--fickle 1.14 mif-to-docbook 1.7 01/02/96 16:48:20-->
|