1 .\" Copyright (c) 1990, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" This code is derived from software contributed to Berkeley by
5 .\" Chris Torek and the American National Standards Committee X3,
6 .\" on Information Processing Systems.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
11 .\" 1. Redistributions of source code must retain the above copyright
12 .\" notice, this list of conditions and the following disclaimer.
13 .\" 2. Redistributions in binary form must reproduce the above copyright
14 .\" notice, this list of conditions and the following disclaimer in the
15 .\" documentation and/or other materials provided with the distribution.
16 .\" 3. All advertising materials mentioning features or use of this software
17 .\" must display the following acknowledgement:
18 .\" This product includes software developed by the University of
19 .\" California, Berkeley and its contributors.
20 .\" 4. Neither the name of the University nor the names of its contributors
21 .\" may be used to endorse or promote products derived from this software
22 .\" without specific prior written permission.
24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 .\" @(#)fopen.3 8.1 (Berkeley) 6/4/93
37 .\" $FreeBSD: src/lib/libc/stdio/fopen.3,v 1.7.2.6 2001/12/14 18:33:57 ru Exp $
38 .\" $DragonFly: src/lib/libcr/stdio/Attic/fopen.3,v 1.2 2003/06/17 04:26:45 dillon Exp $
47 .Nd stream open functions
53 .Fn fopen "const char *path" "const char *mode"
55 .Fn fdopen "int fildes" "const char *mode"
57 .Fn freopen "const char *path" "const char *mode" "FILE *stream"
62 opens the file whose name is the string pointed to by
64 and associates a stream with it.
68 points to a string beginning with one of the following
69 sequences (Additional characters may follow these sequences.):
70 .Bl -tag -width indent
72 Open text file for reading.
73 The stream is positioned at the beginning of the file.
75 Open for reading and writing.
76 The stream is positioned at the beginning of the file.
78 Truncate file to zero length or create text file for writing.
79 The stream is positioned at the beginning of the file.
81 Open for reading and writing.
82 The file is created if it does not exist, otherwise it is truncated.
83 The stream is positioned at the beginning of the file.
86 The file is created if it does not exist.
87 The stream is positioned at the end of the file.
88 Subsequent writes to the file will always end up at the then current
89 end of file, irrespective of any intervening
93 Open for reading and writing.
94 The file is created if it does not exist.
95 The stream is positioned at the end of the file.
96 Subsequent writes to the file will always end up at the then current
97 end of file, irrespective of any intervening
104 string can also include the letter ``b'' either as a third character or
105 as a character between the characters in any of the two-character strings
107 This is strictly for compatibility with
109 and has no effect; the ``b'' is ignored.
111 Any created files will have mode
124 as modified by the process'
128 Reads and writes may be intermixed on read/write streams in any order,
129 and do not require an intermediate seek as in previous versions of
131 This is not portable to other systems, however;
134 a file positioning function intervene between output and input, unless
135 an input operation encounters end-of-file.
139 function associates a stream with the existing file descriptor,
143 of the stream must be compatible with the mode of the file descriptor.
144 When the stream is closed via
152 opens the file whose name is the string pointed to by
154 and associates the stream pointed to by
157 The original stream (if it exists) is closed.
160 argument is used just as in the
163 The primary use of the
166 is to change the file associated with a
173 Upon successful completion
183 is returned and the global variable
185 is set to indicate the error.
205 may also fail and set
207 for any of the errors specified for the routine
213 may also fail and set
215 for any of the errors specified for the routine
221 may also fail and set
223 for any of the errors specified for the routine
229 may also fail and set
231 for any of the errors specified for the routines