はじめに


  1. コマンドラインの表記
  2. オンラインマニュアル

コマンドラインの表記

このページではコマンドライン上の操作を説明するとき、普通の文章と区別しやすくなるよう

ls

のように黒線で囲い、コマンドライン上で操作していることを示すためにコマンドの先頭に"$ "か"# "を付けます。前者は一般ユーザ、後者は特権(root)ユーザで実行することを表します。

文章中のコマンド名はls(1)のようなコマンド名(セクション番号)という形式で書きます。この形式の利点は"make"といった一般的に使われる英単語との混同を避けられ("make", make)、マニュアルページのセクション番号によって正しいリファレンスを提供できることにあります(make, make(1))。後者は特に、同じ名前のライブラリ関数が存在する場合にそれと区別する目的もあります(printf(1), printf(3))。

黒線で囲われているテキストは必ずしもコマンドライン上の操作を表すとは限りません。たとえば

#include <stdio.h>
int
main(void)
{
        printf("Hello World\n");
        return 0;
}

1行目は"#"から始まっていますが、コマンドライン上の操作ではなくC言語の典型的なHello Worldです。テキストファイルの中身を表しています。黒線の中身の意味は文脈に応じて判断してください。

オンラインマニュアル

マニュアルページはオンラインマニュアル(on-line manual pages)とも呼ばれ、BSD Unixであればベースシステムに標準でインストールされています。GNU/Linuxディストリビューションは別途パッケージをインストールする必要があるかもしれません。

このマニュアルではコマンドの説明とコマンドライン引数の一覧、コマンドに関連しているファイル、他に参照すべきマニュアルページの一覧、既知のバグなどを調べられます。あるコマンドの使い方が分からないとき、もっとも詳しく正確な情報はman(1)から得られるでしょう。

マニュアルページは

man printf

あるいはセクション番号を指定して

man 3 printf

と実行することで閲覧できます。ページャ(pager)には通常more(1)less(1)が使われますが、環境変数PAGERを設定して任意のページャを指定できます。

近年ではマニュアルページを書かず-h--helpあるいはusageの出力だけで済ませようとするソフトウェアも存在します(おそらくgroff(1)で書くのが面倒なのでしょう)。単にコマンドライン引数について調べたいときなどはこれを使ったほうが手っ取り早い場合もあります。