INSTALL

   1 1 要件
   2 2 インストールの手順
   3 2.1 YACASL2ファイルのダウンロード
   4 2.2 YACASL2ファイルの検証
   5   2.2.1 GnuPG分離署名での検証
   6   2.2.2 MD5ハッシュ値での検証
   7 2.3 YACASL2ファイルの展開
   8 2.4 'casl2' 'comet2' 'dumpword'のビルド
   9 2.5 'casl2'の実行テスト
  10 2.6 詳細なテスト
  11 2.7 インストール
  12 2.8 環境変数の設定
  13   シェルの確認
  14   2.8.1 'PATH'の設定
  15   2.8.2 'INFOPATH'の設定
  16 1 要件
  17 ******
  18
  19  YACASL2は、LinuxやMac OS Xなど、UNIX系のOS上で動作します。現在動作を確
  20 認しているのは、Ubuntu LinuxとMac OS Xです。
  21
  22  インストール時に、'tar' 'gcc' 'make'が必要です。Linuxでは多くの場合、標
  23 準でインストールされています。Mac OS Xの場合、Xcodeの「Command Line
  24 Tools」に含まれます。
  25
  26 2 インストールの手順
  27 ********************
  28
  29 2.1 YACASL2ファイルのダウンロード
  30 =================================
  31
  32  YACASL2のサイト (http://www.j8takagi.net/yacasl2/)から、'tar.gz'または
  33 'tar.xz'ファイルと、対応する検証用ファイルをダウンロードします。githubの
  34 ダウンロードページ (http://github.com/j8takagi/YACASL2/downloads/)から
  35 'tar.gz'などのファイルをダウンロードすることもできます。
  36
  37 2.2 YACASL2ファイルの検証
  38 =========================
  39
  40  ダウンロードが完了したら、圧縮ファイルが改竄されていないか検証します。
  41 検証には、GnuPG分離署名か、MD5ハッシュ値を使います。
  42
  43 2.2.1 GnuPG分離署名での検証
  44 ---------------------------
  45
  46  GnuPGの'gpg'で圧縮ファイルを検証します。この検証を行うには、GnuPGがイン
  47 ストールされ、自分の秘密鍵と公開鍵のペアが作成されている必要があります。
  48
  49      $ gpg --verify yacasl2.tar.xz.asc
  50      gpg: Signature made Sat Oct 27 02:17:16 2012 JST using RSA key ID 25B62DD1
  51      gpg: Can't check signature: public key not found
  52      $ gpg --recv-keys 25B62DD1
  53      gpg: requesting key 25B62DD1 from hkp server keys.gnupg.net
  54      gpg: key 25B62DD1: public key "j8takagi <j8takagi@nifty.com>" imported
  55      gpg: Total number processed: 1
  56      gpg:               imported: 1  (RSA: 1)
  57
  58      $ gpg --lsign-key 25B62DD1
  59
  60      pub  2048R/25B62DD1  created: 2012-09-29  expires: never       usage: SC
  61                           trust: unknown       validity: full
  62      sub  2048R/92E25C29  created: 2012-09-29  expires: never       usage: E
  63      [  full  ] (1). j8takagi <j8takagi@nifty.com>
  64
  65
  66      pub  2048R/25B62DD1  created: 2012-09-29  expires: never       usage: SC
  67                           trust: unknown       validity: full
  68       Primary key fingerprint: ...
  69
  70           .* <.*@.*>
  71
  72      Are you sure that you want to sign this key with your
  73      key ".* <.*@.*>"
  74
  75      The signature will be marked as non-exportable.
  76
  77      Really sign? (y/N) y
  78
  79      You need a passphrase to unlock the secret key for
  80      user: ".* <.*@.*>"
  81      2048-bit RSA key, ID ........, created 20..-..-..
  82
  83      <input password> password
  84
  85      $ gpg --verify yacasl2.tar.xz.asc
  86      gpg: Signature made Sat Oct 27 02:17:16 2012 JST using RSA key ID 25B62DD1
  87      gpg: checking the trustdb
  88      gpg: 3 marginal(s) needed, 1 complete(s) needed, PGP trust model
  89      gpg: depth: 0  valid:   1  signed:   4  trust: 0-, 0q, 0n, 0m, 0f, 1u
  90      gpg: depth: 1  valid:   4  signed:   0  trust: 4-, 0q, 0n, 0m, 0f, 0u
  91      gpg: Good signature from "j8takagi <j8takagi@nifty.com>"
  92
  93 2.2.2 MD5ハッシュ値での検証
  94 ---------------------------
  95
  96  'openssl'と'diff'で圧縮ファイルを検証します。
  97
  98      $ openssl md5 yacasl2.tar.gz | diff -s yacasl2.tar.gz.md5sum -
  99      Files yacasl2.tar.gz.md5sum and - are identical
 100
 101 2.3 YACASL2ファイルの展開
 102 =========================
 103
 104  YACASL2ファイルをダウンロードしたら、'tar'コマンドで展開します。
 105
 106      $ tar xvzf yacasl2.tar.gz
 107
 108 2.4 'casl2' 'comet2' 'dumpword'のビルド
 109 =======================================
 110
 111  展開したら、'make'コマンドで'casl2' 'comet2' 'dumpword'をビルドします。
 112
 113      $ cd yacasl2
 114      $ make
 115      make -C src
 116      make[1]: Entering directory ‘/home/kazubito/yacasl2/src’
 117      gcc -c -g -Wall -I ../include casl2.c
 118      gcc -c -g -Wall -I ../include word.c
 119      gcc -c -g -Wall -I ../include hash.c
 120      gcc -c -g -Wall -I ../include cerr.c
 121      gcc -c -g -Wall -I ../include struct.c
 122      gcc -c -g -Wall -I ../include cmd.c
 123      gcc -c -g -Wall -I ../include assemble.c
 124      gcc -c -g -Wall -I ../include token.c
 125      gcc -c -g -Wall -I ../include label.c
 126      gcc -c -g -Wall -I ../include macro.c
 127      gcc -c -g -Wall -I ../include exec.c
 128      gcc -c -g -Wall -I ../include dump.c
 129      gcc -g -Wall -I ../include -o ../casl2 casl2.o word.o hash.o cerr.o st
 130      ruct.o cmd.o assemble.o token.o label.o macro.o exec.o dump.o
 131      gcc -c -g -Wall -I ../include comet2.c
 132      gcc -g -Wall -I ../include -o ../comet2 comet2.o word.o hash.o cerr.o
 133      struct.o cmd.o exec.o dump.o
 134      gcc -c -g -Wall -I ../include dumpword.c
 135      gcc -g -Wall -I ../include -o ../dumpword dumpword.o word.o cerr.o
 136      make[1]: Leaving directory ‘/home/kazubito/yacasl2/src’
 137
 138 2.5 'casl2'の実行テスト
 139 =======================
 140
 141  ビルドしたら、次のコマンドが正常に実行できるかを確認します。 正常に実行
 142 された場合は、「Hello, World!」と表示されます。
 143
 144      $ ./casl2 as/hello.casl
 145      Hello, World!
 146
 147 2.6 詳細なテスト
 148 ================
 149
 150  'make check'コマンドを実行すると、正常にビルドできているかどうかを詳細
 151 にテストできます。 テストには、しばらく時間がかかります。
 152
 153      $ make check
 154      195 / 195 tests passed. Details in /home/username/yacasl2/test/integra
 155      tion/casl2/Test.log
 156      All tests are succeded.
 157      149 / 149 tests passed. Details in /home/username/yacasl2/test/integra
 158      tion/comet2/Test.log
 159      All tests are succeded.
 160      4 / 4 tests passed. Details in /home/username/yacasl2/test/integration
 161      /dumpword/Test.log
 162      All tests are succeded.
 163
 164 2.7 インストール
 165 ================
 166
 167  ビルドが成功したら、'make install'コマンドで必要なファイルをインストー
 168 ルできます。 初期設定では、ホームディレクトリー以下にYACASL2のファイルが
 169 インストールされます。
 170
 171      $ make install
 172
 173  コマンド実行時にオプションを指定することで、インストール先のディレクト
 174 リーを変更できます。 例えば、'/usr/local'以下にファイルをインストールす
 175 るには、 次のようにコマンドを実行します。
 176
 177      $ sudo make install prefix=/usr/local
 178
 179  オプションの詳細は次のとおりです。
 180
 181 オプション     説明                                 初期設定
 182 ---------------------------------------------------------------------------
 183 PREFIX         インストール時のルートファイル       '~'
 184 BINDIR         実行ファイルのインストール先         '$prefix/bin'
 185 INFODIR        infoファイルのインストール先         '$prefix/share/info'
 186
 187 2.8 環境変数の設定
 188 ==================
 189
 190  環境変数'PATH'や'CASL2LIB'を設定することで、YACASL2が使いやすくなります
 191 。環境変数は、使っているシェルを確認してから設定します。
 192
 193 シェルの確認
 194 ------------
 195
 196  環境変数の設定方法は使っているシェルによって異なります。シェルは、次の
 197 コマンドで確認できます。
 198
 199      $ echo $SHELL
 200      /bin/bash
 201
 202  現在もっとも多く使われているシェルは、Bashでしょう。以下、Bashでの設定
 203 方法を説明します。
 204
 205 2.8.1 'PATH'の設定
 206 ------------------
 207
 208  'PATH'にYACASL2の実行ファイルのインストール先を追加すると、ディレクトリ
 209 ーの指定を省略して'casl2' 'comet2' 'dumpword'を実行できます。例えば、初
 210 期設定のまま実行ファイルを'~/bin'にインストールしたときは、次のコマンド
 211 で設定できます。
 212
 213      $ PATH=$PATH:~/bin && export PATH
 214
 215  環境変数の設定は、シェルの初期設定ファイルに追加することでログインした
 216 あと自動的に反映されるようになります。Bashでは'~/.bashrc'が初期設定ファ
 217 イルです。次のコマンドで追加できます。
 218
 219      $ echo ’PATH=$PATH:~/bin && export PATH’ >>~/.bashrc
 220
 221 2.8.2 'INFOPATH'の設定
 222 ----------------------
 223
 224  'INFOPATH'にYACASL2のInfoファイルをインストールしたディレクトリーを追加
 225 すると、ディレクトリーの指定を省略して'casl2' 'comet2' 'dumpword'を実行
 226 できます。例えば、初期設定のままInfoファイルを'~/share/info'にインストー
 227 ルしたときは、次のコマンドで設定できます。
 228
 229      $ INFOPATH=$INFOPATH:~/share/info && export INFOPATH
 230
 231  '~/.bashrc'には次のコマンドで追加できます。
 232
 233      $ echo 'INFOPATH=$INFOPATH:~/share/info && export INFOPATH' >>~/.bashrc
 234