1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. 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 "Fcntl 3perl"
.TH Fcntl 3perl 2024-01-12 "perl v5.38.2" "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
Fcntl \- load the C Fcntl.h defines
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& use Fcntl;
\& use Fcntl qw(:DEFAULT :flock);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This module is just a translation of the C \fIfcntl.h\fR file.
Unlike the old mechanism of requiring a translated \fIfcntl.ph\fR
file, this uses the \fBh2xs\fR program (see the Perl source distribution)
and your native C compiler. This means that it has a
far more likely chance of getting the numbers right.
.SH NOTE
.IX Header "NOTE"
Only \f(CW\*(C`#define\*(C'\fR symbols get translated; you must still correctly
pack up your own arguments to pass as args for locking functions, etc.
.SH "EXPORTED SYMBOLS"
.IX Header "EXPORTED SYMBOLS"
By default your system's F_* and O_* constants (eg, F_DUPFD and
O_CREAT) and the FD_CLOEXEC constant are exported into your namespace.
.PP
You can request that the \fBflock()\fR constants (LOCK_SH, LOCK_EX, LOCK_NB
and LOCK_UN) be provided by using the tag \f(CW\*(C`:flock\*(C'\fR. See Exporter.
.PP
You can request that the old constants (FAPPEND, FASYNC, FCREAT,
FDEFER, FEXCL, FNDELAY, FNONBLOCK, FSYNC, FTRUNC) be provided for
compatibility reasons by using the tag \f(CW\*(C`:Fcompat\*(C'\fR. For new
applications the newer versions of these constants are suggested
(O_APPEND, O_ASYNC, O_CREAT, O_DEFER, O_EXCL, O_NDELAY, O_NONBLOCK,
O_SYNC, O_TRUNC).
.PP
For ease of use also the SEEK_* constants (for \fBseek()\fR and \fBsysseek()\fR,
e.g. SEEK_END) and the S_I* constants (for \fBchmod()\fR and \fBstat()\fR) are
available for import. They can be imported either separately or using
the tags \f(CW\*(C`:seek\*(C'\fR and \f(CW\*(C`:mode\*(C'\fR.
.PP
Please refer to your native \fBfcntl\fR\|(2), \fBopen\fR\|(2), \fBfseek\fR\|(3), \fBlseek\fR\|(2)
(equal to Perl's \fBseek()\fR and \fBsysseek()\fR, respectively), and \fBchmod\fR\|(2)
documentation to see what constants are implemented in your system.
.PP
See perlopentut to learn about the uses of the O_* constants
with \fBsysopen()\fR.
.PP
See "seek" in perlfunc and "sysseek" in perlfunc about the SEEK_* constants.
.PP
See "stat" in perlfunc about the S_I* constants.
|
