38 ヘルプとドキュメント #
SUSE® Linux Enterprise Serverではさまざまな情報源とドキュメントが提供されており、その多くはインストール済みのシステムに統合されています。
/usr/share/doc内のドキュメントこの従来のヘルプディレクトリには、システムのさまざまなドキュメントファイルやリリースノートが格納されます。このディレクトリの
packagesサブディレクトリには、インストール済みパッケージの情報も含まれています。詳細については38.1項 「ドキュメントディレクトリ」 を参照してください。- シェルコマンドのマニュアルページと情報ページ
シェルを使用する場合は、コマンドのオプションを記憶しておく必要はありません。シェルは以前からマニュアルページおよび情報ページによって統合ヘルプを提供しています。詳細については38.2項 「マニュアルページ」および38.3項 「情報ページ」を参照してください。
- デスクトップヘルプセンター
GNOMEデスクトップのヘルプセンター(［Help (ヘルプ)］)では、システムの最も重要なドキュメントリソースに検索可能な形式で一元的にアクセスできます。これらのリソースにはインストール済みのアプリケーションのオンラインヘルプ、マニュアルページ、情報ページ、および製品に付属しているSUSEマニュアルが含まれます。
- 一部のアプリケーション用の別のヘルプパッケージ
YaSTを使って新しくソフトウェアをインストールした場合、通常はそのソフトウェアのドキュメントも自動的にインストールされ、デスクトップのHelp Centerに表示されます。ただし、GIMPなどの一部のアプリケーションは、YaSTとは別個にインストールされる独自のオンラインヘルプパッケージを利用しており、ヘルプセンターには表示されない場合があります。
38.1 ドキュメントディレクトリ #
インストールされたLinuxシステム上のドキュメント検索用の従来のディレクトリは、/usr/share/docです。このディレクトリには通常、リリースノート、マニュアルなどに加えて、システムにインストールされたパッケージに関する情報が含まれます。
Linuxの世界では、ソフトウェアのように、多くのマニュアルとその他の文書はパッケージ形式で用意されています。/usr/share/docs内の情報の種類および内容は、インストールされている(文書)パッケージに応じて異なります。ここに記載されているサブディレクトリが見つからない場合は、対応するパッケージがシステムにインストールされているかどうかを確認し、必要に応じてYaSTに追加してください。
38.1.1 SUSEマニュアル #
これらのガイドブックは、HTMLおよびPDFの各バージョンを複数の言語で提供しています。manualサブディレクトリには、製品で使用可能な大半のSUSEマニュアルのHTMLバージョンがあります。製品で使用可能なすべての文書の概要については、マニュアルの序文を参照してください。
複数の言語がインストールされている場合、/usr/share/doc/manualには異なる言語版のマニュアルが含まれる場合があります。SUSEマニュアルのHTMLバージョンは、両デスクトップのヘルプセンターでも利用可能です。インストールメディアでの文書のPDF版およびHTML版の検索場所については、SUSE Linux Enterprise Serverのリリースノートを参照してください。これらの文書は、インストールされたシステムの/usr/share/doc/release-notes/、またはオンラインの製品固有のWebページ(https://www.suse.com/releasenotes//)で参照できます。
38.1.2 パッケージのマニュアル #
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このバージョンでの新しい点が記されています。
38.2 マニュアルページ #
マニュアルページは、どのLinuxシステムにおいても重要な役割を担っています。マニュアルページでは、コマンドと利用可能なオプションおよびパラメータについての使用法が説明されています。マニュアルページは、manの後にコマンド名(たとえば「man ls」)を入力して開くことができます。
マニュアルページは、シェルに直接表示されます。ナビゲートするには、Page ↑およびPage ↓を使用して上下に移動します。HomeキーとEndキーを使用すると、それぞれドキュメントの最初と最後に移動できます。Qキーを押すと、この表示モードが終了します。manコマンド自体の詳細については、man manと入力します。マニュアルページは、表38.1「マニュアルページ - カテゴリと説明」(マニュアルページ自身から抽出)に示すように、カテゴリ別にソートされています。
|
数値 |
説明 |
|---|---|
|
1 |
実行可能プログラムまたはシェルコマンド |
|
2 |
システムコール(カーネルによって提供される機能) |
|
3 |
ライブラリコール(プログラムライブラリ内での機能) |
|
4 |
特別なファイル(通常は |
|
5 |
ファイル形式と命名規則( |
|
6 |
ゲーム |
|
7 |
その他(マクロパッケージおよび規則)、例： man(7)、groff(7) |
|
8 |
システム管理コマンド(通常は |
|
9 |
カーネルルーチン(非標準) |
各マニュアルページは、NAME、SYNOPSIS、DESCRIPTION、SEE ALSO、LICENSINGおよびAUTHORといういくつかのパートで構成されています。コマンドのタイプによっては、他のセクションが追加されている場合があります。
38.3 情報ページ #
情報ページは、システム上にあるもう1つの重要な情報ソースです。通常、情報ページの内容はマニュアルページよりも詳細です。これらはコマンドラインオプションよりも詳細な情報で構成され、チュートリアルやリファレンスマニュアル全体が含まれている場合もあります。特定のコマンドの情報ページを表示するには、infoの後にコマンド名(たとえば「info ls」)を入力します。シェルで直接ビューアを使用してinfoページを参照し、「ノード」と呼ばれるさまざまなセクションを表示できます。Spaceを使用して前に移動し、<—を使用して後ろに移動します。ノード内で、Page ↑およびPage ↓を使用して参照することもできますが、前および後ろのノードにも移動できるのはSpaceおよび<—のみです。Qを押すと、表示モードを終了します。すべてのコマンドに情報ページが付属するわけではありません。逆も同様です。
38.4 リソースのオンライン化 #
オンラインバージョンのSUSEマニュアル(/usr/share/docにインストールされます)に加えて、Webで製品固有のマニュアルやドキュメントにアクセスすることもできます。SUSE Linux Enterprise Server用に提供されているすべてのマニュアルの概要については、https://documentation.suse.com/にある製品ごとのマニュアルに関するWebページをご覧してください。
製品ごとの追加情報を検索する場合は、次のWebサイトも参照してください。
- SUSEテクニカルサポート
質問がある場合や、技術的な問題について解決策が必要な場合、https://www.suse.com/support/でSUSEテクニカルサポートを利用できます。
- SUSEフォーラム
SUSE製品に関して議論できるいくつかのフォーラムがあります。リストについては、https://forums.suse.com/を参照してください。
- SUSEブログ
SUSEブログでは、記事、ヒント、質疑応答を提供しています。https://www.suse.com/c/blog/
- GNOMEマニュアル
GNOMEユーザ、管理者、および開発者向けのマニュアル(https://library.gnome.org/)
- Linux Documentation Project
TLDP(Linux Documentation Project)は、Linux関係のマニュアルを作成するボランティアチームによって運営されています(https://www.tldp.orgを参照)。これは、おそらく、Linuxに関する最も総合的なドキュメントリソースです。マニュアルのセットには初心者向けのチュートリアルも含まれますが、主にシステム管理者などの経験者向けの内容になっています。TLDPは、HOWTO(操作方法)、FAQ(よくある質問)、ガイド(ハンドブック)を無償で提供しています。TLDPからのマニュアルの一部は、SUSE Linux Enterprise Server上でも利用できます。
汎用検索エンジンも使用できます。たとえば、CDへの書き込みやLibreOfficeファイルの変換でトラブルがある場合は、検索する語句として「Linux CD-RW help（Linux CD-RWヘルプ)」または「OpenOffice file conversion problem (OpenOfficeファイルの変換の問題)」を使用します。