From: j8takagi Date: Sat, 31 May 2014 14:38:33 +0000 (+0900) Subject: ドキュメントの目次構成を整理 X-Git-Tag: v0.2p29 X-Git-Url: https://j8takagi.net/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=df3941c7355d0427cbf9f869802400b0cf05e27f;p=YACASL2.git ドキュメントの目次構成を整理 --- diff --git a/VERSION b/VERSION index cb48a50..c9f9728 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -v0.2p28 +v0.2p29 diff --git a/doc/install.texi b/doc/install.texi index 8a0130f..738c63a 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -24,35 +24,41 @@ Copyright @copyright{} 2010-2013 j8takagi @end titlepage @node Top, Require, (dir), (dir) -@chapter YACASL2のインストール @menu * Require:: 要件 -* Download:: YACASL2ファイルのダウンロード -* Verify:: YACASL2ファイルの検証 -* Expand:: YACASL2ファイルの展開 -* Build:: @file{casl2} @file{comet2} @file{dumpword}のビルド -* Simple Test:: @file{casl2}の実行テスト -* Detail Test:: 詳細なテスト -* Install:: インストール -* Environment:: 環境変数の設定 +* install:: インストール @end menu @contents -@node Require, Download, Top, Top -@unnumberedsec 要件 +@node Require, install, Top, Top +@chapter 要件 YACASL2は、LinuxやMac OS Xなど、UNIX系のOS上で動作します。現在動作を確認しているのは、Ubuntu LinuxとVine Linux、Mac OS Xです。 インストール時に、@command{tar} @command{gcc} @command{make}が必要です。Linuxでは多くの場合、標準でインストールされています。Mac OS Xの場合、Xcodeの「Command Line Tools」に含まれます。 -@node Download, Verify, Require, Top +@node install, , Require, Top +@chapter インストールの手順 + +@menu +* Download:: YACASL2ファイルのダウンロード +* Verify:: YACASL2ファイルの検証 +* Expand:: YACASL2ファイルの展開 +* Build:: @file{casl2} @file{comet2} @file{dumpword}のビルド +* Simple Test:: @file{casl2}の実行テスト +* Detail Test:: 詳細なテスト +* Install:: インストール +* Environment:: 環境変数の設定 +@end menu + +@node Download, Verify, install, install @section YACASL2ファイルのダウンロード @uref{http://www.j8takagi.net/yacasl2/, YACASL2のサイト}から、@file{tar.gz}または@file{tar.xz}ファイルと、対応する検証用ファイルをダウンロードします。@uref{http://github.com/j8takagi/YACASL2/downloads/, githubのダウンロードページ}から@file{tar.gz}などのファイルをダウンロードすることもできます。 -@node Verify, Expand, Download, Top +@node Verify, Expand, Download, install @section YACASL2ファイルの検証 ダウンロードが完了したら、圧縮ファイルが改竄されていないか検証します。検証にはGnuPG分離署名か、MD5ハッシュ値を使います。 @@ -116,7 +122,7 @@ $ @kbd{openssl md5 yacasl2.tar.gz | diff -s yacasl2.tar.gz.md5sum -} Files yacasl2.tar.gz.md5sum and - are identical @end example -@node Expand, Build, Verify, Top +@node Expand, Build, Verify, install @section YACASL2ファイルの展開 YACASL2ファイルをダウンロードしたら、@command{tar}コマンドで展開します。 @@ -125,7 +131,7 @@ YACASL2ファイルをダウンロードしたら、@command{tar}コマンドで $ @kbd{tar xvzf yacasl2.tar.gz} @end example -@node Build, Simple Test, Expand, Top +@node Build, Simple Test, Expand, install @section @file{casl2} @file{comet2} @file{dumpword}のビルド 展開したら、@command{make}コマンドで@file{casl2} @file{comet2} @file{dumpword}をビルドします。 @@ -157,7 +163,7 @@ gcc -g -Wall -I ../include -o ../dumpword dumpword.o word.o cerr.o make[1]: Leaving directory ‘/home/kazubito/yacasl2/src’ @end example -@node Simple Test, Detail Test, Build, Top +@node Simple Test, Detail Test, Build, install @section @file{casl2}の実行テスト ビルドしたら、次のコマンドが正常に実行できるかを確認します。 @@ -168,7 +174,7 @@ $ @kbd{./casl2 as/hello.casl} Hello, World! @end example -@node Detail Test, Install, Simple Test, Top +@node Detail Test, Install, Simple Test, install @section 詳細なテスト @command{make check}コマンドを実行すると、正常にビルドできているかどうかを詳細にテストできます。 @@ -187,7 +193,7 @@ All tests are succeded. All tests are succeded. @end example -@node Install, Environment, Detail Test, Top +@node Install, Environment, Detail Test, install @section インストール ビルドが成功したら、@command{make install}コマンドで必要なファイルをインストールできます。 @@ -215,7 +221,7 @@ $ @kbd{sudo make install prefix=/usr/local} @item @var{casl2libdir} @tab CASL II ライブラリファイルのインストール先 @tab @file{$prefix/lib/yacasl2} @end multitable -@node Environment, , Install, Top +@node Environment, , Install, install @section 環境変数の設定 環境変数@code{PATH}や@code{CASL2LIB}を設定することで、YACASL2が使いやすくなります。環境変数は、使っているシェルを確認してから設定します。 @@ -229,7 +235,7 @@ $ @kbd{echo $SHELL} /bin/bash @end example -現在もっとも多く使われているシェルは、BASHでしょう。以下、BASHでの設定方法を説明します。 +現在もっとも多く使われているシェルは、Bashでしょう。以下、Bashでの設定方法を説明します。 @subsection @code{PATH}の設定 @@ -239,7 +245,7 @@ $ @kbd{echo $SHELL} $ @kbd{PATH=$PATH:~/bin && export PATH} @end example -環境変数の設定は、シェルの初期設定ファイルに追加することでログインしたあと自動的に反映されるようになります。BASHでは@file{~/.bashrc}が初期設定ファイルです。次のコマンドで追加できます。 +環境変数の設定は、シェルの初期設定ファイルに追加することでログインしたあと自動的に反映されるようになります。Bashでは@file{~/.bashrc}が初期設定ファイルです。次のコマンドで追加できます。 @example $ @kbd{echo ’PATH=$PATH:~/bin && export PATH’ >>~/.bashrc}