(split) LDP: Release pages for LDP v3.39.

[linuxjm/LDP_man-pages.git] / release / man2 / shmop.2

diff --git a/release/man2/shmop.2 b/release/man2/shmop.2
index a5f2fd7..86bf390 100644 (file)
--- a/release/man2/shmop.2
+++ b/release/man2/shmop.2
@@ -20,8 +20,8 @@
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
 .\"
 .\" Formatted or processed versions of this manual, if unaccompanied by
 .\" the source, must acknowledge the copyright and authors of this work.
 .\"

-.\" Modified Sun Nov 28 17:06:19 1993, Rik Faith <faith@cs.unc.edu>
-.\"          with material from Luigi P. Bai <lpb@softint.com>
+.\" Modified Sun Nov 28 17:06:19 1993, Rik Faith (faith@cs.unc.edu)
+.\"          with material from Luigi P. Bai (lpb@softint.com)

 .\" Portions Copyright 1993 Luigi P. Bai
 .\" Modified Tue Oct 22 22:04:23 1996 by Eric S. Raymond <esr@thyrsus.com>
 .\" Modified, 5 Jan 2002, Michael Kerrisk <mtk.manpages@gmail.com>
 .\" Portions Copyright 1993 Luigi P. Bai
 .\" Modified Tue Oct 22 22:04:23 1996 by Eric S. Raymond <esr@thyrsus.com>
 .\" Modified, 5 Jan 2002, Michael Kerrisk <mtk.manpages@gmail.com>


@@ -36,276 +36,121 @@
 .\"
 .\" FIXME . Add an example program to this page.
 .\" FIXME Linux 2.6.9 added SHM_EXEC, which should be documented
 .\"
 .\" FIXME . Add an example program to this page.
 .\" FIXME Linux 2.6.9 added SHM_EXEC, which should be documented

+.\"*******************************************************************

 .\"
 .\"

-.\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
-.\"         all rights reserved.
-.\" Translated 1999-08-15, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
-.\" Updated & Modified 2002-05-07, Yuichi SATO <ysato@h4.dion.ne.jp>
-.\" Updated & Modified 2003-01-18, Yuichi SATO <ysato444@yahoo.co.jp>
-.\" Updated & Modified 2005-01-07, Yuichi SATO
-.\" Updated 2005-12-05, Akihiro MOTOKI, Catch up to LDP man-pages 2.16
-.\" Updated 2006-04-14, Akihiro MOTOKI, Catch up to LDP man-pages 2.29
+.\" This file was generated with po4a. Translate the source file.

 .\"
 .\"

-.\"WORD:       shared memory           共有メモリ
-.\"WORD:       segment                 セグメント
-.\"WORD:       super-user              スーパー・ユーザー
-.\"WORD:       detach                  分離
-.\"WORD:       attach                  付加
-.\"WORD:       member                  メンバー
-.\"WORD:       implement               実装
-.\"WORD:       page aligned            ページ境界に合った
-.\"WORD:       unaligned               境界違反
-.\"WORD:       descriptor              ディスクリプター
-.\"WORD:       parameter               パラメーター
-.\"
-.TH SHMOP 2 2008-06-03 "Linux" "Linux Programmer's Manual"
+.\"*******************************************************************
+.TH SHMOP 2 2008\-06\-03 Linux "Linux Programmer's Manual"

 .SH 名前
 shmat, shmdt \- 共有メモリ (shared memory) の操作
 .SH 書式
 .nf
 .SH 名前
 shmat, shmdt \- 共有メモリ (shared memory) の操作
 .SH 書式
 .nf

-.B #include <sys/types.h>
-.B #include <sys/shm.h>
+\fB#include <sys/types.h>\fP
+\fB#include <sys/shm.h>\fP

 
 

-.BI "void *shmat(int " shmid ", const void *" shmaddr ", int " shmflg );
+\fBvoid *shmat(int \fP\fIshmid\fP\fB, const void *\fP\fIshmaddr\fP\fB, int \fP\fIshmflg\fP\fB);\fP

 
 

