= パラメータと変数
:encoding: UTF-8
:lang: ja
//:title: Yash マニュアル - パラメータと変数
:description: Yash が扱うパラメータの種類や特別な意味を持つ変数について

dfn:[パラメータ]とは、{zwsp}link:expand.html[パラメータ展開]で値に置き換えられるデータを言います。パラメータには<<positional,位置パラメータ>>・<<special,特殊パラメータ>>・<<variables,変数>>の三種類があります。

[[positional]]
== 位置パラメータ

dfn:[位置パラメータ]は 1 以上の自然数によって識別されるパラメータです。例えば位置パラメータが三つある場合、それらは順に +1+, +2+, +3+ という名称で識別されます。位置パラメータの個数は<<sp-hash,特殊パラメータ +#+>> で取得できます。また全ての位置パラメータを表す特殊パラメータとして +*+ と +@+ があります。

位置パラメータは、シェルの起動時に、シェルのコマンドライン引数を元に初期化されます (link:invoke.html#arguments[起動時のコマンドライン引数]参照)。引数のうち、位置パラメータの値として与えられたオペランドが順に一つずつ位置パラメータとなります。

シェルのコマンド実行中に{zwsp}link:exec.html#function[関数]が呼び出されるとき、位置パラメータはその関数の呼び出しに対する引数に変更されます。すなわち、関数の実行中は位置パラメータによって関数の引数を参照できます。関数呼び出しの直前の位置パラメータの値は保存されており、関数の実行が終了する際に元の値に戻ります。

位置パラメータは、{zwsp}link:_set.html[set] や link:_shift.html[shift] などの組込みコマンドによって変更できます。

+0+ は位置パラメータとは見なされません (特殊パラメータの一つです)。

[[special]]
== 特殊パラメータ

dfn:[特殊パラメータ]は一文字の記号によって識別されるパラメータです。特殊パラメータにはユーザが明示的に値を代入することはできません。

Yash では以下の特殊パラメータが利用可能です。

[[sp-zero]]+0+::
このパラメータの値は、シェルの起動時に与えられたシェルの実行ファイルの名称またはスクリプトファイルの名称です。(link:invoke.html#arguments[起動時のコマンドライン引数]参照)

[[sp-hash]]+#+::
このパラメータの値は、現在の位置パラメータの個数を表す 0 以上の整数です。

[[sp-dollar]]+$+::
このパラメータの値は、シェル自身のプロセス ID を表す正の整数です。この値はサブシェルにおいても変わりません。

[[sp-hyphen]]+-+::
このパラメータの値は、現在シェルで有効になっているオプションの文字をつなげたものです。この値には、{zwsp}link:invoke.html[シェルの起動]時にコマンドライン引数で指定できる一文字のオプションのうち現在有効になっているものが全て含まれます。{zwsp}link:_set.html[Set 組込みコマンド]でオプションを変更した場合は、その変更がこのパラメータの値にも反映されます。

[[sp-question]]+?+::
このパラメータの値は、最後に終了した{zwsp}link:syntax.html#pipelines[パイプライン]の終了ステータスを表す 0 以上の整数です。

[[sp-exclamation]]+!+::
このパラメータの値は、最後に開始した{zwsp}link:syntax.html#async[非同期コマンド]もしくは最後に{zwsp}link:_bg.html[再開]したジョブのプロセス ID です。

[[sp-asterisk]]+*+::
このパラメータの値は、現在の<<positional,位置パラメータ>>の値です。位置パラメータが一つもない場合、このパラメータの値は空文字列です。位置パラメータが複数ある場合、このパラメータの値は全ての位置パラメータの値を連結したものです。各位置パラメータの値の間は以下に従って区切られます。
+
--
- 変数 <<sv-ifs,+IFS+>> が存在し、その値が空でない場合、各位置パラメータは変数 +IFS+ の値の最初の文字で区切られます。
- 変数 +IFS+ が存在し、その値が空の場合、各位置パラメータは間に何も置かずに連結されます。
- 変数 +IFS+ が存在しない場合、各位置パラメータは空白文字で区切られます。
--
+
このパラメータの展開結果に対して{zwsp}link:expand.html#split[単語分割]が行われる場合、値はまず元の位置パラメータに一致するように分割されさらに変数 +IFS+ の値に従って分割されます。この最初の分割は +IFS+ が空文字列でも行います。

[[sp-at]]+@+::
このパラメータは、パラメータ +&#42;+ と同様に現在の全ての<<positional,位置パラメータ>>を表します。ただし、このパラメータが二重引用符による{zwsp}link:syntax.html#quotes[クォート]の中で{zwsp}link:expand.html#params[展開]される場合の扱いがパラメータ +&#42;+ と異なります。この場合、結果は各位置パラメータに正確に一致するように{zwsp}link:expand.html#split[単語分割]されます。また位置パラメータが一つもない場合、このパラメータは展開後の単語には残りません。(よって、引用符の中であるにもかかわらず、展開結果は一つの単語になるとは限りません。)
+
例えば位置パラメータが一つもないとき、コマンドライン +echo 1 "$@" 2+ は ++echo++、++1++、++2++ という三つの単語に展開されます。位置パラメータが ++1++、++2  2++、++3++ の三つのとき、コマンドライン +echo "$@"+ は ++echo++、++1++、++2  2++、++3++ という四つの単語に展開され、コマンドライン +echo "a$@b"+ は ++echo++、++a1++、++2  2++、++3b++ という四つの単語に展開されます。

[[variables]]
== 変数

dfn:[変数]とはユーザが自由に代入可能なパラメータです。各変数は名前で区別され、それぞれが文字列の値を持ちます。

変数の名前は、英数字と下線 (+_+) から構成されます。ただし変数名の頭文字を数字にすることはできません。環境によってはこれ以外の文字も変数名に使用できます。

シェルが扱う変数のうち、エクスポートの対象となっているものはdfn:[環境変数]といいます。これらの変数はシェルが外部コマンドを起動する際に外部コマンドに渡されます。シェルが起動されたときにシェルを起動したプログラムから渡された変数は自動的に環境変数になります。

変数は、{zwsp}link:syntax.html#simple[単純コマンド]によって代入できます。また link:_typeset.html[typeset 組込みコマンド]などでも変数に代入することができます。変数を削除するには link:_unset.html[unset 組込みコマンド]を使います。

[[shellvars]]
=== シェルが使用する変数

以下の名前の変数は、yash の実行において特別な意味を持っています。

[[sv-cdpath]]+CDPATH+::
この変数は link:_cd.html[cd 組込みコマンド]で移動先ディレクトリを検索するために使われます。

[[sv-columns]]+COLUMNS+::
この変数は端末ウィンドウの横幅 (文字数) を指定します。この変数が設定されている場合、デフォルトの横幅ではなくこの変数の値で指定された横幅が{zwsp}link:lineedit.html[行編集]で使われます。

[[sv-command]]+COMMAND+::
<<sv-post_prompt_command,+POST_PROMPT_COMMAND+>> 変数が実行される間、この変数は直前に入力されたコマンドを示します。
+POST_PROMPT_COMMAND+ の実行が終わるとこの変数は消去されます。

[[sv-command_not_found_handler]]+COMMAND_NOT_FOUND_HANDLER+::
シェルが実行しようとしたコマンドが見つからなかったとき、この変数の値がコマンドとして実行されます。不明なコマンドを実行したときに何か別のコマンドを実行させたい時に便利です。{zwsp}link:exec.html#simple[単純コマンドの実行]を参照。
+
この機能は link:posix.html[POSIX 準拠モード]では働きません。

[[sv-dirstack]]+DIRSTACK+::
この配列変数はディレクトリスタックの実装に使われています。{zwsp}link:_pushd.html[pushd 組込みコマンド]でディレクトリを移動したとき、前のディレクトリを覚えておくためにそのパス名がこの配列に入れられます。この配列の内容を変更することは、ディレクトリスタックの内容を直接変更することになります。

[[sv-echo_style]]+ECHO_STYLE+::
この変数は link:_echo.html[echo 組込みコマンド]の挙動を指定します。

[[sv-env]]+ENV+::
link:posix.html[POSIX 準拠モード]で対話モードのシェルが起動されたとき、この変数の値で示されるパスのファイルが初期化スクリプトとして読み込まれます (link:invoke.html#init[シェルの初期化処理]参照)。

[[sv-fcedit]]+FCEDIT+::
link:_fc.html[Fc 組込みコマンド]でコマンドを編集する際、この変数の値で示されたエディタがコマンドの編集に使われます。

[[sv-handled]]+HANDLED+::
この変数は +COMMAND_NOT_FOUND_HANDLER+ 変数の値が実行された後に、コマンドが見つからなかったことをエラーとするかどうかを指示します。{zwsp}link:exec.html#simple[単純コマンドの実行]を参照。

[[sv-histfile]]+HISTFILE+::
link:interact.html#history[コマンド履歴]を保存するファイルのパスを指定します。

[[sv-histrmdup]]+HISTRMDUP+::
link:interact.html#history[コマンド履歴]の重複をチェックする個数を指定します。履歴にコマンドを追加する際、既に履歴にあるコマンドのうちここで指定した個数のコマンドが新しく追加されるコマンドと同じかどうかをチェックします。同じコマンドが既に履歴にあれば、それは履歴から削除されます。
+
例えばこの変数の値が +1+ のときは、履歴に追加されるコマンドが一つ前のコマンドと同じならばそれは削除されます。それより古い履歴のコマンドは、(履歴に追加されるコマンドと同じでも) 削除されません。もしこの変数の値が +HISTSIZE+ 変数の値と同じなら、履歴の中で重複するコマンドはすべて削除されます。あるいはもしこの変数の値が +0+ なら、重複する履歴は一切削除されません。

[[sv-histsize]]+HISTSIZE+::
link:interact.html#history[コマンド履歴]に保存される履歴項目の個数を指定します。

[[sv-home]]+HOME+::
ユーザのホームディレクトリのパスを指定します。{zwsp}link:expand.html#tilde[チルダ展開]や link:_cd.html[cd 組込みコマンド]の動作に影響します。

[[sv-ifs]]+IFS+::
この変数は{zwsp}link:expand.html#split[単語分割]の区切りを指定します。シェルの起動時にこの変数の値は空白文字・タブ・改行の三文字に初期化されます。

[[sv-lang]]+LANG+::
[[sv-lc_all]]+LC_ALL+::
[[sv-lc_collate]]+LC_COLLATE+::
[[sv-lc_ctype]]+LC_CTYPE+::
[[sv-lc_messages]]+LC_MESSAGES+::
[[sv-lc_monetary]]+LC_MONETARY+::
[[sv-lc_numeric]]+LC_NUMERIC+::
[[sv-lc_time]]+LC_TIME+::
これらの変数はシェルが動作するロケールを指定します。シェルが読み書きするファイルのエンコーディングやエラーメッセージの内容などはこの変数で指定されたロケールに従います。
+
+LC_CTYPE+ 変数の値はシェルの起動時にのみ反映されます。シェルの実行中にこの変数を変更してもシェルのロケールは変わりません (シェルが非 link:posix.html[POSIX 準拠モード]で{zwsp}link:interact.html[対話モード]の場合を除く)。

[[sv-lineno]]+LINENO+::
この変数の値は、現在シェルが読み込んで実行しているファイルにおける、現在実行中のコマンドのある行番号を示します。(link:interact.html[対話モード]では、コマンドを入力して実行するたびに行番号は 1 に戻ります)
+
一度この変数に代入したり変数を削除したりすると、この変数を用いて行番号を取得することはできなくなります。

[[sv-lines]]+LINES+::
この変数は端末ウィンドウの行数を指定します。この変数が設定されている場合、デフォルトの行数ではなくこの変数の値で指定された行数が{zwsp}link:lineedit.html[行編集]で使われます。

[[sv-mail]]+MAIL+::
この変数は{zwsp}link:interact.html#mailcheck[メールチェック]の対象となるファイルのパスを指定します。

[[sv-mailcheck]]+MAILCHECK+::
この変数は{zwsp}link:interact.html#mailcheck[メールチェック]を行う間隔を秒単位で指定します。この変数の値はシェルの起動時に +600+ に初期化されます。

[[sv-mailpath]]+MAILPATH+::
この変数は{zwsp}link:interact.html#mailcheck[メールチェック]の対象となるファイルのパスを指定します。

[[sv-nlspath]]+NLSPATH+::
POSIX によるとこの変数の値はロケール依存のメッセージデータファイルのパスを指示することになっていますが、yash では使用していません。

[[sv-oldpwd]]+OLDPWD+::
link:_cd.html[Cd 組込みコマンド]などで作業ディレクトリを変更したときに、変更前の作業ディレクトリパスがこの変数に設定されます。この変数はデフォルトでエクスポート対象になります。

[[sv-optarg]]+OPTARG+::
link:_getopts.html[Getopts 組込みコマンド]で引数付きのオプションを読み込んだとき、その引数の値がこの変数に設定されます。

[[sv-optind]]+OPTIND+::
この変数の値は、{zwsp}link:_getopts.html[getopts 組込みコマンド]で次に読み込むオプションのインデックスを表します。シェルの起動時にこの変数は +1+ に初期化されます。

[[sv-path]]+PATH+::
この変数は、{zwsp}link:exec.html#search[コマンドの検索時]にコマンドのありかを示すパスを指定します。

[[sv-post_prompt_command]]+POST_PROMPT_COMMAND+::
link:posix.html[POSIX 準拠モード]でない{zwsp}link:interact.html[対話モード]のシェルにおいて、シェルがコマンドを一行読み込むたびに、この変数の値がコマンドとして解釈・実行されます。詳細は{zwsp}link:interact.html#prompt[プロンプト]を参照してください。

[[sv-ppid]]+PPID+::
この変数の値は、シェルの親プロセスのプロセス ID を表す正の整数です。この変数はシェルの起動時に初期化されます。この変数の値は{zwsp}link:exec.html#subshell[サブシェル]においても変わりません。

[[sv-prompt_command]]+PROMPT_COMMAND+::
link:posix.html[POSIX 準拠モード]でない{zwsp}link:interact.html[対話モード]のシェルにおいて、シェルが各コマンドの{zwsp}link:interact.html#prompt[プロンプト]を出す直前に、この変数の値がコマンドとして解釈・実行されます。これは、プロンプトを出す直前に毎回
ifdef::basebackend-html[]
pass:[<code><a href="_eval.html">eval</a> -i -- "${PROMPT_COMMAND-}"</code>]
endif::basebackend-html[]
ifndef::basebackend-html[`eval -i -- "${PROMPT_COMMAND-}"`]
というコマンドが実行されるのと同じですが、このコマンドの実行結果は次のコマンドでの +?+ 特殊パラメータの値には影響しません。

[[sv-ps1]]+PS1+::
この変数の値は、対話モードのシェルが出力する標準のコマンドプロンプトを指定します。この値の書式については{zwsp}link:interact.html#prompt[プロンプト]の項を参照してください。
+
この変数はシェルの起動時に実効ユーザ ID が 0 かどうかによって +$&#x20;+ と +#&#x20;+ のどちらかに初期化されます。

[[sv-ps1p]]+PS1P+::
この変数の値は、対話モードのシェルがコマンドを読み込む際に、{zwsp}link:lineedit.html#prediction[推定された]コマンドを表示するフォントの書式を指定します。この値の書式については{zwsp}link:interact.html#prompt[プロンプト]の項を参照してください。

[[sv-ps1r]]+PS1R+::
この変数の値は、対話モードのシェルがコマンドを読み込む際に、入力されるコマンドの右側に表示されるプロンプトを指定します。この値の書式については{zwsp}link:interact.html#prompt[プロンプト]の項を参照してください。

[[sv-ps1s]]+PS1S+::
この変数の値は、対話モードのシェルがコマンドを読み込む際に、入力されるコマンドを表示するフォントの書式を指定します。この値の書式については{zwsp}link:interact.html#prompt[プロンプト]の項を参照してください。

[[sv-ps2]]+PS2+::
この変数の値は、対話モードのシェルが出力する補助的なコマンドプロンプトを指定します。この値の書式については{zwsp}link:interact.html#prompt[プロンプト]の項を参照してください。
この変数はシェルの起動時に +>&#x20;+ に初期化されます。

[[sv-ps2p]]+PS2P+::
この変数は <<sv-ps1p,+PS1P+>> 変数と同様ですが、プロンプトとして <<sv-ps1,+PS1+>> 変数ではなく <<sv-ps2,+PS2+>> 変数の値が使用されるときに使用されます。

[[sv-ps2r]]+PS2R+::
この変数は <<sv-ps1r,+PS1R+>> 変数と同様ですが、プロンプトとして <<sv-ps1,+PS1+>> 変数ではなく <<sv-ps2,+PS2+>> 変数の値が使用されるときに使用されます。

[[sv-ps2s]]+PS2S+::
この変数は <<sv-ps1s,+PS1S+>> 変数と同様ですが、プロンプトとして <<sv-ps1,+PS1+>> 変数ではなく <<sv-ps2,+PS2+>> 変数の値が使用されるときに使用されます。

[[sv-ps4]]+PS4+::
link:_set.html#options[Xtrace オプション]が有効なとき、この変数の値が各トレース出力の前に出力されます。ただし出力の前にこの変数の値に対して{zwsp}link:expand.html#params[パラメータ展開]、{zwsp}link:expand.html#cmdsub[コマンド置換]、{zwsp}link:expand.html#arith[数式展開]を行います。また link:posix.html[POSIX 準拠モード]でなければ、<<sv-ps1,+PS1+>> 変数と同様に、バックスラッシュで始まる特殊な記法が利用できます。
+
この変数はシェルの起動時に +&#x2B;&#x20;+ に初期化されます。

[[sv-ps4s]]+PS4S+::
この変数は <<sv-ps1s,+PS1S+>> 変数と同様ですが、プロンプトとして <<sv-ps1,+PS1+>> 変数が使用されるときではなく、トレース出力の際に <<sv-ps4,+PS4+>> 変数の値が使用されるときに使用されます。この変数を使うとトレース出力のフォントの書式を変更することができます。

[[sv-pwd]]+PWD+::
この変数の値は現在の作業ディレクトリの絶対パスを表します。この変数はシェルの起動時に正しいパスに初期化され、{zwsp}link:_cd.html[cd 組込みコマンド]などで作業ディレクトリを変更する度に再設定されます。この変数はデフォルトでエクスポート対象になります。

[[sv-random]]+RANDOM+::
この変数は乱数を取得するために使用できます。この変数の値は 0 以上 32768 未満の一様分布乱数になっています。
+
この変数に非負整数を代入すると乱数を生成する__種__を再設定できます。
+
一度この変数を削除すると、この変数を用いて乱数を取得することはできなくなります。またシェルが link:posix.html[POSIX 準拠モード]で起動された場合、この変数で乱数を取得することはできません。

[[sv-term]]+TERM+::
この変数は対話モードのシェルが動作している端末の種類を指定します。ここで指定された端末の種類に従って{zwsp}link:lineedit.html[行編集]機能は端末を制御します。この変数の効力を得るためには変数がエクスポートされている必要があります。

[[sv-xdg_config_home]]+XDG_CONFIG_HOME+::
この変数は{zwsp}link:invoke.html#init[シェルの初期化ファイル]の場所を指定するために使われます。
値が定義されていない場合は
ifdef::basebackend-html[]
pass:[<code><a href="#sv-home">$HOME</a>/.config</code>]
endif::basebackend-html[]
ifndef::basebackend-html[`$HOME/.config`]
が使われます。

[[sv-yash_after_cd]]+YASH_AFTER_CD+::
この変数の値は、{zwsp}link:_cd.html[cd 組込みコマンド]や link:_pushd.html[pushd 組込みコマンド]で作業ディレクトリが変更された後にコマンドとして解釈・実行されます。これは、作業ディレクトリが変わった後に毎回
ifdef::basebackend-html[]
pass:[<code><a href="_eval.html">eval</a> -i -- "${YASH_AFTER_CD-}"</code>]
endif::basebackend-html[]
ifndef::basebackend-html[`eval -i -- "${YASH_AFTER_CD-}"`]
というコマンドが実行されるのと同じです。

[[sv-yash_loadpath]]+YASH_LOADPATH+::
link:_dot.html[ドット組込みコマンド]で読み込むスクリプトファイルのあるディレクトリを指定します。<<sv-path,+PATH+>> 変数と同様に、コロンで区切って複数のディレクトリを指定できます。この変数はシェルの起動時に、yash に付属している共通スクリプトのあるディレクトリ名に初期化されます。

[[sv-yash_le_timeout]]+YASH_LE_TIMEOUT+::
この変数は{zwsp}link:lineedit.html[行編集]機能で曖昧な文字シーケンスが入力されたときに、入力文字を確定させるためにシェルが待つ時間をミリ秒単位で指定します。行編集を行う際にこの変数が存在しなければ、デフォルトとして 100 ミリ秒が指定されます。

[[sv-yash_ps1]]+YASH_PS1+::
[[sv-yash_ps1p]]+YASH_PS1P+::
[[sv-yash_ps1r]]+YASH_PS1R+::
[[sv-yash_ps1s]]+YASH_PS1S+::
[[sv-yash_ps2]]+YASH_PS2+::
[[sv-yash_ps2p]]+YASH_PS2P+::
[[sv-yash_ps2r]]+YASH_PS2R+::
[[sv-yash_ps2s]]+YASH_PS2S+::
[[sv-yash_ps4]]+YASH_PS4+::
[[sv-yash_ps4s]]+YASH_PS4S+::
link:posix.html[POSIX 準拠モード]ではないとき、これらの変数は名前に +YASH_+ が付かない +PS1+ 等の変数の代わりに優先して使われます。POSIX 準拠モードではこれらの変数は無視されます。{zwsp}link:interact.html#prompt[プロンプト]で yash 固有の記法を使用する場合はこれらの変数を使用すると POSIX 準拠モードで yash 固有の記法が解釈されずに表示が乱れるのを避けることができます。

[[sv-yash_version]]+YASH_VERSION+::
この変数はシェルの起動時にシェルのバージョン番号に初期化されます。

[[arrays]]
=== 配列

dfn:[配列]とは、一つの変数に複数の値 (文字列) を持たせたものです。一つの配列の複数の値は<<positional,位置パラメータ>>と同様に 1 以上の自然数で識別されます。

配列は、{zwsp}link:syntax.html#simple[単純コマンド]によって代入できます。また link:_array.html[array 組込みコマンド]などでも配列に代入することができます。配列を削除するには変数と同様に link:_unset.html[unset 組込みコマンド]を使います。

配列を配列のままエクスポートすることはできません。配列をエクスポートしようとすると、配列の各値をコロンで区切って繋いだ一つの文字列の値を持つ変数としてエクスポートされます。

link:posix.html[POSIX 準拠モード]では配列は使えません。

// vim: set filetype=asciidoc expandtab: