ヘルプとドキュメント

目次

27.1. ドキュメントディレクトリ
27.2. manページ
27.3. 情報ページ

概要

SUSE® Linux Enterprise Desktopではさまざまな情報源とドキュメントが提供されており、その多くはインストール済みのシステムに統合されています。

/usr/share/doc内のドキュメント

この従来のヘルプディレクトリには、システムのさまざまなドキュメントファイルやリリースノートが格納されます。詳細については「27.1項 「ドキュメントディレクトリ」」を参照してください。

シェルコマンドのマニュアルページと情報ページ

シェルを使用する場合は、コマンドのオプションを記憶しておく必要はありません。シェルは以前からマニュアルページおよび情報ページによって統合ヘルプを提供しています。詳細については「27.2項 「manページ」」および「27.3項 「情報ページ」」を参照してください。

デスクトップヘルプセンター

KDEデスクトップ(KDE help center)とGNOMEデスクトップ(Yelp)の両方のヘルプセンターでは、システムの最も重要なドキュメントリソースに検索可能な形式で一元的にアクセスできます。これらのリソースにはインストール済みのアプリケーションのオンラインヘルプ、マニュアルページ、情報ページ、製品に付属しているNovell/SUSEマニュアルが含まれます。

一部のアプリケーション用の別なヘルプパッケージ

YaSTを使って新しくソフトウェアをインストールした場合、通常はそのソフトウェアのドキュメントも自動的にインストールされ、デスクトップのHelp Centerに表示されます。ただし、GIMPなどの一部のアプリケーションは、YaSTとは別個にインストールされる独自のオンラインヘルプパッケージを利用しており、ヘルプセンターには表示されない場合があります。

ドキュメントディレクトリ

インストールされたLinuxシステム上のドキュメント検索用の従来のディレクトリは、/usr/share/docです。このディレクトリには通常、リリースノート、マニュアルなどに加えて、システムにインストールされたパッケージに関する情報が含まれます。

[Note]インストール済みパッケージに依存する内容

Linuxの世界では、ソフトウェアのように、多くのマニュアル、その他の文書がパッケージ形式で用意されています。/usr/share/docs内の情報の種類および内容は、インストールされている(文書)パッケージに応じて異なります。ここに記載されているサブディレクトリが見つからない場合は、対応するパッケージがシステムにインストールされているかどうかを確認し、必要に応じてYaSTに追加してください。

Novell/SUSEマニュアル

これらのガイドブックは、HTMLおよびPDFの各バージョンを複数の言語で提供しています。manualサブディレクトリでは、製品で使用可能な大半のNovell/SUSEマニュアルのHTMLバージョンがあります。製品で使用可能なすべての文書の概要については、マニュアルの序文を参照してください。

複数の言語がインストールされている場合、/usr/share/doc/manualには異なる言語版のマニュアルが含まれる場合があります。Novell/SUSEマニュアルのHTMLバージョンは、両デスクトップのヘルプセンターでも入手可能です。インストールメディアで文書のPDF版およびHTML版の検索場所については、SUSE Linux Enterprise Desktopのリリースノートを参照してください。これらの文書は、インストールされたシステムの/usr/share/doc/release-notes/、またはオンラインの製品固有のWebページ(http://www.novell.com/documentation/)で参照できます。

HOWTO(操作方法)

howtoパッケージがシステムにインストールされている場合、/usr/share/docにはhowtoサブディレクトリも含まれます。このサブディレクトリには、Linuxソフトウェアのセットアップおよび操作に関連するさまざまなタスクの追加文書があります。

パッケージのドキュメント

packagesの下で、システムにインストールしたソフトウェアパッケージに含まれているドキュメントを見つけてください。各パッケージについて、サブディレクトリ/usr/share/doc/packages/packagenameが作成されます。このサブディレクトリには、パッケージのREADMEファイルが含まれます。さらにサンプル、環境設定ファイル、または追加スクリプトが含まれることがあります。次のリストに、/usr/share/doc/packagesの下にある一般的なファイルを示します。これらの項目はいずれも必須ではなく、多くのパッケージがその一部のみを含みます。

AUTHORS

主な開発者のリスト。

BUGS

既知のバグまたは誤動作。また、Bugzilla Webページへのリンクがあり、そこでバグを検索できる場合があります。

CHANGES , ChangeLog

バージョン間の変更点の概要です。 非常に詳細なものなので、通常は、開発者にとって興味あるものです。

COPYING , LICENSE

ライセンス情報。

FAQ

メーリングリストやニュースグループから集められた質問と答えが含まれています。

INSTALL

システムにこのパッケージをインストールする方法。このファイルに目を通している時点でパッケージがすでにインストールされており、このファイルの内容を無視しても問題はありません。

README, README.*

ソフトウェアに関する一般的な情報。たとえば、ソフトウェアの目的および使用方法などです。

今後の課題

まだ実装されていないものの、今後実装される予定の機能についての説明です。

MANIFEST

ファイルのリストと、それぞれの簡単な概要です。

NEWS

このバージョンでの新しい点が記されています。