日本語 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.4-RELEASE-K, 13.0-RELEASE-K から 13.3-RELEASE-K, 14.0-RELEASE-K から 14.1-RELEASE-K は、全翻訳済み)
13.3-STABLE-K, 15.0-CURRENT-K は現在、作成中で日々更新されています。
Table of Contents
READPASSPHRASE(3) FreeBSD ライブラリ関数マニュアル READPASSPHRASE(3)
名称
readpassphrase -- ユーザからパスフレーズを取得する
書式
#include <readpassphrase.h>
char *
readpassphrase(const char *prompt, char *buf, size_t bufsiz, int flags);
解説
readpassphrase() 関数は、プロンプトを表示し、/dev/tty からパスフレーズを
読み込みます。このファイルがアクセスできず、RPP_REQUIRE_TTY フラグが設定
されていないなら、readpassphrase() は、標準エラー出力にプロンプトを表示
し、標準入力から読み込みます。この場合、エコーをオフにすることは、一般的
にできません。
bufsiz -1 文字まで (一つは、ヌル文字のためにあります) 与えられるバッファ
buf に読み込まれます。どんな追加の文字と終了する改行 (またはリターン) 文
字も廃棄されます。
readpassphrase() 関数は、次のオプションの flags を取ります:
RPP_ECHO_OFF エコーをオフにする (デフォルトの振る舞い)。
RPP_ECHO_ON エコーをオンのままとする。
RPP_REQUIRE_TTY tty がないなら、失敗する。
RPP_FORCELOWER 小文字の入力を強制する。
RPP_FORCEUPPER 大文字の入力を強制する。
RPP_SEVENBIT 入力から高位ビットを取り除く。
RPP_STDIN 標準入力 (stdin) からパスフレーズを強制的に読み込む。
呼び出しプロセスは、プロセスのアドレス空間で平文 (クリアテキスト) のパス
フレーズを目に見えるようにしておくことを回避するためにできるだけ早くパス
フレーズを 0 にするべきです。
戻り値
成功して終了すれば、readpassphrase() ヌル文字で終了したパスフレーズへのポ
インタを返します。エラーに遭遇した場合、端末の状態は、復旧され、NULL ポイ
ンタが返されます。
関連ファイル
/dev/tty
使用例
次のコードの破片は、バッファ passbuf へ /dev/tty からパスフレーズを読み込
みます。
char passbuf[1024];
...
if (readpassphrase("Response: ", passbuf, sizeof(passbuf),
RPP_REQUIRE_TTY) == NULL)
errx(1, "unable to read passphrase");
if (compare(transform(passbuf), epass) != 0)
errx(1, "bad passphrase");
...
memset(passbuf, 0, sizeof(passbuf));
エラー
[EINTR] readpassphrase() 関数は、シグナルによって中断されまし
た。
[EINVAL] bufsiz 引数が 0 です。
[EIO] プロセスは、制御端末から読み込むことを試みるバックグラ
ウンドプロセスのメンバで、プロセスは、SIGTTIN シグナル
を無視するか、またはブロックしているか、またはプロセス
グループは、孤児にされます。
[EMFILE] プロセスは、オープンファイル記述子のためのその制限に既
に到着しました。
[ENFILE] システムファイルテーブルが満杯です。
[ENOTTY] 制御端末がありません。そして、RPP_REQUIRE_TTY フラグが
指定されました。
シグナル
readpassphrase() 関数は、次のシグナルを捕獲します:
SIGALRM SIGHUP SIGINT
SIGPIPE SIGQUIT SIGTERM
SIGTSTP SIGTTIN SIGTTOU
上記のシグナルの 1 つがインタセプトされるとき、端末のエコーは、以前にオフ
にされていたならば、復旧されます。readpassphrase() が呼ばれたとき、シグナ
ルのハンドラがシグナルに対してインストールされたならば、そのハンドラが実
行されます。ハンドラがシグナルのために前もってインストールされなかったな
ら、デフォルトのアクションは、sigaction(2) のように起こされます。
SIGTSTP, SIGTTIN と SIGTTOU シグナル (キーボードから、またはバックグラウ
ンドプロセスからの端末の I/O のために生成されたストップシグナル) は、特別
に扱われます。ストップされた後、プロセスが再開されるとき、
readpassphrase() は、プロンプトを再印刷し、ユーザは、パスフレーズを入力で
きます。
関連項目
sigaction(2), getpass(3)
規格
readpassphrase() 関数は、拡張であり、移植性が必要であるなら、使用すべきで
はありません。
歴史
readpassphrase() 関数は、FreeBSD 4.6 と OpenBSD 2.9 ではじめて登場しまし
た。
FreeBSD 11.4 May 31, 2007 FreeBSD 11.4