-.BI "int shmdt(const void *" shmaddr );
+\fBint shmdt(const void *\fP\fIshmaddr\fP\fB);\fP

 .fi
 .SH 説明
 .fi
 .SH 説明

-.BR shmat ()
-は
-.I shmid
-で指定された共有メモリ・セグメント (shared memory segment) を
-コールしたプロセスのアドレス空間に付加 (attach) する。
-付加するアドレスは
-.I shmaddr
-に以下のどれかの形式で指定する:
+\fBshmat\fP()  は \fIshmid\fP で指定された共有メモリ・セグメント (shared memory segment) を
+コールしたプロセスのアドレス空間に付加 (attach) する。 付加するアドレスは \fIshmaddr\fP に以下のどれかの形式で指定する:

 .LP
 .LP

-.I shmaddr
-が NULL ならば、システムはセグメントを付加するための
-適切な (使用されていない) アドレスを選択する。
+\fIshmaddr\fP が NULL ならば、システムはセグメントを付加するための 適切な (使用されていない) アドレスを選択する。

 .LP
 .LP

-.I shmaddr
-が NULL でなく
-.B SHM_RND
-が
-.I shmflg
-に指定されている場合は、
-.I shmaddr
-を
-.B SHMLBA
-の倍数へと切り捨てた (rounding down) のと等しいアドレスへ付加する。
-その他の場合は
-.I shmaddr
+\fIshmaddr\fP が NULL でなく \fBSHM_RND\fP が \fIshmflg\fP に指定されている場合は、 \fIshmaddr\fP を
+\fBSHMLBA\fP の倍数へと切り捨てた (rounding down) のと等しいアドレスへ付加する。 その他の場合は \fIshmaddr\fP

 は付加を行なうアドレスで、ページ境界を指している必要がある。
 .PP
 は付加を行なうアドレスで、ページ境界を指している必要がある。
 .PP

-.B SHM_RDONLY
-が
-.I shmflg
-に指定されていた場合は、
-セグメントは読み込み専用に付加され、プロセスはそのセグメントへの
-読み込み許可を持たなければならない。
-そうでなければそのセグメントは読み込みと書き込みのために付加され、
-プロセスはそのセグメントに読み込みと書き込みの許可を持つ必要がある。
-書き込み専用の共有メモリ・セグメントという概念は存在しない。
+\fBSHM_RDONLY\fP が \fIshmflg\fP に指定されていた場合は、 セグメントは読み込み専用に付加され、プロセスはそのセグメントへの
+読み込み許可を持たなければならない。 そうでなければそのセグメントは読み込みと書き込みのために付加され、
+プロセスはそのセグメントに読み込みと書き込みの許可を持つ必要がある。 書き込み専用の共有メモリ・セグメントという概念は存在しない。

 .PP
 .PP

-(Linux 特有の)
-.B SHM_REMAP
-フラグが
-.I shmflg
-に指定された場合は、
-セグメントのマッピングを既存のマッピングに置き換える。
-マッピングの範囲は、
-.I shmaddr
-から始まりセグメントのサイズ分だけある
-(通常
-.B EINVAL
-エラーは、このアドレス範囲にマッピングが既に存在するために起る)。
-このフラグを指定する場合は、
-.I shmaddr
-が NULL であってはならない。
+(Linux 特有の)  \fBSHM_REMAP\fP フラグが \fIshmflg\fP に指定された場合は、
+セグメントのマッピングを既存のマッピングに置き換える。 マッピングの範囲は、 \fIshmaddr\fP から始まりセグメントのサイズ分だけある (通常
+\fBEINVAL\fP エラーは、このアドレス範囲にマッピングが既に存在するために起る)。 このフラグを指定する場合は、 \fIshmaddr\fP が NULL
+であってはならない。

 .PP
 .PP

