Exerb Project
ようこそ > コマンドリファレンス

# コマンドリファレンス

## 目次

1. 概要
2. exerbコマンド
   1. パラメータ
   2. オプション
3. mkexyコマンド
   1. パラメータ
   2. オプション

## 1.概要

Exerbには2つのコマンドが含まれています。 実行ファイルを生成するexerbコマンドと、レシピファイルを生成するmkexyコマンドです。

## 2.exerbコマンド

Rubyスクリプトファイル、またはレシピファイルを指定して、実行ファイルを生成します。

exerb [オプション] {Rubyスクリプトファイル|レシピファイル}

### 1.パラメータ

Rubyスクリプト、またはレシピファイルのファイル名を指定します。 複数のファイル名を指定することはできません。 ファイル名の拡張子が"rb"の場合はRubyスクリプトファイルとして、それ以外の場合にはレシピファイルとして処理されます。

Rubyスクリプトファイルが指定された場合、そのRubyスクリプトのみを含む実行ファイルが生成されます。 単一のRubyスクリプトで構成されているシンプルなソフトウェアを、実行ファイルに変換する場合に使用します。

レシピファイルが指定された場合、そのレシピに含まれている情報に従って実行ファイルが生成されます。 複数のRubyスクリプト、拡張ライブラリで構成されているソフトウェアを、実行ファイルに変換する場合に使用します。 レシピファイルのフォーマットについては『レシピリファレンス』を参照してください。

### 2.オプション

下記のオプションを指定することができます。 コマンドオプションとレシピファイルで同一項目が指定された場合、コマンドオプションが優先されます。

オプション | 説明
--- | ---
-c | --corename | 定義された名称でコアを指定します。-Cオプションと同時に指定された場合、-Cオプションが優先されます。
-C | --corefile | ファイルパスでコアを指定します。-cオプションと同時に指定された場合、-Cオプションが優先されます。
-o | --outfile | 出力ファイル名を指定します。
-k | --kcode | 文字コードを指定します。none、euc、sjis、utf8のいずれかを指定してください。
-a | --archive | アーカイブのみ生成します。実行ファイルは生成されません。
-v | --verbose | 冗長な情報を表示します。
-e | --execute | 生成した実行ファイルを実行します。
-i | --config | 各種設定内容を表示します。
-V | --version | バージョン情報を表示します。
-h | --help | ヘルプメッセージを表示します。

## 3.mkexyコマンド

Rubyスクリプトを実行して、レシピファイルを自動的に生成します。 下記のいずれかの方法で起動してください。

mkexy [オプション] Rubyスクリプトファイル [パラメータ]

ruby -r exerb/mkexy [オプション] Rubyスクリプトファイル [パラメータ]

### 1.パラメータ

「Rubyスクリプトファイル」には、レシピファイル生成対象であるRubyスクリプトを指定します。 指定されたRubyスクリプトが実行され、終了時にレシピファイルが生成されます。

「パラメータ」には、レシピファイル生成対象のRubyスクリプトに渡す引数を指定します。

### 2.オプション

そのままrubyコマンドへのオプションとなります。