20 ヘルプとドキュメンテーション #Edit source
openSUSE® Leap には様々な情報やドキュメンテーションが用意されています。これらはオンラインのほか、インストール済みのシステム内にも存在しています。
- 製品のドキュメンテーション
openSUSE Leap における幅広い分野を扱ったドキュメンテーションが https://doc.opensuse.org に公開されています。このドキュメンテーションでは、インストールやアップグレード、仮想化システムの管理やチューニング、セキュリティなど、様々な範囲をカバーしています。
/usr/share/doc内のドキュメンテーションこのディレクトリ内にある
release-notesサブディレクトリには、お使いのシステムに対するリリースノートが含まれています。また、packagesサブディレクトリには、インストール済みのパッケージに対する情報も含まれています。詳しくは 20.1項 「ドキュメンテーションのディレクトリ」 をお読みください。- シェルコマンドに対するマニュアルページと info ページ
シェルでの作業を行う際、コマンドのオプションがわからなくなってしまった場合、伝統的にはマニュアルページや info ページに必要な情報が用意されていますので、こちらをお読みください。詳しくは 20.2項 「マニュアルページ」 や 20.3項 「info ページ」 をお読みください。
- デスクトップのヘルプセンター
GNOME デスクトップのヘルプセンター (Help) を利用することで、様々な GNOME デスクトップのドキュメンテーションにアクセスすることができます。
- アプリケーションが独自に提供するヘルプパッケージ
YaST で新しいソフトウエアをインストールすると、通常はソフトウエアのドキュメンテーションが自動的にインストールされ、デスクトップのヘルプセンター内に表示されるようになります。ですが GIMP などのように、アプリケーションによっては、 YaST から個別にインストールできる専用のヘルプパッケージが用意されていることがあります。なお、これらはヘルプセンターから検索することはできません。
20.1 ドキュメンテーションのディレクトリ #Edit source
インストール済みの Linux システムにおいて、伝統的にドキュメンテーションが配置されるディレクトリと言えば /usr/share/doc です。このディレクトリにはリリースノートのほか、お使いのシステムにインストールされているパッケージに関する情報が提供されています。
注記: インストール済みのパッケージへの依存について
Linux の世界ではソフトウエアと同様に、マニュアルなどのドキュメンテーションがパッケージ形式で提供されています。 /usr/share/doc 内にある情報も同様に、インストールされているパッケージ (場合によってはドキュメンテーションのみ別途のパッケージになっている場合もあります) に依存します。そのため、ここで説明しているディレクトリの中に必要なドキュメンテーションがシステム内に見つからない場合は、 YaST で必要なパッケージをインストールするようにしてください。
20.1.1 リリースノート #Edit source
openSUSE Leap のリリースノートは、 HTML, PDF, RTF, テキストの各形式で提供されています。これらは /usr/share/doc/release-notes/ ディレクトリ内に保存されるほか、各製品固有の Web ページ https://doc.opensuse.org/release-notes/ でも提供されています。
20.1.2 パッケージのドキュメンテーション #Edit source
packages ディレクトリ内には、お使いのシステムにインストールされたソフトウエアパッケージに対応する、付属のドキュメンテーションが配置されます。なお、それぞれのパッケージに対してサブディレクトリ /usr/share/doc/packages/パッケージ名 が作成されます。一般的なパッケージの場合、パッケージ名のディレクトリ内に README ファイルとサンプル、設定ファイルや追加のスクリプトなどが配置されます。下記の表には、 /usr/share/doc/packages 以下によく配置されるファイルのファイル名と、その用途を示しています。いずれのファイルも、必須というわけではありませんし、多くのパッケージはこれらのうちの一部のみを提供していることに注意してください。
AUTHORS主な開発者の一覧が書かれています。
BUGS既知のバグや不具合が書かれています。また、バグを検索するための Bugzilla などの Web ページのアドレスが書かれている場合もあります。
CHANGES,ChangeLogバージョン間での変更履歴が書かれています。細かい内容が書かれていることが多いため、通常は開発者が読むべきものです。
COPYING,LICENSEライセンスに関する情報が書かれています。
FAQメーリングリストやニュースグループなどで収集された、質問とその回答集です。
INSTALLお使いのシステムに対して、このパッケージをインストールする方法が書かれています。ただし、このファイルが読めていると言うことは、パッケージのインストールまでが完了していることを意味しますので、このファイルについては読む必要がありません。
README,README.*ソフトウエアに関する一般的な情報が書かれています。たとえば目的や使用方法などが書かれています。
TODO将来的に提供される予定の機能を説明しています。
MANIFEST簡潔な説明を含むファイルの一覧です。
NEWSこのバージョンで新しくなったことを説明したファイルです。
20.2 マニュアルページ #Edit source
マニュアルページは、ほとんどの Linux システムで使用できます。コマンドの使用方法の説明や、利用可能なオプションやパラメータに対する説明も書かれています。マニュアルページは man に続いてコマンド名を指定することで、表示することができます。たとえば man ls のようになります。
マニュアルページはシェル内に直接表示されます。ページ内を移動したい場合は、 Page ↑ や Page ↓ などで行うことができます。また、マニュアルページの冒頭や末尾に移動したい場合は、それぞれ Home と End を使用します。なお、 Q を押すとマニュアルページの表示を終了することができます。詳しくは man man と入力して実行し、 man コマンド自身のマニュアルページをお読みください。なお、マニュアルページは 表20.1「マニュアルページの分類と説明」 に示すカテゴリに分類されています (man 自身のマニュアルページから抜粋しています) 。
表 20.1: マニュアルページの分類と説明 #
|
番号 |
説明 |
|---|---|
|
1 |
実行可能なプログラムやシェルコマンド |
|
2 |
システムコール (カーネルが提供する関数) |
|
3 |
ライブラリコール (プログラムライブラリが提供する関数) |
|
4 |
特殊ファイル (通常は |
|
5 |
ファイルの書式と慣習 ( |
|
6 |
ゲーム |
|
7 |
その他 (マクロパッケージや各種の慣習を含む。たとえば man(7) や groff(7) など) |
|
8 |
システム管理用のコマンド (通常は |
|
9 |
カーネルルーチン (非標準) |
それぞれのマニュアルページは、複数のセクションから構成されています。ラベルにはたとえば、 NAME (名前) , SYNOPSIS (書式) , DESCRIPTION (説明) , SEE ALSO (関連項目) , LICENSING (ライセンス) , AUTHOR (作者) などがあります。
20.3 info ページ #Edit source
info ページはお使いのシステムにおけるもう 1 つの重要な情報源です。一般的に、マニュアルページよりも詳細な説明がなされています。コマンドラインオプションのほか、具体的な使用に関するチュートリアルや、リファレンスとなるドキュメンテーションが含まれている場合もあります。特定のコマンドに対する info ページを読むには、 info に続いてコマンド名を指定してください。たとえば info ls のようになります。 info ページはシェル内でビューアとして表示され、様々なセクション (「ノード」 と呼びます) を読むことができます。また、 Space で前に進み、 <— で後ろに進みます。ノード内では Page ↑ と Page ↓ で移動を行うことができますが、 Space や <— を使用することで、前後のノードに移動することができます。なお、 Q を押すと閲覧モードを終了することができます。ただし、全てのコマンドに対して info ページが用意されているわけではありませんので、あらかじめご注意ください。
20.4 オンラインのリソース #Edit source
openSUSE Leap に対して提供されている全てのドキュメンテーションを読むには、 https://doc.opensuse.org/ にある各製品の Web ページにアクセスしてください。
また、追加の製品関連のドキュメンテーションをお探しの場合は、下記の Web サイトをご覧ください:
- ユーザコミュニティ
- GNOME ドキュメンテーション
GNOME の一般ユーザや管理者、開発者向けのドキュメンテーションがそれぞれ公開されています: https://help.gnome.org/
- Linux Documentation Project
Linux Documentation Project (TLDP; Linux 文書作成プロジェクト) はボランティアからなるチームで運用されているプロジェクトです (詳しくは https://tldp.org/ をお読みください) 。ここでは Linux において最も広範囲なドキュメンテーションを提供しています。ドキュメンテーション集には、初心者向けのチュートリアル集が用意されていますが、多くは知識のあるユーザやプロのシステム管理者向けのものになっています。また、 TLDP では HOWTO や FAW 、各種のガイド (ハンドブック) などがフリーライセンスで公開されています。 TLDP が提供するドキュメンテーションの一部については、 openSUSE Leap 内でも提供されています。