手引きの読み方


1.概要

ここでは「みんなのための・みんなによる手引集」を読み進める上で 知っておいて欲しい、各ドキュメントの表記規則を紹介します。


2.コマンド

文中には説明文の他に、実際に入力するコマンド(コンピュータへの命令)が紹介されています。 その多くは専攻サーバにログインして実行するためものです。

表記例1:
$ mkdir somefolder
解説:
$ プロンプト。コンピュータが表示するので、この文字はユーザは入力しない。
ユーザの使用環境によっては、この文字と異なる場合もある。
mkdir ユーザが入力する部分。この部分は書かれた通り入力する。
somefolder ユーザが入力する部分。この部分は例としての文字列で、 実際は適切な文字・数字・記号等を入力する。


次のように、コンピュータからの応答(命令に対する返事) を一緒に例示する場合もあります。

表記例2:
$ /var/qmail/bin/maildirmake ~/Maildir/(~/Maildir/ を作成)
$ ls ~/Maildir/ -al                    (~/Maildir/ の生成を確認)
total 4
drwx--S---   5 kyoma    kyoma        1024 Jul 26 20:03 .
drwxr-xr-x  10 kyoma    kyoma        1024 Jul 27 23:14 ..
drwx--S---   2 kyoma    kyoma        1024 Jul 27 16:53 cur
drwx--S---   2 kyoma    kyoma        1024 Jul 27 16:53 new
drwx--S---   2 kyoma    kyoma        1024 Jul 27 16:52 tmp

この場合、行頭がプロンプト(ここでは $ )ではない部分が、 コンピュータからの応答を表しています。

書き手によっては括弧書きや矢印で説明を加えたりしている事があります。 読む際には実際に入力する部分と読み誤らないよう留意してください。


3.引用文

文中には、編集するファイル内容を例として引用して説明していることがあります。 そうした説明は主に、設定ファイルの書き方などを紹介する場合に表れます。

表記例:
AuthType Basic
AuthName The-T-Directory
AuthUserFile /home/hoge/.users
<Limit GET POST>
order deny,allow
deny from all
allow from xxx.xx.xx.xx ← 許可したいIPアドレス
</Limit>

解説:

多くのブラウザでは左側に線が引かれて見えると思います。 /home/hoge/.users 等の斜体で書かれた部分は例としての文字列で、 実際は適切な文字・数字・記号等を入力します。

書き手によっては括弧書きや矢印で説明を加えたりしている事があります。 読む際には実際に入力する部分と読み誤らないよう留意してください。


最終更新日: 2000/07/28(河野仁之) Copyright © 2000 EPnetFaN