.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "IPC::SysV 3perl"
.TH IPC::SysV 3perl "2021-09-24" "perl v5.32.1" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
IPC::SysV \- System V IPC constants and system calls
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use IPC::SysV qw(IPC_STAT IPC_PRIVATE);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`IPC::SysV\*(C'\fR defines and conditionally exports all the constants
defined in your system include files which are needed by the SysV
\&\s-1IPC\s0 calls.  Common ones include
.PP
.Vb 4
\&  IPC_CREAT IPC_EXCL IPC_NOWAIT IPC_PRIVATE IPC_RMID IPC_SET IPC_STAT
\&  GETVAL SETVAL GETPID GETNCNT GETZCNT GETALL SETALL
\&  SEM_A SEM_R SEM_UNDO
\&  SHM_RDONLY SHM_RND SHMLBA
.Ve
.PP
and auxiliary ones
.PP
.Vb 3
\&  S_IRUSR S_IWUSR S_IRWXU
\&  S_IRGRP S_IWGRP S_IRWXG
\&  S_IROTH S_IWOTH S_IRWXO
.Ve
.PP
but your system might have more.
.IP "ftok( \s-1PATH\s0 )" 4
.IX Item "ftok( PATH )"
.PD 0
.IP "ftok( \s-1PATH, ID\s0 )" 4
.IX Item "ftok( PATH, ID )"
.PD
Return a key based on \s-1PATH\s0 and \s-1ID,\s0 which can be used as a key for
\&\f(CW\*(C`msgget\*(C'\fR, \f(CW\*(C`semget\*(C'\fR and \f(CW\*(C`shmget\*(C'\fR. See \fBftok\fR\|(3).
.Sp
If \s-1ID\s0 is omitted, it defaults to \f(CW1\fR. If a single character is
given for \s-1ID,\s0 the numeric value of that character is used.
.IP "shmat( \s-1ID, ADDR, FLAG\s0 )" 4
.IX Item "shmat( ID, ADDR, FLAG )"
Attach the shared memory segment identified by \s-1ID\s0 to the address
space of the calling process. See \fBshmat\fR\|(2).
.Sp
\&\s-1ADDR\s0 should be \f(CW\*(C`undef\*(C'\fR unless you really know what you're doing.
.IP "shmdt( \s-1ADDR\s0 )" 4
.IX Item "shmdt( ADDR )"
Detach the shared memory segment located at the address specified
by \s-1ADDR\s0 from the address space of the calling process. See \fBshmdt\fR\|(2).
.IP "memread( \s-1ADDR, VAR, POS, SIZE\s0 )" 4
.IX Item "memread( ADDR, VAR, POS, SIZE )"
Reads \s-1SIZE\s0 bytes from a memory segment at \s-1ADDR\s0 starting at position \s-1POS.
VAR\s0 must be a variable that will hold the data read. Returns true if
successful, or false if there is an error. \fBmemread()\fR taints the variable.
.IP "memwrite( \s-1ADDR, STRING, POS, SIZE\s0 )" 4
.IX Item "memwrite( ADDR, STRING, POS, SIZE )"
Writes \s-1SIZE\s0 bytes from \s-1STRING\s0 to a memory segment at \s-1ADDR\s0 starting at
position \s-1POS.\s0 If \s-1STRING\s0 is too long, only \s-1SIZE\s0 bytes are used; if \s-1STRING\s0
is too short, nulls are written to fill out \s-1SIZE\s0 bytes. Returns true if
successful, or false if there is an error.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
IPC::Msg, IPC::Semaphore, IPC::SharedMem, \fBftok\fR\|(3), \fBshmat\fR\|(2), \fBshmdt\fR\|(2)
.SH "AUTHORS"
.IX Header "AUTHORS"
Graham Barr <gbarr@pobox.com>,
Jarkko Hietaniemi <jhi@iki.fi>,
Marcus Holland-Moritz <mhx@cpan.org>
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Version 2.x, Copyright (C) 2007\-2013, Marcus Holland-Moritz.
.PP
Version 1.x, Copyright (c) 1997, Graham Barr.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.