概要
openSUSE® では様々な情報やドキュメンテーションが提供されていて、 それらの多くはお使いのシステムに既にインストールされています。
/usr/share/doc 内のドキュメンテーション
伝統的にヘルプ用として利用されてきたこのディレクトリには、お使いのシステムに
関する様々なドキュメンテーションファイルやリリースノートが含まれています。
それ以外にも、 packages ディレクトリ以下にインストール
済みのパッケージに対する情報も含まれています。
詳しくは 35.1項 「ドキュメンテーションディレクトリ」 をお読みください。
シェルで作業を行なう場合は、コマンドオプションを全て記憶しておく必要は ありません。伝統的に、シェルにはマニュアルページや info ページの形で、同梱の ヘルプ機能が用意されています。詳しくは 35.2項 「マニュアルページ」 や 35.3項 「info ページ」 をお読みください。
KDE デスクトップのヘルプセンター (KDE ヘルプセンター) や GNOME デスクトップのヘルプ (Help) では、お使いのシステムにおける最も重要なドキュメンテーションを、 検索可能な形態で提供しています。これらの資源にはインストール済みアプリケーションの オンラインヘルプのほか、マニュアルページや info ページ、製品添付の Novell/SUSE マニュアルなどが含まれています。
YaST から新しいソフトウエアをインストールすると、ソフトウエアの ドキュメンテーションが (多くの場合) 自動でインストールされ、お使いのデスクトップの ヘルプセンターからアクセスすることができるようになります。しかしながら、 GIMP などの アプリケーションでは、 YaST から個別にインストール可能なヘルプパッケージが 提供されていて、ヘルプセンターに統合されない場合もあります。
お使いのインストール済み Linux システムにおいて、伝統的にドキュメンテーション
用のディレクトリとして使用されているのが /usr/share/doc
です。通常、このディレクトリにはお使いのシステムにインストールされている
パッケージについて、それらの情報やリリースノートなどが含まれています。
![]() | インストール済みパッケージに依存するコンテンツ |
|---|---|
Linux の世界では、多くのマニュアルやその他の種類のドキュメンテーションが、
ソフトウエアと同様にパッケージとして提供されています。
| |
Novell/SUSE では、様々な言語に対応した HTML 版および PDF 版の
ドキュメンテーションを提供しています。 manual サブ
ディレクトリには、お使いの製品に対応した Novell/SUSE マニュアルのうち、
HTML 版がインストールされています。お使いの製品で利用可能なドキュメンテーション
の概要については、各マニュアルの序文をお読みください。
また、複数の言語をインストールしている場合、 /usr/share/doc/manual
には複数の言語に対応したマニュアルがインストールされます。 Novell/SUSE
マニュアルについても、両方のデスクトップのヘルプセンターに対応した HTML 版の
マニュアルがインストールされます。ご利用のインストールメディアのどの場所に
PDF 版や HTML 版のマニュアルが存在するかについての情報は、 openSUSE
のリリースノートをお読みください。インストール済みのシステムの場合、
リリースノートは /usr/share/doc/release-notes/ 以下に
インストールされますし、製品別の Web サイト
(http://www.novell.com/documentation/) (英語) から読むことも
できます。
お使いのシステムに howto パッケージを
インストールしている場合、 /usr/share/doc ディレクトリには
howto というサブディレクトリが存在しているはずです。
このディレクトリには Linux ソフトウエアを設定したり操作したりする際に必要な、
様々な作業向けのドキュメンテーションが含まれています。
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
このバージョンで何が新しくなったのかを記しています。
マニュアルページは Linux システムでは必要不可欠なものです。マニュアルページは コマンドに関する使用方法を説明しているほか、利用可能な全てのオプションや パラメータについても説明が書かれています。マニュアルページを表示するには、 man に続いてコマンド名を入力します。たとえば man ls のように入力します。
マニュアルページはシェル内に直接出力されます。それぞれ Page ↑ と Page ↓ のキーで上下に移動することができるほか、 Home と End でそれぞれ文書の冒頭と 文末に移動することもできます。閲覧を終了するには Q キーを 押してください。 man コマンド自身についてより詳しい 使い方を知りたい場合は、 man man と入力してください。 マニュアルページは 表35.1「マニュアルページ—カテゴリとその説明」 に示している ようなカテゴリに分類されています (man コマンドのマニュアルページから引用 しています):
表35.1 マニュアルページ—カテゴリとその説明¶
|
番号 |
説明 |
|---|---|
|
1 |
実行可能なプログラムやシェルコマンド |
|
2 |
システムコール (カーネルが提供する機能) |
|
3 |
ライブラリコール (プログラムライブラリが提供する機能) |
|
4 |
特殊ファイル (一般に |
|
5 |
ファイルの書式と慣習 ( |
|
6 |
ゲーム |
|
7 |
その他 (マクロのパッケージや慣習など) 。たとえば man(7), groff(7) などがあります |
|
8 |
システム管理コマンド (通常は |
|
9 |
カーネルルーチン (非標準) |
それぞれのマニュアルページは複数のパートから構成され、それぞれ NAME (名前), SYNOPSIS (書式), DESCRIPTION (説明), SEE ALSO (関連項目), LICENSING (ライセンス), AUTHOR (著者) などの項目があります。コマンドの種類によっては、追加のパートが存在する 場合もあります。
info ページはお使いのシステムにおいて、もう 1 つの重要な情報源です。 通常はマニュアルページよりも詳しい説明が書かれています。特定のコマンドについて info ページを閲覧するには、 info に続いてコマンド名を 入力します。たとえば info ls のように入力します。 info ページはシェル内に直接出力され、 「nodes. (ノード)」 と 呼ばれる複数のセクションから構成されます。 Space で 前に、 <— で後ろにそれぞれ移動します。 また、ノード内では Page ↑ や Page ↓ を利用することもできますが、 Space や Space を押さないと次のノードや直前のノードに移動する ことができません。閲覧を終了するには、 Q を押してください。 なお、マニュアルページと info ページはそれぞれ独立して提供されるもので、 いずれか一方しか用意されていない場合があります。
openSUSE システムの様々な側面について情報を得るには、 http://ja.opensuse.org にある Wiki をご利用ください。 Wiki のページは自由に追加/編集することができます。追加や編集にあたっては、 あらかじめユーザ登録を行なってログインする必要があります。ログイン後、 リンクを押して編集を行なってください。