日本語 man コマンド類 (ja-man-1.1j_5) と日本語 man ドキュメント (ja-man-doc-5.4 (5.4-RELEASE 用) など) をインストールすると、以下のような man コマンド閲覧、キーワード検索が コンソールからできるようになります。
4.11-RELEASE-K, 5.4-RELEASE-K, 5.5-RELEASE-K, 6.0-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K, 12.1-RELEASE-K は、 プライベート版 (小金丸が編集してまとめたもの) ですが、 より多くの翻訳したファイルが含まれています。 (5.4-RELEASE-K から 6.4-RELEASE-K, 7.0-RELEASE-K から 7.4-RELEASE-K, 8.0-RELEASE-K から 8.4-RELEASE-K, 9.0-RELEASE-K から 9.3-RELEASE-K, 10.0-RELEASE-K から 10.3-RELEASE-K, 11.0-RELEASE-K から 11.4-RELEASE-K, 12.0-RELEASE-K から 12.3-RELEASE-K, 13.0-RELEASE-K から 13.2-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
GETENV(3) FreeBSD ライブラリ関数マニュアル GETENV(3)
名称
getenv, putenv, setenv, unsetenv -- 環境変数の関数群
ライブラリ
標準 C ライブラリ (libc, -lc)
書式
#include <stdlib.h>
char *
getenv(const char *name);
int
setenv(const char *name, const char *value, int overwrite);
int
putenv(char *string);
int
unsetenv(const char *name);
解説
これらの関数は、ホストの環境変数のリストに環境変数を設定する、未設定とす
る、取り出します。
getenv() 関数は、環境変数 name の現在の値を取得します。アプリケーション
は、getenv() 関数によって指された文字列を修正するべきではありません。
setenv() 関数は、現在の環境変数リストに環境変数 name を挿入するか、または
リセットします。変数 name に存在しないなら、与えられた value で挿入されま
す。変数が存在するなら、引数の overwrite がテストされます。overwrite が 0
であるなら、変数は、リセットされず、そうでなければ、与えられた value にリ
セットされます。
putenv() 関数は、形式 ``name=value'' の引数を取り、それを現在の環境変数に
直接入れるので、引数を変更することは、環境変数を変更します。変数 name が
リストに存在しないなら、それは、与えられた value で挿入されます。変数
name が存在するなら、それは、与えられた value にリセットされます。
unsetenv() 関数は、リストの name によって指される変数名のすべてのインスタ
ンスを削除します。
内部の使用法のための環境のコピーを行う間に、破壊 (例えば、値のない名前)
が検出されるなら、setenv(), unsetenv() と putenv() は、問題に関して
stderr (標準エラー) に警告を出力し、破壊されたエントリを落とし、エラーな
しでタスクを完了します。
戻り値
getenv() 関数は、ヌル文字で終了する文字列として環境変数の値を返します。変
数 name が現在の環境変数にないなら、NULL が返されます。
関数 setenv(), putenv(), および unsetenv() は、処理が成功すると値 0 を返
します。そうでない場合、値 -1 が返され、グローバル変数 errno にエラーを示
す値が設定されます。
エラー
[EINVAL] 関数 getenv(), setenv() または unsetenv() は、name が
NULL ポインタ、空の文字列を指している、または ``='' 文
字を含んでいる文字列を指しているので、失敗しました。
関数 putenv() は、string が NULL ポインタ、string に
``='' 文字がないか、または ``='' が string の最初の文
字であるので、失敗しました。これは、POSIX 仕様に従って
いません。
[ENOMEM] 関数 setenv(), unsetenv() または putenv() は、環境変数
のためのメモリを割り付けることができなかったので、失敗
しました。
関連項目
csh(1), sh(1), execve(2), environ(7)
規格
getenv() 関数は、ISO/IEC 9899:1990 (``ISO C90'') に適合しています。
setenv(), putenv() と unsetenv() 関数は、IEEE Std 1003.1-2001
(``POSIX.1'') に適合しています。
歴史
関数 setenv() と unsetenv() は、Version 7 AT&T UNIX で登場しました。
putenv() 関数は、4.3BSD-Reno で登場しました。
FreeBSD 7.0 まで、putenv() は、string のコピーを行い、setenv() を使用し
て、それを環境変数に挿入していました。これは、POSIX 仕様に従うために
``name=value'' のペアのメモリの位置として、string を使用するように、変更
されました。
バグ
name へのあらゆる以前の値より大きなサイズの value を割り当てる setenv()
への連続した呼び出しは、メモリリークの結果となります。この関数のための
FreeBSD セマンティクス (すなわち、value の内容は、コピーされ、古い値は、
無制限にアクセス可能であり続ける) は、このバグを回避不可能にします。将来
のバージョンは、バグを修正するために、1 つまたはこれらのセマンティックな
保証の両方を削除します。
FreeBSD 11.2 June 20, 2007 FreeBSD 11.2