Debian Codegraph @

upstream/debian-unstable/man3/IPC::SysV.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "IPC::SysV 3perl"
58 .TH IPC::SysV 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 IPC::SysV \- System V IPC constants and system calls
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use IPC::SysV qw(IPC_STAT IPC_PRIVATE);
69 .Ve
70 .SH DESCRIPTION
71 .IX Header "DESCRIPTION"
72 \&\f(CW\*(C`IPC::SysV\*(C'\fR defines and conditionally exports all the constants
73 defined in your system include files which are needed by the SysV
74 IPC calls. Common ones include
75 .PP
76 .Vb 4
77 \& IPC_CREAT IPC_EXCL IPC_NOWAIT IPC_PRIVATE IPC_RMID IPC_SET IPC_STAT
78 \& GETVAL SETVAL GETPID GETNCNT GETZCNT GETALL SETALL
79 \& SEM_A SEM_R SEM_UNDO
80 \& SHM_RDONLY SHM_RND SHMLBA
81 .Ve
82 .PP
83 and auxiliary ones
84 .PP
85 .Vb 3
86 \& S_IRUSR S_IWUSR S_IRWXU
87 \& S_IRGRP S_IWGRP S_IRWXG
88 \& S_IROTH S_IWOTH S_IRWXO
89 .Ve
90 .PP
91 but your system might have more.
92 .IP "ftok( PATH )" 4
93 .IX Item "ftok( PATH )"
94 .PD 0
95 .IP "ftok( PATH, ID )" 4
96 .IX Item "ftok( PATH, ID )"
97 .PD
98 Return a key based on PATH and ID, which can be used as a key for
99 \&\f(CW\*(C`msgget\*(C'\fR, \f(CW\*(C`semget\*(C'\fR and \f(CW\*(C`shmget\*(C'\fR. See \fBftok\fR\|(3).
100 .Sp
101 If ID is omitted, it defaults to \f(CW1\fR. If a single character is
102 given for ID, the numeric value of that character is used.
103 .IP "shmat( ID, ADDR, FLAG )" 4
104 .IX Item "shmat( ID, ADDR, FLAG )"
105 Attach the shared memory segment identified by ID to the address
106 space of the calling process. See \fBshmat\fR\|(2).
107 .Sp
108 ADDR should be \f(CW\*(C`undef\*(C'\fR unless you really know what you're doing.
109 .IP "shmdt( ADDR )" 4
110 .IX Item "shmdt( ADDR )"
111 Detach the shared memory segment located at the address specified
112 by ADDR from the address space of the calling process. See \fBshmdt\fR\|(2).
113 .IP "memread( ADDR, VAR, POS, SIZE )" 4
114 .IX Item "memread( ADDR, VAR, POS, SIZE )"
115 Reads SIZE bytes from a memory segment at ADDR starting at position POS.
116 VAR must be a variable that will hold the data read. Returns true if
117 successful, or false if there is an error. \fBmemread()\fR taints the variable.
118 .IP "memwrite( ADDR, STRING, POS, SIZE )" 4
119 .IX Item "memwrite( ADDR, STRING, POS, SIZE )"
120 Writes SIZE bytes from STRING to a memory segment at ADDR starting at
121 position POS. If STRING is too long, only SIZE bytes are used; if STRING
122 is too short, nulls are written to fill out SIZE bytes. Returns true if
123 successful, or false if there is an error.
124 .SH "SEE ALSO"
125 .IX Header "SEE ALSO"
126 IPC::Msg, IPC::Semaphore, IPC::SharedMem, \fBftok\fR\|(3), \fBshmat\fR\|(2), \fBshmdt\fR\|(2)
127 .SH AUTHORS
128 .IX Header "AUTHORS"
129 Graham Barr <[email protected]>,
130 Jarkko Hietaniemi <[email protected]>,
131 Marcus Holland-Moritz <[email protected]>
132 .SH COPYRIGHT
133 .IX Header "COPYRIGHT"
134 Version 2.x, Copyright (C) 2007\-2013, Marcus Holland-Moritz.
135 .PP
136 Version 1.x, Copyright (c) 1997, Graham Barr.
137 .PP
138 This program is free software; you can redistribute it and/or
139 modify it under the same terms as Perl itself.