第27章 ヘルプとドキュメント

目次

27.1. ドキュメントディレクトリ
27.2. manページ
27.3. 情報ページ
27.4. リソースのオンライン化

概要

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

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

この従来のヘルプディレクトリには、システムのさまざまなドキュメントファイルやリリースノートが格納されます。このディレクトリのpackagesサブディレクトリには、インストール済みパッケージの情報も含まれています。詳細については27.1項 「ドキュメントディレクトリ」 を参照 てください。

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

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

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

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

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

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

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

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

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

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

27.1.1. 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.suse.com/documentation/)で参照できます。

27.1.2. HOWTO(操作方法)

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

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

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

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

27.2. manページ

マニュアルページは、どのLinuxシステムにおいても重要な役割を担っています。マニュアルページでは、コマンドと利用可能なオプションおよびパラメータについての使用法が説明されています。マニュアルページは、manの後にコマンド名(たとえば「man ls」)を入力して開くことができます。

マニュアルページは、シェルに直接表示されます。ナビゲートするには、Page ↑およびPage ↓を使用して上下に移動します。<Home>キーと<End>キーを使用すると、それぞれドキュメントの最初と最後に移動できます。<Q>キーを押すと、この表示モードが終了します。manコマンド自体の詳細については、「man man」と入力します。マニュアルページは、表27.1「マニュアルページ—カテゴリと説明」(マニュアルページ自身から抽出)に示すように、カテゴリ別にソートされています。

表27.1 マニュアルページ—カテゴリと説明

数値

説明

1

実行可能プログラムまたはシェルコマンド

2

システムコール(カーネルによって提供される機能)

3

ライブラリコール(プログラムライブラリ内での機能)

4

特別なファイル(通常は/dev内にあります)

5

ファイル形式と命名規則(/etc/fstab)

6

ゲーム

7

その他(マクロパッケージおよび規則)、例: man(7)、groff(7)

8

システム管理コマンド(通常はrootに関するもののみ;)

9

カーネルルーチン(非標準)


各マニュアルページは、NAMESYNOPSISDESCRIPTIONSEE ALSOLICENSINGおよびAUTHORといういくつかのパートで構成されています。コマンドのタイプによっては、他のセクションが追加されている場合があります。

27.3. 情報ページ

情報ページは、システム上にあるもう1つの重要な情報ソースです。通常、情報ページの内容はマニュアルページよりも詳細です。特定のコマンドのinfoページを表示するには、infoの後にコマンド名(たとえば「info ls」)を入力します。シェルで直接ビューアを使用してinfoページを参照し、ノードと呼ばれるさまざまなセクションを表示できます。と呼ばれるさまざまなセクションを表示できます。Spaceを使用して前に移動し、<—を使用して後ろに移動します。ノード内で、Page ↑およびPage ↓を使用して参照することもできますが、前および後ろのノードにも移動できるのはSpaceおよび<—のみです。Qを押すと、表示モードを終了します。すべてのマニュアルページにinfoページが付属するわけではありません。逆も同様です。

27.4. リソースのオンライン化

/usr/share/docにインストールされたオンラインバージョンのNovellマニュアルに加えて、Webで製品固有のマニュアルやドキュメントにアクセスすることもできます。利用可能なすべてのSUSE Linux Enterprise Desktopマニュアルの概要については、製品固有のドキュメントに関するWebページ(http://www.novell.com/documentation/)をご覧してください。

製品ごとの追加情報を検索する場合は、次のWebサイトも参照してください。

Novellテクニカルサポートナレッジベース

Novellテクニカルサポートのナレッジベースは、http://www.novell.com/support/で見つけることができます。このナレッジベースは、SUSE Linux Enterprise Desktopの技術的な問題に対するソリューションとして書かれた記事を提供します。

Novellフォーラム

Novell製品に関して議論できるいくつかのフォーラムがあります。リストについては、http://forums.novell.com/を参照してください。

Cool Solutions

記事、ヒント、質疑応答、およびダウンロードできる無料ツールを提供するオンラインコミュニティ(http://www.novell.com/communities/coolsolutions)

KDEマニュアル

KDEの多数の側面を解説するユーザと管理者向けのマニュアル(http://www.kde.org/documentation/)

GNOMEマニュアル

GNOMEユーザ、管理者、および開発者向けのマニュアル(http://library.gnome.org/)

Linux Documentation Project

TLDP(Linux Documentation Project)は、Linux関係のマニュアルを作成するボランティアチームによって運営されています(http://www.tldp.org参照)。これは、おそらく、Linuxに関する最も総合的なドキュメントリソースです。マニュアルのセットには初心者向けのチュートリアルも含まれますが、主にシステム管理者などの経験者向けの内容になっています。TLDPは、HOWTO(操作方法)、FAQ(よくある質問)、ガイド(ハンドブック)を無償で提供しています。TLDPからのドキュメントの一部は、SUSE Linux Enterprise Desktop上でも利用できます。

汎用の検索エンジンも使用できます。たとえば、CDへの書き込みやLibreOfficeファイルの変換でトラブルがある場合は、検索する語句として Linux CD-RW help(Linux CD-RWヘルプ)またはOpenOffice file conversion problem (OpenOfficeファイルの変換の問題)を使用します。また、Google™ にはLinux用の検索エンジンhttp://www.google.com/linuxも用意されています。このエンジンを利用すれば、有益な情報を探し出すことができます。