textdrop

シェルプロンプトとは

シェルプロンプトとは、シェルがユーザ入力を待ち受けるときに表示されている文字列のことです。
例えば、この Mac OS X で bash を使っていると、

textdrop:~ sasai$

となっています。この場合、シェルプロンプトの形式は「ホスト名:ディレクトリ名 ユーザ名$」となっています。

ドキュメントに何を使うか

ドキュメントにシェルのコマンドラインを書くことがよくあります。インストールや設定手順など、Unix系システムではよく登場します。でも、シェルの種類やシステムによって、デフォルトのシェルプロンプトの形式はいろいろです。

このうち、シェルプロンプトの末尾の記号、先の例だと “$” の部分、には昔から決まりがあり、以下のようになっています。

Bシェル系の場合 (sh, bash, ksh, zsh)
   $  一般ユーザ
   # スーパーユーザ(root)

Cシェル系の場合 (csh, tcsh)
   %  一般ユーザ
   # スーパーユーザ(root)

なので、シェルプロンプトが”#”ならスーパーユーザ、それ以外なら一般ユーザと考えることができます。
とはいえ、プロンプトは自分で自由に設定することが可能なので、常にこうなっている保証はありません。
でもドキュメントの中で使うのなら、この慣例に従うべきでしょう。

じゃあ、一般ユーザのときには何を使うか？これはBシェル系とCシェル系で違っているのですが、最近はCシェル系を使うのは少数派だと思うので、Bシェル系の”$”を使うのが無難でしょう。

また、慣れた人にとっては自明なことなので特に言及していない場合もありますが、想定しているシェルの種類や、プロンプトの記号については、最初に説明しておくべきですね。特に、入門書や初心者向けのドキュメントには不可欠です。

この記号の部分以外については、必要なければなくていよいでしょう。でも、

• ホストの違いを表したい
• ディレクトリの違いを表したい

というように、特別な理由があれば、シェルプロンプトに入れておくのも一案だと思います。

まとめ

シェルプロンプトには、一般ユーザなら ‘$’、スーパーユーザなら ‘#’ を使う。それ以外は必要に応じて。
シェルの種類やシェルプロンプトの意味については、最初に説明しておく。

番外

Windows のコマンドプロンプトは

   C:\>

というように、記号は ‘>’ ですね。

ネットワーク関連のドキュメントでは、例として、IPアドレスやドメイン名を使うことがよくあります。あまり考えなく適当なIPアドレスやドメイン名を使っているのをよく見かけますが、実は、こういう目的のために予約されているIPアドレス、ドメイン名があります。

ドキュメントに使えるIPアドレスについて、RFC 3330に次のように書かれています。

192.0.2.0/24 – This block is assigned as “TEST-NET” for use in documentation and example code. It is often used in conjunction with domain names example.com or example.net in vendor and protocol documentation. Addresses within this block should not appear on the public Internet.

192.0.2.0/24のブロック（192.0.2.0〜192.0.2.255）は、ドキュメントやコード例で使えるよう予約してあり、インターネット上では使っちゃいけないことになっています。
また、”example.com”や”example.net”といったドメイン名と組み合わせて使うことが多いと書かれていますが、ドキュメントに使えるドメイン名について、RFC 2606に次のように書かれています。

2. TLDs for Testing, & Documentation Examples
    〜中略〜
“.example” is recommended for use in documentation or as examples.

3. Reserved Example Second Level Domain Names
    〜中略〜
 The Internet Assigned Numbers Authority (IANA) also currently has the following second level    domain names reserved which can be used as examples.

       example.com
       example.net
       example.org

このように、”example.com”などのドメイン名は予約されていて、一般の団体や企業、個人がこうしたドメイン名を使うことはできないとされています。

絶対にこうしなきゃいけないわけではありませんが、これらのIPアドレスやドメイン名はドキュメントを書くときに正々堂々と使えるので安心ですね。特別な理由がなければ、こうしたIPアドレスとドメイン名を使うのがおすすめです。

参考

• RFC 3330: Special-Use IPv4 Addresses
• RFC 2606: Reserved Top Level DNS Names