Debian Codegraph @

upstream/mageia-cauldron/man3pm/IPC::SysV.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "IPC::SysV 3pm"
61 .TH IPC::SysV 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 IPC::SysV \- System V IPC constants and system calls
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use IPC::SysV qw(IPC_STAT IPC_PRIVATE);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 \&\f(CW\*(C`IPC::SysV\*(C'\fR defines and conditionally exports all the constants
76 defined in your system include files which are needed by the SysV
77 IPC calls. Common ones include
78 .PP
79 .Vb 4
80 \& IPC_CREAT IPC_EXCL IPC_NOWAIT IPC_PRIVATE IPC_RMID IPC_SET IPC_STAT
81 \& GETVAL SETVAL GETPID GETNCNT GETZCNT GETALL SETALL
82 \& SEM_A SEM_R SEM_UNDO
83 \& SHM_RDONLY SHM_RND SHMLBA
84 .Ve
85 .PP
86 and auxiliary ones
87 .PP
88 .Vb 3
89 \& S_IRUSR S_IWUSR S_IRWXU
90 \& S_IRGRP S_IWGRP S_IRWXG
91 \& S_IROTH S_IWOTH S_IRWXO
92 .Ve
93 .PP
94 but your system might have more.
95 .IP "ftok( PATH )" 4
96 .IX Item "ftok( PATH )"
97 .PD 0
98 .IP "ftok( PATH, ID )" 4
99 .IX Item "ftok( PATH, ID )"
100 .PD
101 Return a key based on PATH and ID, which can be used as a key for
102 \&\f(CW\*(C`msgget\*(C'\fR, \f(CW\*(C`semget\*(C'\fR and \f(CW\*(C`shmget\*(C'\fR. See \fBftok\fR\|(3).
103 .Sp
104 If ID is omitted, it defaults to \f(CW1\fR. If a single character is
105 given for ID, the numeric value of that character is used.
106 .IP "shmat( ID, ADDR, FLAG )" 4
107 .IX Item "shmat( ID, ADDR, FLAG )"
108 Attach the shared memory segment identified by ID to the address
109 space of the calling process. See \fBshmat\fR\|(2).
110 .Sp
111 ADDR should be \f(CW\*(C`undef\*(C'\fR unless you really know what you\*(Aqre doing.
112 .IP "shmdt( ADDR )" 4
113 .IX Item "shmdt( ADDR )"
114 Detach the shared memory segment located at the address specified
115 by ADDR from the address space of the calling process. See \fBshmdt\fR\|(2).
116 .IP "memread( ADDR, VAR, POS, SIZE )" 4
117 .IX Item "memread( ADDR, VAR, POS, SIZE )"
118 Reads SIZE bytes from a memory segment at ADDR starting at position POS.
119 VAR must be a variable that will hold the data read. Returns true if
120 successful, or false if there is an error. \fBmemread()\fR taints the variable.
121 .IP "memwrite( ADDR, STRING, POS, SIZE )" 4
122 .IX Item "memwrite( ADDR, STRING, POS, SIZE )"
123 Writes SIZE bytes from STRING to a memory segment at ADDR starting at
124 position POS. If STRING is too long, only SIZE bytes are used; if STRING
125 is too short, nulls are written to fill out SIZE bytes. Returns true if
126 successful, or false if there is an error.
127 .SH "SEE ALSO"
128 .IX Header "SEE ALSO"
129 IPC::Msg, IPC::Semaphore, IPC::SharedMem, \fBftok\fR\|(3), \fBshmat\fR\|(2), \fBshmdt\fR\|(2)
130 .SH AUTHORS
131 .IX Header "AUTHORS"
132 Graham Barr <[email protected]>,
133 Jarkko Hietaniemi <[email protected]>,
134 Marcus Holland\-Moritz <[email protected]>
135 .SH COPYRIGHT
136 .IX Header "COPYRIGHT"
137 Version 2.x, Copyright (C) 2007\-2013, Marcus Holland\-Moritz.
138 .PP
139 Version 1.x, Copyright (c) 1997, Graham Barr.
140 .PP
141 This program is free software; you can redistribute it and/or
142 modify it under the same terms as Perl itself.