-呼び出したプロセスの
-.BR brk (2)
-の値は付加によって変化しない。
-そのセグメントはプロセスが終了 (exit) したら自動的に分離 (detach) される。
-同じセグメントをプロセスのアドレス空間に、読み込み専用および読み書き両用
-として付加でき、また複数回付加することもできる。
+呼び出したプロセスの \fBbrk\fP(2)  の値は付加によって変化しない。 そのセグメントはプロセスが終了 (exit) したら自動的に分離
+(detach) される。 同じセグメントをプロセスのアドレス空間に、読み込み専用および読み書き両用 として付加でき、また複数回付加することもできる。

 .PP
 .PP

-成功した
-.BR shmat ()
-コールは共有メモリ・セグメントに関連する
-.I shmid_ds
-構造体
-.RB ( shmctl (2)
-を参照) のメンバーを以下のように更新する:
+成功した \fBshmat\fP()  コールは共有メモリ・セグメントに関連する \fIshmid_ds\fP 構造体 (\fBshmctl\fP(2)  を参照)
+のメンバーを以下のように更新する:

 .IP
 .IP

-.I shm_atime
-には現在の時刻を設定する。
+\fIshm_atime\fP には現在の時刻を設定する。

 .IP
 .IP

-.I shm_lpid
-には呼び出したプロセスのプロセス ID を設定する。
+\fIshm_lpid\fP には呼び出したプロセスのプロセス ID が設定される。

 .IP
 .IP

-.I shm_nattch
-を 1 増加させる。
+\fIshm_nattch\fP を 1 増加させる。

 .PP
 .PP

-.BR shmdt ()
-は呼び出したプロセスのアドレス空間から
-.I shmaddr
-で指定されたアドレスに配置された共有メモリ・セグメントを分離 (detach) する。
-分離する共有メモリ・セグメントは、現在
-.I shmaddr
-に付加されているものでなければならない。
-.I shmaddr
-は、それを付加した時に
-.BR shmat ()
-が返した値に等しくなければならない。
+\fBshmdt\fP()  は呼び出したプロセスのアドレス空間から \fIshmaddr\fP で指定されたアドレスに配置された共有メモリ・セグメントを分離
+(detach) する。 分離する共有メモリ・セグメントは、現在 \fIshmaddr\fP に付加されているものでなければならない。 \fIshmaddr\fP
+は、それを付加した時に \fBshmat\fP()  が返した値に等しくなければならない。

 .PP
 .PP

-成功した
-.BR shmdt ()
-コールはその共有メモリ・セグメントに関連する
-.I shmid_ds
-構造体のメンバーを以下のように更新する:
+成功した \fBshmdt\fP()  コールはその共有メモリ・セグメントに関連する \fIshmid_ds\fP 構造体のメンバーを以下のように更新する:

 .IP
 .IP

-.I shm_dtime
-には現在の時刻が設定される。
+\fIshm_dtime\fP には現在の時刻が設定される。

 .IP
 .IP

-.I shm_lpid
-には呼び出したプロセスのプロセス ID が設定される。
+\fIshm_lpid\fP には呼び出したプロセスのプロセス ID が設定される。

 .IP
 .IP

-.I shm_nattch
-を 1 減少させる。
-もし 0 になり、削除マークがあった場合は
-そのセグメントは削除される。
+\fIshm_nattch\fP を 1 減少させる。 もし 0 になり、削除マークがあった場合は そのセグメントは削除される。

 .PP
 .PP

-.BR fork (2)
-した後、子プロセスは付加された共有メモリ・セグメントを継承する。
+\fBfork\fP(2)  した後、子プロセスは付加された共有メモリ・セグメントを継承する。

 
 

-.BR exec (2)
-した後、全ての付加された共有メモリ・セグメントはプロセスから分離される。
+\fBexec\fP(2)  した後、全ての付加された共有メモリ・セグメントはプロセスから分離される。

 
 

-.BR exit (2)
-において、全ての付加された共有メモリ・セグメントはプロセスから分離される。
-.PP
+\fBexit\fP(2)  において、全ての付加された共有メモリ・セグメントはプロセスから分離される。

 .SH 返り値
 .SH 返り値

