From: j8takagi Date: Sun, 21 Apr 2013 08:50:17 +0000 (+0900) Subject: Texinfo 5.1にあわせて、ドキュメントを修正 X-Git-Tag: v0.2p10~9 X-Git-Url: https://j8takagi.net/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ac006f13842236a2a2e197e4a1cc795b094a442f;p=YACASL2.git Texinfo 5.1にあわせて、ドキュメントを修正 --- diff --git a/INSTALL b/INSTALL index 612947f..d166f78 100644 --- a/INSTALL +++ b/INSTALL @@ -1,54 +1,51 @@ 1 YACASL2のインストール -****************************** - -Table of Contents -***************** +*********************** 1 YACASL2のインストール - 要件 - 1.1 YACASL2ファイルのダウンロード - 1.2 YACASL2ファイルの検証 - 1.2.1 GnuPG分離署名での検証 - 1.2.2 MD5ハッシュ値での検証 - 1.3 YACASL2ファイルの展開 - 1.4 `casl2' `comet2' `dumpword'のビルド - 1.5 `casl2'の実行テスト - 1.6 詳細なテスト - 1.7 インストール - 1.8 環境変数の設定 - シェルの確認 - 1.8.1 `PATH'の設定 - 1.8.2 `INFOPATH'の設定 - 1.8.3 `CASL2LIB'の設定 - - 要件 -====== +1.1 YACASL2ファイルのダウンロード +1.2 YACASL2ファイルの検証 + 1.2.1 GnuPG分離署名での検証 + 1.2.2 MD5ハッシュ値での検証 +1.3 YACASL2ファイルの展開 +1.4 'casl2' 'comet2' 'dumpword'のビルド +1.5 'casl2'の実行テスト +1.6 詳細なテスト +1.7 インストール +1.8 環境変数の設定 + シェルの確認 + 1.8.1 'PATH'の設定 + 1.8.2 'INFOPATH'の設定 + 1.8.3 'CASL2LIB'の設定 +要件 +==== - YACASL2は、LinuxやMac OS -Xなど、UNIX系のOS上で動作します。現在動作を確認しているのは、Ubuntu -LinuxとVine Linux、Mac OS Xです。 + YACASL2は、LinuxやMac OS Xなど、UNIX系のOS上で動作します。現在動作を確 +認しているのは、Ubuntu LinuxとVine Linux、Mac OS Xです。 - インストール時に、`tar' `gcc' -`make'が必要です。Linuxでは多くの場合、標準でインストールされています。Mac -OS Xの場合、Xcodeの「Command Line Tools」に含まれます。 + インストール時に、'tar' 'gcc' 'make'が必要です。Linuxでは多くの場合、標 +準でインストールされています。Mac OS Xの場合、Xcodeの「Command Line +Tools」に含まれます。 1.1 YACASL2ファイルのダウンロード -============================================ +================================= - YACASL2のサイト -(http://www.j8takagi.net/yacasl2/)から、`tar.gz'または`tar.xz'ファイルと、対応する検証用ファイルをダウンロードします。githubのダウンロードページ -(http://github.com/j8takagi/YACASL2/downloads/)から`tar.gz'などのファイルをダウンロードすることもできます。 + YACASL2のサイト (http://www.j8takagi.net/yacasl2/)から、'tar.gz'または +'tar.xz'ファイルと、対応する検証用ファイルをダウンロードします。githubの +ダウンロードページ (http://github.com/j8takagi/YACASL2/downloads/)から +'tar.gz'などのファイルをダウンロードすることもできます。 1.2 YACASL2ファイルの検証 -================================ +========================= - ダウンロードが完了したら、圧縮ファイルが改竄されていないか検証します。検証にはGnuPG分離署名か、MD5ハッシュ値を使います。 + ダウンロードが完了したら、圧縮ファイルが改竄されていないか検証します。 +検証にはGnuPG分離署名か、MD5ハッシュ値を使います。 1.2.1 GnuPG分離署名での検証 ------------------------------------ +--------------------------- - GnuPGの`gpg'で圧縮ファイルを検証します。この検証を行うには、GnuPGがインストールされ、自分の秘密鍵と公開鍵のペアが作成されている必要があります。 + GnuPGの'gpg'で圧縮ファイルを検証します。この検証を行うには、GnuPGがイン +ストールされ、自分の秘密鍵と公開鍵のペアが作成されている必要があります。 $ gpg --verify yacasl2.tar.xz.asc gpg: Signature made Sat Oct 27 02:17:16 2012 JST using RSA key ID 25B62DD1 @@ -95,24 +92,24 @@ OS Xの場合、Xcodeの「Command Line Tools」に含まれます。 gpg: Good signature from "j8takagi " 1.2.2 MD5ハッシュ値での検証 ------------------------------------- +--------------------------- - `openssl'と`diff'で圧縮ファイルを検証します。 + 'openssl'と'diff'で圧縮ファイルを検証します。 $ openssl md5 yacasl2.tar.gz | diff -s yacasl2.tar.gz.md5sum - Files yacasl2.tar.gz.md5sum and - are identical 1.3 YACASL2ファイルの展開 -================================ +========================= - YACASL2ファイルをダウンロードしたら、`tar'コマンドで展開します。 + YACASL2ファイルをダウンロードしたら、'tar'コマンドで展開します。 $ tar xvzf yacasl2.tar.gz -1.4 `casl2' `comet2' `dumpword'のビルド -=========================================== +1.4 'casl2' 'comet2' 'dumpword'のビルド +======================================= - 展開したら、`make'コマンドで`casl2' `comet2' `dumpword'をビルドします。 + 展開したら、'make'コマンドで'casl2' 'comet2' 'dumpword'をビルドします。 $ cd yacasl2 $ make @@ -139,21 +136,20 @@ OS Xの場合、Xcodeの「Command Line Tools」に含まれます。 gcc -g -Wall -I ../include -o ../dumpword dumpword.o word.o cerr.o make[1]: Leaving directory ‘/home/kazubito/yacasl2/src’ -1.5 `casl2'の実行テスト -============================= +1.5 'casl2'の実行テスト +======================= - ビルドしたら、次のコマンドが正常に実行できるかを確認します。 -正常に実行された場合は、「Hello, World!」と表示されます。 + ビルドしたら、次のコマンドが正常に実行できるかを確認します。 正常に実行 +された場合は、「Hello, World!」と表示されます。 $ ./casl2 as/hello.casl Hello, World! 1.6 詳細なテスト -====================== +================ - `make -check'コマンドを実行すると、正常にビルドできているかどうかを詳細にテストできます。 -テストには、しばらく時間がかかります。 + 'make check'コマンドを実行すると、正常にビルドできているかどうかを詳細 +にテストできます。 テストには、しばらく時間がかかります。 $ make check 195 / 195 tests passed. Details in /home/username/yacasl2/test/integra @@ -167,80 +163,89 @@ check'コマンドを実行すると、正常にビルドできているかど All tests are succeded. 1.7 インストール -====================== +================ - ビルドが成功したら、`make -install'コマンドで必要なファイルをインストールできます。 -初期設定では、ホームディレクトリー以下にYACASL2のファイルがインストールされます。 + ビルドが成功したら、'make install'コマンドで必要なファイルをインストー +ルできます。 初期設定では、ホームディレクトリー以下にYACASL2のファイルが +インストールされます。 $ make install - コマンド実行時にオプションを指定することで、インストール先のディレクトリーを変更できます。 -例えば、`/usr/local'以下にファイルをインストールするには、 -次のようにコマンドを実行します。 + コマンド実行時にオプションを指定することで、インストール先のディレクト +リーを変更できます。 例えば、'/usr/local'以下にファイルをインストールす +るには、 次のようにコマンドを実行します。 $ sudo make install prefix=/usr/local オプションの詳細は次のとおりです。 オプション 説明 初期設定 ---------------------------------------------------------------------------- -PREFIX インストール時のルートファイル `~' -BINDIR 実行ファイルのインストール先 `$prefix/bin' -INFODIR infoファイルのインストール先 `$prefix/info' -CASL2LIBDIR CASL II `$prefix/lib/yacasl2' - ライブラリファイルのインストール先 +--------------------------------------------------------------------------- +PREFIX インストール時のルートファイル '~' +BINDIR 実行ファイルのインストール先 '$prefix/bin' +INFODIR infoファイルのインストール先 '$prefix/info' +CASL2LIBDIR CASL II ライブラリファイルのインス '$prefix/lib/yacasl2' + トール先 1.8 環境変数の設定 -========================= +================== - 環境変数`PATH'や`CASL2LIB'を設定することで、YACASL2が使いやすくなります。環境変数は、使っているシェルを確認してから設定します。 + 環境変数'PATH'や'CASL2LIB'を設定することで、YACASL2が使いやすくなります +。環境変数は、使っているシェルを確認してから設定します。 シェルの確認 ------------------- +------------ - 環境変数の設定方法は使っているシェルによって異なります。シェルは、次のコマンドで確認できます。 + 環境変数の設定方法は使っているシェルによって異なります。シェルは、次の +コマンドで確認できます。 $ echo $SHELL /bin/bash - 現在もっとも多く使われているシェルは、BASHでしょう。以下、BASHでの設定方法を説明します。 + 現在もっとも多く使われているシェルは、BASHでしょう。以下、BASHでの設定 +方法を説明します。 -1.8.1 `PATH'の設定 ---------------------- +1.8.1 'PATH'の設定 +------------------ - `PATH'にYACASL2の実行ファイルのインストール先を追加すると、ディレクトリーの指定を省略して`casl2' -`comet2' -`dumpword'を実行できます。例えば、初期設定のまま実行ファイルを`~/bin'にインストールしたときは、次のコマンドで設定できます。 + 'PATH'にYACASL2の実行ファイルのインストール先を追加すると、ディレクトリ +ーの指定を省略して'casl2' 'comet2' 'dumpword'を実行できます。例えば、初 +期設定のまま実行ファイルを'~/bin'にインストールしたときは、次のコマンド +で設定できます。 $ PATH=$PATH:~/bin && export PATH - 環境変数の設定は、シェルの初期設定ファイルに追加することでログインしたあと自動的に反映されるようになります。BASHでは`~/.bashrc'が初期設定ファイルです。次のコマンドで追加できます。 + 環境変数の設定は、シェルの初期設定ファイルに追加することでログインした +あと自動的に反映されるようになります。BASHでは'~/.bashrc'が初期設定ファ +イルです。次のコマンドで追加できます。 $ echo ’PATH=$PATH:~/bin && export PATH’ >>~/.bashrc -1.8.2 `INFOPATH'の設定 -------------------------- +1.8.2 'INFOPATH'の設定 +---------------------- - `INFOPATH'にYACASL2のInfoファイルをインストールしたディレクトリーを追加すると、ディレクトリーの指定を省略して`casl2' -`comet2' -`dumpword'を実行できます。例えば、初期設定のままInfoファイルを`~/share/info'にインストールしたときは、次のコマンドで設定できます。 + 'INFOPATH'にYACASL2のInfoファイルをインストールしたディレクトリーを追加 +すると、ディレクトリーの指定を省略して'casl2' 'comet2' 'dumpword'を実行 +できます。例えば、初期設定のままInfoファイルを'~/share/info'にインストー +ルしたときは、次のコマンドで設定できます。 $ INFOPATH=$INFOPATH:~/share && export INFOPATH - `~/.bashrc'には次のコマンドで追加できます。 + '~/.bashrc'には次のコマンドで追加できます。 $ echo 'INFOPATH=$INFOPATH:~/share/info && export INFOPATH' >>~/.bashrc -1.8.3 `CASL2LIB'の設定 -------------------------- +1.8.3 'CASL2LIB'の設定 +---------------------- - 環境変数`CASL2LIB'を設定しておけば、CASL -IIプログラム作成時に共通ライブラリを呼び出す手間が小さくなります。例えば、CASL2LIBを`~/yacasl2/casl2lib'にインストールしたときは、次のコマンドで設定できます。 + 環境変数'CASL2LIB'を設定しておけば、CASL IIプログラム作成時に共通ライブ +ラリを呼び出す手間が小さくなります。例えば、CASL2LIBを +'~/yacasl2/casl2lib'にインストールしたときは、次のコマンドで設定できます +。 $ CASL2LIB=~/yacasl2/casl2lib && export CASL2LIB - `~/.bashrc'には次のコマンドで追加できます。 + '~/.bashrc'には次のコマンドで追加できます。 $ echo 'CASL2LIB=~/yacasl2/casl2lib && export CASL2LIB' >>~/.bashrc diff --git a/doc/manual.texi b/doc/manual.texi index 46bda54..998b34e 100644 --- a/doc/manual.texi +++ b/doc/manual.texi @@ -533,7 +533,7 @@ $ @kbd{casl2 hello.casl} $ @kbd{casl2 addl_outl.casl ~/yacasl2/as/casl2lib/outl.casl} @end example -@unnumberedsubsec オプション +@unnumberedsec オプション @command{casl2}は、次のオプションを指定できます。 @@ -678,7 +678,7 @@ $ @kbd{comet2 hello.o} 引数が指定されない場合は、エラーメッセージを表示して終了します。 複数の引数を指定した場合、2番目以降の引数は無視されます。 -@unnumberedsubsec オプション +@unnumberedsec オプション @command{comet2}は、次のオプションを指定できます。 @@ -784,7 +784,7 @@ $ @kbd{dumpword 10} 引数が指定されない場合は、使い方を表示して終了します。 複数の引数を指定した場合、1つ目の引数だけが表示され、2つ目以降の引数は無視されます。 -@unnumberedsubsec 注意 +@unnumberedsec 注意 マイナスの数や16進数はシェルの仕様により、そのままでは指定できません。