satellite2/doc/README.ja

\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_
 
                        S A T E L L I T E 
         System Analisis Total Environment for Laboratory
               - Language and InTeractive Execution

                     -- マニュアル作成 手引き --

        $Id: README.ja,v 1.1 2002/12/12 10:28:17 okumura Exp $

\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_\_


１. はじめに

  SATELLITE のマニュアルは, jlatex 209 形式の LaTeX ファイルにて提供されて
  います. 

  そのため, マニュアルの作成には

    -  DVI ファイルを出力する為の jlatex もしくは platex209 コマンド
    -  PS  ファイルへ変換する為の dvi2ps もしくは dvips コマンド
    -  PDF ファイルへ変換する為の ps2pdf もしくは dvipdfm コマンド

  等の  LaTeX 環境が必要となります.


２. マニュアルの作成

  (1) マニュアルの作成

    個々のマニュアルは拡張モジュール毎およびマニュアルの種類毎のディレク
    トリに格納されており(次章参考), これらのディレクトリに用意された 
    Makefile を用いて make コマンドを実行することにより容易にマニュアルを
    作成することができます.

      % make

    このとき Makefile には, マニュアル作成の際に利用するコマンド等が明示
    的に指定されていますので, 適宜自身の環境にあったコマンドを利用するよ
    うに以下のコマンド等の定義を編集しなおす必要があります.

     LATEX            : latex コマンド
     DVIPS            : dvi - ps 変換コマンド
     PS2PDF           : ps - pdf 変換コマンド
     JAPANESE_CHARSET : 使用する latex の日本語コード (euc, sjis, jis)
     SIDE             : 1-片面/2-両面 印刷の指定

  (2) マニュアルの削除

     作成したマニュアルを削除し, 個々のディレクトリの内容を作成以前の状態
     に戻すには以下のコマンドを実行します.

      % make clean


３. ディレクトリ構造

  各ディレクトリは大別して 3種類あります.

   (分類1) 全てのマニュアルを作成するために必要なスタイルファイル等が格納
           されているディレクトリ

   (分類2) SATELLITE-SHELL や各機能を提供する拡張モジュール毎に分類されて
           いるディレクトリ

   (分類3) 全ての拡張モジュールを含んだ総合マニュアル作成用のディレクトリ


  以下は各ディレクトリ毎の内容物です.

   (分類1)
    common       - マニュアルの TeX ファイルをコンパイルするために
                   必要なスタイルファイル等
   (分類2)
    shell        - SATELLITE-SHELL 用のマニュアル
    bps          - BPS モジュール用のマニュアル
    dcm          - DCM モジュール用のマニュアル
    gpm          - GPM モジュール用のマニュアル
    ispp         - ISPP モジュール用のマニュアル
    ncs          - NCS モジュール用のマニュアル
    npe          - NPE モジュール用のマニュアル
    system       - SYSTEM モジュール用のマニュアル

   (分類3)
    prog_guide   - プログラマーズガイド
    refernce     - 全コマンドリファレンス
    usersman     - 全ユーザーズマニュアル

  通常のマニュアルの作成ならば, (分類3) のディレクトリのみで make を実行
  すれば, 全てのマニュアルを作成することが可能です.

  個別のマニュアルが必要ならば (分類2) のディレクトリで make を実行してく
  ださい. 


４. help コマンド用のマニュアルのインストールについて

   help コマンド用ドキュメントファイル群は, reference 以下で SIDE に 1 を
   定義して make を実行し, 作成されたものを利用します.

   SATELLITE 自体 を標準でコンパイル・インストールした場合, PREFIX が 
   /usr/local/satellite となっていますので help コマンドは

   xdvi +%page% /usr/local/satellite/share/doc/satellite/reference-jp.dvi \
        -expert

  ( %page% - ページ番号)

  と実行するようになっています. 
   ( PREFIX を変更してインストールした場合は, 適宜読み替えて下さい.)

  このとき, このコマンドが利用するマニュアルは tex の dvi ファイルですので, 
  reference ディレクトリ以下の生成物で必要となるのは,

   - SATELLITECommand-j.dvi 
   - SATELLITECommand-j.idx
   - 各モジュール毎の図ディレクトリ以下の eps ファイル
      Fig_BPS, Fig_DCM,Fig_GPM, Fig_ISPP, Fig_NCS, Fig_NPE, Fig_SATELLITE
      Fig_SHELL, Fig_SYSTEM

  のファイル群です.

  標準のコンパイルならば, /usr/local/satellite/share/doc/satellite/ という
  ディレクトリを作成して, そこへこれらのファイルおよびディレクトリをコピー
  してください.

  その後, 

     SATELLITECommand-j.idx → reference-jp.idx 
     SATELLITECommand-j.dvi → reference-jp.dvi

  へ名前を変更するなりシンボリックリンクをはるなりすれば, SATELLITE 上で
  help("axis") 等のコマンドが使用できるようになります.

  以下はインストール先のディレクトリ構成です.

  okumura@straus:[185]% ls -F /usr/local/satellite/share/doc/satellite/
  Fig_BPS/                Fig_NPE/                SATELLITECommand-j.idx
  Fig_DCM/                Fig_SATELLITE/          SATELLITECommand-j.pdf
  Fig_GPM/                Fig_SHELL/              SATELLITECommand-j.ps
  Fig_ISPP/               Fig_SYSTEM/             reference-jp.dvi@
  Fig_NCS/                SATELLITECommand-j.dvi  reference-jp.idx@


                                                           -- 以上 --