#
# gt4f90io Installation Guide in RD (Ruby Document) format
#
#   For instruction of installing gt4f90io, see "INSTALL.htm.en"
#   (written in English) or  "INSTALL.htm.ja" (written in Japanese)
#   included in "gt4f90io" TGZ package available from
#   http://www.gfd-dennou.org/arch/gt4f90io.
#   Otherwise, see this file directly, or generate
#   above mentioned html files with "make guide" 
#   in current directory after installing  rdtool
#   <http://www2.pos.to/~tosh/ruby/rdtool/>.

=begin TOPLINK
[((<English|URL:INSTALL.htm.en>)) |
((<Japanese|URL:INSTALL.htm.ja>))]
[((<GFD Dennou Club|URL:http://www.gfd-dennou.org>)) |
((<Gtool4 Project|URL:http://www.gfd-dennou.org/arch/gtool4>))]
=end TOPLINK

=begin JA

= gt4f90io インストールガイド
* 森川 靖大 (morikawa), 豊田 英司 (toyoda), 小高 正嗣 (odakker)
  * $Id: INSTALL,v 1.5 2005/06/14 18:05:35 morikawa Exp $

=end JA
=begin EN

= gt4f90io Installation Guide
* Yasuhiro MORIKAWA (morikawa), Eizi TOYODA (toyoda), Masatsugu ODAKA (odakker)
  * $Id: INSTALL,v 1.5 2005/06/14 18:05:35 morikawa Exp $

=end EN

=begin JA
== 動作環境

このプログラムは以下の環境での動作を確認しています.

=end JA

=begin EN
== Operation Environment

This program is operated by following environments.

=end EN

=begin

  * ((<"Debian GNU/Linux 3.0, 3.1 "|URL:http://www.debian.org/      >)) +
    ((<Fujitsu Fortran Version 5.0 (in JAPANESE)|URL:http://www.fqs.co.jp/fort-c/>))

  * ((<"Debian GNU/Linux 3.0, 3.1 "|URL:http://www.debian.org/      >)) +
    ((<Intel Fortran 8.0 (8.0.039以降) |URL:http://www.intel.com/software/products/compilers/flin/>))

  * ((<"Debian GNU/Linux 3.0, 3.1"|URL:http://www.debian.org/      >)) +
    ((<Intel Fortran 8.1     |URL:http://www.intel.com/software/products/compilers/flin/>))

  * ((<"Debian GNU/Linux 3.0, 3.1"|URL:http://www.debian.org/      >)) +
    ((<GNU Fortran 95 (g95)       |URL:http://g95.sourceforge.net/>))

=end

=begin JA
== 入出力ファイル形式

gt4f90io は以下のファイル形式をサポートします.

  * ((<gtool4 netCDF 規約|URL:doc/data-gt4ncconv.htm>))
    に従う netCDF ファイル

また, 今後以下のファイル形式がサポートされるといいなと考えています.

  * GrADS 格子点データ
  * GRIB
  * その他一般のべた書き系データ

=end JA

=begin EN
== Input Output Data Format

gt4f90io support following data format.

  * NetCDF file conformed with
    ((<gtool4 netCDF conventions (in JAPANESE)|URL:doc/data-gt4ncconv.htm>))

=end EN


=begin JA
== コンパイルに必要なライブラリ

gt4f90io を利用するためには, 以下のソフトウェアを
事前にインストールしておく必要があります.

* ((<netCDF|URL:http://www.gfd-dennou.org/arch/netcdf>))
  (バージョン 3.5.0, 3.6.0)
  * ((<3.6.0 版 TGZ|URL:http://www.gfd-dennou.org/arch/netcdf/unidata-mirror/netcdf-3.6.0-p1.tar.gz>))
  * インストールガイド
    * [((<Unidata 本家 NetCDFクイックインストールガイド (英語) |URL:http://my.unidata.ucar.edu/content/software/netcdf/docs/netcdf-install/Quick-Instructions-for-Installing-NetCDF-on-Unix.html#Quick-Instructions-for-Installing-NetCDF-on-Unix>))
      |
      ((<(日本語訳)|URL:./INSTALL_netcdf.htm>)) ]
      * [((<Unidata 本家のインストールガイドの目次|URL:http://my.unidata.ucar.edu/content/software/netcdf/docs/netcdf-install/index.html>))]


ドキュメントを生成するためには以下のソフトウェアを
事前にインストールしておく必要があります. ただし,
((<gt4f90io の TGZ パッケージ|URL:http://www.gfd-dennou.org/arch/gtool4/gt4f90io/gt4f90io_current.tgz>))
から入手する場合には既に生成済みです.

* ((<ruby|URL:http://www.ruby-lang.org/>))
* ((<rdtool|URL:http://www2.pos.to/~tosh/ruby/rdtool/ja/>))
#* ((<rdoc|URL:http://rdoc.sourceforge.net/>))
#* ((<rd2latex-lib|URL:http://shugo.net/archive/rd2latex/>))

=end JA
=begin EN

== Libraries needed for compile

To use gt4f90io, following softwares should be installed.

* ((<netCDF|URL:http://my.unidata.ucar.edu/content/software/netcdf/index.html>))
  (version 3.5.0 or 3.6.0)
  * ((<Version 3.6.0 TGZ|URL:http://www.gfd-dennou.org/arch/netcdf/unidata-mirror/netcdf-3.6.0-p1.tar.gz>))
  * Installation Guide
    * [((<Quick Instructions for Installing (Unidata)|URL:http://my.unidata.ucar.edu/content/software/netcdf/docs/netcdf-install/Quick-Instructions-for-Installing-NetCDF-on-Unix.html#Quick-Instructions-for-Installing-NetCDF-on-Unix>))]
      * [((<NetCDF Installation and Porting Guide (Unidata)|URL:http://my.unidata.ucar.edu/content/software/netcdf/docs/netcdf-install/index.html>))]


Following softwares should be installed for generating documentations.
But, if you get from
((<gt4f90io TGZ package|URL:http://www.gfd-dennou.org/arch/gtool4/gt4f90io/gt4f90io_current.tgz>)),
documentations are already generated.

* ((<ruby|URL:http://www.ruby-lang.org/>))
* ((<rdtool|URL:http://www2.pos.to/~tosh/ruby/rdtool/en/>))
#* ((<rdoc|URL:http://rdoc.sourceforge.net/>))
#* ((<rd2latex-lib|URL:http://shugo.net/archive/rd2latex/>))

=end EN


=begin JA
== コンパイルの手引き
=end JA
=begin EN
== Compile source code
=end EN

=begin JA
=== TGZ パッケージの展開

適当な作業ディレクトリでソースアーカイブを展開します.
ソースは gt4f90io-((|バージョン|)) というディレクトリに展開されます.

	$ tar xvzf gt4f90io-current.tgz

=end JA
=begin EN
=== Extract TGZ Package

Make an empty directory, and extract archive.
A directory `gt4f90io-((|version|))'
created at the current working directory.

	$ tar xvzf gt4f90io-current.tgz

=end EN


=begin JA
=== Fortran コンパイラの指定

環境変数 ((* FC *)) に使用する Fortran コンパイラを指定してください.
以下は, 利用するコンパイラが g95 の場合です.

* sh, bash の場合

	$ export FC=g95

* csh, tcsh の場合

	$ setenv FC g95

=end JA
=begin EN
=== Specify Fortran Compiler

Specify Fortran compiler to environmental variable ((* FC *)).
For example, if you use "g95",

* sh, bash

	$ export FC=g95

* csh, tcsh

	$ setenv FC g95

=end EN


=begin JA
=== Config.mk の作成

展開されたディレクトリに移動し, (({ ./configure }))を実行します.
(({ --with-netcdf= })) には netcdf ライブラリのパスを指定します.
(以下の例は /usr/local/netcdf/lib/libnetcdf.a にライブラリがある
場合のものです).
このコマンドによって (({ Config.mk })) ファイルが生成されます.

	$ ./configure --with-netcdf=/usr/local/netcdf/lib/libnetcdf.a

なお, インストール先やコンパイルのオプションを変更したい場合は,
以下のように (({ --help })) オプションをつけることで,
指定可能なオプションリストが表示されます.

	$ ./configure --help

主なオプションに関しての説明です.

:(({--with-netcdf=}))((|ARG|))
  ((|ARG|)) に ((<コンパイルに必要なライブラリ>)) の
  netCDF ライブラリを指定します. 必ず明示的に指定する必要があります.

:(({--prefix=}))((|ARG|))
  ((|ARG|)) にライブラリやモジュール, 実行ファイルのインストール先の
  ディレクトリのプレフィックスを指定します.
  デフォルトは (({ /usr/local/gt4f90io })) です.

:(({--libdir=}))((|ARG|))
  ((|ARG|)) にライブラリのインストール先のディレクトリを指定します.
  デフォルトは (({ /usr/local/gt4f90io/lib })) です.

:(({--includedir=}))((|ARG|))
  ((|ARG|)) にモジュール情報ファイルのインストール先のディレクトリ
  を指定します. デフォルトは (({ /usr/local/gt4f90io/include })) です.

:(({--bindir=}))((|ARG|))
  ((|ARG|)) に実行ファイルのインストール先のディレクトリを指定します.
  デフォルトは (({ /usr/local/gt4f90io/bin })) です.

:(({--with-docdir=}))((|ARG|))
  ((|ARG|)) にドキュメントファイルのインストール先を指定します.
  デフォルトは (({ /usr/local/gt4f90io/doc })) です.

:(({--with-gt4libname=}))((|ARG|))
  ((|ARG|)) に gt4f90io のライブラリ名を指定します.
  ライブラリ名は (({lib}))((|<ARG>|))(({.a})) となります.
  デフォルトは (({ gt4f90io })) であり, その際のライブラリ名は
  (({ libgt4f90io.a })) となります.

:(({--with-gt4suffix=}))((|ARG|))
  ((|ARG|)) にはインストールディレクトリ, ライブラリ名,
  実行ファイルの末尾につける接尾語を指定します.
  例えば, 他が全てデフォルトの設定で (({ ffc5 })) と指定すると,
  インストール先のディレクトリのプレフィックスが
  (({ /usr/local/gt4f90io-ffc5 })), ライブラリ名が
  (({ libgt4f90io-ffc5.a })), インストールする実行ファイル名は
  (({ gt4frt.ffc5 })), (({ gt4config.ffc5 })) 等のように
  なります.

:(({--with-lang_conform_check=}))((|ARG|))
  ((|ARG|)) に言語規格を指定することで, コンパイル時に言語規格の
  チェックを行うよう, オプションを追加します. 現在 "(({95}))"
  のみ指定可能です. コンパイラによっては指定できません.

:(({--enable-debug}))
  このオプションを指定することで, コンパイル時や実行時にデバッグメッセージ
  を出力するオプションを追加します.
  コンパイラによっては指定できません.

:(({--with-abort=}))((|ARG|))
  ((|ARG|)) に (({abort, errtra-setrcd, exit, setrcd, stop})) のいずれか
  を指定することで, 終了時に用いる Fortran の内部関数を変更することが
  可能です. デフォルトは (({ abort })) です.

  : abort
    Fortran の内部サブルーチン abort で終了します.

  : errtra-setrcd
    Fujitsu Fortran の ERRTRA サービスサブルーチンを呼び出し,
    現在実行中のプログラム単位までのトレースバックマップを出力し,
    終了します. Fujitsu Fortran の SETRCD サービスサブルーチンにて,
    復帰コード 13 を設定し, 終了コードとして 3 を設定します.

  : exit
    Fortran の内部サブルーチン exit で終了します.

  : setrcd
    Fujitsu Fortran の SETRCD サービスサブルーチンを呼び出し,
    Fortran の復帰コードとして 3 を設定して終了します.

  : stop
    Fortran の内部関数 stop で終了します.

=end JA
=begin EN

=== Create `Config.mk'

Move created directroy, and excute `(({ ./configure }))'.

If your path of netCDF library is `/usr/local/netcdf/lib/libnetcdf.a',
you should set options as follow.

A configure file `Config.mk' created at the current working directory.

	$ ./configure --with-netcdf=/usr/local/netcdf/lib/libnetcdf.a

If you want to change directory to which the library and the module, etc.
are installed, please set (({ --help })) option as follow. Available
options are showed.

	$ ./configure --help

Descriptions about principal options are listed below.

:(({--with-netcdf=}))((|ARG|))
  Specify netCDF library in ((<Libraries needed for compile>)) to ((|ARG|)).
  You must specify explicitly.

:(({--prefix=}))((|ARG|))
  Specify prefix to ((|ARG|)).
  Default value is (({ /usr/local/gt4f90io })).

:(({--libdir=}))((|ARG|))
  Specify directory to which the library is installed to ((|ARG|)).
  Default value is (({ /usr/local/gt4f90io/lib })).

:(({--includedir=}))((|ARG|))
  Specify directory to which the module is installed to ((|ARG|)).
  Default value is (({ /usr/local/gt4f90io/include })).

:(({--bindir=}))((|ARG|))
  Specify directory to which the executable file is installed to ((|ARG|)).
  Default value is (({ /usr/local/gt4f90io/bin })).

:(({--with-docdir=}))((|ARG|))
  Specify directory to which the documentation file is installed to ((|ARG|)).
  Default value is (({ /usr/local/gt4f90io/doc })).

:(({--with-gt4libname=}))((|ARG|))
  Specify gt4f90io library name to ((|ARG|)).
  Library name becomes (({lib}))((|<ARG>|))(({.a})) .
  Default value is (({ gt4f90io })), so library name becomes
  (({ libgt4f90io.a })) .

:(({--with-gt4suffix=}))((|ARG|))
  Specify suffix of installdir, library name, executable files to((|ARG|)).
  For example, you specify (({ ffc5 })) when others are default,
  prefix of installdir becomes (({ /usr/local/gt4f90io-ffc5 })),
  library name becomes (({ libgt4f90io-ffc5.a })),
  executable files become (({ gt4frt.ffc5 })), (({ gt4config.ffc5 })).

:(({--with-lang_conform_check=}))((|ARG|))
  Specify language standard to ((|ARG|)).
  And when you compile source code, check the language standard conformance.
  Now, "(({95}))" is valid.
  The compiler that can be used is limited.

:(({--enable-debug}))
  When you compile source code and execute binary file, output debug
  messages.
  The compiler that can be used is limited.

:(({--with-abort=}))((|ARG|))
  Specify one of (({abort, errtra-setrcd, exit, setrcd, stop})) to
  ((|ARG|)).
  Default value is (({ abort })).

  : abort
    Stop by intrinsic subroutine "abort".

  : errtra-setrcd
    Stop by Fujitsu Fortran service subroutine "ERRTRA".
    And outputs error trace back map.

  : exit
    Stop by intrinsic subroutine "exit".

  : setrcd
    Stop by Fujitsu Fortran service subroutine "SETRCD".
    And outputs error trace back map.

  : stop
    Stop by intrinsic subroutine "stop".

=end EN


=begin JA
=== Config.mk の編集

環境に合わせ (({ Config.mk })) を手動で編集してください.

   FC          : Fortran コンパイラ

   SYSFLAGS    : コンパイル時・リンク時に必要なフラグ
                 (Fortran コンパイラ実行時に必要なオプション)

   SYSLDFLAGS  : リンク時に必要なフラグ

   SYSLDLIBS   : リンク時に必要なライブラリ

   F90MODTYPE  : モジュール情報の渡し方

   DEST_LIB    : gt4f90io ライブラリインストールディレクトリ

   DEST_INC    : gt4f90io モジュールインストールディレクトリ

   DEST_BIN    : gt4f90io 実行ファイルインストールディレクトリ

   DEST_DOC    : gt4f90io ドキュメントファイルインストールディレクトリ



   MODS        : モジュールファイル拡張子

   AR          : アーカイブコマンド

=end JA
=begin EN
=== Edit `Config.mk'

Edit `(({Config.mk}))' manually, if you want to change.

   FC          : Fortran Compiler

   SYSFLAGS    : Flags needed when compiled and linked

   SYSLDFLAGS  : Flags needed when linked

   SYSLDLIBS   : Libraries needed when linked

   F90MODTYPE  : Information of Modules
                 (std.mod, HP.mod, fqs.mod, intel.d, hitachi.f90)

   DEST_LIB    : Directory to which the library file is installed

   DEST_INC    : directory to which the module files are installed

   DEST_BIN    : directory to which the executable files are installed

   DEST_DOC    : directory to which the documantation files are installed


   MODS        : Extensions of Module Files used when "make clean"

   AR          : Archive command


=end EN

=begin JA
=== ソースコードのコンパイル

カレントディレクトリで以下のコマンドを実行してください.

	$ make
=end JA
=begin EN
=== Compile source code

In current directory, execute following command.

	$ make
=end EN


=begin JA
=== ドキュメントの生成

マニュアルとコードリファレンスのコンパイルはカレントディレクトリ
において, 以下のコマンドを実行してください.
((<gt4f90io の TGZ パッケージ|URL:http://www.gfd-dennou.org/arch/gtool4/gt4f90io/gt4f90io_current.tgz>))
から入手する場合には既に生成済みです.

	$ make doc
=end JA
=begin EN
=== Generate documentations

To generate documentations, execute following command in current directory.
If you get from
((<gt4f90io TGZ package|URL:http://www.gfd-dennou.org/arch/gtool4/gt4f90io/gt4f90io_current.tgz>)),
documentations are already generated.

	$ make doc
=end EN

=begin JA
== インストールの手引き

カレントディレクトリで以下のコマンドを実行してください.
システム領域にインストールする場合には管理者権限が
必要です. (デフォルトの場合はシステム領域にインストールします).

	# make install

ドキュメントをインストールする場合には以下のコマンドを実行します.

	# make install-doc

=end JA
=begin EN
== Install Procedure

In current directory, execute following command.
If you install to system, you need to be administrator.
(By default, you install to system).

	# make install

If you want to install documentation files, execute following command.

	# make install-doc

=end EN



=begin JA
== テストプログラム実行の手順

カレントディレクトリにおいて, 以下のコマンドを実行してください.
エラーが生じずに
"(({ *** Compilation and installation are succeeded !! *** }))"
というメッセージが表示されればインストールは完了です.

	$ make test-installed

=end JA
=begin EN
== Execute test programs

In current directry, execute following command.
If message "(({ *** Compilation and installation are succeeded !! *** }))"
are showed without error, installation is completed.

	$ make test-installed

=end EN

=begin HTML
<hr></hr>
=end HTML