catopenのヘルプ・マニュアル
日本語 英語
catopen --help
man catopen
CATOPEN(3) Linux Programmer’s Manual CATOPEN(3)
名前
catopen, catclose - メッセージカタログのオープン/クローズ
書式
#include
nl_catd catopen(const char *name, int flag);
int catclose(nl_catd catalog);
説明
関数 catopen() はメッセージカタログをオープンし、カタログディスクリプタ
を返す。このディスクリプタは catclose() または execve(2) が呼び出される
ま で有効である。カタログディスクリプタを実装するためにファイルディスク
リプタを使用すると、 FD_CLOEXEC フラグが設定される。
引き数 name はオープンするメッセージカタログの名前を指定する。 name が
絶 対パスで指定されている場合 (すなわち '/' を含んでいる場合)、 name は
メッセージカタログへのパス名である。それ以外の場合、環境変数 NLSPATH が
name とともに使用され %N を置き換える (locale(7) 参照)。プロセスが root
権限を持っているときに NLSPATH が使われるかどうかは指定されていな い 。
NLSPATH 環境変数が存在しないか、 NLSPATH で指定されたパスの中のどのパス
においてもメッセージカタログをオープンできない場合、実装で定義されて い
る パスが使われる。後者のデフォルトパスは、 flag 引き数が NL_CAT_LOCALE
の場合には LC_MESSAGES のロケール設定に依存し、 flag 引き数が 0 の場 合
には LANG 環境変数に依存する。ロケールの LC_MESSAGES を変更すると、オー
プンされているカタログディスクリプタが無効になるかもしれない。
catopen() の flag 引き数は、使用される言語のソースを示すために使われ る
。 NL_CAT_LOCALE に設定されると、 LC_MESSAGES の現在のロケール設定が使
われる。それ以外の場合は LANG 環境変数が使われる。
関数 catclose() は catalog で指定されたメッセージカタログをクローズする
。これは、以降の catalog で指定されるメッセージカタログへの全ての参照を
無効にする。
返り値
関数 catopen() が成功すると、 nl_catd 型のメッセージカタログディスク リ
プ タを返す。失敗した場合は (nl_catdv) -1 を返し、 errno を設定してエラ
ーを示す。ここで起こり得るエラーの値には、 open(2) の呼び出しの際に起こ
り得る全てのエラーの値が含まれる。
関数 catclose() は、成功した場合 0 を、失敗した場合 -1 を返す。
環境変数
LC_MESSAGES
LC_MESSAGES ロケール設定のソースになることも可能なので、 flag が
NL_CAT_LOCALE に設定されている場合は、使用する言語を決定するのに
使われる。
LANG flag が 0 の場合、使用する言語を決定する。
準拠
POSIX.1-2001. 定数 MCLoadBySet と MCLoadAll に対応するソースが何である
のかがはっきりしていない (下記参照)。
注意
以上は POSIX.1-2001 における説明である。 glibc では NL_CAT_LOCALE の 値
は 1 である (以下の MCLoadAll と比較のこと)。デフォルトのパスは場合によ
って様々であるが、通常は /usr/share/locale 以下のファイルが調べられる。
Linux における注意
こ れらの関数は libc.so.4.4.4c 以降で使用可能である。 linux の libc4 と
libc5 においては、カタログディスクリプタ nl_catd は mmap(2) されたメ モ
リの領域であってファイルディスクリプタではない。 catopen() の flag は、
MCLoadBySet (=0) か MCLoadAll (=1) のどちらかである。前者の場合、カタロ
グのセットは必要時にロードされる。後者の場合、最初の catopen() の呼び出
しのときに全てのカタログがメモリ内にロードされる。デフォルトのパスは 場
合 によって様々であるが、通常は /etc/locale と /usr/share/locale 以下の
ファイルが調べられる。
関連項目
catgets(3), setlocale(3)
GNU 2001-12-14 CATOPEN(3)
CATOPEN(3) Linux Programmer’s Manual CATOPEN(3)
NAME
catopen, catclose - open/close a message catalog
SYNOPSIS
#include
nl_catd catopen(const char *name, int flag);
int catclose(nl_catd catalog);
DESCRIPTION
The function catopen() opens a message catalog and returns a catalog
descriptor. The descriptor remains valid until catclose() or
execve(2). If a file descriptor is used to implement catalog descrip-
tors then the FD_CLOEXEC flag will be set.
The argument name specifies the name of the message catalog to be
opened. If name specifies and absolute path (i.e., contains a '/'),
then name specifies a pathname for the message catalog. Otherwise, the
environment variable NLSPATH is used with name substituted for %N (see
locale(7)). It is unspecified whether NLSPATH will be used when the
process has root privileges. If NLSPATH does not exist in the environ-
ment, or if a message catalog cannot be opened in any of the paths
specified by it, then an implementation defined path is used. This
latter default path may depend on the LC_MESSAGES locale setting when
the flag argument is NL_CAT_LOCALE and on the LANG environment variable
when the flag argument is 0. Changing the LC_MESSAGES part of the
locale may invalidate open catalog descriptors.
The flag argument to catopen() is used to indicate the source for the
language to use. If it is set to NL_CAT_LOCALE then it will use the
current locale setting for LC_MESSAGES. Otherwise it will use the LANG
environment variable.
The function catclose() closes the message catalog identified by cata-
log. It invalidates any subsequent references to the message catalog
defined by catalog.
RETURN VALUE
The function catopen() returns a message catalog descriptor of type
nl_catd on success. On failure, it returns (nl_catd) -1 and sets errno
to indicate the error. The possible error values include all possible
values for the open(2) call.
The function catclose() returns 0 on success, or -1 on failure.
ENVIRONMENT
LC_MESSAGES
May be the source of the LC_MESSAGES locale setting, and thus
determine the language to use if flag is set to NL_CAT_LOCALE.
LANG The language to use if flag is 0.
CONFORMING TO
POSIX.1-2001. It is unclear what the source was for the constants
MCLoadBySet and MCLoadAll (see below).
NOTES
The above is the POSIX.1-2001 description. The glibc value for
NL_CAT_LOCALE is 1. (Compare MCLoadAll below.) The default path
varies, but usually looks at a number of places below
/usr/share/locale.
Linux Notes
These functions are available for Linux since libc 4.4.4c. In the case
of linux libc4 and libc5, the catalog descriptor nl_catd is a
mmap(2)’ed area of memory and not a file descriptor. The flag argument
to catopen() should be either MCLoadBySet (=0) or MCLoadAll (=1). The
former value indicates that a set from the catalog is to be loaded when
needed, whereas the latter causes the initial call to catopen() to load
the entire catalog into memory. The default search path varies, but
usually looks at a number of places below /etc/locale and
/usr/lib/locale.
SEE ALSO
catgets(3), setlocale(3)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
GNU 2001-12-14 CATOPEN(3)