-.BR shmat ()
-は、成功した場合、
-付加された共有メモリ・セグメントのアドレスを返す。
-エラーの場合、
-.I (void\ *)\ \-1
-を返し、
-.I errno
-にエラーの原因を示す値を設定する。
+\fBshmat\fP()  は、成功した場合、 付加された共有メモリ・セグメントのアドレスを返す。 エラーの場合、 \fI(void\ *)\ \-1\fP
+を返し、 \fIerrno\fP にエラーの原因を示す値を設定する。

 
 

-.BR shmdt ()
-は、成功すると 0 を返す。
-エラーの場合、\-1 を返し、
-.I errno
-にエラーの原因を示す値を設定する。
+\fBshmdt\fP()  は、成功すると 0 を返す。 エラーの場合、\-1 を返し、 \fIerrno\fP にエラーの原因を示す値を設定する。

 .SH エラー
 .SH エラー

-.BR shmat ()
-が失敗した場合、
-.I errno
-に以下の値のどれかを設定して返す:
-.TP
-.B EACCES
-呼び出したプロセスに要求された種類の付加に必要な許可がなく、
-.B CAP_IPC_OWNER
-ケーパビリティ (capability) がない。
-.TP
-.B EINVAL
-.I shmid
-の値が不正である。
-.I shmaddr
-の値が境界違反 (unaligned) (つまり、ページ境界に合っておらず、
-\fBSHM_RND\fP が指定されていない) または
-が不正である。
-.I shmaddr
-へのセグメントの付加に失敗した。
-または
-.B SHM_REMAP
-が指定されているが、
-.I shmaddr
-が NULL であった。
-.TP
-.B ENOMEM
-ディスクリプター (descriptor) やページ・テーブルのためのメモリを
-割り当てることができない。
+\fBshmat\fP()  が失敗した場合、 \fIerrno\fP に以下の値のどれかを設定して返す:
+.TP 
+\fBEACCES\fP
+呼び出したプロセスに要求された種類の付加に必要な許可がなく、 \fBCAP_IPC_OWNER\fP ケーパビリティ (capability) がない。
+.TP 
+\fBEINVAL\fP
+\fIshmid\fP の値が不正である。 \fIshmaddr\fP の値が境界違反 (unaligned) (つまり、ページ境界に合っておらず、
+\fBSHM_RND\fP が指定されていない) または が不正である。 \fIshmaddr\fP へのセグメントの付加に失敗した。 または
+\fBSHM_REMAP\fP が指定されているが、 \fIshmaddr\fP が NULL であった。
+.TP 
+\fBENOMEM\fP
+ディスクリプター (descriptor) やページ・テーブルのためのメモリを 割り当てることができない。

 .PP
 .PP

-.BR shmdt ()
-が失敗した場合、
-.B EINVAL
-は以下のようにセットされる:
-.TP
-.B EINVAL
-.I shmaddr
-に付加された共有メモリ・セグメントが存在しない。
-もしくは、
-.\" こちらは 2.6.17-rc1 以降の場合だけ。
-.I shmaddr
-がページ境界に合っていない。
+\fBshmdt\fP()  が失敗した場合、 \fBEINVAL\fP は以下のようにセットされる:
+.TP 
+\fBEINVAL\fP
+.\" The following since 2.6.17-rc1:
+\fIshmaddr\fP に付加された共有メモリ・セグメントが存在しない。 もしくは、 \fIshmaddr\fP がページ境界に合っていない。

 .SH 準拠
 .SH 準拠

-SVr4, POSIX.1-2001.
-.\" SVr4 には他に EMFILE エラー状態についての記述がある。
+.\" SVr4 documents an additional error condition EMFILE.
+SVr4, POSIX.1\-2001.

 
 

