Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / amd64 / man / man3 / Fcntl.3
CommitLineData
920dae64
AT
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "Fcntl 3"
132.TH Fcntl 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
133.SH "NAME"
134Fcntl \- load the C Fcntl.h defines
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 2
138\& use Fcntl;
139\& use Fcntl qw(:DEFAULT :flock);
140.Ve
141.SH "DESCRIPTION"
142.IX Header "DESCRIPTION"
143This module is just a translation of the C \fIfcntl.h\fR file.
144Unlike the old mechanism of requiring a translated \fIfcntl.ph\fR
145file, this uses the \fBh2xs\fR program (see the Perl source distribution)
146and your native C compiler. This means that it has a
147far more likely chance of getting the numbers right.
148.SH "NOTE"
149.IX Header "NOTE"
150Only \f(CW\*(C`#define\*(C'\fR symbols get translated; you must still correctly
151pack up your own arguments to pass as args for locking functions, etc.
152.SH "EXPORTED SYMBOLS"
153.IX Header "EXPORTED SYMBOLS"
154By default your system's F_* and O_* constants (eg, F_DUPFD and
155O_CREAT) and the \s-1FD_CLOEXEC\s0 constant are exported into your namespace.
156.PP
157You can request that the \fIflock()\fR constants (\s-1LOCK_SH\s0, \s-1LOCK_EX\s0, \s-1LOCK_NB\s0
158and \s-1LOCK_UN\s0) be provided by using the tag \f(CW\*(C`:flock\*(C'\fR. See Exporter.
159.PP
160You can request that the old constants (\s-1FAPPEND\s0, \s-1FASYNC\s0, \s-1FCREAT\s0,
161\&\s-1FDEFER\s0, \s-1FEXCL\s0, \s-1FNDELAY\s0, \s-1FNONBLOCK\s0, \s-1FSYNC\s0, \s-1FTRUNC\s0) be provided for
162compatibility reasons by using the tag \f(CW\*(C`:Fcompat\*(C'\fR. For new
163applications the newer versions of these constants are suggested
164(O_APPEND, O_ASYNC, O_CREAT, O_DEFER, O_EXCL, O_NDELAY, O_NONBLOCK,
165O_SYNC, O_TRUNC).
166.PP
167For ease of use also the SEEK_* constants (for \fIseek()\fR and \fIsysseek()\fR,
168e.g. \s-1SEEK_END\s0) and the S_I* constants (for \fIchmod()\fR and \fIstat()\fR) are
169available for import. They can be imported either separately or using
170the tags \f(CW\*(C`:seek\*(C'\fR and \f(CW\*(C`:mode\*(C'\fR.
171.PP
172Please refer to your native \fIfcntl\fR\|(2), \fIopen\fR\|(2), \fIfseek\fR\|(3), \fIlseek\fR\|(2)
173(equal to Perl's \fIseek()\fR and \fIsysseek()\fR, respectively), and \fIchmod\fR\|(2)
174documentation to see what constants are implemented in your system.
175.PP
176See perlopentut to learn about the uses of the O_* constants
177with \fIsysopen()\fR.
178.PP
179See \*(L"seek\*(R" in perlfunc and \*(L"sysseek\*(R" in perlfunc about the SEEK_* constants.
180.PP
181See \*(L"stat\*(R" in perlfunc about the S_I* constants.