-SVID 3 で (たぶんそれより前だと思うが)
-\fIshmaddr\fP 引き数の型は
-.I "char *"
-から
-.I "const void *"
-に、\fIshmat\fP() の返り値の型は
-.I "char *"
-から
-.I "void *"
-に変更された
-(Linux では libc4 と libc5 のプロトタイプは
-.I "char *"
-であり、glibc2 のプロトタイプは
-.I "void *"
-である)。
+SVID 3 で (たぶんそれより前だと思うが)  \fIshmaddr\fP 引き数の型は \fIchar *\fP から \fIconst void *\fP
+に、\fIshmat\fP() の返り値の型は \fIchar *\fP から \fIvoid *\fP に変更された (Linux では libc4 と libc5
+のプロトタイプは \fIchar *\fP であり、glibc2 のプロトタイプは \fIvoid *\fP である)。

 .SH 注意
 .SH 注意

-共有メモリセグメントを付加する場合の移植性の高い方法としては、
-.I shmaddr
-を NULL にして
-.BR shmat ()
-を使用するのがよい。
-このような方法で付加される共有メモリセグメントは、
-プロセスが異なれば別のアドレスに付加される、という点に注意すること。
-よって共有メモリ内で管理されるポインタは、
-絶対アドレスではなく、
-(一般的にはセグメントの開始アドレスからの)
-相対アドレスで作成するべきである。
+共有メモリセグメントを付加する場合の移植性の高い方法としては、 \fIshmaddr\fP を NULL にして \fBshmat\fP()  を使用するのがよい。
+このような方法で付加される共有メモリセグメントは、 プロセスが異なれば別のアドレスに付加される、という点に注意すること。
+よって共有メモリ内で管理されるポインタは、 絶対アドレスではなく、 (一般的にはセグメントの開始アドレスからの)  相対アドレスで作成するべきである。

 .PP
 .PP

-Linux では共有メモリセグメントに既に削除マークが付けられていても、
-その共有メモリセグメントを付加することができる。
-しかし POSIX.1-2001 ではこのような動作を指定しておらず、
-他の多くの実装もこれをサポートしていない。
+Linux では共有メモリセグメントに既に削除マークが付けられていても、 その共有メモリセグメントを付加することができる。 しかし
+POSIX.1\-2001 ではこのような動作を指定しておらず、 他の多くの実装もこれをサポートしていない。

 .LP
 .LP

-以下のシステム・パラメーターは、
-.BR shmat ()
-に影響する:
-.TP
+以下のシステム・パラメーターは、 \fBshmat\fP()  に影響する:
+.TP 

 .\" FIXME A good explanation of the rationale for the existence
 .\" of SHMLBA would be useful here
 .\" FIXME A good explanation of the rationale for the existence
 .\" of SHMLBA would be useful here

-.B SHMLBA
-セグメントの境界アドレスの最小倍数。ページ境界に合ってなければならない。
-現在の実装では
-.B SHMLBA
-の値は
-.B PAGE_SIZE
-である。
+\fBSHMLBA\fP

 .\" FIXME That last sentence isn't true for all Linux
 .\" architectures (i.e., SHMLBA != PAGE_SIZE for some architectures)
 .\" -- MTK, Nov 04
 .\" FIXME That last sentence isn't true for all Linux
 .\" architectures (i.e., SHMLBA != PAGE_SIZE for some architectures)
 .\" -- MTK, Nov 04

+セグメントの境界アドレスの最小倍数。ページ境界に合ってなければならない。 現在の実装では \fBSHMLBA\fP の値は \fBPAGE_SIZE\fP である。

 .PP
 .PP

-現在の実装では、プロセスごとの
-共有メモリ・セグメントの最大数
-.RB ( SHMSEG )
-に関する実装依存の制限はない。
+現在の実装では、プロセスごとの 共有メモリ・セグメントの最大数 (\fBSHMSEG\fP)  に関する実装依存の制限はない。

 .SH 関連項目
 .SH 関連項目

-.BR brk (2),
-.BR mmap (2),
-.BR shmctl (2),
-.BR shmget (2),
-.BR capabilities (7),
-.BR shm_overview (7),
-.BR svipc (7)
+\fBbrk\fP(2), \fBmmap\fP(2), \fBshmctl\fP(2), \fBshmget\fP(2), \fBcapabilities\fP(7),
+\fBshm_overview\fP(7), \fBsvipc\fP(7)