1 # SOME DESCRIPTIVE TITLE
2 # Copyright (C) YEAR Free Software Foundation, Inc.
3 # This file is distributed under the same license as the PACKAGE package.
4 # FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
9 "Project-Id-Version: PACKAGE VERSION\n"
10 "POT-Creation-Date: 2012-04-25 05:37+0900\n"
11 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
12 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
13 "Language-Team: LANGUAGE <LL@li.org>\n"
16 "Content-Type: text/plain; charset=UTF-8\n"
17 "Content-Transfer-Encoding: 8bit\n"
20 #: build/C/man3/asprintf.3:25
26 #: build/C/man3/asprintf.3:25
32 #: build/C/man3/asprintf.3:25 build/C/man3/ctermid.3:24 build/C/man3/dprintf.3:25 build/C/man3/fclose.3:42 build/C/man3/fcloseall.3:24 build/C/man3/fflush.3:43 build/C/man3/fgetwc.3:16 build/C/man3/fmemopen.3:6 build/C/man3/fopen.3:42 build/C/man3/fputwc.3:14 build/C/man3/fread.3:43 build/C/man3/fseek.3:40 build/C/man3/getline.3:24 build/C/man3/gets.3:25 build/C/man3/getw.3:23 build/C/man3/popen.3:38 build/C/man3/printf.3:34 build/C/man3/puts.3:24 build/C/man3/remove.3:31 build/C/man3/scanf.3:50 build/C/man3/wprintf.3:14
38 #: build/C/man3/asprintf.3:25 build/C/man3/ctermid.3:24 build/C/man3/dprintf.3:25 build/C/man3/fclose.3:42 build/C/man3/fcloseall.3:24 build/C/man3/ferror.3:42 build/C/man3/fflush.3:43 build/C/man3/fgetwc.3:16 build/C/man3/flockfile.3:23 build/C/man3/fmemopen.3:6 build/C/man3/fmtmsg.3:9 build/C/man3/fopen.3:42 build/C/man3/fopencookie.3:24 build/C/man3/fpurge.3:23 build/C/man3/fputwc.3:14 build/C/man3/fread.3:43 build/C/man3/fseek.3:40 build/C/man3/fseeko.3:23 build/C/man3/getline.3:24 build/C/man3/gets.3:25 build/C/man3/getw.3:23 build/C/man2/link.2:31 build/C/man2/llseek.2:26 build/C/man2/lseek.2:45 build/C/man3/lseek64.3:23 build/C/man2/open.2:52 build/C/man3/perror.3:30 build/C/man2/pipe.2:36 build/C/man3/popen.3:38 build/C/man3/printf.3:34 build/C/man3/puts.3:24 build/C/man2/read.2:35 build/C/man2/readlink.2:41 build/C/man2/readv.2:30 build/C/man3/remove.3:31 build/C/man2/rename.2:32 build/C/man2/rmdir.2:30 build/C/man3/scanf.3:50 build/C/man3/setbuf.3:46 build/C/man3/stdin.3:9 build/C/man3/stdio.3:37 build/C/man3/stdio_ext.3:23 build/C/man2/symlink.2:32 build/C/man7/symlink.7:35 build/C/man3/tempnam.3:23 build/C/man3/tmpfile.3:29 build/C/man3/tmpnam.3:25 build/C/man2/unlink.2:32 build/C/man3/unlocked_stdio.3:23 build/C/man3/wprintf.3:14 build/C/man2/write.2:39
40 msgid "Linux Programmer's Manual"
44 #: build/C/man3/asprintf.3:26 build/C/man3/ctermid.3:25 build/C/man3/dprintf.3:26 build/C/man3/fclose.3:43 build/C/man3/fcloseall.3:25 build/C/man3/ferror.3:43 build/C/man3/fflush.3:44 build/C/man3/fgetwc.3:17 build/C/man3/flockfile.3:24 build/C/man3/fmemopen.3:7 build/C/man3/fmtmsg.3:10 build/C/man3/fopen.3:43 build/C/man3/fopencookie.3:25 build/C/man3/fpurge.3:24 build/C/man3/fputwc.3:15 build/C/man3/fread.3:44 build/C/man3/fseek.3:41 build/C/man3/fseeko.3:24 build/C/man3/getline.3:25 build/C/man3/gets.3:26 build/C/man3/getw.3:24 build/C/man2/link.2:32 build/C/man2/llseek.2:27 build/C/man2/lseek.2:46 build/C/man3/lseek64.3:24 build/C/man2/open.2:53 build/C/man3/perror.3:31 build/C/man2/pipe.2:37 build/C/man3/popen.3:39 build/C/man3/printf.3:35 build/C/man3/puts.3:25 build/C/man2/read.2:36 build/C/man2/readlink.2:42 build/C/man2/readv.2:31 build/C/man3/remove.3:32 build/C/man2/rename.2:33 build/C/man2/rmdir.2:31 build/C/man3/scanf.3:51 build/C/man3/setbuf.3:47 build/C/man3/stdin.3:10 build/C/man3/stdio.3:38 build/C/man3/stdio_ext.3:24 build/C/man2/symlink.2:33 build/C/man7/symlink.7:36 build/C/man3/tempnam.3:24 build/C/man3/tmpfile.3:30 build/C/man3/tmpnam.3:26 build/C/man2/unlink.2:33 build/C/man3/unlocked_stdio.3:24 build/C/man3/wprintf.3:15 build/C/man2/write.2:40
50 #: build/C/man3/asprintf.3:28
51 msgid "asprintf, vasprintf - print to allocated string"
55 #: build/C/man3/asprintf.3:28 build/C/man3/ctermid.3:27 build/C/man3/dprintf.3:28 build/C/man3/fclose.3:45 build/C/man3/fcloseall.3:27 build/C/man3/ferror.3:45 build/C/man3/fflush.3:46 build/C/man3/fgetwc.3:19 build/C/man3/flockfile.3:26 build/C/man3/fmemopen.3:9 build/C/man3/fmtmsg.3:12 build/C/man3/fopen.3:45 build/C/man3/fopencookie.3:27 build/C/man3/fpurge.3:26 build/C/man3/fputwc.3:17 build/C/man3/fread.3:46 build/C/man3/fseek.3:43 build/C/man3/fseeko.3:26 build/C/man3/getline.3:27 build/C/man3/gets.3:28 build/C/man3/getw.3:26 build/C/man2/link.2:34 build/C/man2/llseek.2:29 build/C/man2/lseek.2:48 build/C/man3/lseek64.3:26 build/C/man2/open.2:55 build/C/man3/perror.3:33 build/C/man2/pipe.2:39 build/C/man3/popen.3:41 build/C/man3/printf.3:38 build/C/man3/puts.3:27 build/C/man2/read.2:38 build/C/man2/readlink.2:44 build/C/man2/readv.2:33 build/C/man3/remove.3:34 build/C/man2/rename.2:35 build/C/man2/rmdir.2:33 build/C/man3/scanf.3:53 build/C/man3/setbuf.3:49 build/C/man3/stdin.3:12 build/C/man3/stdio.3:40 build/C/man3/stdio_ext.3:28 build/C/man2/symlink.2:35 build/C/man3/tempnam.3:26 build/C/man3/tmpfile.3:32 build/C/man3/tmpnam.3:28 build/C/man2/unlink.2:35 build/C/man3/unlocked_stdio.3:27 build/C/man3/wprintf.3:18 build/C/man2/write.2:42
61 #: build/C/man3/asprintf.3:30
62 msgid "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */"
66 #: build/C/man3/asprintf.3:32 build/C/man3/dprintf.3:30 build/C/man3/fclose.3:47 build/C/man3/ferror.3:47 build/C/man3/fflush.3:48 build/C/man3/fseek.3:45 build/C/man3/perror.3:35 build/C/man3/printf.3:40 build/C/man3/remove.3:36 build/C/man2/rename.2:37 build/C/man3/stdio.3:42 build/C/man3/stdio_ext.3:30
67 msgid "B<#include E<lt>stdio.hE<gt>>"
71 #: build/C/man3/asprintf.3:34
72 msgid "B<int asprintf(char **>I<strp>B<, const char *>I<fmt>B<, ...);>"
76 #: build/C/man3/asprintf.3:36
78 "B<int vasprintf(char **>I<strp>B<, const char *>I<fmt>B<, va_list "
83 #: build/C/man3/asprintf.3:36 build/C/man3/ctermid.3:44 build/C/man3/dprintf.3:54 build/C/man3/fclose.3:49 build/C/man3/fcloseall.3:34 build/C/man3/ferror.3:63 build/C/man3/fflush.3:50 build/C/man3/fgetwc.3:28 build/C/man3/flockfile.3:49 build/C/man3/fmemopen.3:42 build/C/man3/fmtmsg.3:22 build/C/man3/fopen.3:63 build/C/man3/fopencookie.3:35 build/C/man3/fpurge.3:40 build/C/man3/fputwc.3:26 build/C/man3/fread.3:56 build/C/man3/fseek.3:55 build/C/man3/fseeko.3:35 build/C/man3/getline.3:56 build/C/man3/gets.3:44 build/C/man3/getw.3:57 build/C/man2/link.2:38 build/C/man2/llseek.2:38 build/C/man2/lseek.2:54 build/C/man3/lseek64.3:34 build/C/man2/open.2:66 build/C/man3/perror.3:54 build/C/man2/pipe.2:51 build/C/man3/popen.3:62 build/C/man3/printf.3:76 build/C/man3/puts.3:41 build/C/man2/read.2:44 build/C/man2/readlink.2:61 build/C/man2/readv.2:56 build/C/man3/remove.3:38 build/C/man2/rename.2:39 build/C/man2/rmdir.2:37 build/C/man3/scanf.3:85 build/C/man3/setbuf.3:71 build/C/man3/stdin.3:20 build/C/man3/stdio.3:48 build/C/man3/stdio_ext.3:52 build/C/man2/symlink.2:52 build/C/man3/tempnam.3:40 build/C/man3/tmpfile.3:38 build/C/man3/tmpnam.3:34 build/C/man2/unlink.2:39 build/C/man3/unlocked_stdio.3:104 build/C/man3/wprintf.3:58 build/C/man2/write.2:46
89 #: build/C/man3/asprintf.3:51
91 "The functions B<asprintf>() and B<vasprintf>() are analogs of "
92 "B<sprintf>(3) and B<vsprintf>(3), except that they allocate a string large "
93 "enough to hold the output including the terminating null byte, and return a "
94 "pointer to it via the first argument. This pointer should be passed to "
95 "B<free>(3) to release the allocated storage when it is no longer needed."
99 #: build/C/man3/asprintf.3:51 build/C/man3/ctermid.3:57 build/C/man3/fclose.3:57 build/C/man3/fcloseall.3:49 build/C/man3/fflush.3:72 build/C/man3/fgetwc.3:53 build/C/man3/flockfile.3:112 build/C/man3/fmemopen.3:172 build/C/man3/fmtmsg.3:148 build/C/man3/fopen.3:189 build/C/man3/fopencookie.3:235 build/C/man3/fpurge.3:56 build/C/man3/fputwc.3:52 build/C/man3/fread.3:81 build/C/man3/fseek.3:117 build/C/man3/fseeko.3:63 build/C/man3/getline.3:108 build/C/man3/gets.3:109 build/C/man3/getw.3:71 build/C/man2/link.2:52 build/C/man2/llseek.2:57 build/C/man2/lseek.2:151 build/C/man2/open.2:464 build/C/man2/pipe.2:92 build/C/man3/popen.3:121 build/C/man3/puts.3:82 build/C/man2/read.2:63 build/C/man2/readlink.2:75 build/C/man2/readv.2:175 build/C/man3/remove.3:60 build/C/man2/rename.2:91 build/C/man2/rmdir.2:40 build/C/man3/scanf.3:528 build/C/man3/setbuf.3:150 build/C/man2/symlink.2:84 build/C/man3/tempnam.3:85 build/C/man3/tmpfile.3:45 build/C/man3/tmpnam.3:68 build/C/man2/unlink.2:55 build/C/man3/wprintf.3:185 build/C/man2/write.2:89
105 #: build/C/man3/asprintf.3:59
107 "When successful, these functions return the number of bytes printed, just "
108 "like B<sprintf>(3). If memory allocation wasn't possible, or some other "
109 "error occurs, these functions will return -1, and the contents of I<strp> is "
114 #: build/C/man3/asprintf.3:59 build/C/man3/ctermid.3:59 build/C/man3/dprintf.3:68 build/C/man3/fclose.3:88 build/C/man3/fcloseall.3:54 build/C/man3/ferror.3:105 build/C/man3/fflush.3:91 build/C/man3/fgetwc.3:65 build/C/man3/flockfile.3:119 build/C/man3/fmemopen.3:191 build/C/man3/fmtmsg.3:221 build/C/man3/fopen.3:246 build/C/man3/fopencookie.3:242 build/C/man3/fpurge.3:68 build/C/man3/fputwc.3:63 build/C/man3/fread.3:101 build/C/man3/fseek.3:164 build/C/man3/fseeko.3:75 build/C/man3/getline.3:132 build/C/man3/gets.3:136 build/C/man3/getw.3:78 build/C/man2/link.2:128 build/C/man2/llseek.2:76 build/C/man2/lseek.2:189 build/C/man2/open.2:610 build/C/man3/perror.3:111 build/C/man2/pipe.2:118 build/C/man3/popen.3:167 build/C/man3/printf.3:807 build/C/man3/puts.3:101 build/C/man2/read.2:155 build/C/man2/readlink.2:123 build/C/man2/readv.2:212 build/C/man3/remove.3:70 build/C/man2/rename.2:229 build/C/man2/rmdir.2:127 build/C/man3/scanf.3:575 build/C/man3/setbuf.3:162 build/C/man3/stdin.3:109 build/C/man3/stdio.3:244 build/C/man2/symlink.2:144 build/C/man3/tempnam.3:94 build/C/man3/tmpfile.3:74 build/C/man3/tmpnam.3:75 build/C/man2/unlink.2:141 build/C/man3/unlocked_stdio.3:111 build/C/man3/wprintf.3:193 build/C/man2/write.2:179
116 msgid "CONFORMING TO"
120 #: build/C/man3/asprintf.3:65
122 "These functions are GNU extensions, not in C or POSIX. They are also "
123 "available under *BSD. The FreeBSD implementation sets I<strp> to NULL on "
128 #: build/C/man3/asprintf.3:65 build/C/man3/ctermid.3:69 build/C/man3/dprintf.3:94 build/C/man3/fclose.3:100 build/C/man3/fcloseall.3:56 build/C/man3/ferror.3:112 build/C/man3/fflush.3:106 build/C/man3/fgetwc.3:82 build/C/man3/flockfile.3:127 build/C/man3/fmemopen.3:273 build/C/man3/fmtmsg.3:293 build/C/man3/fopen.3:302 build/C/man3/fopencookie.3:434 build/C/man3/fpurge.3:78 build/C/man3/fputwc.3:80 build/C/man3/fread.3:103 build/C/man3/fseek.3:166 build/C/man3/fseeko.3:81 build/C/man3/getline.3:166 build/C/man3/gets.3:171 build/C/man3/getw.3:84 build/C/man2/link.2:177 build/C/man2/llseek.2:82 build/C/man2/lseek.2:234 build/C/man3/lseek64.3:157 build/C/man2/open.2:849 build/C/man3/perror.3:139 build/C/man2/pipe.2:190 build/C/man3/popen.3:196 build/C/man3/printf.3:1074 build/C/man3/puts.3:110 build/C/man2/read.2:178 build/C/man2/readlink.2:212 build/C/man2/readv.2:282 build/C/man3/remove.3:81 build/C/man2/rename.2:242 build/C/man2/rmdir.2:132 build/C/man3/scanf.3:717 build/C/man3/setbuf.3:198 build/C/man3/stdin.3:150 build/C/man3/stdio.3:248 build/C/man3/stdio_ext.3:130 build/C/man2/symlink.2:159 build/C/man7/symlink.7:470 build/C/man3/tempnam.3:164 build/C/man3/tmpfile.3:86 build/C/man3/tmpnam.3:151 build/C/man2/unlink.2:148 build/C/man3/unlocked_stdio.3:134 build/C/man3/wprintf.3:229 build/C/man2/write.2:205
134 #: build/C/man3/asprintf.3:68
135 msgid "B<free>(3), B<malloc>(3), B<printf>(3)"
139 #: build/C/man3/ctermid.3:24
145 #: build/C/man3/ctermid.3:24
151 #: build/C/man3/ctermid.3:27
152 msgid "ctermid - get controlling terminal name"
156 #: build/C/man3/ctermid.3:32 build/C/man3/fgetwc.3:22 build/C/man3/flockfile.3:29 build/C/man3/fmemopen.3:12 build/C/man3/fopen.3:48 build/C/man3/fputwc.3:20 build/C/man3/fread.3:49 build/C/man3/fseeko.3:29 build/C/man3/getline.3:30 build/C/man3/gets.3:31 build/C/man3/getw.3:29 build/C/man3/popen.3:44 build/C/man3/puts.3:30 build/C/man3/scanf.3:56 build/C/man3/setbuf.3:52 build/C/man3/stdin.3:15 build/C/man3/tempnam.3:29 build/C/man3/tmpfile.3:35 build/C/man3/tmpnam.3:31 build/C/man3/unlocked_stdio.3:30
158 msgid "B<#include E<lt>stdio.hE<gt>>\n"
162 #: build/C/man3/ctermid.3:34
164 msgid "B<char *ctermid(char *>I<s>B<);>\n"
168 #: build/C/man3/ctermid.3:39 build/C/man3/dprintf.3:38 build/C/man3/ferror.3:59 build/C/man3/flockfile.3:40 build/C/man3/fmemopen.3:25 build/C/man3/fopen.3:59 build/C/man3/getline.3:40 build/C/man3/getw.3:38 build/C/man3/perror.3:49 build/C/man3/popen.3:53 build/C/man3/printf.3:63 build/C/man2/readlink.2:52 build/C/man2/readv.2:51 build/C/man3/scanf.3:71 build/C/man3/setbuf.3:66 build/C/man2/symlink.2:43 build/C/man3/tempnam.3:36 build/C/man3/unlocked_stdio.3:66 build/C/man3/wprintf.3:37
169 msgid "Feature Test Macro Requirements for glibc (see B<feature_test_macros>(7)):"
172 #. From <unistd.h>: _XOPEN_SOURCE
174 #: build/C/man3/ctermid.3:44
175 msgid "B<ctermid>(): _POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE"
179 #: build/C/man3/ctermid.3:57
181 "B<ctermid>() returns a string which is the pathname for the current "
182 "controlling terminal for this process. If I<s> is NULL, a static buffer is "
183 "used, otherwise I<s> points to a buffer used to hold the terminal pathname. "
184 "The symbolic constant B<L_ctermid> is the maximum number of characters in "
185 "the returned pathname."
189 #: build/C/man3/ctermid.3:59
190 msgid "The pointer to the pathname."
194 #: build/C/man3/ctermid.3:61
195 msgid "Svr4, POSIX.1-2001."
199 #: build/C/man3/ctermid.3:61 build/C/man3/fmemopen.3:201 build/C/man3/gets.3:150 build/C/man3/getw.3:80 build/C/man2/link.2:171 build/C/man2/open.2:838 build/C/man3/popen.3:173 build/C/man3/printf.3:930 build/C/man3/puts.3:103 build/C/man2/readv.2:256 build/C/man3/remove.3:78 build/C/man2/rename.2:231 build/C/man2/rmdir.2:129 build/C/man3/scanf.3:682 build/C/man3/setbuf.3:168 build/C/man3/tempnam.3:154 build/C/man3/tmpnam.3:144 build/C/man2/unlink.2:145
205 #: build/C/man3/ctermid.3:65
207 "The path returned may not uniquely identify the controlling terminal; it "
208 "may, for example, be I</dev/tty>."
211 #. in glibc 2.3.x, x >= 4, the glibc headers threw an error
212 #. if ctermid() was given an argument; fixed in 2.4.
214 #: build/C/man3/ctermid.3:69
215 msgid "It is not assured that the program can open the terminal."
219 #: build/C/man3/ctermid.3:70
220 msgid "B<ttyname>(3)"
224 #: build/C/man3/dprintf.3:25
230 #: build/C/man3/dprintf.3:25 build/C/man3/fmemopen.3:6
236 #: build/C/man3/dprintf.3:28
237 msgid "dprintf, vdprintf - print to a file descriptor"
241 #: build/C/man3/dprintf.3:32
242 msgid "B<int dprintf(int >I<fd>B<, const char *>I<format>B<, ...);>"
246 #: build/C/man3/dprintf.3:34
247 msgid "B<int vdprintf(int >I<fd>B<, const char *>I<format>B<, va_list >I<ap>B<);>"
251 #: build/C/man3/dprintf.3:42
252 msgid "B<dprintf>(), B<vdprintf>():"
256 #: build/C/man3/dprintf.3:45 build/C/man3/fmemopen.3:33 build/C/man3/getline.3:47
258 msgid "Since glibc 2.10:"
262 #: build/C/man3/dprintf.3:48 build/C/man3/fmemopen.3:36
263 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 700 || _POSIX_C_SOURCE\\ E<gt>=\\ 200809L"
267 #: build/C/man3/dprintf.3:48 build/C/man3/fmemopen.3:36 build/C/man3/getline.3:50
269 msgid "Before glibc 2.10:"
273 #: build/C/man3/dprintf.3:51 build/C/man3/fmemopen.3:39 build/C/man3/getline.3:53 build/C/man3/unlocked_stdio.3:102
278 #: build/C/man3/dprintf.3:68
280 "The functions B<dprintf>() and B<vdprintf>() (as found in the glibc2 "
281 "library) are exact analogs of B<fprintf>(3) and B<vfprintf>(3), except that "
282 "they output to a file descriptor I<fd> instead of to a I<stdio> stream."
286 #. These functions are GNU extensions, not in C or POSIX.
287 #. Clearly, the names were badly chosen.
288 #. Many systems (like MacOS) have incompatible functions called
290 #. usually some debugging version of
292 #. perhaps with a prototype like
294 #. .BI "void dprintf(int level, const char *" format ", ...);"
296 #. where the first argument is a debugging level (and output is to
302 #. is also a popular macro name for a debugging printf.
303 #. So, probably, it is better to avoid this function in programs
304 #. intended to be portable.
306 #. A better name would have been
309 #: build/C/man3/dprintf.3:94
311 "These functions are GNU extensions that are nowadays specified in "
316 #: build/C/man3/dprintf.3:95
321 #: build/C/man3/fclose.3:42
327 #: build/C/man3/fclose.3:42 build/C/man3/fopen.3:42 build/C/man2/read.2:35
333 #: build/C/man3/fclose.3:45
334 msgid "fclose - close a stream"
338 #: build/C/man3/fclose.3:49
339 msgid "B<int fclose(FILE *>I<fp>B<);>"
343 #: build/C/man3/fclose.3:57
345 "The B<fclose>() function will flushes the stream pointed to by I<fp> "
346 "(writing any buffered output data using B<fflush>(3)) and closes the "
347 "underlying file descriptor."
351 #: build/C/man3/fclose.3:68
353 "Upon successful completion 0 is returned. Otherwise, B<EOF> is returned and "
354 "I<errno> is set to indicate the error. In either case any further access "
355 "(including another call to B<fclose>()) to the stream results in undefined "
360 #: build/C/man3/fclose.3:68 build/C/man3/ferror.3:95 build/C/man3/fflush.3:79 build/C/man3/fgetwc.3:59 build/C/man3/flockfile.3:117 build/C/man3/fopen.3:201 build/C/man3/fpurge.3:63 build/C/man3/fputwc.3:58 build/C/man3/fseek.3:132 build/C/man3/fseeko.3:72 build/C/man3/getline.3:120 build/C/man2/link.2:57 build/C/man2/llseek.2:64 build/C/man2/lseek.2:159 build/C/man2/open.2:472 build/C/man2/pipe.2:97 build/C/man3/popen.3:141 build/C/man2/read.2:77 build/C/man2/readlink.2:83 build/C/man2/readv.2:186 build/C/man3/remove.3:65 build/C/man2/rename.2:96 build/C/man2/rmdir.2:45 build/C/man3/scanf.3:545 build/C/man2/symlink.2:89 build/C/man3/tempnam.3:90 build/C/man3/tmpfile.3:52 build/C/man3/tmpnam.3:73 build/C/man2/unlink.2:60 build/C/man2/write.2:107
366 #: build/C/man3/fclose.3:69 build/C/man3/fflush.3:80 build/C/man3/fpurge.3:64 build/C/man3/fseek.3:133 build/C/man2/llseek.2:65 build/C/man2/lseek.2:160 build/C/man2/read.2:96 build/C/man3/scanf.3:551 build/C/man2/write.2:126
371 #. This error cannot occur unless you are mixing ANSI C stdio operations and
372 #. low-level file operations on the same stream. If you do get this error,
373 #. you must have closed the stream's low-level file descriptor using
374 #. something like close(fileno(fp)).
376 #: build/C/man3/fclose.3:78
377 msgid "The file descriptor underlying I<fp> is not valid."
381 #: build/C/man3/fclose.3:88
383 "The B<fclose>() function may also fail and set I<errno> for any of the "
384 "errors specified for the routines B<close>(2), B<write>(2) or B<fflush>(3)."
388 #: build/C/man3/fclose.3:90 build/C/man3/fseek.3:166 build/C/man3/puts.3:103
393 #: build/C/man3/fclose.3:90 build/C/man3/fflush.3:97 build/C/man3/fgetwc.3:67 build/C/man3/fmemopen.3:195 build/C/man3/fmtmsg.3:236 build/C/man3/fopen.3:255 build/C/man3/fpurge.3:76 build/C/man3/fputwc.3:65 build/C/man3/fseeko.3:77 build/C/man2/link.2:133 build/C/man2/llseek.2:79 build/C/man2/lseek.2:199 build/C/man2/open.2:636 build/C/man3/perror.3:124 build/C/man3/printf.3:868 build/C/man2/read.2:157 build/C/man2/readlink.2:128 build/C/man2/readv.2:224 build/C/man3/remove.3:72 build/C/man3/scanf.3:606 build/C/man3/stdin.3:118 build/C/man2/symlink.2:150 build/C/man3/tempnam.3:99 build/C/man3/tmpfile.3:76 build/C/man3/tmpnam.3:80 build/C/man3/wprintf.3:195 build/C/man2/write.2:188
399 #: build/C/man3/fclose.3:100
401 "Note that B<fclose>() only flushes the user space buffers provided by the C "
402 "library. To ensure that the data is physically stored on disk the kernel "
403 "buffers must be flushed too, for example, with B<sync>(2) or B<fsync>(2)."
407 #: build/C/man3/fclose.3:105
408 msgid "B<close>(2), B<fcloseall>(3), B<fflush>(3), B<fopen>(3), B<setbuf>(3)"
412 #: build/C/man3/fcloseall.3:24
418 #: build/C/man3/fcloseall.3:24
424 #: build/C/man3/fcloseall.3:27
425 msgid "fcloseall - close all open streams"
429 #: build/C/man3/fcloseall.3:31 build/C/man3/fopencookie.3:31
432 "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
433 "B<#include E<lt>stdio.hE<gt>>\n"
437 #: build/C/man3/fcloseall.3:33
439 msgid "B<int fcloseall(void);>\n"
443 #: build/C/man3/fcloseall.3:42
445 "The B<fcloseall>() function closes all of the calling process's open "
446 "streams. Buffered output for each stream is written before it is closed (as "
447 "for B<fflush>(3)); buffered input is discarded."
451 #: build/C/man3/fcloseall.3:49
452 msgid "The standard streams, I<stdin>, I<stdout>, and I<stderr> are also closed."
456 #: build/C/man3/fcloseall.3:54
458 "This function returns 0 if all files were successfully closed; on error, "
459 "B<EOF> is returned."
463 #: build/C/man3/fcloseall.3:56
464 msgid "This function is a GNU extension."
468 #: build/C/man3/fcloseall.3:61
469 msgid "B<close>(2), B<fclose>(3), B<fflush>(3), B<fopen>(3), B<setbuf>(3)"
473 #: build/C/man3/ferror.3:42
479 #: build/C/man3/ferror.3:42 build/C/man3/flockfile.3:23 build/C/man3/unlocked_stdio.3:23
485 #: build/C/man3/ferror.3:45
486 msgid "clearerr, feof, ferror, fileno - check and reset stream status"
490 #: build/C/man3/ferror.3:49
491 msgid "B<void clearerr(FILE *>I<stream>B<);>"
495 #: build/C/man3/ferror.3:51
496 msgid "B<int feof(FILE *>I<stream>B<);>"
500 #: build/C/man3/ferror.3:53
501 msgid "B<int ferror(FILE *>I<stream>B<);>"
505 #: build/C/man3/ferror.3:55
506 msgid "B<int fileno(FILE *>I<stream>B<);>"
510 #: build/C/man3/ferror.3:63
511 msgid "B<fileno>(): _POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE"
515 #: build/C/man3/ferror.3:68
517 "The function B<clearerr>() clears the end-of-file and error indicators for "
518 "the stream pointed to by I<stream>."
522 #: build/C/man3/ferror.3:77
524 "The function B<feof>() tests the end-of-file indicator for the stream "
525 "pointed to by I<stream>, returning nonzero if it is set. The end-of-file "
526 "indicator can only be cleared by the function B<clearerr>()."
530 #: build/C/man3/ferror.3:86
532 "The function B<ferror>() tests the error indicator for the stream pointed "
533 "to by I<stream>, returning nonzero if it is set. The error indicator can "
534 "only be reset by the B<clearerr>() function."
538 #: build/C/man3/ferror.3:92
540 "The function B<fileno>() examines the argument I<stream> and returns its "
541 "integer descriptor."
545 #: build/C/man3/ferror.3:95 build/C/man3/fgetwc.3:53 build/C/man3/fputwc.3:52 build/C/man3/fread.3:81 build/C/man3/gets.3:109 build/C/man3/puts.3:82
546 msgid "For nonlocking counterparts, see B<unlocked_stdio>(3)."
550 #: build/C/man3/ferror.3:105
552 "These functions should not fail and do not set the external variable "
553 "I<errno>. (However, in case B<fileno>() detects that its argument is not a "
554 "valid stream, it must return -1 and set I<errno> to B<EBADF>.)"
558 #: build/C/man3/ferror.3:112
560 "The functions B<clearerr>(), B<feof>(), and B<ferror>() conform to C89 and "
565 #: build/C/man3/ferror.3:116
566 msgid "B<open>(2), B<fdopen>(3), B<stdio>(3), B<unlocked_stdio>(3)"
570 #: build/C/man3/fflush.3:43
576 #: build/C/man3/fflush.3:43
582 #: build/C/man3/fflush.3:46
583 msgid "fflush - flush a stream"
587 #: build/C/man3/fflush.3:50
588 msgid "B<int fflush(FILE *>I<stream>B<);>"
592 #: build/C/man3/fflush.3:61
594 "For output streams, B<fflush>() forces a write of all user-space buffered "
595 "data for the given output or update I<stream> via the stream's underlying "
596 "write function. For input streams, B<fflush>() discards any buffered data "
597 "that has been fetched from the underlying file, but has not been consumed by "
598 "the application. The open status of the stream is unaffected."
602 #: build/C/man3/fflush.3:69
604 "If the I<stream> argument is NULL, B<fflush>() flushes I<all> open output "
609 #: build/C/man3/fflush.3:72
610 msgid "For a nonlocking counterpart, see B<unlocked_stdio>(3)."
614 #: build/C/man3/fflush.3:79
616 "Upon successful completion 0 is returned. Otherwise, B<EOF> is returned and "
617 "I<errno> is set to indicate the error."
621 #: build/C/man3/fflush.3:84
622 msgid "I<Stream> is not an open stream, or is not open for writing."
626 #: build/C/man3/fflush.3:91
628 "The function B<fflush>() may also fail and set I<errno> for any of the "
629 "errors specified for B<write>(2)."
633 #: build/C/man3/fflush.3:93
634 msgid "C89, C99, POSIX.1-2001, POSIX.1-2008."
637 #. Verified on: Solaris 8.
639 #: build/C/man3/fflush.3:97
641 "The standards do not specify the behavior for input streams. Most other "
642 "implementations behave the same as Linux."
646 #: build/C/man3/fflush.3:106
648 "Note that B<fflush>() only flushes the user space buffers provided by the C "
649 "library. To ensure that the data is physically stored on disk the kernel "
650 "buffers must be flushed too, for example, with B<sync>(2) or B<fsync>(2)."
654 #: build/C/man3/fflush.3:113
656 "B<fsync>(2), B<sync>(2), B<write>(2), B<fclose>(3), B<fopen>(3), "
657 "B<setbuf>(3), B<unlocked_stdio>(3)"
661 #: build/C/man3/fgetwc.3:16
667 #: build/C/man3/fgetwc.3:16 build/C/man3/fputwc.3:14
673 #: build/C/man3/fgetwc.3:19
674 msgid "fgetwc, getwc - read a wide character from a FILE stream"
678 #: build/C/man3/fgetwc.3:24 build/C/man3/fmemopen.3:18 build/C/man3/fputwc.3:22 build/C/man3/unlocked_stdio.3:52
680 msgid "B<#include E<lt>wchar.hE<gt>>\n"
684 #: build/C/man3/fgetwc.3:27
687 "B<wint_t fgetwc(FILE *>I<stream>B<);>\n"
688 "B<wint_t getwc(FILE *>I<stream>B<);>\n"
692 #: build/C/man3/fgetwc.3:42
694 "The B<fgetwc>() function is the wide-character equivalent of the "
695 "B<fgetc>(3) function. It reads a wide character from I<stream> and returns "
696 "it. If the end of stream is reached, or if I<ferror(stream)> becomes true, "
697 "it returns B<WEOF>. If a wide-character conversion error occurs, it sets "
698 "I<errno> to B<EILSEQ> and returns B<WEOF>."
702 #: build/C/man3/fgetwc.3:50
704 "The B<getwc>() function or macro functions identically to B<fgetwc>(). It "
705 "may be implemented as a macro, and may evaluate its argument more than "
706 "once. There is no reason ever to use it."
710 #: build/C/man3/fgetwc.3:59
712 "The B<fgetwc>() function returns the next wide-character from the stream, "
717 #: build/C/man3/fgetwc.3:61 build/C/man3/fputwc.3:60
718 msgid "Apart from the usual ones, there is"
722 #: build/C/man3/fgetwc.3:61 build/C/man3/fputwc.3:60 build/C/man3/scanf.3:556
728 #: build/C/man3/fgetwc.3:65
729 msgid "The data obtained from the input stream does not form a valid character."
733 #: build/C/man3/fgetwc.3:67 build/C/man3/fputwc.3:65
734 msgid "C99, POSIX.1-2001."
738 #: build/C/man3/fgetwc.3:74
740 "The behavior of B<fgetwc>() depends on the B<LC_CTYPE> category of the "
745 #: build/C/man3/fgetwc.3:82
747 "In the absence of additional information passed to the B<fopen>(3) call, it "
748 "is reasonable to expect that B<fgetwc>() will actually read a multibyte "
749 "sequence from the stream and then convert it to a wide character."
753 #: build/C/man3/fgetwc.3:86
754 msgid "B<fgetws>(3), B<fputwc>(3), B<ungetwc>(3), B<unlocked_stdio>(3)"
758 #: build/C/man3/flockfile.3:23
764 #: build/C/man3/flockfile.3:26
765 msgid "flockfile, ftrylockfile, funlockfile - lock FILE for stdio"
769 #: build/C/man3/flockfile.3:31
771 msgid "B<void flockfile(FILE *>I<filehandle>B<);>\n"
775 #: build/C/man3/flockfile.3:33
777 msgid "B<int ftrylockfile(FILE *>I<filehandle>B<);>\n"
781 #: build/C/man3/flockfile.3:35
783 msgid "B<void funlockfile(FILE *>I<filehandle>B<);>\n"
787 #: build/C/man3/flockfile.3:44 build/C/man3/wprintf.3:41
788 msgid "All functions shown above:"
792 #: build/C/man3/flockfile.3:47
794 "_POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE "
799 #: build/C/man3/flockfile.3:61
801 "The stdio functions are thread-safe. This is achieved by assigning to each "
802 "I<FILE> object a lockcount and (if the lockcount is nonzero) an owning "
803 "thread. For each library call, these functions wait until the I<FILE> "
804 "object is no longer locked by a different thread, then lock it, do the "
805 "requested I/O, and unlock the object again."
809 #: build/C/man3/flockfile.3:67
811 "(Note: this locking has nothing to do with the file locking done by "
812 "functions like B<flock>(2) and B<lockf>(3).)"
816 #: build/C/man3/flockfile.3:75
818 "All this is invisible to the C-programmer, but there may be two reasons to "
819 "wish for more detailed control. On the one hand, maybe a series of I/O "
820 "actions by one thread belongs together, and should not be interrupted by the "
821 "I/O of some other thread. On the other hand, maybe the locking overhead "
822 "should be avoided for greater efficiency."
826 #: build/C/man3/flockfile.3:92
828 "To this end, a thread can explicitly lock the I<FILE> object, then do its "
829 "series of I/O actions, then unlock. This prevents other threads from coming "
830 "in between. If the reason for doing this was to achieve greater efficiency, "
831 "one does the I/O with the nonlocking versions of the stdio functions: with "
832 "B<getc_unlocked>(3) and B<putc_unlocked>(3) instead of B<getc>(3) and "
837 #: build/C/man3/flockfile.3:99
839 "The B<flockfile>() function waits for I<*filehandle> to be no longer locked "
840 "by a different thread, then makes the current thread owner of "
841 "I<*filehandle>, and increments the lockcount."
845 #: build/C/man3/flockfile.3:103
846 msgid "The B<funlockfile>() function decrements the lock count."
850 #: build/C/man3/flockfile.3:112
852 "The B<ftrylockfile>() function is a nonblocking version of B<flockfile>(). "
853 "It does nothing in case some other thread owns I<*filehandle>, and it "
854 "obtains ownership and increments the lockcount otherwise."
858 #: build/C/man3/flockfile.3:117
860 "The B<ftrylockfile>() function returns zero for success (the lock was "
861 "obtained), and nonzero for failure."
865 #: build/C/man3/flockfile.3:119
870 #: build/C/man3/flockfile.3:121 build/C/man3/popen.3:169
871 msgid "POSIX.1-2001."
875 #: build/C/man3/flockfile.3:121
881 #: build/C/man3/flockfile.3:127
883 "These functions are available when B<_POSIX_THREAD_SAFE_FUNCTIONS> is "
884 "defined. They are in libc since libc 5.1.1 and in glibc since glibc 2.0."
888 #: build/C/man3/flockfile.3:128
889 msgid "B<unlocked_stdio>(3)"
893 #: build/C/man3/fmemopen.3:6
899 #: build/C/man3/fmemopen.3:9
900 msgid "fmemopen, open_memstream, open_wmemstream - open memory as stream"
904 #: build/C/man3/fmemopen.3:14
907 "B<FILE *fmemopen(void *>I<buf>B<, size_t >I<size>B<, const char "
912 #: build/C/man3/fmemopen.3:16
914 msgid "B<FILE *open_memstream(char **>I<ptr>B<, size_t *>I<sizeloc>B<);>\n"
918 #: build/C/man3/fmemopen.3:20
920 msgid "B<FILE *open_wmemstream(wchar_t **>I<ptr>B<, size_t *>I<sizeloc>B<);>\n"
924 #: build/C/man3/fmemopen.3:30
925 msgid "B<fmemopen>(), B<open_memstream>(), B<open_wmemstream>():"
929 #: build/C/man3/fmemopen.3:53
931 "The B<fmemopen>() function opens a stream that permits the access specified "
932 "by I<mode>. The stream allows I/O to be performed on the string or memory "
933 "buffer pointed to by I<buf>. This buffer must be at least I<size> bytes "
938 #: build/C/man3/fmemopen.3:73
940 "The argument I<mode> is the same as for B<fopen>(3). If I<mode> specifies "
941 "an append mode, then the initial file position is set to the location of the "
942 "first null byte (\\(aq\\e0\\(aq) in the buffer; otherwise the initial file "
943 "position is set to the start of the buffer. Since glibc 2.9, the letter 'b' "
944 "may be specified as the second character in I<mode>. This provides "
945 "\"binary\" mode: writes don't implicitly add a terminating null byte, and "
946 "B<fseek>(3) B<SEEK_END> is relative to the end of the buffer (i.e., the "
947 "value specified by the I<size> argument), rather than the current string "
952 #: build/C/man3/fmemopen.3:85
954 "When a stream that has been opened for writing is flushed (B<fflush>(3)) or "
955 "closed (B<fclose>(3)), a null byte is written at the end of the buffer if "
956 "there is space. The caller should ensure that an extra byte is available in "
957 "the buffer (and that I<size> counts that byte) to allow for this."
960 #. See http://sourceware.org/bugzilla/show_bug.cgi?id=1995
962 #. http://sources.redhat.com/ml/libc-alpha/2006-04/msg00064.html
964 #: build/C/man3/fmemopen.3:103
966 "Attempts to write more than I<size> bytes to the buffer result in an error. "
967 "(By default, such errors will only be visible when the I<stdio> buffer is "
968 "flushed. Disabling buffering with I<setbuf(fp,\\ NULL)> may be useful to "
969 "detect errors at the time of an output operation. Alternatively, the caller "
970 "can explicitly set I<buf> as the stdio stream buffer, at the same time "
971 "informing stdio of the buffer's size, using I<setbuffer(fp, buf, size)>.)"
975 #: build/C/man3/fmemopen.3:111
977 "In a stream opened for reading, null bytes (\\(aq\\e0\\(aq) in the buffer do "
978 "not cause read operations to return an end-of-file indication. A read from "
979 "the buffer will only indicate end-of-file when the file pointer advances "
980 "I<size> bytes past the start of the buffer."
984 #: build/C/man3/fmemopen.3:126
986 "If I<buf> is specified as NULL, then B<fmemopen>() dynamically allocates a "
987 "buffer I<size> bytes long. This is useful for an application that wants to "
988 "write data to a temporary buffer and then read it back again. The buffer is "
989 "automatically freed when the stream is closed. Note that the caller has no "
990 "way to obtain a pointer to the temporary buffer allocated by this call (but "
991 "see B<open_memstream>() below)."
995 #: build/C/man3/fmemopen.3:137
997 "The B<open_memstream>() function opens a stream for writing to a buffer. "
998 "The buffer is dynamically allocated (as with B<malloc>(3)), and "
999 "automatically grows as required. After closing the stream, the caller "
1000 "should B<free>(3) this buffer."
1004 #: build/C/man3/fmemopen.3:152
1006 "When the stream is closed (B<fclose>(3)) or flushed (B<fflush>(3)), the "
1007 "locations pointed to by I<ptr> and I<sizeloc> are updated to contain, "
1008 "respectively, a pointer to the buffer and the current size of the buffer. "
1009 "These values remain valid only as long as the caller performs no further "
1010 "output on the stream. If further output is performed, then the stream must "
1011 "again be flushed before trying to access these variables."
1015 #: build/C/man3/fmemopen.3:158
1017 "A null byte is maintained at the end of the buffer. This byte is I<not> "
1018 "included in the size value stored at I<sizeloc>."
1022 #: build/C/man3/fmemopen.3:166
1024 "The stream's file position can be changed with B<fseek>(3) or "
1025 "B<fseeko>(3). Moving the file position past the end of the data already "
1026 "written fills the intervening space with zeros."
1030 #: build/C/man3/fmemopen.3:172
1032 "The B<open_wmemstream>() is similar to B<open_memstream>(), but operates on "
1033 "wide characters instead of bytes."
1037 #: build/C/man3/fmemopen.3:184
1039 "Upon successful completion B<fmemopen>(), B<open_memstream>() and "
1040 "B<open_wmemstream>() return a I<FILE> pointer. Otherwise, NULL is returned "
1041 "and I<errno> is set to indicate the error."
1045 #: build/C/man3/fmemopen.3:184 build/C/man3/fmtmsg.3:218 build/C/man3/getline.3:130 build/C/man2/pipe.2:113 build/C/man2/readv.2:207
1051 #: build/C/man3/fmemopen.3:191
1053 "B<fmemopen>() and B<open_memstream>() were already available in glibc "
1054 "1.0.x. B<open_wmemstream>() is available since glibc 2.4."
1058 #: build/C/man3/fmemopen.3:195
1060 "POSIX.1-2008. These functions are not specified in POSIX.1-2001, and are "
1061 "not widely available on other systems."
1065 #: build/C/man3/fmemopen.3:201
1067 "There is no file descriptor associated with the file stream returned by "
1068 "these functions (i.e., B<fileno>(3) will return an error if called on the "
1072 #. http://sourceware.org/bugzilla/show_bug.cgi?id=1996
1074 #: build/C/man3/fmemopen.3:208
1076 "In glibc before version 2.7, seeking past the end of a stream created by "
1077 "B<open_memstream>() does not enlarge the buffer; instead the B<fseek>(3) "
1078 "call fails, returning -1."
1082 #: build/C/man3/fmemopen.3:208 build/C/man3/fmtmsg.3:240 build/C/man3/fopencookie.3:244 build/C/man3/getline.3:139 build/C/man2/pipe.2:124 build/C/man3/printf.3:974 build/C/man2/readlink.2:155 build/C/man2/readv.2:263
1088 #: build/C/man3/fmemopen.3:218
1090 "The program below uses B<fmemopen>() to open an input buffer, and "
1091 "B<open_memstream>() to open a dynamically sized output buffer. The program "
1092 "scans its input string (taken from the program's first command-line "
1093 "argument) reading integers, and writes the squares of these integers to the "
1094 "output buffer. An example of the output produced by this program is the "
1099 #: build/C/man3/fmemopen.3:223
1102 "$B< ./a.out \\(aq1 23 43\\(aq>\n"
1103 "size=11; ptr=1 529 1849\n"
1107 #: build/C/man3/fmemopen.3:225 build/C/man3/fopencookie.3:268
1109 msgid "Program source"
1113 #: build/C/man3/fmemopen.3:232
1116 "#define _GNU_SOURCE\n"
1117 "#include E<lt>string.hE<gt>\n"
1118 "#include E<lt>stdio.hE<gt>\n"
1119 "#include E<lt>stdlib.hE<gt>\n"
1123 #: build/C/man3/fmemopen.3:235
1126 "#define handle_error(msg) \\e\n"
1127 " do { perror(msg); exit(EXIT_FAILURE); } while (0)\n"
1131 #: build/C/man3/fmemopen.3:243
1135 "main(int argc, char *argv[])\n"
1137 " FILE *out, *in;\n"
1144 #: build/C/man3/fmemopen.3:248
1147 " if (argc != 2) {\n"
1148 "\tfprintf(stderr, \"Usage: %s E<lt>fileE<gt>\\en\", argv[0]);\n"
1149 "\texit(EXIT_FAILURE);\n"
1154 #: build/C/man3/fmemopen.3:252
1157 " in = fmemopen(argv[1], strlen(argv[1]), \"r\");\n"
1158 " if (in == NULL)\n"
1159 " handle_error(\"fmemopen\");\n"
1163 #: build/C/man3/fmemopen.3:256
1166 " out = open_memstream(&ptr, &size);\n"
1167 " if (out == NULL)\n"
1168 " handle_error(\"open_memstream\");\n"
1172 #: build/C/man3/fmemopen.3:261
1176 " s = fscanf(in, \"%d\", &v);\n"
1177 " if (s E<lt>= 0)\n"
1182 #: build/C/man3/fmemopen.3:272
1185 " s = fprintf(out, \"%d \", v * v);\n"
1187 " handle_error(\"fprintf\");\n"
1191 " printf(\"size=%ld; ptr=%s\\en\", (long) size, ptr);\n"
1193 " exit(EXIT_SUCCESS);\n"
1198 #: build/C/man3/fmemopen.3:275
1199 msgid "B<fopen>(3), B<fopencookie>(3)"
1203 #: build/C/man3/fmtmsg.3:9
1209 #: build/C/man3/fmtmsg.3:9
1215 #: build/C/man3/fmtmsg.3:12
1216 msgid "fmtmsg - print formatted error messages"
1220 #: build/C/man3/fmtmsg.3:15
1222 msgid "B<#include E<lt>fmtmsg.hE<gt>>\n"
1226 #: build/C/man3/fmtmsg.3:17
1228 msgid "B<int fmtmsg(long >I<classification>B<, const char *>I<label>B<,>\n"
1232 #: build/C/man3/fmtmsg.3:19
1234 msgid "B< int >I<severity>B<, const char *>I<text>B<,>\n"
1238 #: build/C/man3/fmtmsg.3:21
1240 msgid "B< const char *>I<action>B<, const char *>I<tag>B<);>\n"
1244 #: build/C/man3/fmtmsg.3:32
1246 "This function displays a message described by its arguments on the device(s) "
1247 "specified in the I<classification> argument. For messages written to "
1248 "I<stderr>, the format depends on the B<MSGVERB> environment variable."
1252 #: build/C/man3/fmtmsg.3:39
1254 "The I<label> argument identifies the source of the message. The string must "
1255 "consist of two colon separated parts where the first part has not more than "
1256 "10 and the second part not more than 14 characters."
1260 #: build/C/man3/fmtmsg.3:43
1261 msgid "The I<text> argument describes the condition of the error."
1265 #: build/C/man3/fmtmsg.3:48
1267 "The I<action> argument describes possible steps to recover from the error. "
1268 "If it is printed, it is prefixed by \"TO FIX: \"."
1272 #: build/C/man3/fmtmsg.3:56
1274 "The I<tag> argument is a reference to the online documentation where more "
1275 "information can be found. It should contain the I<label> value and a unique "
1276 "identification number."
1280 #: build/C/man3/fmtmsg.3:56
1282 msgid "Dummy arguments"
1286 #: build/C/man3/fmtmsg.3:75
1288 "Each of the arguments can have a dummy value. The dummy classification "
1289 "value B<MM_NULLMC> (0L) does not specify any output, so nothing is printed. "
1290 "The dummy severity value B<NO_SEV> (0) says that no severity is supplied. "
1291 "The values B<MM_NULLLBL>, B<MM_NULLTXT>, B<MM_NULLACT>, B<MM_NULLTAG> are "
1292 "synonyms for I<((char *) 0)>, the empty string, and B<MM_NULLSEV> is a "
1293 "synonym for B<NO_SEV>."
1297 #: build/C/man3/fmtmsg.3:75
1299 msgid "The classification argument"
1303 #: build/C/man3/fmtmsg.3:79
1305 "The I<classification> argument is the sum of values describing 4 types of "
1310 #: build/C/man3/fmtmsg.3:82
1311 msgid "The first value defines the output channel."
1315 #: build/C/man3/fmtmsg.3:82
1321 #: build/C/man3/fmtmsg.3:86
1322 msgid "Output to I<stderr>."
1326 #: build/C/man3/fmtmsg.3:86
1328 msgid "B<MM_CONSOLE>"
1332 #: build/C/man3/fmtmsg.3:89
1333 msgid "Output to the system console."
1337 #: build/C/man3/fmtmsg.3:89
1339 msgid "B<MM_PRINT | MM_CONSOLE>"
1343 #: build/C/man3/fmtmsg.3:92
1344 msgid "Output to both."
1348 #: build/C/man3/fmtmsg.3:94
1349 msgid "The second value is the source of the error:"
1353 #: build/C/man3/fmtmsg.3:94
1359 #: build/C/man3/fmtmsg.3:97
1360 msgid "A hardware error occurred."
1364 #: build/C/man3/fmtmsg.3:97
1370 #: build/C/man3/fmtmsg.3:100
1371 msgid "A firmware error occurred."
1375 #: build/C/man3/fmtmsg.3:100
1381 #: build/C/man3/fmtmsg.3:103
1382 msgid "A software error occurred."
1386 #: build/C/man3/fmtmsg.3:105
1387 msgid "The third value encodes the detector of the problem:"
1391 #: build/C/man3/fmtmsg.3:105
1397 #: build/C/man3/fmtmsg.3:108
1398 msgid "It is detected by an application."
1402 #: build/C/man3/fmtmsg.3:108
1408 #: build/C/man3/fmtmsg.3:111
1409 msgid "It is detected by a utility."
1413 #: build/C/man3/fmtmsg.3:111
1419 #: build/C/man3/fmtmsg.3:114
1420 msgid "It is detected by the operating system."
1424 #: build/C/man3/fmtmsg.3:116
1425 msgid "The fourth value shows the severity of the incident:"
1429 #: build/C/man3/fmtmsg.3:116
1431 msgid "B<MM_RECOVER>"
1435 #: build/C/man3/fmtmsg.3:119
1436 msgid "It is a recoverable error."
1440 #: build/C/man3/fmtmsg.3:119
1442 msgid "B<MM_NRECOV>"
1446 #: build/C/man3/fmtmsg.3:122
1447 msgid "It is a nonrecoverable error."
1451 #: build/C/man3/fmtmsg.3:122
1453 msgid "The severity argument"
1457 #: build/C/man3/fmtmsg.3:126
1458 msgid "The I<severity> argument can take one of the following values:"
1462 #: build/C/man3/fmtmsg.3:126
1468 #: build/C/man3/fmtmsg.3:129
1469 msgid "No severity is printed."
1473 #: build/C/man3/fmtmsg.3:129
1479 #: build/C/man3/fmtmsg.3:132
1480 msgid "This value is printed as HALT."
1484 #: build/C/man3/fmtmsg.3:132
1490 #: build/C/man3/fmtmsg.3:135
1491 msgid "This value is printed as ERROR."
1495 #: build/C/man3/fmtmsg.3:135
1497 msgid "B<MM_WARNING>"
1501 #: build/C/man3/fmtmsg.3:138
1502 msgid "This value is printed as WARNING."
1506 #: build/C/man3/fmtmsg.3:138
1512 #: build/C/man3/fmtmsg.3:141
1513 msgid "This value is printed as INFO."
1517 #: build/C/man3/fmtmsg.3:148
1519 "The numeric values are between 0 and 4. Using B<addseverity>(3) or the "
1520 "environment variable B<SEV_LEVEL> you can add more levels and strings to "
1525 #: build/C/man3/fmtmsg.3:150
1526 msgid "The function can return 4 values:"
1530 #: build/C/man3/fmtmsg.3:150
1536 #: build/C/man3/fmtmsg.3:153
1537 msgid "Everything went smooth."
1541 #: build/C/man3/fmtmsg.3:153
1547 #: build/C/man3/fmtmsg.3:156
1548 msgid "Complete failure."
1552 #: build/C/man3/fmtmsg.3:156
1558 #: build/C/man3/fmtmsg.3:160
1559 msgid "Error writing to I<stderr>."
1563 #: build/C/man3/fmtmsg.3:160
1569 #: build/C/man3/fmtmsg.3:163
1570 msgid "Error writing to the console."
1574 #: build/C/man3/fmtmsg.3:163
1580 #: build/C/man3/fmtmsg.3:174
1582 "The environment variable B<MSGVERB> (\"message verbosity\") can be used to "
1583 "suppress parts of the output to I<stderr>. (It does not influence output to "
1584 "the console.) When this variable is defined, is non-NULL, and is a "
1585 "colon-separated list of valid keywords, then only the parts of the message "
1586 "corresponding to these keywords is printed. Valid keywords are \"label\", "
1587 "\"severity\", \"text\", \"action\" and \"tag\"."
1591 #: build/C/man3/fmtmsg.3:186
1593 "The environment variable B<SEV_LEVEL> can be used to introduce new severity "
1594 "levels. By default, only the five severity levels described above are "
1595 "available. Any other numeric value would make B<fmtmsg>() print nothing. "
1596 "If the user puts B<SEV_LEVEL> with a format like"
1600 #: build/C/man3/fmtmsg.3:189
1601 msgid "SEV_LEVEL=[description[:description[:...]]]"
1605 #: build/C/man3/fmtmsg.3:194
1607 "in the environment of the process before the first call to B<fmtmsg>(), "
1608 "where each description is of the form"
1612 #: build/C/man3/fmtmsg.3:197
1613 msgid "severity-keyword,level,printstring"
1617 #: build/C/man3/fmtmsg.3:204
1619 "then B<fmtmsg>() will also accept the indicated values for the level (in "
1620 "addition to the standard levels 0-4), and use the indicated printstring when "
1621 "such a level occurs."
1625 #: build/C/man3/fmtmsg.3:218
1627 "The severity-keyword part is not used by B<fmtmsg>() but it has to be "
1628 "present. The level part is a string representation of a number. The "
1629 "numeric value must be a number greater than 4. This value must be used in "
1630 "the severity argument of B<fmtmsg>() to select this class. It is not "
1631 "possible to overwrite any of the predefined classes. The printstring is the "
1632 "string printed when a message of this class is processed by B<fmtmsg>()."
1636 #: build/C/man3/fmtmsg.3:221
1637 msgid "B<fmtmsg>() is provided in glibc since version 2.1."
1641 #: build/C/man3/fmtmsg.3:236
1643 "The functions B<fmtmsg>() and B<addseverity>(3), and environment variables "
1644 "B<MSGVERB> and B<SEV_LEVEL> come from System V. The function B<fmtmsg>() "
1645 "and the environment variable B<MSGVERB> are described in POSIX.1-2001."
1649 #: build/C/man3/fmtmsg.3:240
1651 "System V and UnixWare man pages tell us that these functions have been "
1652 "replaced by \"pfmt() and addsev()\" or by \"pfmt(), vpfmt(), lfmt(), and "
1653 "vlfmt()\", and will be removed later."
1657 #: build/C/man3/fmtmsg.3:245
1660 "#include E<lt>stdio.hE<gt>\n"
1661 "#include E<lt>stdlib.hE<gt>\n"
1662 "#include E<lt>fmtmsg.hE<gt>\n"
1666 #: build/C/man3/fmtmsg.3:251
1672 " long class = MM_PRINT | MM_SOFT | MM_OPSYS | MM_RECOVER;\n"
1677 #: build/C/man3/fmtmsg.3:272
1680 " err = fmtmsg(class, \"util-linux:mount\", MM_ERROR,\n"
1681 " \"unknown mount option\", \"See mount(8).\",\n"
1682 " \"util-linux:mount:017\");\n"
1687 " printf(\"Nothing printed\\en\");\n"
1690 " printf(\"Nothing printed to stderr\\en\");\n"
1693 " printf(\"No console output\\en\");\n"
1696 " printf(\"Unknown error from fmtmsg()\\en\");\n"
1698 " exit(EXIT_SUCCESS);\n"
1703 #: build/C/man3/fmtmsg.3:275
1704 msgid "The output should be:"
1708 #: build/C/man3/fmtmsg.3:279
1711 " util-linux:mount: ERROR: unknown mount option\n"
1712 " TO FIX: See mount(8). util-linux:mount:017\n"
1716 #: build/C/man3/fmtmsg.3:282
1721 #: build/C/man3/fmtmsg.3:285
1723 msgid " MSGVERB=text:action; export MSGVERB\n"
1727 #: build/C/man3/fmtmsg.3:288
1728 msgid "the output becomes:"
1732 #: build/C/man3/fmtmsg.3:292
1735 " unknown mount option\n"
1736 " TO FIX: See mount(8).\n"
1740 #: build/C/man3/fmtmsg.3:295
1741 msgid "B<addseverity>(3), B<perror>(3)"
1745 #: build/C/man3/fopen.3:42
1751 #: build/C/man3/fopen.3:45
1752 msgid "fopen, fdopen, freopen - stream open functions"
1756 #: build/C/man3/fopen.3:50
1758 msgid "B<FILE *fopen(const char *>I<path>B<, const char *>I<mode>B<);>\n"
1762 #: build/C/man3/fopen.3:52
1764 msgid "B<FILE *fdopen(int >I<fd>B<, const char *>I<mode>B<);>\n"
1768 #: build/C/man3/fopen.3:54
1771 "B<FILE *freopen(const char *>I<path>B<, const char *>I<mode>B<, FILE "
1772 "*>I<stream>B<);>\n"
1776 #: build/C/man3/fopen.3:63
1777 msgid "B<fdopen>(): _POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE"
1781 #: build/C/man3/fopen.3:69
1783 "The B<fopen>() function opens the file whose name is the string pointed to "
1784 "by I<path> and associates a stream with it."
1788 #: build/C/man3/fopen.3:74
1790 "The argument I<mode> points to a string beginning with one of the following "
1791 "sequences (Additional characters may follow these sequences.):"
1795 #: build/C/man3/fopen.3:74
1801 #: build/C/man3/fopen.3:78
1803 "Open text file for reading. The stream is positioned at the beginning of "
1808 #: build/C/man3/fopen.3:78
1814 #: build/C/man3/fopen.3:82
1816 "Open for reading and writing. The stream is positioned at the beginning of "
1821 #: build/C/man3/fopen.3:82
1827 #: build/C/man3/fopen.3:86
1829 "Truncate file to zero length or create text file for writing. The stream is "
1830 "positioned at the beginning of the file."
1834 #: build/C/man3/fopen.3:86
1840 #: build/C/man3/fopen.3:92
1842 "Open for reading and writing. The file is created if it does not exist, "
1843 "otherwise it is truncated. The stream is positioned at the beginning of the "
1848 #: build/C/man3/fopen.3:92 build/C/man3/scanf.3:444
1854 #: build/C/man3/fopen.3:97
1856 "Open for appending (writing at end of file). The file is created if it does "
1857 "not exist. The stream is positioned at the end of the file."
1861 #: build/C/man3/fopen.3:97
1867 #: build/C/man3/fopen.3:103
1869 "Open for reading and appending (writing at end of file). The file is "
1870 "created if it does not exist. The initial file position for reading is at "
1871 "the beginning of the file, but output is always appended to the end of the "
1876 #: build/C/man3/fopen.3:116
1878 "The I<mode> string can also include the letter \\(aqb\\(aq either as a last "
1879 "character or as a character between the characters in any of the "
1880 "two-character strings described above. This is strictly for compatibility "
1881 "with C89 and has no effect; the \\(aqb\\(aq is ignored on all POSIX "
1882 "conforming systems, including Linux. (Other systems may treat text files "
1883 "and binary files differently, and adding the \\(aqb\\(aq may be a good idea "
1884 "if you do I/O to a binary file and expect that your program may be ported to "
1885 "non-UNIX environments.)"
1889 #: build/C/man3/fopen.3:119
1890 msgid "See NOTES below for details of glibc extensions for I<mode>."
1894 #: build/C/man3/fopen.3:124
1896 "Any created files will have mode B<S_IRUSR> | B<S_IWUSR> | B<S_IRGRP> | "
1897 "B<S_IWGRP> | B<S_IROTH> | B<S_IWOTH> (0666), as modified by the process's "
1898 "umask value (see B<umask>(2))."
1902 #: build/C/man3/fopen.3:139
1904 "Reads and writes may be intermixed on read/write streams in any order. Note "
1905 "that ANSI C requires that a file positioning function intervene between "
1906 "output and input, unless an input operation encounters end-of-file. (If "
1907 "this condition is not met, then a read is allowed to return the result of "
1908 "writes other than the most recent.) Therefore it is good practice (and "
1909 "indeed sometimes necessary under Linux) to put an B<fseek>(3) or "
1910 "B<fgetpos>(3) operation between write and read operations on such a "
1911 "stream. This operation may be an apparent no-op (as in I<fseek(..., 0L, "
1912 "SEEK_CUR)> called for its synchronizing side effect."
1916 #: build/C/man3/fopen.3:144
1918 "Opening a file in append mode (B<a> as the first character of I<mode>) "
1919 "causes all subsequent write operations to this stream to occur at "
1920 "end-of-file, as if preceded by an"
1924 #: build/C/man3/fopen.3:147
1926 msgid " fseek(stream,0,SEEK_END);\n"
1930 #: build/C/man3/fopen.3:150
1935 #: build/C/man3/fopen.3:171
1937 "The B<fdopen>() function associates a stream with the existing file "
1938 "descriptor, I<fd>. The I<mode> of the stream (one of the values \"r\", "
1939 "\"r+\", \"w\", \"w+\", \"a\", \"a+\") must be compatible with the mode of "
1940 "the file descriptor. The file position indicator of the new stream is set "
1941 "to that belonging to I<fd>, and the error and end-of-file indicators are "
1942 "cleared. Modes \"w\" or \"w+\" do not cause truncation of the file. The "
1943 "file descriptor is not dup'ed, and will be closed when the stream created by "
1944 "B<fdopen>() is closed. The result of applying B<fdopen>() to a shared "
1945 "memory object is undefined."
1949 #: build/C/man3/fopen.3:189
1951 "The B<freopen>() function opens the file whose name is the string pointed "
1952 "to by I<path> and associates the stream pointed to by I<stream> with it. "
1953 "The original stream (if it exists) is closed. The I<mode> argument is used "
1954 "just as in the B<fopen>() function. The primary use of the B<freopen>() "
1955 "function is to change the file associated with a standard text stream "
1956 "(I<stderr>, I<stdin>, or I<stdout>)."
1960 #: build/C/man3/fopen.3:201
1962 "Upon successful completion B<fopen>(), B<fdopen>() and B<freopen>() return "
1963 "a I<FILE> pointer. Otherwise, NULL is returned and I<errno> is set to "
1964 "indicate the error."
1968 #: build/C/man3/fopen.3:202 build/C/man3/fseek.3:138 build/C/man3/getline.3:121 build/C/man2/llseek.2:72 build/C/man2/lseek.2:164 build/C/man2/pipe.2:102 build/C/man2/read.2:108 build/C/man2/read.2:119 build/C/man2/readlink.2:93 build/C/man2/readlink.2:102 build/C/man2/readv.2:198 build/C/man2/rename.2:136 build/C/man2/rmdir.2:67 build/C/man3/scanf.3:563 build/C/man2/write.2:148
1974 #: build/C/man3/fopen.3:212
1976 "The I<mode> provided to B<fopen>(), B<fdopen>(), or B<freopen>() was "
1981 #: build/C/man3/fopen.3:222
1983 "The B<fopen>(), B<fdopen>() and B<freopen>() functions may also fail and "
1984 "set I<errno> for any of the errors specified for the routine B<malloc>(3)."
1988 #: build/C/man3/fopen.3:229
1990 "The B<fopen>() function may also fail and set I<errno> for any of the "
1991 "errors specified for the routine B<open>(2)."
1995 #: build/C/man3/fopen.3:236
1997 "The B<fdopen>() function may also fail and set I<errno> for any of the "
1998 "errors specified for the routine B<fcntl>(2)."
2002 #: build/C/man3/fopen.3:246
2004 "The B<freopen>() function may also fail and set I<errno> for any of the "
2005 "errors specified for the routines B<open>(2), B<fclose>(3) and "
2010 #: build/C/man3/fopen.3:255
2012 "The B<fopen>() and B<freopen>() functions conform to C89. The B<fdopen>() "
2013 "function conforms to POSIX.1-1990."
2017 #: build/C/man3/fopen.3:256
2023 #: build/C/man3/fopen.3:259
2025 "The GNU C library allows the following extensions for the string specified "
2030 #: build/C/man3/fopen.3:259
2032 msgid "B<c> (since glibc 2.3.3)"
2036 #: build/C/man3/fopen.3:264
2038 "Do not make the open operation, or subsequent read and write operations, "
2039 "thread cancellation points."
2043 #: build/C/man3/fopen.3:264
2045 msgid "B<e> (since glibc 2.7)"
2049 #: build/C/man3/fopen.3:272
2051 "Open the file with the B<O_CLOEXEC> flag. See B<open>(2) for more "
2056 #: build/C/man3/fopen.3:272
2058 msgid "B<m> (since glibc 2.3)"
2063 #: build/C/man3/fopen.3:284
2065 "Attempt to access the file using B<mmap>(2), rather than I/O system calls "
2066 "(B<read>(2), B<write>(2)). Currently, use of B<mmap>(2) is only attempted "
2067 "for a file opened for reading."
2071 #: build/C/man3/fopen.3:284 build/C/man3/scanf.3:418
2077 #. FIXME C11 specifies this flag
2078 #. FIXME document /,ccs= charset/
2080 #: build/C/man3/fopen.3:302
2082 "Open the file exclusively (like the B<O_EXCL> flag of B<open>(2)). If the "
2083 "file already exists, B<fopen>() fails, and sets I<errno> to B<EEXIST>. "
2084 "This flag is ignored for B<fdopen>()."
2088 #: build/C/man3/fopen.3:307
2089 msgid "B<open>(2), B<fclose>(3), B<fileno>(3), B<fmemopen>(3), B<fopencookie>(3)"
2093 #: build/C/man3/fopencookie.3:24
2099 #: build/C/man3/fopencookie.3:24
2105 #: build/C/man3/fopencookie.3:24 build/C/man2/link.2:31 build/C/man2/llseek.2:26 build/C/man2/lseek.2:45 build/C/man3/lseek64.3:23 build/C/man2/open.2:52 build/C/man2/pipe.2:36 build/C/man2/read.2:35 build/C/man2/readlink.2:41 build/C/man2/readv.2:30 build/C/man2/rename.2:32 build/C/man2/rmdir.2:30 build/C/man3/setbuf.3:46 build/C/man3/stdin.3:9 build/C/man2/symlink.2:32 build/C/man7/symlink.7:35 build/C/man2/unlink.2:32 build/C/man2/write.2:39
2111 #: build/C/man3/fopencookie.3:27
2112 msgid "fopencookie - opening a custom stream"
2116 #: build/C/man3/fopencookie.3:34
2119 "B<FILE *fopencookie(void *>I<cookie>B<, const char *>I<mode>B<,>\n"
2120 "B< cookie_io_functions_t >I<io_funcs>B<);>\n"
2124 #: build/C/man3/fopencookie.3:47
2126 "The B<fopencookie>() function allows the programmer to create a custom "
2127 "implementation for a standard I/O stream. This implementation can store the "
2128 "stream's data at a location of its own choosing; for example, "
2129 "B<fopencookie>() is used to implement B<fmemopen>(3), which provides a "
2130 "stream interface to data that is stored in a buffer in memory."
2134 #: build/C/man3/fopencookie.3:49
2135 msgid "In order to create a custom stream the programmer must:"
2139 #: build/C/man3/fopencookie.3:49 build/C/man3/fopencookie.3:52 build/C/man3/fopencookie.3:63 build/C/man3/scanf.3:669 build/C/man3/scanf.3:674 build/C/man3/scanf.3:680 build/C/man7/symlink.7:248 build/C/man7/symlink.7:258 build/C/man7/symlink.7:288 build/C/man7/symlink.7:348 build/C/man7/symlink.7:377 build/C/man7/symlink.7:406 build/C/man7/symlink.7:437 build/C/man7/symlink.7:450
2145 #: build/C/man3/fopencookie.3:52
2147 "Implement four \"hook\" functions that are used internally by the standard "
2148 "I/O library when performing I/O on the stream."
2152 #: build/C/man3/fopencookie.3:63
2154 "Define a \"cookie\" data type, a structure that provides bookkeeping "
2155 "information (e.g., where to store data) used by the aforementioned hook "
2156 "functions. The standard I/O package knows nothing about the contents of "
2157 "this cookie (thus it is typed as I<void\\ *> when passed to "
2158 "B<fopencookie>()), but automatically supplies the cookie as the first "
2159 "argument when calling the hook functions."
2163 #: build/C/man3/fopencookie.3:68
2165 "Call B<fopencookie>() to open a new stream and associate the cookie and "
2166 "hook functions with that stream."
2170 #: build/C/man3/fopencookie.3:76
2172 "The B<fopencookie>() function serves a purpose similar to B<fopen>(3): it "
2173 "opens a new stream and returns a pointer to a I<FILE> object that is used to "
2174 "operate on that stream."
2178 #: build/C/man3/fopencookie.3:83
2180 "The I<cookie> argument is a pointer to the caller's cookie structure that is "
2181 "to be associated with the new stream. This pointer is supplied as the first "
2182 "argument when the standard I/O library invokes any of the hook functions "
2187 #: build/C/man3/fopencookie.3:99
2189 "The I<mode> argument serves the same purpose as for B<fopen>(3). The "
2190 "following modes are supported: I<r>, I<w>, I<a>, I<r+>, I<w+>, and I<a+>. "
2191 "See B<fopen>(3) for details."
2195 #: build/C/man3/fopencookie.3:105
2197 "The I<io_funcs> argument is a structure that contains four fields pointing "
2198 "to the programmer-defined hook functions that are used to implement this "
2199 "stream. The structure is defined as follows"
2203 #: build/C/man3/fopencookie.3:114
2206 "struct cookie_io_functions_t {\n"
2207 " cookie_read_function_t *read;\n"
2208 " cookie_write_function_t *write;\n"
2209 " cookie_seek_function_t *seek;\n"
2210 " cookie_close_function_t *close;\n"
2215 #: build/C/man3/fopencookie.3:118
2216 msgid "The four fields are as follows:"
2220 #: build/C/man3/fopencookie.3:118
2222 msgid "I<cookie_read_function_t *read>"
2226 #: build/C/man3/fopencookie.3:122
2228 "This function implements read operations for the stream. When called, it "
2229 "receives three arguments:"
2233 #: build/C/man3/fopencookie.3:124
2235 msgid " ssize_t read(void *cookie, char *buf, size_t size);\n"
2239 #: build/C/man3/fopencookie.3:139
2241 "The I<buf> and I<size> arguments are, respectively, a buffer into which "
2242 "input data can be placed and the size of that buffer. As its function "
2243 "result, the I<read> function should return the number of bytes copied into "
2244 "I<buf>, 0 on end of file, or -1 on error. The I<read> function should "
2245 "update the stream offset appropriately."
2249 #: build/C/man3/fopencookie.3:144
2251 "If I<*read> is a NULL pointer, then reads from the custom stream always "
2252 "return end of file."
2256 #: build/C/man3/fopencookie.3:144
2258 msgid "I<cookie_write_function_t *write>"
2262 #: build/C/man3/fopencookie.3:148
2264 "This function implements write operations for the stream. When called, it "
2265 "receives three arguments:"
2269 #: build/C/man3/fopencookie.3:150
2271 msgid " ssize_t write(void *cookie, const char *buf, size_t size);\n"
2275 #: build/C/man3/fopencookie.3:165
2277 "The I<buf> and I<size> arguments are, respectively, a buffer of data to be "
2278 "output to the stream and the size of that buffer. As its function result, "
2279 "the I<write> function should return the number of bytes copied from I<buf>, "
2280 "or -1 on error. The I<write> function should update the stream offset "
2285 #: build/C/man3/fopencookie.3:170
2286 msgid "If I<*write> is a NULL pointer, then output to the stream is discarded."
2290 #: build/C/man3/fopencookie.3:170
2292 msgid "I<cookie_seek_function_t *seek>"
2296 #: build/C/man3/fopencookie.3:174
2298 "This function implements seek operations on the stream. When called, it "
2299 "receives three arguments:"
2303 #: build/C/man3/fopencookie.3:176
2305 msgid " int seek(void *cookie, off64_t *offset, int whence);\n"
2309 #: build/C/man3/fopencookie.3:182
2311 "The I<*offset> argument specifies the new file offset depending on which of "
2312 "the following three values is supplied in I<whence>:"
2316 #: build/C/man3/fopencookie.3:183 build/C/man2/lseek.2:65
2322 #: build/C/man3/fopencookie.3:188
2324 "The stream offset should be set I<*offset> bytes from the start of the "
2329 #: build/C/man3/fopencookie.3:188 build/C/man2/lseek.2:70
2335 #: build/C/man3/fopencookie.3:192
2336 msgid "I<*offset> should be added to the current stream offset."
2340 #: build/C/man3/fopencookie.3:192 build/C/man2/lseek.2:75
2346 #: build/C/man3/fopencookie.3:196
2347 msgid "The stream offset should be set to the size of the stream plus I<*offset>."
2351 #: build/C/man3/fopencookie.3:203
2353 "Before returning, the I<seek> function should update I<*offset> to indicate "
2354 "the new stream offset."
2358 #: build/C/man3/fopencookie.3:207
2360 "As its function result, the I<seek> function should return 0 on success, and "
2365 #: build/C/man3/fopencookie.3:212
2367 "If I<*seek> is a NULL pointer, then it is not possible to perform seek "
2368 "operations on the stream."
2372 #: build/C/man3/fopencookie.3:212
2374 msgid "I<cookie_close_function_t *close>"
2378 #: build/C/man3/fopencookie.3:218
2380 "This function closes the stream. The hook function can do things such as "
2381 "freeing buffers allocated for the stream. When called, it receives one "
2386 #: build/C/man3/fopencookie.3:220
2388 msgid " int close(void *cookie);\n"
2392 #: build/C/man3/fopencookie.3:225
2394 "The I<cookie> argument is the cookie that the programmer supplied when "
2395 "calling B<fopencookie>()."
2399 #: build/C/man3/fopencookie.3:231
2401 "As its function result, the I<close> function should return 0 on success, "
2402 "and B<EOF> on error."
2406 #: build/C/man3/fopencookie.3:235
2408 "If I<*close> is NULL, then no special action is performed when the stream is "
2413 #. It's not clear if errno ever gets set...
2415 #: build/C/man3/fopencookie.3:242
2417 "On success B<fopencookie>() returns a pointer to the new stream. On error, "
2422 #: build/C/man3/fopencookie.3:244
2423 msgid "This function is a nonstandard GNU extension."
2427 #: build/C/man3/fopencookie.3:253
2429 "The program below implements a custom stream whose functionality is similar "
2430 "(but not identical) to that available via B<fmemopen>(3). It implements a "
2431 "stream whose data is stored in a memory buffer. The program writes its "
2432 "command-line arguments to the stream, and then seeks through the stream "
2433 "reading two out of every five characters and writing them to standard "
2434 "output. The following shell session demonstrates the use of the program:"
2438 #: build/C/man3/fopencookie.3:261
2441 "$B< ./a.out \\(aqhello world\\(aq>\n"
2445 "Reached end of file\n"
2449 #: build/C/man3/fopencookie.3:268
2451 "Note that a more general version of the program below could be improved to "
2452 "more robustly handle various error situations (e.g., opening a stream with a "
2453 "cookie that already has an open stream; closing a stream that has already "
2458 #: build/C/man3/fopencookie.3:277
2461 "#define _GNU_SOURCE\n"
2462 "#include E<lt>sys/types.hE<gt>\n"
2463 "#include E<lt>stdio.hE<gt>\n"
2464 "#include E<lt>stdlib.hE<gt>\n"
2465 "#include E<lt>unistd.hE<gt>\n"
2466 "#include E<lt>string.hE<gt>\n"
2470 #: build/C/man3/fopencookie.3:279
2472 msgid "#define INIT_BUF_SIZE 4\n"
2476 #: build/C/man3/fopencookie.3:286
2479 "struct memfile_cookie {\n"
2480 " char *buf; /* Dynamically sized buffer for data */\n"
2481 " size_t allocated; /* Size of buf */\n"
2482 " size_t endpos; /* Number of characters in buf */\n"
2483 " off_t offset; /* Current file offset in buf */\n"
2488 #: build/C/man3/fopencookie.3:292
2492 "memfile_write(void *c, const char *buf, size_t size)\n"
2494 " char *new_buff;\n"
2495 " struct memfile_cookie *cookie = c;\n"
2499 #: build/C/man3/fopencookie.3:294
2501 msgid " /* Buffer too small? Keep doubling size until big enough */\n"
2505 #: build/C/man3/fopencookie.3:304
2508 " while (size + cookie-E<gt>offset E<gt> cookie-E<gt>allocated) {\n"
2509 " new_buff = realloc(cookie-E<gt>buf, cookie-E<gt>allocated * 2);\n"
2510 " if (new_buff == NULL) {\n"
2513 " cookie-E<gt>allocated *= 2;\n"
2514 " cookie-E<gt>buf = new_buff;\n"
2520 #: build/C/man3/fopencookie.3:306
2522 msgid " memcpy(cookie-E<gt>buf + cookie-E<gt>offset, buf, size);\n"
2526 #: build/C/man3/fopencookie.3:310
2529 " cookie-E<gt>offset += size;\n"
2530 " if (cookie-E<gt>offset E<gt> cookie-E<gt>endpos)\n"
2531 " cookie-E<gt>endpos = cookie-E<gt>offset;\n"
2535 #: build/C/man3/fopencookie.3:313
2543 #: build/C/man3/fopencookie.3:319
2547 "memfile_read(void *c, char *buf, size_t size)\n"
2549 " ssize_t xbytes;\n"
2550 " struct memfile_cookie *cookie = c;\n"
2554 #: build/C/man3/fopencookie.3:321
2556 msgid " /* Fetch minimum of bytes requested and bytes available */\n"
2560 #: build/C/man3/fopencookie.3:327
2564 " if (cookie-E<gt>offset + size E<gt> cookie-E<gt>endpos)\n"
2565 " xbytes = cookie-E<gt>endpos - cookie-E<gt>offset;\n"
2566 " if (xbytes E<lt> 0) /* offset may be past endpos */\n"
2571 #: build/C/man3/fopencookie.3:329
2573 msgid " memcpy(buf, cookie-E<gt>buf + cookie-E<gt>offset, xbytes);\n"
2577 #: build/C/man3/fopencookie.3:333
2580 " cookie-E<gt>offset += xbytes;\n"
2586 #: build/C/man3/fopencookie.3:339
2590 "memfile_seek(void *c, off64_t *offset, int whence)\n"
2592 " off64_t new_offset;\n"
2593 " struct memfile_cookie *cookie = c;\n"
2597 #: build/C/man3/fopencookie.3:348
2600 " if (whence == SEEK_SET)\n"
2601 " new_offset = *offset;\n"
2602 " else if (whence == SEEK_END)\n"
2603 " new_offset = cookie-E<gt>endpos + *offset;\n"
2604 " else if (whence == SEEK_CUR)\n"
2605 " new_offset = cookie-E<gt>offset + *offset;\n"
2611 #: build/C/man3/fopencookie.3:351
2614 " if (new_offset E<lt> 0)\n"
2619 #: build/C/man3/fopencookie.3:356
2622 " cookie-E<gt>offset = new_offset;\n"
2623 " *offset = new_offset;\n"
2629 #: build/C/man3/fopencookie.3:361
2633 "memfile_close(void *c)\n"
2635 " struct memfile_cookie *cookie = c;\n"
2639 #: build/C/man3/fopencookie.3:365
2642 " free(cookie-E<gt>buf);\n"
2643 " cookie-E<gt>allocated = 0;\n"
2644 " cookie-E<gt>buf = NULL;\n"
2648 #: build/C/man3/fopencookie.3:368
2656 #: build/C/man3/fopencookie.3:384
2660 "main(int argc, char *argv[])\n"
2662 " cookie_io_functions_t memfile_func = {\n"
2663 " .read = memfile_read,\n"
2664 " .write = memfile_write,\n"
2665 " .seek = memfile_seek,\n"
2666 " .close = memfile_close\n"
2669 " struct memfile_cookie mycookie;\n"
2673 " char buf[1000];\n"
2677 #: build/C/man3/fopencookie.3:386
2679 msgid " /* Set up the cookie before calling fopencookie() */\n"
2683 #: build/C/man3/fopencookie.3:392
2686 " mycookie.buf = malloc(INIT_BUF_SIZE);\n"
2687 " if (mycookie.buf == NULL) {\n"
2688 " perror(\"malloc\");\n"
2689 " exit(EXIT_FAILURE);\n"
2694 #: build/C/man3/fopencookie.3:396
2697 " mycookie.allocated = INIT_BUF_SIZE;\n"
2698 " mycookie.offset = 0;\n"
2699 " mycookie.endpos = 0;\n"
2703 #: build/C/man3/fopencookie.3:402
2706 " fp = fopencookie(&mycookie,\"w+\", memfile_func);\n"
2707 " if (fp == NULL) {\n"
2708 " perror(\"fopencookie\");\n"
2709 " exit(EXIT_FAILURE);\n"
2714 #: build/C/man3/fopencookie.3:404
2716 msgid " /* Write command-line arguments to our file */\n"
2720 #: build/C/man3/fopencookie.3:410
2723 " for (j = 1; j E<lt> argc; j++)\n"
2724 " if (fputs(argv[j], fp) == EOF) {\n"
2725 " perror(\"fputs\");\n"
2726 " exit(EXIT_FAILURE);\n"
2731 #: build/C/man3/fopencookie.3:412
2733 msgid " /* Read two bytes out of every five, until EOF */\n"
2737 #: build/C/man3/fopencookie.3:427
2740 " for (p = 0; ; p += 5) {\n"
2741 " if (fseek(fp, p, SEEK_SET) == -1) {\n"
2742 " perror(\"fseek\");\n"
2743 " exit(EXIT_FAILURE);\n"
2745 " nread = fread(buf, 1, 2, fp);\n"
2746 " if (nread == -1) {\n"
2747 " perror(\"fread\");\n"
2748 " exit(EXIT_FAILURE);\n"
2750 " if (nread == 0) {\n"
2751 " printf(\"Reached end of file\\en\");\n"
2757 #: build/C/man3/fopencookie.3:430
2760 " printf(\"/%.*s/\\en\", nread, buf);\n"
2765 #: build/C/man3/fopencookie.3:433 build/C/man2/readlink.2:211
2768 " exit(EXIT_SUCCESS);\n"
2773 #: build/C/man3/fopencookie.3:438
2774 msgid "B<fclose>(3), B<fmemopen>(3), B<fopen>(3), B<fseek>(3)"
2778 #: build/C/man3/fpurge.3:23
2784 #: build/C/man3/fpurge.3:23
2790 #: build/C/man3/fpurge.3:26
2791 msgid "fpurge, __fpurge - purge a stream"
2795 #: build/C/man3/fpurge.3:30
2798 "/* unsupported */\n"
2799 "B<#include E<lt>stdio.hE<gt>>\n"
2803 #: build/C/man3/fpurge.3:32
2805 msgid "B<int fpurge(FILE *>I<stream>B<);>\n"
2809 #: build/C/man3/fpurge.3:35
2813 "B<#include E<lt>stdio.hE<gt>>\n"
2817 #: build/C/man3/fpurge.3:37
2819 msgid "B<#include E<lt>stdio_ext.hE<gt>>\n"
2823 #: build/C/man3/fpurge.3:39
2825 msgid "B<void __fpurge(FILE *>I<stream>B<);>\n"
2829 #: build/C/man3/fpurge.3:52
2831 "The function B<fpurge>() clears the buffers of the given stream. For "
2832 "output streams this discards any unwritten output. For input streams this "
2833 "discards any input read from the underlying object but not yet obtained via "
2834 "B<getc>(3); this includes any text pushed back via B<ungetc>(3). See also "
2839 #: build/C/man3/fpurge.3:56
2841 "The function B<__fpurge>() does precisely the same, but without returning a "
2846 #: build/C/man3/fpurge.3:63
2848 "Upon successful completion B<fpurge>() returns 0. On error, it returns -1 "
2849 "and sets I<errno> appropriately."
2853 #: build/C/man3/fpurge.3:68
2854 msgid "I<stream> is not an open stream."
2858 #: build/C/man3/fpurge.3:76
2860 "These functions are nonstandard and not portable. The function B<fpurge>() "
2861 "was introduced in 4.4BSD and is not available under Linux. The function "
2862 "B<__fpurge>() was introduced in Solaris, and is present in glibc 2.1.95 and "
2867 #: build/C/man3/fpurge.3:78
2868 msgid "Usually it is a mistake to want to discard input buffers."
2873 #: build/C/man3/fpurge.3:82
2874 msgid "B<fflush>(3), B<setbuf>(3), B<stdio_ext>(3)"
2878 #: build/C/man3/fputwc.3:14
2884 #: build/C/man3/fputwc.3:17
2885 msgid "fputwc, putwc - write a wide character to a FILE stream"
2889 #: build/C/man3/fputwc.3:25
2892 "B<wint_t fputwc(wchar_t >I<wc>B<, FILE *>I<stream>B<);>\n"
2893 "B<wint_t putwc(wchar_t >I<wc>B<, FILE *>I<stream>B<);>\n"
2897 #: build/C/man3/fputwc.3:41
2899 "The B<fputwc>() function is the wide-character equivalent of the "
2900 "B<fputc>(3) function. It writes the wide character I<wc> to I<stream>. If "
2901 "I<ferror(stream)> becomes true, it returns B<WEOF>. If a wide-character "
2902 "conversion error occurs, it sets I<errno> to B<EILSEQ> and returns B<WEOF>. "
2903 "Otherwise it returns I<wc>."
2907 #: build/C/man3/fputwc.3:49
2909 "The B<putwc>() function or macro functions identically to B<fputwc>(). It "
2910 "may be implemented as a macro, and may evaluate its argument more than "
2911 "once. There is no reason ever to use it."
2915 #: build/C/man3/fputwc.3:58
2917 "The B<fputwc>() function returns I<wc> if no error occurred, or B<WEOF> to "
2918 "indicate an error."
2922 #: build/C/man3/fputwc.3:63
2923 msgid "Conversion of I<wc> to the stream's encoding fails."
2927 #: build/C/man3/fputwc.3:72
2929 "The behavior of B<fputwc>() depends on the B<LC_CTYPE> category of the "
2934 #: build/C/man3/fputwc.3:80
2936 "In the absence of additional information passed to the B<fopen>(3) call, it "
2937 "is reasonable to expect that B<fputwc>() will actually write the multibyte "
2938 "sequence corresponding to the wide character I<wc>."
2942 #: build/C/man3/fputwc.3:83
2943 msgid "B<fgetwc>(3), B<fputws>(3), B<unlocked_stdio>(3)"
2947 #: build/C/man3/fread.3:43
2953 #: build/C/man3/fread.3:43
2959 #: build/C/man3/fread.3:46
2960 msgid "fread, fwrite - binary stream input/output"
2964 #: build/C/man3/fread.3:52
2967 "B<size_t fread(void *>I<ptr>B<, size_t >I<size>B<, size_t >I<nmemb>B<, FILE "
2968 "*>I<stream>B<);>\n"
2972 #: build/C/man3/fread.3:55
2975 "B<size_t fwrite(const void *>I<ptr>B<, size_t >I<size>B<, size_t "
2977 "B< FILE *>I<stream>B<);>\n"
2981 #: build/C/man3/fread.3:67
2983 "The function B<fread>() reads I<nmemb> elements of data, each I<size> bytes "
2984 "long, from the stream pointed to by I<stream>, storing them at the location "
2989 #: build/C/man3/fread.3:78
2991 "The function B<fwrite>() writes I<nmemb> elements of data, each I<size> "
2992 "bytes long, to the stream pointed to by I<stream>, obtaining them from the "
2993 "location given by I<ptr>."
2997 #: build/C/man3/fread.3:94
2999 "On success, B<fread>() and B<fwrite>() return the number of I<items> read "
3000 "or written. This number equals the number of bytes transferred only when "
3001 "I<size> is 1. If an error occurs, or the end of the file is reached, the "
3002 "return value is a short item count (or zero)."
3006 #: build/C/man3/fread.3:101
3008 "B<fread>() does not distinguish between end-of-file and error, and callers "
3009 "must use B<feof>(3) and B<ferror>(3) to determine which occurred."
3013 #: build/C/man3/fread.3:103
3014 msgid "C89, POSIX.1-2001."
3018 #: build/C/man3/fread.3:108
3019 msgid "B<read>(2), B<write>(2), B<feof>(3), B<ferror>(3), B<unlocked_stdio>(3)"
3023 #: build/C/man3/fseek.3:40
3029 #: build/C/man3/fseek.3:40
3035 #: build/C/man3/fseek.3:43
3036 msgid "fgetpos, fseek, fsetpos, ftell, rewind - reposition a stream"
3040 #: build/C/man3/fseek.3:47
3041 msgid "B<int fseek(FILE *>I<stream>B<, long >I<offset>B<, int >I<whence>B<);>"
3045 #: build/C/man3/fseek.3:49
3046 msgid "B<long ftell(FILE *>I<stream>B<);>"
3050 #: build/C/man3/fseek.3:51
3051 msgid "B<void rewind(FILE *>I<stream>B<);>"
3055 #: build/C/man3/fseek.3:53
3056 msgid "B<int fgetpos(FILE *>I<stream>B<, fpos_t *>I<pos>B<);>"
3060 #: build/C/man3/fseek.3:55
3061 msgid "B<int fsetpos(FILE *>I<stream>B<, fpos_t *>I<pos>B<);>"
3065 #: build/C/man3/fseek.3:79
3067 "The B<fseek>() function sets the file position indicator for the stream "
3068 "pointed to by I<stream>. The new position, measured in bytes, is obtained "
3069 "by adding I<offset> bytes to the position specified by I<whence>. If "
3070 "I<whence> is set to B<SEEK_SET>, B<SEEK_CUR>, or B<SEEK_END>, the offset is "
3071 "relative to the start of the file, the current position indicator, or "
3072 "end-of-file, respectively. A successful call to the B<fseek>() function "
3073 "clears the end-of-file indicator for the stream and undoes any effects of "
3074 "the B<ungetc>(3) function on the same stream."
3078 #: build/C/man3/fseek.3:85
3080 "The B<ftell>() function obtains the current value of the file position "
3081 "indicator for the stream pointed to by I<stream>."
3085 #: build/C/man3/fseek.3:92
3087 "The B<rewind>() function sets the file position indicator for the stream "
3088 "pointed to by I<stream> to the beginning of the file. It is equivalent to:"
3092 #: build/C/man3/fseek.3:95
3093 msgid "(void) fseek(stream, 0L, SEEK_SET)"
3097 #: build/C/man3/fseek.3:99
3099 "except that the error indicator for the stream is also cleared (see "
3104 #: build/C/man3/fseek.3:117
3106 "The B<fgetpos>() and B<fsetpos>() functions are alternate interfaces "
3107 "equivalent to B<ftell>() and B<fseek>() (with whence set to B<SEEK_SET>), "
3108 "setting and storing the current value of the file offset into or from the "
3109 "object referenced by I<pos>. On some non-UNIX systems an I<fpos_t> object "
3110 "may be a complex object and these routines may be the only way to portably "
3111 "reposition a text stream."
3115 #: build/C/man3/fseek.3:132
3117 "The B<rewind>() function returns no value. Upon successful completion, "
3118 "B<fgetpos>(), B<fseek>(), B<fsetpos>() return 0, and B<ftell>() returns "
3119 "the current offset. Otherwise, -1 is returned and I<errno> is set to "
3120 "indicate the error."
3124 #: build/C/man3/fseek.3:138
3125 msgid "The I<stream> specified is not a seekable stream."
3129 #: build/C/man3/fseek.3:149
3131 "The I<whence> argument to B<fseek>() was not B<SEEK_SET>, B<SEEK_END>, or "
3136 #: build/C/man3/fseek.3:164
3138 "The functions B<fgetpos>(), B<fseek>(), B<fsetpos>(), and B<ftell>() may "
3139 "also fail and set I<errno> for any of the errors specified for the routines "
3140 "B<fflush>(3), B<fstat>(2), B<lseek>(2), and B<malloc>(3)."
3144 #: build/C/man3/fseek.3:168
3145 msgid "B<lseek>(2), B<fseeko>(3)"
3149 #: build/C/man3/fseeko.3:23
3155 #: build/C/man3/fseeko.3:23
3161 #: build/C/man3/fseeko.3:26
3162 msgid "fseeko, ftello - seek to or report file position"
3166 #: build/C/man3/fseeko.3:31
3168 msgid "B<int fseeko(FILE *>I<stream>B<, off_t >I<offset>B<, int >I<whence>B<);>\n"
3172 #: build/C/man3/fseeko.3:34
3175 "B<off_t ftello(FILE *>I<stream>B<);>\n"
3180 #: build/C/man3/fseeko.3:52
3182 "The B<fseeko>() and B<ftello>() functions are identical to B<fseek>(3) "
3183 "and B<ftell>(3) (see B<fseek>(3)), respectively, except that the I<offset> "
3184 "argument of B<fseeko>() and the return value of B<ftello>() is of type "
3185 "I<off_t> instead of I<long>."
3189 #: build/C/man3/fseeko.3:55
3191 "On many architectures both I<off_t> and I<long> are 32-bit types, but "
3196 #: build/C/man3/fseeko.3:59 build/C/man3/lseek64.3:79
3198 msgid "#define _FILE_OFFSET_BITS 64\n"
3202 #: build/C/man3/fseeko.3:63
3203 msgid "will turn I<off_t> into a 64-bit type."
3207 #: build/C/man3/fseeko.3:72
3209 "On successful completion, B<fseeko>() returns 0, while B<ftello>() returns "
3210 "the current offset. Otherwise, -1 is returned and I<errno> is set to "
3211 "indicate the error."
3215 #: build/C/man3/fseeko.3:75
3216 msgid "See the ERRORS in B<fseek>(3)."
3220 #: build/C/man3/fseeko.3:77
3221 msgid "SUSv2, POSIX.1-2001."
3225 #: build/C/man3/fseeko.3:81
3227 "These functions are found on System V-like systems. They are not present in "
3228 "libc4, libc5, glibc 2.0 but are available since glibc 2.1."
3232 #: build/C/man3/fseeko.3:82
3237 #: build/C/man3/getline.3:24
3243 #: build/C/man3/getline.3:24
3249 #: build/C/man3/getline.3:27
3250 msgid "getline, getdelim - delimited string input"
3254 #: build/C/man3/getline.3:32
3257 "B<ssize_t getline(char **>I<lineptr>B<, size_t *>I<n>B<, FILE "
3258 "*>I<stream>B<);>\n"
3262 #: build/C/man3/getline.3:35
3265 "B<ssize_t getdelim(char **>I<lineptr>B<, size_t *>I<n>B<, int >I<delim>B<, "
3266 "FILE *>I<stream>B<);>\n"
3270 #: build/C/man3/getline.3:45
3271 msgid "B<getline>(), B<getdelim>():"
3275 #: build/C/man3/getline.3:50
3276 msgid "_POSIX_C_SOURCE\\ E<gt>=\\ 200809L || _XOPEN_SOURCE\\ E<gt>=\\ 700"
3280 #: build/C/man3/getline.3:63
3282 "B<getline>() reads an entire line from I<stream>, storing the address of "
3283 "the buffer containing the text into I<*lineptr>. The buffer is "
3284 "null-terminated and includes the newline character, if one was found."
3288 #: build/C/man3/getline.3:73
3290 "If I<*lineptr> is NULL, then B<getline>() will allocate a buffer for "
3291 "storing the line, which should be freed by the user program. (In this case, "
3292 "the value in I<*n> is ignored.)"
3296 #: build/C/man3/getline.3:91
3298 "Alternatively, before calling B<getline>(), I<*lineptr> can contain a "
3299 "pointer to a B<malloc>(3)-allocated buffer I<*n> bytes in size. If the "
3300 "buffer is not large enough to hold the line, B<getline>() resizes it with "
3301 "B<realloc>(3), updating I<*lineptr> and I<*n> as necessary."
3305 #: build/C/man3/getline.3:97
3307 "In either case, on a successful call, I<*lineptr> and I<*n> will be updated "
3308 "to reflect the buffer address and allocated size respectively."
3312 #: build/C/man3/getline.3:108
3314 "B<getdelim>() works like B<getline>(), except that a line delimiter other "
3315 "than newline can be specified as the I<delimiter> argument. As with "
3316 "B<getline>(), a delimiter character is not added if one was not present in "
3317 "the input before end of file was reached."
3321 #: build/C/man3/getline.3:117
3323 "On success, B<getline>() and B<getdelim>() return the number of characters "
3324 "read, including the delimiter character, but not including the terminating "
3325 "null byte. This value can be used to handle embedded null bytes in the line "
3330 #: build/C/man3/getline.3:120
3332 "Both functions return -1 on failure to read a line (including end-of-file "
3337 #: build/C/man3/getline.3:130
3338 msgid "Bad arguments (I<n> or I<lineptr> is NULL, or I<stream> is not valid)."
3342 #: build/C/man3/getline.3:132
3343 msgid "These functions are available since libc 4.6.27."
3347 #: build/C/man3/getline.3:139
3349 "Both B<getline>() and B<getdelim>() were originally GNU extensions. They "
3350 "were standardized in POSIX.1-2008."
3354 #: build/C/man3/getline.3:144
3357 "#define _GNU_SOURCE\n"
3358 "#include E<lt>stdio.hE<gt>\n"
3359 "#include E<lt>stdlib.hE<gt>\n"
3363 #: build/C/man3/getline.3:152
3370 " char *line = NULL;\n"
3371 " size_t len = 0;\n"
3376 #: build/C/man3/getline.3:156
3379 " fp = fopen(\"/etc/motd\", \"r\");\n"
3380 " if (fp == NULL)\n"
3381 " exit(EXIT_FAILURE);\n"
3385 #: build/C/man3/getline.3:161
3388 " while ((read = getline(&line, &len, fp)) != -1) {\n"
3389 " printf(\"Retrieved line of length %zu :\\en\", read);\n"
3390 " printf(\"%s\", line);\n"
3395 #: build/C/man3/getline.3:165
3399 " exit(EXIT_SUCCESS);\n"
3404 #: build/C/man3/getline.3:172
3405 msgid "B<read>(2), B<fgets>(3), B<fopen>(3), B<fread>(3), B<gets>(3), B<scanf>(3)"
3409 #: build/C/man3/gets.3:25
3415 #: build/C/man3/gets.3:25
3421 #: build/C/man3/gets.3:28
3422 msgid "fgetc, fgets, getc, getchar, gets, ungetc - input of characters and strings"
3426 #: build/C/man3/gets.3:33
3428 msgid "B<int fgetc(FILE *>I<stream>B<);>\n"
3432 #: build/C/man3/gets.3:35
3434 msgid "B<char *fgets(char *>I<s>B<, int >I<size>B<, FILE *>I<stream>B<);>\n"
3438 #: build/C/man3/gets.3:37
3440 msgid "B<int getc(FILE *>I<stream>B<);>\n"
3444 #: build/C/man3/gets.3:39
3446 msgid "B<int getchar(void);>\n"
3450 #: build/C/man3/gets.3:41
3452 msgid "B<char *gets(char *>I<s>B<);>\n"
3456 #: build/C/man3/gets.3:43
3458 msgid "B<int ungetc(int >I<c>B<, FILE *>I<stream>B<);>\n"
3462 #: build/C/man3/gets.3:55
3464 "B<fgetc>() reads the next character from I<stream> and returns it as an "
3465 "I<unsigned char> cast to an I<int>, or B<EOF> on end of file or error."
3469 #: build/C/man3/gets.3:62
3471 "B<getc>() is equivalent to B<fgetc>() except that it may be implemented as "
3472 "a macro which evaluates I<stream> more than once."
3476 #: build/C/man3/gets.3:66
3477 msgid "B<getchar>() is equivalent to B<getc(>I<stdin>B<)>."
3481 #: build/C/man3/gets.3:76
3483 "B<gets>() reads a line from I<stdin> into the buffer pointed to by I<s> "
3484 "until either a terminating newline or B<EOF>, which it replaces with a null "
3485 "byte (\\(aq\\e0\\(aq). No check for buffer overrun is performed (see BUGS "
3490 #: build/C/man3/gets.3:90
3492 "B<fgets>() reads in at most one less than I<size> characters from I<stream> "
3493 "and stores them into the buffer pointed to by I<s>. Reading stops after an "
3494 "B<EOF> or a newline. If a newline is read, it is stored into the buffer. A "
3495 "terminating null byte (\\(aq\\e0\\(aq) is stored after the last character "
3500 #: build/C/man3/gets.3:101
3502 "B<ungetc>() pushes I<c> back to I<stream>, cast to I<unsigned char>, where "
3503 "it is available for subsequent read operations. Pushed-back characters will "
3504 "be returned in reverse order; only one pushback is guaranteed."
3508 #: build/C/man3/gets.3:106
3510 "Calls to the functions described here can be mixed with each other and with "
3511 "calls to other input functions from the I<stdio> library for the same input "
3516 #: build/C/man3/gets.3:121
3518 "B<fgetc>(), B<getc>() and B<getchar>() return the character read as an "
3519 "I<unsigned char> cast to an I<int> or B<EOF> on end of file or error."
3523 #: build/C/man3/gets.3:129
3525 "B<gets>() and B<fgets>() return I<s> on success, and NULL on error or when "
3526 "end of file occurs while no characters have been read."
3530 #: build/C/man3/gets.3:136
3531 msgid "B<ungetc>() returns I<c> on success, or B<EOF> on error."
3535 #: build/C/man3/gets.3:138
3536 msgid "C89, C99, POSIX.1-2001."
3540 #: build/C/man3/gets.3:150
3542 "LSB deprecates B<gets>(). POSIX.1-2008 marks B<gets>() obsolescent. ISO "
3543 "C11 removes the specification of B<gets>() from the C language, and since "
3544 "version 2.16, glibc header files don't expose the function declaration if "
3545 "the B<_ISOC11_SOURCE> feature test macro is defined."
3549 #: build/C/man3/gets.3:164
3551 "Never use B<gets>(). Because it is impossible to tell without knowing the "
3552 "data in advance how many characters B<gets>() will read, and because "
3553 "B<gets>() will continue to store characters past the end of the buffer, it "
3554 "is extremely dangerous to use. It has been used to break computer "
3555 "security. Use B<fgets>() instead."
3559 #: build/C/man3/gets.3:171
3561 "It is not advisable to mix calls to input functions from the I<stdio> "
3562 "library with low-level calls to B<read>(2) for the file descriptor "
3563 "associated with the input stream; the results will be undefined and very "
3564 "probably not what you want."
3568 #: build/C/man3/gets.3:186
3570 "B<read>(2), B<write>(2), B<ferror>(3), B<fgetwc>(3), B<fgetws>(3), "
3571 "B<fopen>(3), B<fread>(3), B<fseek>(3), B<getline>(3), B<getwchar>(3), "
3572 "B<puts>(3), B<scanf>(3), B<ungetwc>(3), B<unlocked_stdio>(3), "
3573 "B<feature_test_macros>(7)"
3577 #: build/C/man3/getw.3:23
3583 #: build/C/man3/getw.3:23
3589 #: build/C/man3/getw.3:26
3590 msgid "getw, putw - input and output of words (ints)"
3594 #: build/C/man3/getw.3:31
3596 msgid "B<int getw(FILE *>I<stream>B<);>\n"
3600 #: build/C/man3/getw.3:33
3602 msgid "B<int putw(int >I<w>B<, FILE *>I<stream>B<);>\n"
3606 #: build/C/man3/getw.3:42
3607 msgid "B<getw>(), B<putw>():"
3611 #: build/C/man3/getw.3:45
3613 msgid "Since glibc 2.3.3:"
3617 #: build/C/man3/getw.3:48
3618 msgid "_SVID_SOURCE || _BSD_SOURCE ||"
3622 #: build/C/man3/getw.3:51
3625 "(_XOPEN_SOURCE &&\n"
3626 " !(_POSIX_C_SOURCE\\ E<gt>=\\ 200112L || _XOPEN_SOURCE\\ E<gt>=\\ 600))\n"
3630 #: build/C/man3/getw.3:51
3632 msgid "Before glibc 2.3.3:"
3636 #: build/C/man3/getw.3:54
3637 msgid "_SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE"
3641 #: build/C/man3/getw.3:64
3643 "B<getw>() reads a word (that is, an I<int>) from I<stream>. It's provided "
3644 "for compatibility with SVr4. We recommend you use B<fread>(3) instead."
3648 #: build/C/man3/getw.3:71
3650 "B<putw>() writes the word I<w> (that is, an I<int>) to I<stream>. It is "
3651 "provided for compatibility with SVr4, but we recommend you use B<fwrite>(3) "
3656 #: build/C/man3/getw.3:78
3658 "Normally, B<getw>() returns the word read, and B<putw>() returns 0. On "
3659 "error, they return B<EOF>."
3663 #: build/C/man3/getw.3:80
3664 msgid "SVr4, SUSv2. Not present in POSIX.1-2001."
3668 #: build/C/man3/getw.3:84
3670 "The value returned on error is also a legitimate data value. B<ferror>(3) "
3671 "can be used to distinguish between the two cases."
3675 #: build/C/man3/getw.3:89
3676 msgid "B<ferror>(3), B<fread>(3), B<fwrite>(3), B<getc>(3), B<putc>(3)"
3680 #: build/C/man2/link.2:31
3686 #: build/C/man2/link.2:31
3692 #: build/C/man2/link.2:34
3693 msgid "link - make a new name for a file"
3697 #: build/C/man2/link.2:36 build/C/man2/lseek.2:52 build/C/man3/lseek64.3:32 build/C/man2/readlink.2:46 build/C/man2/rmdir.2:35 build/C/man2/symlink.2:37 build/C/man2/unlink.2:37 build/C/man2/write.2:44
3698 msgid "B<#include E<lt>unistd.hE<gt>>"
3702 #: build/C/man2/link.2:38
3703 msgid "B<int link(const char *>I<oldpath>B<, const char *>I<newpath>B<);>"
3707 #: build/C/man2/link.2:41
3709 "B<link>() creates a new link (also known as a hard link) to an existing "
3714 #: build/C/man2/link.2:47 build/C/man2/symlink.2:84
3715 msgid "If I<newpath> exists it will I<not> be overwritten."
3719 #: build/C/man2/link.2:52
3721 "This new name may be used exactly as the old one for any operation; both "
3722 "names refer to the same file (and so have the same permissions and "
3723 "ownership) and it is impossible to tell which name was the \"original\"."
3727 #: build/C/man2/link.2:57 build/C/man2/pipe.2:97 build/C/man3/remove.3:65 build/C/man2/rename.2:96 build/C/man2/rmdir.2:45 build/C/man2/symlink.2:89 build/C/man2/unlink.2:60
3729 "On success, zero is returned. On error, -1 is returned, and I<errno> is set "
3734 #: build/C/man2/link.2:58 build/C/man2/open.2:473 build/C/man2/readlink.2:84 build/C/man2/rename.2:97 build/C/man2/rmdir.2:46 build/C/man2/symlink.2:90 build/C/man3/tmpfile.3:53 build/C/man2/unlink.2:61
3740 #: build/C/man2/link.2:69
3742 "Write access to the directory containing I<newpath> is denied, or search "
3743 "permission is denied for one of the directories in the path prefix of "
3744 "I<oldpath> or I<newpath>. (See also B<path_resolution>(7).)"
3748 #: build/C/man2/link.2:69 build/C/man2/open.2:482 build/C/man2/symlink.2:99 build/C/man3/tmpfile.3:56
3754 #: build/C/man2/link.2:73 build/C/man2/symlink.2:103
3755 msgid "I<newpath> already exists."
3759 #: build/C/man2/link.2:73 build/C/man2/llseek.2:69 build/C/man2/open.2:488 build/C/man2/pipe.2:98 build/C/man2/read.2:100 build/C/man2/readlink.2:89 build/C/man2/rename.2:133 build/C/man2/rmdir.2:64 build/C/man2/symlink.2:103 build/C/man2/unlink.2:80 build/C/man2/write.2:135
3765 #: build/C/man2/link.2:76 build/C/man2/rename.2:136 build/C/man2/symlink.2:106
3766 msgid "I<oldpath> or I<newpath> points outside your accessible address space."
3770 #: build/C/man2/link.2:76 build/C/man2/read.2:129 build/C/man2/readlink.2:105 build/C/man2/symlink.2:106 build/C/man2/unlink.2:84 build/C/man2/write.2:159
3776 #: build/C/man2/link.2:79 build/C/man2/symlink.2:109 build/C/man2/unlink.2:87
3777 msgid "An I/O error occurred."
3781 #: build/C/man2/link.2:79 build/C/man2/open.2:512 build/C/man2/readlink.2:108 build/C/man2/rename.2:146 build/C/man2/rmdir.2:73 build/C/man2/symlink.2:109 build/C/man2/unlink.2:92
3787 #: build/C/man2/link.2:83 build/C/man2/rename.2:150
3789 "Too many symbolic links were encountered in resolving I<oldpath> or "
3794 #: build/C/man2/link.2:83 build/C/man2/rename.2:150
3800 #: build/C/man2/link.2:88
3802 "The file referred to by I<oldpath> already has the maximum number of links "
3807 #: build/C/man2/link.2:88 build/C/man2/open.2:522 build/C/man2/readlink.2:111 build/C/man2/rename.2:157 build/C/man2/rmdir.2:77 build/C/man2/symlink.2:113 build/C/man2/unlink.2:96
3809 msgid "B<ENAMETOOLONG>"
3813 #: build/C/man2/link.2:91 build/C/man2/rename.2:160 build/C/man2/symlink.2:116
3814 msgid "I<oldpath> or I<newpath> was too long."
3818 #: build/C/man2/link.2:91 build/C/man2/open.2:536 build/C/man2/readlink.2:114 build/C/man2/rename.2:160 build/C/man2/rmdir.2:80 build/C/man2/symlink.2:116 build/C/man2/unlink.2:99
3824 #: build/C/man2/link.2:96
3826 "A directory component in I<oldpath> or I<newpath> does not exist or is a "
3827 "dangling symbolic link."
3831 #: build/C/man2/link.2:96 build/C/man2/open.2:543 build/C/man2/readlink.2:117 build/C/man2/rename.2:173 build/C/man2/rmdir.2:85 build/C/man3/scanf.3:568 build/C/man2/symlink.2:123 build/C/man3/tempnam.3:91 build/C/man2/unlink.2:106
3837 #: build/C/man2/link.2:99 build/C/man2/open.2:546 build/C/man2/readlink.2:120 build/C/man2/rename.2:176 build/C/man2/rmdir.2:88 build/C/man2/symlink.2:126 build/C/man2/unlink.2:109
3838 msgid "Insufficient kernel memory was available."
3842 #: build/C/man2/link.2:99 build/C/man2/open.2:546 build/C/man2/rename.2:176 build/C/man2/symlink.2:126 build/C/man3/tmpfile.3:68 build/C/man2/write.2:162
3848 #: build/C/man2/link.2:103 build/C/man2/rename.2:180 build/C/man2/symlink.2:130
3849 msgid "The device containing the file has no room for the new directory entry."
3853 #: build/C/man2/link.2:103 build/C/man2/open.2:552 build/C/man2/readlink.2:120 build/C/man2/rename.2:180 build/C/man2/rmdir.2:88 build/C/man2/symlink.2:130 build/C/man2/unlink.2:109
3859 #: build/C/man2/link.2:108
3861 "A component used as a directory in I<oldpath> or I<newpath> is not, in fact, "
3866 #: build/C/man2/link.2:108 build/C/man2/link.2:112 build/C/man2/open.2:585 build/C/man2/rmdir.2:107 build/C/man2/rmdir.2:118 build/C/man2/symlink.2:135 build/C/man2/unlink.2:114
3872 #: build/C/man2/link.2:112
3873 msgid "I<oldpath> is a directory."
3877 #: build/C/man2/link.2:117
3879 "The file system containing I<oldpath> and I<newpath> does not support the "
3880 "creation of hard links."
3884 #: build/C/man2/link.2:117 build/C/man2/open.2:593 build/C/man2/rename.2:218 build/C/man2/rmdir.2:123 build/C/man2/symlink.2:140 build/C/man3/tmpfile.3:71 build/C/man2/unlink.2:137
3890 #: build/C/man2/link.2:120 build/C/man2/rename.2:221
3891 msgid "The file is on a read-only file system."
3895 #: build/C/man2/link.2:120 build/C/man2/rename.2:221
3901 #: build/C/man2/link.2:128
3903 "I<oldpath> and I<newpath> are not on the same mounted file system. (Linux "
3904 "permits a file system to be mounted at multiple points, but B<link>() does "
3905 "not work across different mount points, even if the same file system is "
3909 #. SVr4 documents additional ENOLINK and
3910 #. EMULTIHOP error conditions; POSIX.1 does not document ELOOP.
3911 #. X/OPEN does not document EFAULT, ENOMEM or EIO.
3913 #: build/C/man2/link.2:133
3914 msgid "SVr4, 4.3BSD, POSIX.1-2001 (but see NOTES)."
3918 #: build/C/man2/link.2:140
3920 "Hard links, as created by B<link>(), cannot span file systems. Use "
3921 "B<symlink>(2) if this is required."
3924 #. more precisely: since kernel 1.3.56
3925 #. For example, the default Solaris compilation environment
3926 #. behaves like Linux, and contributors to a March 2005
3927 #. thread in the Austin mailing list reported that some
3928 #. other (System V) implementations did/do the same -- MTK, Apr 05
3930 #: build/C/man2/link.2:171
3932 "POSIX.1-2001 says that B<link>() should dereference I<oldpath> if it is a "
3933 "symbolic link. However, since kernel 2.0, Linux does not do so: if "
3934 "I<oldpath> is a symbolic link, then I<newpath> is created as a (hard) link "
3935 "to the same symbolic link file (i.e., I<newpath> becomes a symbolic link to "
3936 "the same file that I<oldpath> refers to). Some other implementations behave "
3937 "in the same manner as Linux. POSIX.1-2008 changes the specification of "
3938 "B<link>(), making it implementation-dependent whether or not I<oldpath> is "
3939 "dereferenced if it is a symbolic link. For precise control over the "
3940 "treatment of symbolic links when creating a link, see B<linkat>(2)."
3944 #: build/C/man2/link.2:177
3946 "On NFS file systems, the return code may be wrong in case the NFS server "
3947 "performs the link creation and dies before it can say so. Use B<stat>(2) "
3948 "to find out if the link got created."
3952 #: build/C/man2/link.2:186
3954 "B<ln>(1), B<linkat>(2), B<open>(2), B<rename>(2), B<stat>(2), B<symlink>(2), "
3955 "B<unlink>(2), B<path_resolution>(7), B<symlink>(7)"
3959 #: build/C/man2/llseek.2:26
3965 #: build/C/man2/llseek.2:26
3971 #: build/C/man2/llseek.2:29
3972 msgid "_llseek - reposition read/write file offset"
3976 #: build/C/man2/llseek.2:33
3979 "B<#include E<lt>sys/types.hE<gt>>\n"
3980 "B<#include E<lt>unistd.hE<gt>>\n"
3984 #: build/C/man2/llseek.2:37
3987 "B<int _llseek(unsigned int >I<fd>B<, unsigned long >I<offset_high>B<,>\n"
3988 "B< unsigned long >I<offset_low>B<, loff_t *>I<result>B<,>\n"
3989 "B< unsigned int >I<whence>B<);>\n"
3993 #: build/C/man2/llseek.2:57
3995 "The B<_llseek>() function repositions the offset of the open file "
3996 "associated with the file descriptor I<fd> to I<(offset_highE<lt>E<lt>32) | "
3997 "offset_low> bytes relative to the beginning of the file, the current "
3998 "position in the file, or the end of the file, depending on whether I<whence> "
3999 "is B<SEEK_SET>, B<SEEK_CUR>, or B<SEEK_END>, respectively. It returns the "
4000 "resulting file position in the argument I<result>."
4004 #: build/C/man2/llseek.2:64
4006 "Upon successful completion, B<_llseek>() returns 0. Otherwise, a value of "
4007 "-1 is returned and I<errno> is set to indicate the error."
4011 #: build/C/man2/llseek.2:69 build/C/man2/lseek.2:164
4012 msgid "I<fd> is not an open file descriptor."
4016 #: build/C/man2/llseek.2:72
4017 msgid "Problem with copying results to user space."
4021 #: build/C/man2/llseek.2:76
4022 msgid "I<whence> is invalid."
4026 #: build/C/man2/llseek.2:79
4028 "This function is Linux-specific, and should not be used in programs intended "
4033 #: build/C/man2/llseek.2:82
4035 "Glibc does not provide a wrapper for this system call; call it using "
4040 #: build/C/man2/llseek.2:84
4041 msgid "B<lseek>(2), B<lseek64>(3)"
4045 #: build/C/man2/lseek.2:45
4051 #: build/C/man2/lseek.2:45
4057 #: build/C/man2/lseek.2:48
4058 msgid "lseek - reposition read/write file offset"
4062 #: build/C/man2/lseek.2:50 build/C/man3/lseek64.3:30
4063 msgid "B<#include E<lt>sys/types.hE<gt>>"
4067 #: build/C/man2/lseek.2:54
4068 msgid "B<off_t lseek(int >I<fd>B<, off_t >I<offset>B<, int >I<whence>B<);>"
4072 #: build/C/man2/lseek.2:65
4074 "The B<lseek>() function repositions the offset of the open file associated "
4075 "with the file descriptor I<fd> to the argument I<offset> according to the "
4076 "directive I<whence> as follows:"
4080 #: build/C/man2/lseek.2:70
4081 msgid "The offset is set to I<offset> bytes."
4085 #: build/C/man2/lseek.2:75
4086 msgid "The offset is set to its current location plus I<offset> bytes."
4090 #: build/C/man2/lseek.2:80
4091 msgid "The offset is set to the size of the file plus I<offset> bytes."
4095 #: build/C/man2/lseek.2:88
4097 "The B<lseek>() function allows the file offset to be set beyond the end of "
4098 "the file (but this does not change the size of the file). If data is later "
4099 "written at this point, subsequent reads of the data in the gap (a \"hole\") "
4100 "return null bytes (\\(aq\\e0\\(aq) until data is actually written into the "
4105 #: build/C/man2/lseek.2:88
4107 msgid "Seeking file data and holes"
4111 #: build/C/man2/lseek.2:91
4113 "Since version 3.1, Linux supports the following additional values for "
4118 #: build/C/man2/lseek.2:91
4120 msgid "B<SEEK_DATA>"
4124 #: build/C/man2/lseek.2:102
4126 "Adjust the file offset to the next location in the file greater than or "
4127 "equal to I<offset> containing data. If I<offset> points to data, then the "
4128 "file offset is set to I<offset>."
4132 #: build/C/man2/lseek.2:102
4134 msgid "B<SEEK_HOLE>"
4138 #: build/C/man2/lseek.2:116
4140 "Adjust the file offset to the next hole in the file greater than or equal to "
4141 "I<offset>. If I<offset> points into the middle of a hole, then the file "
4142 "offset is set to I<offset>. If there is no hole past I<offset>, then the "
4143 "file offset is adjusted to the end of the file (i.e., there is an implicit "
4144 "hole at the end of any file)."
4148 #: build/C/man2/lseek.2:122
4150 "In both of the above cases, B<lseek>() fails if I<offset> points past the "
4155 #: build/C/man2/lseek.2:128
4157 "These operations allow applications to map holes in a sparsely allocated "
4158 "file. This can be useful for applications such as file backup tools, which "
4159 "can save space when creating backups and preserve holes, if they have a "
4160 "mechanism for discovering holes."
4163 #. https://lkml.org/lkml/2011/4/22/79
4164 #. http://lwn.net/Articles/440255/
4165 #. http://blogs.oracle.com/bonwick/entry/seek_hole_and_seek_data
4167 #: build/C/man2/lseek.2:151
4169 "For the purposes of these operations, a hole is a sequence of zeros that "
4170 "(normally) has not been allocated in the underlying file storage. However, "
4171 "a file system is not obliged to report holes, so these operations are not a "
4172 "guaranteed mechanism for mapping the storage space actually allocated to a "
4173 "file. (Furthermore, a sequence of zeros that actually has been written to "
4174 "the underlying storage may not be reported as a hole.) In the simplest "
4175 "implementation, a file system can support the operations by making "
4176 "B<SEEK_HOLE> always return the offset of the end of the file, and making "
4177 "B<SEEK_DATA> always return I<offset> (i.e., even if the location referred to "
4178 "by I<offset> is a hole, it can be considered to consist of data that is a "
4179 "sequence of zeros)."
4183 #: build/C/man2/lseek.2:159
4185 "Upon successful completion, B<lseek>() returns the resulting offset "
4186 "location as measured in bytes from the beginning of the file. On error, the "
4187 "value I<(off_t)\\ -1> is returned and I<errno> is set to indicate the error."
4190 #. Some systems may allow negative offsets for character devices
4191 #. and/or for remote file systems.
4193 #: build/C/man2/lseek.2:172
4195 "I<whence> is not valid. Or: the resulting file offset would be negative, or "
4196 "beyond the end of a seekable device."
4200 #: build/C/man2/lseek.2:172 build/C/man2/open.2:565
4202 msgid "B<EOVERFLOW>"
4205 #. HP-UX 11 says EINVAL for this case (but POSIX.1 says EOVERFLOW)
4207 #: build/C/man2/lseek.2:177
4208 msgid "The resulting file offset cannot be represented in an I<off_t>."
4212 #: build/C/man2/lseek.2:177
4218 #: build/C/man2/lseek.2:181
4219 msgid "I<fd> is associated with a pipe, socket, or FIFO."
4223 #: build/C/man2/lseek.2:181 build/C/man2/open.2:559
4229 #: build/C/man2/lseek.2:189
4231 "I<whence> is B<SEEK_DATA> or B<SEEK_HOLE>, and the current file offset is "
4232 "beyond the end of the file."
4235 #. SVr4 documents additional error
4236 #. conditions EDEADLK, ENOLCK, ENOLNK, ENOSR, ENXIO, or ERANGE.
4238 #: build/C/man2/lseek.2:191 build/C/man2/read.2:157 build/C/man2/rmdir.2:129 build/C/man2/symlink.2:150 build/C/man2/unlink.2:145 build/C/man2/write.2:183
4239 msgid "SVr4, 4.3BSD, POSIX.1-2001."
4242 #. FIXME . Review http://austingroupbugs.net/view.php?id=415 in the future
4244 #: build/C/man2/lseek.2:199
4246 "B<SEEK_DATA> and B<SEEK_HOLE> are nonstandard extensions also present in "
4247 "Solaris, FreeBSD, and DragonFly BSD; they are proposed for inclusion in the "
4248 "next POSIX revision (Issue 8)."
4252 #: build/C/man2/lseek.2:203
4254 "Some devices are incapable of seeking and POSIX does not specify which "
4255 "devices must support B<lseek>()."
4258 #. Other systems return the number of written characters,
4259 #. using SEEK_SET to set the counter. (Of written characters.)
4261 #: build/C/man2/lseek.2:210
4262 msgid "On Linux, using B<lseek>() on a tty device returns B<ESPIPE>."
4266 #: build/C/man2/lseek.2:213
4268 "When converting old code, substitute values for I<whence> with the following "
4273 #: build/C/man2/lseek.2:216
4279 #: build/C/man2/lseek.2:217
4281 msgid "0\tSEEK_SET\n"
4285 #: build/C/man2/lseek.2:218
4287 msgid "1\tSEEK_CUR\n"
4291 #: build/C/man2/lseek.2:219
4293 msgid "2\tSEEK_END\n"
4297 #: build/C/man2/lseek.2:220
4299 msgid "L_SET\tSEEK_SET\n"
4303 #: build/C/man2/lseek.2:221
4305 msgid "L_INCR\tSEEK_CUR\n"
4309 #: build/C/man2/lseek.2:222
4311 msgid "L_XTND\tSEEK_END\n"
4315 #: build/C/man2/lseek.2:234
4317 "Note that file descriptors created by B<dup>(2) or B<fork>(2) share the "
4318 "current file position pointer, so seeking on such files may be subject to "
4323 #: build/C/man2/lseek.2:240
4325 "B<dup>(2), B<fork>(2), B<open>(2), B<fseek>(3), B<lseek64>(3), "
4326 "B<posix_fallocate>(3)"
4330 #: build/C/man3/lseek64.3:23
4336 #: build/C/man3/lseek64.3:23
4342 #: build/C/man3/lseek64.3:26
4343 msgid "lseek64 - reposition 64-bit read/write file offset"
4347 #: build/C/man3/lseek64.3:28
4348 msgid "B<#define _LARGEFILE64_SOURCE> /* See feature_test_macros(7) */"
4352 #: build/C/man3/lseek64.3:34
4353 msgid "B<off64_t lseek64(int >I<fd>B<, off64_t >I<offset>B<, int >I<whence>B<);>"
4357 #: build/C/man3/lseek64.3:51
4359 "The B<lseek>(2) family of functions reposition the offset of the open file "
4360 "associated with the file descriptor I<fd> to I<offset> bytes relative to the "
4361 "start, current position, or end of the file, when I<whence> has the value "
4362 "B<SEEK_SET>, B<SEEK_CUR>, or B<SEEK_END>, respectively."
4366 #: build/C/man3/lseek64.3:54
4367 msgid "For more details, return value, and errors, see B<lseek>(2)."
4371 #: build/C/man3/lseek64.3:61
4373 "Four interfaces are available: B<lseek>(2), B<lseek64>(), B<llseek>(2), and "
4374 "the raw system call B<_llseek>(2)."
4378 #: build/C/man3/lseek64.3:61
4384 #: build/C/man3/lseek64.3:63 build/C/man3/lseek64.3:85 build/C/man3/lseek64.3:114
4389 #: build/C/man3/lseek64.3:67
4391 msgid "B<off_t lseek(int >I<fd>B<, off_t >I<offset>B<, int >I<whence>B<);>\n"
4395 #: build/C/man3/lseek64.3:75
4397 "B<lseek>(2) uses the type I<off_t>. This is a 32-bit signed type on 32-bit "
4398 "architectures, unless one compiles with"
4402 #: build/C/man3/lseek64.3:83
4403 msgid "in which case it is a 64-bit signed type."
4407 #: build/C/man3/lseek64.3:83
4413 #: build/C/man3/lseek64.3:89
4415 msgid "B<off64_t lseek64(int >I<fd>B<, off64_t >I<offset>B<, int >I<whence>B<);>\n"
4419 #: build/C/man3/lseek64.3:100
4421 "The library routine B<lseek64>() uses a 64-bit type even when I<off_t> is a "
4422 "32-bit type. Its prototype (and the type I<off64_t>) is available only "
4423 "when one compiles with"
4427 #: build/C/man3/lseek64.3:104
4429 msgid "#define _LARGEFILE64_SOURCE\n"
4432 #. in glibc 2.0.94, not in 2.0.6
4434 #: build/C/man3/lseek64.3:112
4436 "The function B<lseek64>() is available since glibc 2.1, and is defined to "
4437 "be an alias for B<llseek>()."
4441 #: build/C/man3/lseek64.3:112
4447 #: build/C/man3/lseek64.3:118
4449 msgid "B<loff_t llseek(int >I<fd>B<, loff_t >I<offset>B<, int >I<whence>B<);>\n"
4452 #. in libc 5.0.9, not in 4.7.6
4454 #: build/C/man3/lseek64.3:137
4456 "The type I<loff_t> is a 64-bit signed type. The library routine B<llseek>() "
4457 "is available in libc5 and glibc and works without special defines. Its "
4458 "prototype was given in I<E<lt>unistd.hE<gt>> with libc5, but glibc does not "
4459 "provide a prototype. This is bad, since a prototype is needed. Users "
4460 "should add the above prototype, or something equivalent, to their own "
4461 "source. When users complained about data loss caused by a miscompilation of "
4462 "B<e2fsck>(8), glibc 2.1.3 added the link-time warning"
4466 #: build/C/man3/lseek64.3:140
4467 msgid "the \\`llseek\\' function may be dangerous; use \\`lseek64\\' instead."
4471 #: build/C/man3/lseek64.3:144
4472 msgid "This makes this function unusable if one desires a warning-free compilation."
4476 #: build/C/man3/lseek64.3:144
4482 #: build/C/man3/lseek64.3:147
4484 "All the above functions are implemented in terms of this system call. The "
4489 #: build/C/man3/lseek64.3:152
4492 "B<int _llseek(int >I<fd>B<, off_t >I<offset_hi>B<, off_t >I<offset_lo>B<,>\n"
4493 "B< loff_t *>I<result>B<, int >I<whence>B<);>\n"
4497 #: build/C/man3/lseek64.3:157
4498 msgid "For more details, see B<llseek>(2)."
4502 #: build/C/man3/lseek64.3:159
4503 msgid "B<llseek>(2), B<lseek>(2)"
4507 #: build/C/man2/open.2:52
4513 #: build/C/man2/open.2:52
4519 #: build/C/man2/open.2:55
4520 msgid "open, creat - open and possibly create a file or device"
4524 #: build/C/man2/open.2:60
4527 "B<#include E<lt>sys/types.hE<gt>>\n"
4528 "B<#include E<lt>sys/stat.hE<gt>>\n"
4529 "B<#include E<lt>fcntl.hE<gt>>\n"
4533 #: build/C/man2/open.2:63
4536 "B<int open(const char *>I<pathname>B<, int >I<flags>B<);>\n"
4537 "B<int open(const char *>I<pathname>B<, int >I<flags>B<, mode_t "
4542 #: build/C/man2/open.2:65
4544 msgid "B<int creat(const char *>I<pathname>B<, mode_t >I<mode>B<);>\n"
4548 #: build/C/man2/open.2:76
4550 "Given a I<pathname> for a file, B<open>() returns a file descriptor, a "
4551 "small, nonnegative integer for use in subsequent system calls (B<read>(2), "
4552 "B<write>(2), B<lseek>(2), B<fcntl>(2), etc.). The file descriptor returned "
4553 "by a successful call will be the lowest-numbered file descriptor not "
4554 "currently open for the process."
4558 #: build/C/man2/open.2:88
4560 "By default, the new file descriptor is set to remain open across an "
4561 "B<execve>(2) (i.e., the B<FD_CLOEXEC> file descriptor flag described in "
4562 "B<fcntl>(2) is initially disabled; the B<O_CLOEXEC> flag, described below, "
4563 "can be used to change this default). The file offset is set to the "
4564 "beginning of the file (see B<lseek>(2))."
4568 #: build/C/man2/open.2:107
4570 "A call to B<open>() creates a new I<open file description>, an entry in the "
4571 "system-wide table of open files. This entry records the file offset and the "
4572 "file status flags (modifiable via the B<fcntl>(2) B<F_SETFL> operation). A "
4573 "file descriptor is a reference to one of these entries; this reference is "
4574 "unaffected if I<pathname> is subsequently removed or modified to refer to a "
4575 "different file. The new open file description is initially not shared with "
4576 "any other process, but sharing may arise via B<fork>(2)."
4580 #: build/C/man2/open.2:115
4582 "The argument I<flags> must include one of the following I<access modes>: "
4583 "B<O_RDONLY>, B<O_WRONLY>, or B<O_RDWR>. These request opening the file "
4584 "read-only, write-only, or read/write, respectively."
4587 #. FIXME . Actually is it true that the "file status flags" are all of the
4588 #. remaining flags listed below? SUSv4 divides the flags into:
4592 #. * Other (O_CLOEXEC, O_DIRECTORY, O_NOFOLLOW)
4593 #. though it's not clear what the difference between "other" and
4594 #. "File creation" flags is. (I've raised an Aardvark to see if this
4595 #. can be clarified in SUSv4; 10 Oct 2008.)
4597 #: build/C/man2/open.2:142
4599 "In addition, zero or more file creation flags and file status flags can be "
4600 "bitwise-I<or>'d in I<flags>. The I<file creation flags> are B<O_CREAT>, "
4601 "B<O_EXCL>, B<O_NOCTTY>, and B<O_TRUNC>. The I<file status flags> are all of "
4602 "the remaining flags listed below. The distinction between these two groups "
4603 "of flags is that the file status flags can be retrieved and (in some cases) "
4604 "modified using B<fcntl>(2). The full list of file creation flags and file "
4605 "status flags is as follows:"
4609 #: build/C/man2/open.2:142
4614 #. For more background, see
4615 #. http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=453946
4616 #. http://nfs.sourceforge.net/
4618 #: build/C/man2/open.2:159
4620 "The file is opened in append mode. Before each B<write>(2), the file offset "
4621 "is positioned at the end of the file, as if with B<lseek>(2). B<O_APPEND> "
4622 "may lead to corrupted files on NFS file systems if more than one process "
4623 "appends data to a file at once. This is because NFS does not support "
4624 "appending to a file, so the client kernel has to simulate it, which can't be "
4625 "done without a race condition."
4629 #: build/C/man2/open.2:159
4635 #: build/C/man2/open.2:172
4637 "Enable signal-driven I/O: generate a signal (B<SIGIO> by default, but this "
4638 "can be changed via B<fcntl>(2)) when input or output becomes possible on "
4639 "this file descriptor. This feature is only available for terminals, "
4640 "pseudoterminals, sockets, and (since Linux 2.6) pipes and FIFOs. See "
4641 "B<fcntl>(2) for further details."
4645 #: build/C/man2/open.2:172
4647 msgid "B<O_CLOEXEC> (Since Linux 2.6.23)"
4650 #. This flag fixes only one form of the race condition;
4651 #. The race can also occur with, for example, descriptors
4652 #. returned by accept(), pipe(), etc.
4654 #: build/C/man2/open.2:197
4656 "Enable the close-on-exec flag for the new file descriptor. Specifying this "
4657 "flag permits a program to avoid additional B<fcntl>(2) B<F_SETFD> "
4658 "operations to set the B<FD_CLOEXEC> flag. Additionally, use of this flag is "
4659 "essential in some multithreaded programs since using a separate B<fcntl>(2) "
4660 "B<F_SETFD> operation to set the B<FD_CLOEXEC> flag does not suffice to avoid "
4661 "race conditions where one thread opens a file descriptor at the same time as "
4662 "another thread does a B<fork>(2) plus B<execve>(2)."
4666 #: build/C/man2/open.2:197
4671 #. As at 2.6.25, bsdgroups is supported by ext2, ext3, ext4, and
4672 #. XFS (since 2.6.14).
4674 #: build/C/man2/open.2:213
4676 "If the file does not exist it will be created. The owner (user ID) of the "
4677 "file is set to the effective user ID of the process. The group ownership "
4678 "(group ID) is set either to the effective group ID of the process or to the "
4679 "group ID of the parent directory (depending on file system type and mount "
4680 "options, and the mode of the parent directory, see the mount options "
4681 "I<bsdgroups> and I<sysvgroups> described in B<mount>(8))."
4685 #: build/C/man2/open.2:236
4687 "I<mode> specifies the permissions to use in case a new file is created. "
4688 "This argument must be supplied when B<O_CREAT> is specified in I<flags>; if "
4689 "B<O_CREAT> is not specified, then I<mode> is ignored. The effective "
4690 "permissions are modified by the process's I<umask> in the usual way: The "
4691 "permissions of the created file are I<(mode\\ &\\ ~umask)>. Note that this "
4692 "mode only applies to future accesses of the newly created file; the "
4693 "B<open>() call that creates a read-only file may well return a read/write "
4698 #: build/C/man2/open.2:239
4699 msgid "The following symbolic constants are provided for I<mode>:"
4703 #: build/C/man2/open.2:239
4709 #: build/C/man2/open.2:242
4710 msgid "00700 user (file owner) has read, write and execute permission"
4714 #: build/C/man2/open.2:242
4720 #: build/C/man2/open.2:245
4721 msgid "00400 user has read permission"
4725 #: build/C/man2/open.2:245
4731 #: build/C/man2/open.2:248
4732 msgid "00200 user has write permission"
4736 #: build/C/man2/open.2:248
4742 #: build/C/man2/open.2:251
4743 msgid "00100 user has execute permission"
4747 #: build/C/man2/open.2:251
4753 #: build/C/man2/open.2:254
4754 msgid "00070 group has read, write and execute permission"
4758 #: build/C/man2/open.2:254
4764 #: build/C/man2/open.2:257
4765 msgid "00040 group has read permission"
4769 #: build/C/man2/open.2:257
4775 #: build/C/man2/open.2:260
4776 msgid "00020 group has write permission"
4780 #: build/C/man2/open.2:260
4786 #: build/C/man2/open.2:263
4787 msgid "00010 group has execute permission"
4791 #: build/C/man2/open.2:263
4797 #: build/C/man2/open.2:266
4798 msgid "00007 others have read, write and execute permission"
4802 #: build/C/man2/open.2:266
4808 #: build/C/man2/open.2:269
4809 msgid "00004 others have read permission"
4813 #: build/C/man2/open.2:269
4819 #: build/C/man2/open.2:272
4820 msgid "00002 others have write permission"
4824 #: build/C/man2/open.2:272
4830 #: build/C/man2/open.2:275
4831 msgid "00001 others have execute permission"
4835 #: build/C/man2/open.2:276
4837 msgid "B<O_DIRECT> (Since Linux 2.4.10)"
4841 #: build/C/man2/open.2:293
4843 "Try to minimize cache effects of the I/O to and from this file. In general "
4844 "this will degrade performance, but it is useful in special situations, such "
4845 "as when applications do their own caching. File I/O is done directly "
4846 "to/from user space buffers. The B<O_DIRECT> flag on its own makes an effort "
4847 "to transfer data synchronously, but does not give the guarantees of the "
4848 "B<O_SYNC> flag that data and necessary metadata are transferred. To "
4849 "guarantee synchronous I/O, B<O_SYNC> must be used in addition to "
4850 "B<O_DIRECT>. See NOTES below for further discussion."
4854 #: build/C/man2/open.2:297
4856 "A semantically similar (but deprecated) interface for block devices is "
4857 "described in B<raw>(8)."
4861 #: build/C/man2/open.2:297
4863 msgid "B<O_DIRECTORY>"
4866 #. But see the following and its replies:
4867 #. http://marc.theaimsgroup.com/?t=112748702800001&r=1&w=2
4868 #. [PATCH] open: O_DIRECTORY and O_CREAT together should fail
4869 #. O_DIRECTORY | O_CREAT causes O_DIRECTORY to be ignored.
4871 #: build/C/man2/open.2:311
4873 "If I<pathname> is not a directory, cause the open to fail. This flag is "
4874 "Linux-specific, and was added in kernel version 2.1.126, to avoid "
4875 "denial-of-service problems if B<opendir>(3) is called on a FIFO or tape "
4876 "device, but should not be used outside of the implementation of "
4881 #: build/C/man2/open.2:311
4887 #: build/C/man2/open.2:321
4889 "Ensure that this call creates the file: if this flag is specified in "
4890 "conjunction with B<O_CREAT>, and I<pathname> already exists, then B<open>() "
4894 #. POSIX.1-2001 explicitly requires this behavior.
4896 #: build/C/man2/open.2:329
4898 "When these two flags are specified, symbolic links are not followed: if "
4899 "I<pathname> is a symbolic link, then B<open>() fails regardless of where "
4900 "the symbolic link points to."
4904 #: build/C/man2/open.2:345
4906 "In general, the behavior of B<O_EXCL> is undefined if it is used without "
4907 "B<O_CREAT>. There is one exception: on Linux 2.6 and later, B<O_EXCL> can "
4908 "be used without B<O_CREAT> if I<pathname> refers to a block device. If the "
4909 "block device is in use by the system (e.g., mounted), B<open>() fails with "
4910 "the error B<EBUSY>."
4914 #: build/C/man2/open.2:367
4916 "On NFS, B<O_EXCL> is only supported when using NFSv3 or later on kernel 2.6 "
4917 "or later. In NFS environments where B<O_EXCL> support is not provided, "
4918 "programs that rely on it for performing locking tasks will contain a race "
4919 "condition. Portable programs that want to perform atomic file locking using "
4920 "a lockfile, and need to avoid reliance on NFS support for B<O_EXCL>, can "
4921 "create a unique file on the same file system (e.g., incorporating hostname "
4922 "and PID), and use B<link>(2) to make a link to the lockfile. If B<link>(2) "
4923 "returns 0, the lock is successful. Otherwise, use B<stat>(2) on the unique "
4924 "file to check if its link count has increased to 2, in which case the lock "
4925 "is also successful."
4929 #: build/C/man2/open.2:367
4931 msgid "B<O_LARGEFILE>"
4935 #: build/C/man2/open.2:389
4937 "(LFS) Allow files whose sizes cannot be represented in an I<off_t> (but can "
4938 "be represented in an I<off64_t>) to be opened. The B<_LARGEFILE64_SOURCE> "
4939 "macro must be defined (before including I<any> header files) in order to "
4940 "obtain this definition. Setting the B<_FILE_OFFSET_BITS> feature test macro "
4941 "to 64 (rather than using B<O_LARGEFILE>) is the preferred method of "
4942 "accessing large files on 32-bit systems (see B<feature_test_macros>(7))."
4946 #: build/C/man2/open.2:389
4948 msgid "B<O_NOATIME> (Since Linux 2.6.8)"
4951 #. The O_NOATIME flag also affects the treatment of st_atime
4952 #. by mmap() and readdir(2), MTK, Dec 04.
4954 #: build/C/man2/open.2:400
4956 "Do not update the file last access time (st_atime in the inode) when the "
4957 "file is B<read>(2). This flag is intended for use by indexing or backup "
4958 "programs, where its use can significantly reduce the amount of disk "
4959 "activity. This flag may not be effective on all file systems. One example "
4960 "is NFS, where the server maintains the access time."
4964 #: build/C/man2/open.2:400
4970 #: build/C/man2/open.2:408
4972 "If I<pathname> refers to a terminal device\\(emsee B<tty>(4)\\(em it will "
4973 "not become the process's controlling terminal even if the process does not "
4978 #: build/C/man2/open.2:408
4980 msgid "B<O_NOFOLLOW>"
4983 #. The headers from glibc 2.0.100 and later include a
4984 #. definition of this flag; \fIkernels before 2.1.126 will ignore it if
4987 #: build/C/man2/open.2:417
4989 "If I<pathname> is a symbolic link, then the open fails. This is a FreeBSD "
4990 "extension, which was added to Linux in version 2.1.126. Symbolic links in "
4991 "earlier components of the pathname will still be followed."
4995 #: build/C/man2/open.2:417
4997 msgid "B<O_NONBLOCK> or B<O_NDELAY>"
5001 #: build/C/man2/open.2:430
5003 "When possible, the file is opened in nonblocking mode. Neither the "
5004 "B<open>() nor any subsequent operations on the file descriptor which is "
5005 "returned will cause the calling process to wait. For the handling of FIFOs "
5006 "(named pipes), see also B<fifo>(7). For a discussion of the effect of "
5007 "B<O_NONBLOCK> in conjunction with mandatory file locks and with file leases, "
5012 #: build/C/man2/open.2:430
5018 #: build/C/man2/open.2:438
5020 "The file is opened for synchronous I/O. Any B<write>(2)s on the resulting "
5021 "file descriptor will block the calling process until the data has been "
5022 "physically written to the underlying hardware. I<But see NOTES below>."
5026 #: build/C/man2/open.2:438
5032 #: build/C/man2/open.2:452
5034 "If the file already exists and is a regular file and the open mode allows "
5035 "writing (i.e., is B<O_RDWR> or B<O_WRONLY>) it will be truncated to length "
5036 "0. If the file is a FIFO or terminal device file, the B<O_TRUNC> flag is "
5037 "ignored. Otherwise the effect of B<O_TRUNC> is unspecified."
5041 #: build/C/man2/open.2:456
5043 "Some of these optional flags can be altered using B<fcntl>(2) after the "
5044 "file has been opened."
5048 #: build/C/man2/open.2:464
5050 "B<creat>() is equivalent to B<open>() with I<flags> equal to "
5051 "B<O_CREAT|O_WRONLY|O_TRUNC>."
5055 #: build/C/man2/open.2:472
5057 "B<open>() and B<creat>() return the new file descriptor, or -1 if an error "
5058 "occurred (in which case, I<errno> is set appropriately)."
5062 #: build/C/man2/open.2:482
5064 "The requested access to the file is not allowed, or search permission is "
5065 "denied for one of the directories in the path prefix of I<pathname>, or the "
5066 "file did not exist yet and write access to the parent directory is not "
5067 "allowed. (See also B<path_resolution>(7).)"
5071 #: build/C/man2/open.2:488
5072 msgid "I<pathname> already exists and B<O_CREAT> and B<O_EXCL> were used."
5076 #: build/C/man2/open.2:492 build/C/man2/rmdir.2:67 build/C/man2/unlink.2:84
5077 msgid "I<pathname> points outside your accessible address space."
5081 #: build/C/man2/open.2:492 build/C/man2/write.2:139
5087 #: build/C/man2/open.2:496
5088 msgid "See B<EOVERFLOW>."
5092 #: build/C/man2/open.2:496 build/C/man2/read.2:104 build/C/man3/scanf.3:559 build/C/man3/tmpfile.3:59 build/C/man2/write.2:144
5098 #: build/C/man2/open.2:503
5100 "While blocked waiting to complete an open of a slow device (e.g., a FIFO; "
5101 "see B<fifo>(7)), the call was interrupted by a signal handler; see "
5106 #: build/C/man2/open.2:503 build/C/man2/read.2:140 build/C/man2/rename.2:140 build/C/man2/unlink.2:87
5112 #: build/C/man2/open.2:512
5114 "I<pathname> refers to a directory and the access requested involved writing "
5115 "(that is, B<O_WRONLY> or B<O_RDWR> is set)."
5119 #: build/C/man2/open.2:519
5121 "Too many symbolic links were encountered in resolving I<pathname>, or "
5122 "B<O_NOFOLLOW> was specified but I<pathname> was a symbolic link."
5126 #: build/C/man2/open.2:519 build/C/man2/pipe.2:107 build/C/man3/tmpfile.3:62
5132 #: build/C/man2/open.2:522
5133 msgid "The process already has the maximum number of files open."
5137 #: build/C/man2/open.2:526 build/C/man2/rmdir.2:80 build/C/man2/unlink.2:99
5138 msgid "I<pathname> was too long."
5142 #: build/C/man2/open.2:526 build/C/man2/pipe.2:110 build/C/man3/tmpfile.3:65
5148 #: build/C/man2/open.2:529 build/C/man2/pipe.2:113
5149 msgid "The system limit on the total number of open files has been reached."
5153 #: build/C/man2/open.2:529
5159 #: build/C/man2/open.2:536
5161 "I<pathname> refers to a device special file and no corresponding device "
5162 "exists. (This is a Linux kernel bug; in this situation B<ENXIO> must be "
5167 #: build/C/man2/open.2:543
5169 "B<O_CREAT> is not set and the named file does not exist. Or, a directory "
5170 "component in I<pathname> does not exist or is a dangling symbolic link."
5174 #: build/C/man2/open.2:552
5176 "I<pathname> was to be created but the device containing I<pathname> has no "
5177 "room for the new file."
5181 #: build/C/man2/open.2:559
5183 "A component used as a directory in I<pathname> is not, in fact, a directory, "
5184 "or B<O_DIRECTORY> was specified and I<pathname> was not a directory."
5188 #: build/C/man2/open.2:565
5190 "B<O_NONBLOCK> | B<O_WRONLY> is set, the named file is a FIFO and no process "
5191 "has the file open for reading. Or, the file is a device special file and no "
5192 "corresponding device exists."
5195 #. See http://bugzilla.kernel.org/show_bug.cgi?id=7253
5196 #. "Open of a large file on 32-bit fails with EFBIG, should be EOVERFLOW"
5197 #. Reported 2006-10-03
5199 #: build/C/man2/open.2:585
5201 "I<pathname> refers to a regular file that is too large to be opened. The "
5202 "usual scenario here is that an application compiled on a 32-bit platform "
5203 "without I<-D_FILE_OFFSET_BITS=64> tried to open a file whose size exceeds "
5204 "I<(2E<lt>E<lt>31)-1> bits; see also B<O_LARGEFILE> above. This is the error "
5205 "specified by POSIX.1-2001; in kernels before 2.6.24, Linux gave the error "
5206 "B<EFBIG> for this case."
5209 #. Strictly speaking, it's the file system UID... (MTK)
5211 #: build/C/man2/open.2:593
5213 "The B<O_NOATIME> flag was specified, but the effective user ID of the caller "
5214 "did not match the owner of the file and the caller was not privileged "
5219 #: build/C/man2/open.2:598
5221 "I<pathname> refers to a file on a read-only file system and write access was "
5226 #: build/C/man2/open.2:598
5232 #: build/C/man2/open.2:603
5234 "I<pathname> refers to an executable image which is currently being executed "
5235 "and write access was requested."
5239 #: build/C/man2/open.2:603
5241 msgid "B<EWOULDBLOCK>"
5245 #: build/C/man2/open.2:610
5247 "The B<O_NONBLOCK> flag was specified, and an incompatible lease was held on "
5248 "the file (see B<fcntl>(2))."
5252 #: build/C/man2/open.2:623
5254 "SVr4, 4.3BSD, POSIX.1-2001. The B<O_DIRECTORY>, B<O_NOATIME>, and "
5255 "B<O_NOFOLLOW> flags are Linux-specific, and one may need to define "
5256 "B<_GNU_SOURCE> (before including I<any> header files) to obtain their "
5261 #: build/C/man2/open.2:628
5263 "The B<O_CLOEXEC> flag is not specified in POSIX.1-2001, but is specified in "
5268 #: build/C/man2/open.2:636
5270 "B<O_DIRECT> is not specified in POSIX; one has to define B<_GNU_SOURCE> "
5271 "(before including I<any> header files) to get its definition."
5275 #: build/C/man2/open.2:644
5277 "Under Linux, the B<O_NONBLOCK> flag indicates that one wants to open but "
5278 "does not necessarily have the intention to read or write. This is typically "
5279 "used to open devices in order to get a file descriptor for use with "
5283 #. See for example util-linux's disk-utils/setfdprm.c
5284 #. For some background on access mode 3, see
5285 #. http://thread.gmane.org/gmane.linux.kernel/653123
5286 #. "[RFC] correct flags to f_mode conversion in __dentry_open"
5287 #. LKML, 12 Mar 2008
5289 #: build/C/man2/open.2:673
5291 "Unlike the other values that can be specified in I<flags>, the I<access "
5292 "mode> values B<O_RDONLY>, B<O_WRONLY>, and B<O_RDWR>, do not specify "
5293 "individual bits. Rather, they define the low order two bits of I<flags>, "
5294 "and are defined respectively as 0, 1, and 2. In other words, the "
5295 "combination B<O_RDONLY | O_WRONLY> is a logical error, and certainly does "
5296 "not have the same meaning as B<O_RDWR>. Linux reserves the special, "
5297 "nonstandard access mode 3 (binary 11) in I<flags> to mean: check for read "
5298 "and write permission on the file and return a descriptor that can't be used "
5299 "for reading or writing. This nonstandard access mode is used by some Linux "
5300 "drivers to return a descriptor that is only to be used for device-specific "
5301 "B<ioctl>(2) operations."
5304 #. Linux 2.0, 2.5: truncate
5305 #. Solaris 5.7, 5.8: truncate
5306 #. Irix 6.5: truncate
5307 #. Tru64 5.1B: truncate
5308 #. HP-UX 11.22: truncate
5309 #. FreeBSD 4.7: truncate
5311 #: build/C/man2/open.2:684
5313 "The (undefined) effect of B<O_RDONLY | O_TRUNC> varies among "
5314 "implementations. On many systems the file is actually truncated."
5318 #: build/C/man2/open.2:688
5320 "There are many infelicities in the protocol underlying NFS, affecting "
5321 "amongst others B<O_SYNC> and B<O_NDELAY>."
5325 #: build/C/man2/open.2:710
5327 "POSIX provides for three different variants of synchronized I/O, "
5328 "corresponding to the flags B<O_SYNC>, B<O_DSYNC>, and B<O_RSYNC>. Currently "
5329 "(2.6.31), Linux only implements B<O_SYNC>, but glibc maps B<O_DSYNC> and "
5330 "B<O_RSYNC> to the same numerical value as B<O_SYNC>. Most Linux file "
5331 "systems don't actually implement the POSIX B<O_SYNC> semantics, which "
5332 "require all metadata updates of a write to be on disk on returning to "
5333 "userspace, but only the B<O_DSYNC> semantics, which require only actual file "
5334 "data and metadata necessary to retrieve it to be on disk by the time the "
5335 "system call returns."
5339 #: build/C/man2/open.2:718
5341 "Note that B<open>() can open device special files, but B<creat>() cannot "
5342 "create them; use B<mknod>(2) instead."
5346 #: build/C/man2/open.2:731
5348 "On NFS file systems with UID mapping enabled, B<open>() may return a file "
5349 "descriptor but, for example, B<read>(2) requests are denied with "
5350 "B<EACCES>. This is because the client performs B<open>() by checking the "
5351 "permissions, but UID mapping is performed by the server upon read and write "
5356 #: build/C/man2/open.2:750
5358 "If the file is newly created, its I<st_atime>, I<st_ctime>, I<st_mtime> "
5359 "fields (respectively, time of last access, time of last status change, and "
5360 "time of last modification; see B<stat>(2)) are set to the current time, and "
5361 "so are the I<st_ctime> and I<st_mtime> fields of the parent directory. "
5362 "Otherwise, if the file is modified because of the B<O_TRUNC> flag, its "
5363 "st_ctime and st_mtime fields are set to the current time."
5367 #: build/C/man2/open.2:750
5373 #: build/C/man2/open.2:767
5375 "The B<O_DIRECT> flag may impose alignment restrictions on the length and "
5376 "address of userspace buffers and the file offset of I/Os. In Linux "
5377 "alignment restrictions vary by file system and kernel version and might be "
5378 "absent entirely. However there is currently no file system-independent "
5379 "interface for an application to discover these restrictions for a given file "
5380 "or file system. Some file systems provide their own interfaces for doing "
5381 "so, for example the B<XFS_IOC_DIOINFO> operation in B<xfsctl>(3)."
5385 #: build/C/man2/open.2:773
5387 "Under Linux 2.4, transfer sizes, and the alignment of the user buffer and "
5388 "the file offset must all be multiples of the logical block size of the file "
5389 "system. Under Linux 2.6, alignment to 512-byte boundaries suffices."
5393 #: build/C/man2/open.2:783
5395 "The B<O_DIRECT> flag was introduced in SGI IRIX, where it has alignment "
5396 "restrictions similar to those of Linux 2.4. IRIX has also a B<fcntl>(2) "
5397 "call to query appropriate alignments, and sizes. FreeBSD 4.x introduced a "
5398 "flag of the same name, but without alignment restrictions."
5402 #: build/C/man2/open.2:792
5404 "B<O_DIRECT> support was added under Linux in kernel version 2.4.10. Older "
5405 "Linux kernels simply ignore this flag. Some file systems may not implement "
5406 "the flag and B<open>() will fail with B<EINVAL> if it is used."
5410 #: build/C/man2/open.2:803
5412 "Applications should avoid mixing B<O_DIRECT> and normal I/O to the same "
5413 "file, and especially to overlapping byte regions in the same file. Even "
5414 "when the file system correctly handles the coherency issues in this "
5415 "situation, overall I/O throughput is likely to be slower than using either "
5416 "mode alone. Likewise, applications should avoid mixing B<mmap>(2) of files "
5417 "with direct I/O to the same files."
5421 #: build/C/man2/open.2:825
5423 "The behaviour of B<O_DIRECT> with NFS will differ from local file systems. "
5424 "Older kernels, or kernels configured in certain ways, may not support this "
5425 "combination. The NFS protocol does not support passing the flag to the "
5426 "server, so B<O_DIRECT> I/O will only bypass the page cache on the client; "
5427 "the server may still cache the I/O. The client asks the server to make the "
5428 "I/O synchronous to preserve the synchronous semantics of B<O_DIRECT>. Some "
5429 "servers will perform poorly under these circumstances, especially if the I/O "
5430 "size is small. Some servers may also be configured to lie to clients about "
5431 "the I/O having reached stable storage; this will avoid the performance "
5432 "penalty at some risk to data integrity in the event of server power "
5433 "failure. The Linux NFS client places no alignment restrictions on "
5438 #: build/C/man2/open.2:832
5440 "In summary, B<O_DIRECT> is a potentially powerful tool that should be used "
5441 "with caution. It is recommended that applications treat use of B<O_DIRECT> "
5442 "as a performance option which is disabled by default."
5446 #: build/C/man2/open.2:837
5448 "\"The thing that has always disturbed me about O_DIRECT is that the whole "
5449 "interface is just stupid, and was probably designed by a deranged monkey on "
5450 "some serious mind-controlling substances.\"\\(emLinus"
5453 #. FIXME . Check bugzilla report on open(O_ASYNC)
5454 #. See http://bugzilla.kernel.org/show_bug.cgi?id=5993
5456 #: build/C/man2/open.2:849
5458 "Currently, it is not possible to enable signal-driven I/O by specifying "
5459 "B<O_ASYNC> when calling B<open>(); use B<fcntl>(2) to enable this flag."
5463 #: build/C/man2/open.2:870
5465 "B<chmod>(2), B<chown>(2), B<close>(2), B<dup>(2), B<fcntl>(2), B<link>(2), "
5466 "B<lseek>(2), B<mknod>(2), B<mmap>(2), B<mount>(2), B<openat>(2), B<read>(2), "
5467 "B<socket>(2), B<stat>(2), B<umask>(2), B<unlink>(2), B<write>(2), "
5468 "B<fopen>(3), B<fifo>(7), B<path_resolution>(7), B<symlink>(7)"
5472 #: build/C/man3/perror.3:30
5478 #: build/C/man3/perror.3:30
5484 #: build/C/man3/perror.3:33
5485 msgid "perror - print a system error message"
5489 #: build/C/man3/perror.3:37
5490 msgid "B<void perror(const char *>I<s>B<);>"
5494 #: build/C/man3/perror.3:39
5495 msgid "B<#include E<lt>errno.hE<gt>>"
5499 #: build/C/man3/perror.3:41
5500 msgid "B<const char *>I<sys_errlist>B<[];>"
5504 #: build/C/man3/perror.3:43
5505 msgid "B<int >I<sys_nerr>B<;>"
5509 #: build/C/man3/perror.3:45
5510 msgid "B<int >I<errno>B<;>"
5514 #: build/C/man3/perror.3:54
5515 msgid "I<sys_errlist>, I<sys_nerr>: _BSD_SOURCE"
5519 #: build/C/man3/perror.3:67
5521 "The routine B<perror>() produces a message on the standard error output, "
5522 "describing the last error encountered during a call to a system or library "
5523 "function. First (if I<s> is not NULL and I<*s> is not a null byte "
5524 "(\\(aq\\e0\\(aq)) the argument string I<s> is printed, followed by a colon "
5525 "and a blank. Then the message and a new-line."
5529 #: build/C/man3/perror.3:75
5531 "To be of most use, the argument string should include the name of the "
5532 "function that incurred the error. The error number is taken from the "
5533 "external variable I<errno>, which is set when errors occur but not cleared "
5534 "when successful calls are made."
5538 #: build/C/man3/perror.3:89
5540 "The global error list I<sys_errlist>[] indexed by I<errno> can be used to "
5541 "obtain the error message without the newline. The largest message number "
5542 "provided in the table is I<sys_nerr>-1. Be careful when directly accessing "
5543 "this list because new error values may not have been added to "
5544 "I<sys_errlist>[]. The use of I<sys_errlist>[] is nowadays deprecated."
5548 #: build/C/man3/perror.3:111
5550 "When a system call fails, it usually returns -1 and sets the variable "
5551 "I<errno> to a value describing what went wrong. (These values can be found "
5552 "in I<E<lt>errno.hE<gt>>.) Many library functions do likewise. The function "
5553 "B<perror>() serves to translate this error code into human-readable form. "
5554 "Note that I<errno> is undefined after a successful library call: this call "
5555 "may well change this variable, even though it succeeds, for example because "
5556 "it internally used some other library function that failed. Thus, if a "
5557 "failing call is not immediately followed by a call to B<perror>(), the value "
5558 "of I<errno> should be saved."
5562 #: build/C/man3/perror.3:124
5564 "The function B<perror>() and the external I<errno> (see B<errno>(3)) "
5565 "conform to C89, C99, 4.3BSD, POSIX.1-2001. The externals I<sys_nerr> and "
5566 "I<sys_errlist> conform to BSD."
5569 #. and only when _BSD_SOURCE is defined.
5572 #. is defined, the symbols
5578 #: build/C/man3/perror.3:139
5580 "The externals I<sys_nerr> and I<sys_errlist> are defined by glibc, but in "
5581 "I<E<lt>stdio.hE<gt>>."
5585 #: build/C/man3/perror.3:143
5586 msgid "B<err>(3), B<errno>(3), B<error>(3), B<strerror>(3)"
5590 #: build/C/man2/pipe.2:36
5596 #: build/C/man2/pipe.2:36
5602 #: build/C/man2/pipe.2:39
5603 msgid "pipe, pipe2 - create pipe"
5607 #: build/C/man2/pipe.2:42 build/C/man2/read.2:41
5609 msgid "B<#include E<lt>unistd.hE<gt>>\n"
5613 #: build/C/man2/pipe.2:44
5615 msgid "B<int pipe(int >I<pipefd>B<[2]);>\n"
5619 #: build/C/man2/pipe.2:48
5622 "B<#define _GNU_SOURCE> /* See feature_test_macros(7) */\n"
5623 "B<#include E<lt>fcntl.hE<gt>> /* Obtain O_* constant "
5625 "B<#include E<lt>unistd.hE<gt>>\n"
5629 #: build/C/man2/pipe.2:50
5631 msgid "B<int pipe2(int >I<pipefd>B<[2], int >I<flags>B<);>\n"
5635 #: build/C/man2/pipe.2:66
5637 "B<pipe>() creates a pipe, a unidirectional data channel that can be used "
5638 "for interprocess communication. The array I<pipefd> is used to return two "
5639 "file descriptors referring to the ends of the pipe. I<pipefd[0]> refers to "
5640 "the read end of the pipe. I<pipefd[1]> refers to the write end of the "
5641 "pipe. Data written to the write end of the pipe is buffered by the kernel "
5642 "until it is read from the read end of the pipe. For further details, see "
5647 #: build/C/man2/pipe.2:76
5649 "If I<flags> is 0, then B<pipe2>() is the same as B<pipe>(). The following "
5650 "values can be bitwise ORed in I<flags> to obtain different behavior:"
5654 #: build/C/man2/pipe.2:76
5656 msgid "B<O_NONBLOCK>"
5660 #: build/C/man2/pipe.2:84
5662 "Set the B<O_NONBLOCK> file status flag on the two new open file "
5663 "descriptions. Using this flag saves extra calls to B<fcntl>(2) to achieve "
5668 #: build/C/man2/pipe.2:84
5670 msgid "B<O_CLOEXEC>"
5674 #: build/C/man2/pipe.2:92
5676 "Set the close-on-exec (B<FD_CLOEXEC>) flag on the two new file "
5677 "descriptors. See the description of the same flag in B<open>(2) for "
5678 "reasons why this may be useful."
5682 #: build/C/man2/pipe.2:102
5683 msgid "I<pipefd> is not valid."
5687 #: build/C/man2/pipe.2:107
5688 msgid "(B<pipe2>()) Invalid value in I<flags>."
5692 #: build/C/man2/pipe.2:110
5693 msgid "Too many file descriptors are in use by the process."
5697 #: build/C/man2/pipe.2:118
5699 "B<pipe2>() was added to Linux in version 2.6.27; glibc support is available "
5700 "starting with version 2.9."
5704 #: build/C/man2/pipe.2:121
5705 msgid "B<pipe>(): POSIX.1-2001."
5709 #: build/C/man2/pipe.2:124
5710 msgid "B<pipe2>() is Linux-specific."
5713 #. fork.2 refers to this example program.
5715 #: build/C/man2/pipe.2:140
5717 "The following program creates a pipe, and then B<fork>(2)s to create a child "
5718 "process; the child inherits a duplicate set of file descriptors that refer "
5719 "to the same pipe. After the B<fork>(2), each process closes the descriptors "
5720 "that it doesn't need for the pipe (see B<pipe>(7)). The parent then writes "
5721 "the string contained in the program's command-line argument to the pipe, and "
5722 "the child reads this string a byte at a time from the pipe and echoes it on "
5727 #: build/C/man2/pipe.2:147
5730 "#include E<lt>sys/wait.hE<gt>\n"
5731 "#include E<lt>stdio.hE<gt>\n"
5732 "#include E<lt>stdlib.hE<gt>\n"
5733 "#include E<lt>unistd.hE<gt>\n"
5734 "#include E<lt>string.hE<gt>\n"
5738 #: build/C/man2/pipe.2:154
5742 "main(int argc, char *argv[])\n"
5750 #: build/C/man2/pipe.2:159
5753 " if (argc != 2) {\n"
5754 "\tfprintf(stderr, \"Usage: %s E<lt>stringE<gt>\\en\", argv[0]);\n"
5755 "\texit(EXIT_FAILURE);\n"
5760 #: build/C/man2/pipe.2:164
5763 " if (pipe(pipefd) == -1) {\n"
5764 " perror(\"pipe\");\n"
5765 " exit(EXIT_FAILURE);\n"
5770 #: build/C/man2/pipe.2:170
5774 " if (cpid == -1) {\n"
5775 " perror(\"fork\");\n"
5776 " exit(EXIT_FAILURE);\n"
5781 #: build/C/man2/pipe.2:173
5784 " if (cpid == 0) { /* Child reads from pipe */\n"
5785 " close(pipefd[1]); /* Close unused write end */\n"
5789 #: build/C/man2/pipe.2:176
5792 " while (read(pipefd[0], &buf, 1) E<gt> 0)\n"
5793 " write(STDOUT_FILENO, &buf, 1);\n"
5797 #: build/C/man2/pipe.2:180
5800 " write(STDOUT_FILENO, \"\\en\", 1);\n"
5801 " close(pipefd[0]);\n"
5802 " _exit(EXIT_SUCCESS);\n"
5806 #: build/C/man2/pipe.2:189
5809 " } else { /* Parent writes argv[1] to pipe */\n"
5810 " close(pipefd[0]); /* Close unused read end */\n"
5811 " write(pipefd[1], argv[1], strlen(argv[1]));\n"
5812 " close(pipefd[1]); /* Reader will see EOF */\n"
5813 " wait(NULL); /* Wait for child */\n"
5814 " exit(EXIT_SUCCESS);\n"
5820 #: build/C/man2/pipe.2:196
5822 "B<fork>(2), B<read>(2), B<socketpair>(2), B<write>(2), B<popen>(3), "
5827 #: build/C/man3/popen.3:38
5833 #: build/C/man3/popen.3:38
5839 #: build/C/man3/popen.3:41
5840 msgid "popen, pclose - pipe stream to or from a process"
5844 #: build/C/man3/popen.3:46
5846 msgid "B<FILE *popen(const char *>I<command>B<, const char *>I<type>B<);>\n"
5850 #: build/C/man3/popen.3:48
5852 msgid "B<int pclose(FILE *>I<stream>B<);>\n"
5856 #: build/C/man3/popen.3:58
5857 msgid "B<popen>(), B<pclose>():"
5861 #: build/C/man3/popen.3:60
5862 msgid "_POSIX_C_SOURCE\\ E<gt>=\\ 2 || _XOPEN_SOURCE || _BSD_SOURCE || _SVID_SOURCE"
5866 #: build/C/man3/popen.3:71
5868 "The B<popen>() function opens a process by creating a pipe, forking, and "
5869 "invoking the shell. Since a pipe is by definition unidirectional, the "
5870 "I<type> argument may specify only reading or writing, not both; the "
5871 "resulting stream is correspondingly read-only or write-only."
5875 #: build/C/man3/popen.3:95
5877 "The I<command> argument is a pointer to a null-terminated string containing "
5878 "a shell command line. This command is passed to I</bin/sh> using the B<-c> "
5879 "flag; interpretation, if any, is performed by the shell. The I<type> "
5880 "argument is a pointer to a null-terminated string which must contain either "
5881 "the letter \\(aqr\\(aq for reading or the letter \\(aqw\\(aq for writing. "
5882 "Since glibc 2.9, this argument can additionally include the letter "
5883 "\\(aqe\\(aq, which causes the close-on-exec flag (B<FD_CLOEXEC>) to be set "
5884 "on the underlying file descriptor; see the description of the B<O_CLOEXEC> "
5885 "flag in B<open>(2) for reasons why this may be useful."
5889 #: build/C/man3/popen.3:111
5891 "The return value from B<popen>() is a normal standard I/O stream in all "
5892 "respects save that it must be closed with B<pclose>() rather than "
5893 "B<fclose>(3). Writing to such a stream writes to the standard input of the "
5894 "command; the command's standard output is the same as that of the process "
5895 "that called B<popen>(), unless this is altered by the command itself. "
5896 "Conversely, reading from a \"popened\" stream reads the command's standard "
5897 "output, and the command's standard input is the same as that of the process "
5898 "that called B<popen>()."
5902 #: build/C/man3/popen.3:115
5903 msgid "Note that output B<popen>() streams are fully buffered by default."
5907 #: build/C/man3/popen.3:121
5909 "The B<pclose>() function waits for the associated process to terminate and "
5910 "returns the exit status of the command as returned by B<wait4>(2)."
5914 #: build/C/man3/popen.3:129
5916 "The B<popen>() function returns NULL if the B<fork>(2) or B<pipe>(2) "
5917 "calls fail, or if it cannot allocate memory."
5920 #. These conditions actually give undefined results, so I commented
5923 #. is not associated with a "popen()ed" command, if
5925 #. already "pclose()d", or if
5927 #: build/C/man3/popen.3:141
5929 "The B<pclose>() function returns -1 if B<wait4>(2) returns an error, or "
5930 "some other error is detected."
5934 #: build/C/man3/popen.3:160
5936 "The B<popen>() function does not set I<errno> if memory allocation fails. "
5937 "If the underlying B<fork>(2) or B<pipe>(2) fails, I<errno> is set "
5938 "appropriately. If the I<type> argument is invalid, and this condition is "
5939 "detected, I<errno> is set to B<EINVAL>."
5943 #: build/C/man3/popen.3:167
5945 "If B<pclose>() cannot obtain the child status, I<errno> is set to "
5950 #: build/C/man3/popen.3:173
5951 msgid "The \\(aqe\\(aq value for I<type> is a Linux extension."
5955 #: build/C/man3/popen.3:186
5957 "Since the standard input of a command opened for reading shares its seek "
5958 "offset with the process that called B<popen>(), if the original process has "
5959 "done a buffered read, the command's input position may not be as expected. "
5960 "Similarly, the output from a command opened for writing may become "
5961 "intermingled with that of the original process. The latter can be avoided "
5962 "by calling B<fflush>(3) before B<popen>()."
5970 #. function appeared in Version 7 AT&T UNIX.
5972 #: build/C/man3/popen.3:196
5974 "Failure to execute the shell is indistinguishable from the shell's failure "
5975 "to execute command, or an immediate exit of the command. The only hint is "
5976 "an exit status of 127."
5980 #: build/C/man3/popen.3:205
5982 "B<sh>(1), B<fork>(2), B<pipe>(2), B<wait4>(2), B<fclose>(3), B<fflush>(3), "
5983 "B<fopen>(3), B<stdio>(3), B<system>(3)"
5987 #: build/C/man3/printf.3:34
5993 #: build/C/man3/printf.3:34 build/C/man3/puts.3:24 build/C/man3/scanf.3:50
5999 #: build/C/man3/printf.3:38
6001 "printf, fprintf, sprintf, snprintf, vprintf, vfprintf, vsprintf, vsnprintf - "
6002 "formatted output conversion"
6006 #: build/C/man3/printf.3:42
6007 msgid "B<int printf(const char *>I<format>B<, ...);>"
6011 #: build/C/man3/printf.3:44
6012 msgid "B<int fprintf(FILE *>I<stream>B<, const char *>I<format>B<, ...);>"
6016 #: build/C/man3/printf.3:46
6017 msgid "B<int sprintf(char *>I<str>B<, const char *>I<format>B<, ...);>"
6021 #: build/C/man3/printf.3:48
6023 "B<int snprintf(char *>I<str>B<, size_t >I<size>B<, const char *>I<format>B<, "
6028 #: build/C/man3/printf.3:50
6029 msgid "B<#include E<lt>stdarg.hE<gt>>"
6033 #: build/C/man3/printf.3:52
6034 msgid "B<int vprintf(const char *>I<format>B<, va_list >I<ap>B<);>"
6038 #: build/C/man3/printf.3:54
6040 "B<int vfprintf(FILE *>I<stream>B<, const char *>I<format>B<, va_list "
6045 #: build/C/man3/printf.3:56
6047 "B<int vsprintf(char *>I<str>B<, const char *>I<format>B<, va_list "
6052 #: build/C/man3/printf.3:59
6054 "B<int vsnprintf(char *>I<str>B<, size_t >I<size>B<, const char "
6055 "*>I<format>B<, va_list >I<ap>B<);>"
6059 #: build/C/man3/printf.3:68
6060 msgid "B<snprintf>(), B<vsnprintf>():"
6064 #: build/C/man3/printf.3:71
6066 "_BSD_SOURCE || _XOPEN_SOURCE\\ E<gt>=\\ 500 || _ISOC99_SOURCE || "
6067 "_POSIX_C_SOURCE\\ E<gt>=\\ 200112L;"
6071 #: build/C/man3/printf.3:74 build/C/man3/scanf.3:83
6072 msgid "or I<cc -std=c99>"
6076 #: build/C/man3/printf.3:101
6078 "The functions in the B<printf>() family produce output according to a "
6079 "I<format> as described below. The functions B<printf>() and B<vprintf>() "
6080 "write output to I<stdout>, the standard output stream; B<fprintf>() and "
6081 "B<vfprintf>() write output to the given output I<stream>; B<sprintf>(), "
6082 "B<snprintf>(), B<vsprintf>() and B<vsnprintf>() write to the character "
6087 #: build/C/man3/printf.3:110
6089 "The functions B<snprintf>() and B<vsnprintf>() write at most I<size> bytes "
6090 "(including the terminating null byte (\\(aq\\e0\\(aq)) to I<str>."
6094 #: build/C/man3/printf.3:134
6096 "The functions B<vprintf>(), B<vfprintf>(), B<vsprintf>(), B<vsnprintf>() "
6097 "are equivalent to the functions B<printf>(), B<fprintf>(), B<sprintf>(), "
6098 "B<snprintf>(), respectively, except that they are called with a I<va_list> "
6099 "instead of a variable number of arguments. These functions do not call the "
6100 "I<va_end> macro. Because they invoke the I<va_arg> macro, the value of "
6101 "I<ap> is undefined after the call. See B<stdarg>(3)."
6105 #: build/C/man3/printf.3:141
6107 "These eight functions write the output under the control of a I<format> "
6108 "string that specifies how subsequent arguments (or arguments accessed via "
6109 "the variable-length argument facilities of B<stdarg>(3)) are converted for "
6114 #: build/C/man3/printf.3:152
6116 "C99 and POSIX.1-2001 specify that the results are undefined if a call to "
6117 "B<sprintf>(), B<snprintf>(), B<vsprintf>(), or B<vsnprintf>() would cause "
6118 "copying to take place between objects that overlap (e.g., if the target "
6119 "string array and one of the supplied input arguments refer to the same "
6120 "buffer). See NOTES."
6124 #: build/C/man3/printf.3:152
6126 msgid "Return value"
6130 #: build/C/man3/printf.3:155
6132 "Upon successful return, these functions return the number of characters "
6133 "printed (excluding the null byte used to end output to strings)."
6137 #: build/C/man3/printf.3:171
6139 "The functions B<snprintf>() and B<vsnprintf>() do not write more than "
6140 "I<size> bytes (including the terminating null byte (\\(aq\\e0\\(aq)). If "
6141 "the output was truncated due to this limit then the return value is the "
6142 "number of characters (excluding the terminating null byte) which would have "
6143 "been written to the final string if enough space had been available. Thus, "
6144 "a return value of I<size> or more means that the output was truncated. (See "
6145 "also below under NOTES.)"
6149 #: build/C/man3/printf.3:173
6150 msgid "If an output error is encountered, a negative value is returned."
6154 #: build/C/man3/printf.3:173
6156 msgid "Format of the format string"
6160 #: build/C/man3/printf.3:195
6162 "The format string is a character string, beginning and ending in its initial "
6163 "shift state, if any. The format string is composed of zero or more "
6164 "directives: ordinary characters (not B<%>), which are copied unchanged to "
6165 "the output stream; and conversion specifications, each of which results in "
6166 "fetching zero or more subsequent arguments. Each conversion specification "
6167 "is introduced by the character B<%>, and ends with a I<conversion "
6168 "specifier>. In between there may be (in this order) zero or more I<flags>, "
6169 "an optional minimum I<field width>, an optional I<precision> and an optional "
6170 "I<length modifier>."
6174 #: build/C/man3/printf.3:208
6176 "The arguments must correspond properly (after type promotion) with the "
6177 "conversion specifier. By default, the arguments are used in the order "
6178 "given, where each \\(aq*\\(aq and each conversion specifier asks for the "
6179 "next argument (and it is an error if insufficiently many arguments are "
6180 "given). One can also specify explicitly which argument is taken, at each "
6181 "place where an argument is required, by writing \"%m$\" instead of "
6182 "\\(aq%\\(aq and \"*m$\" instead of \\(aq*\\(aq, where the decimal integer m "
6183 "denotes the position in the argument list of the desired argument, indexed "
6184 "starting from 1. Thus,"
6188 #: build/C/man3/printf.3:212
6190 msgid "printf(\"%*d\", width, num);\n"
6194 #: build/C/man3/printf.3:216
6199 #: build/C/man3/printf.3:220
6201 msgid "printf(\"%2$*1$d\", width, num);\n"
6205 #: build/C/man3/printf.3:236
6207 "are equivalent. The second style allows repeated references to the same "
6208 "argument. The C99 standard does not include the style using \\(aq$\\(aq, "
6209 "which comes from the Single UNIX Specification. If the style using "
6210 "\\(aq$\\(aq is used, it must be used throughout for all conversions taking "
6211 "an argument and all width and precision arguments, but it may be mixed with "
6212 "\"%%\" formats which do not consume an argument. There may be no gaps in "
6213 "the numbers of arguments specified using \\(aq$\\(aq; for example, if "
6214 "arguments 1 and 3 are specified, argument 2 must also be specified somewhere "
6215 "in the format string."
6219 #: build/C/man3/printf.3:246
6221 "For some numeric conversions a radix character (\"decimal point\") or "
6222 "thousands' grouping character is used. The actual character used depends on "
6223 "the B<LC_NUMERIC> part of the locale. The POSIX locale uses \\(aq.\\(aq as "
6224 "radix character, and does not have a grouping character. Thus,"
6228 #: build/C/man3/printf.3:250
6230 msgid " printf(\"%\\(aq.2f\", 1234567.89);\n"
6234 #: build/C/man3/printf.3:255
6236 "results in \"1234567.89\" in the POSIX locale, in \"1234567,89\" in the "
6237 "nl_NL locale, and in \"1.234.567,89\" in the da_DK locale."
6241 #: build/C/man3/printf.3:255
6243 msgid "The flag characters"
6247 #: build/C/man3/printf.3:257
6248 msgid "The character % is followed by zero or more of the following flags:"
6252 #: build/C/man3/printf.3:257
6258 #: build/C/man3/printf.3:291
6260 "The value should be converted to an \"alternate form\". For B<o> "
6261 "conversions, the first character of the output string is made zero (by "
6262 "prefixing a 0 if it was not zero already). For B<x> and B<X> conversions, a "
6263 "nonzero result has the string \"0x\" (or \"0X\" for B<X> conversions) "
6264 "prepended to it. For B<a>, B<A>, B<e>, B<E>, B<f>, B<F>, B<g>, and B<G> "
6265 "conversions, the result will always contain a decimal point, even if no "
6266 "digits follow it (normally, a decimal point appears in the results of those "
6267 "conversions only if a digit follows). For B<g> and B<G> conversions, "
6268 "trailing zeros are not removed from the result as they would otherwise be. "
6269 "For other conversions, the result is undefined."
6273 #: build/C/man3/printf.3:291
6279 #: build/C/man3/printf.3:331
6281 "The value should be zero padded. For B<d>, B<i>, B<o>, B<u>, B<x>, B<X>, "
6282 "B<a>, B<A>, B<e>, B<E>, B<f>, B<F>, B<g>, and B<G> conversions, the "
6283 "converted value is padded on the left with zeros rather than blanks. If the "
6284 "B<\\&0> and B<-> flags both appear, the B<\\&0> flag is ignored. If a "
6285 "precision is given with a numeric conversion (B<d>, B<i>, B<o>, B<u>, B<x>, "
6286 "and B<X>), the B<\\&0> flag is ignored. For other conversions, the behavior "
6291 #: build/C/man3/printf.3:331
6297 #: build/C/man3/printf.3:344
6299 "The converted value is to be left adjusted on the field boundary. (The "
6300 "default is right justification.) Except for B<n> conversions, the converted "
6301 "value is padded on the right with blanks, rather than on the left with "
6302 "blanks or zeros. A B<-> overrides a B<\\&0> if both are given."
6306 #: build/C/man3/printf.3:344
6308 msgid "B<\\(aq \\(aq>"
6312 #: build/C/man3/printf.3:348
6314 "(a space) A blank should be left before a positive number (or empty string) "
6315 "produced by a signed conversion."
6319 #: build/C/man3/printf.3:348
6325 #: build/C/man3/printf.3:356
6327 "A sign (+ or -) should always be placed before a number produced by a signed "
6328 "conversion. By default a sign is used only for negative numbers. A B<+> "
6329 "overrides a space if both are used."
6333 #: build/C/man3/printf.3:359
6335 "The five flag characters above are defined in the C standard. The SUSv2 "
6336 "specifies one further flag character."
6340 #: build/C/man3/printf.3:359
6346 #: build/C/man3/printf.3:376
6348 "For decimal conversion (B<i>, B<d>, B<u>, B<f>, B<F>, B<g>, B<G>) the "
6349 "output is to be grouped with thousands' grouping characters if the locale "
6350 "information indicates any. Note that many versions of B<gcc>(1) cannot "
6351 "parse this option and will issue a warning. SUSv2 does not include "
6356 #: build/C/man3/printf.3:378
6357 msgid "glibc 2.2 adds one further flag character."
6361 #: build/C/man3/printf.3:378
6366 #. outdigits keyword in locale file
6368 #: build/C/man3/printf.3:388
6370 "For decimal integer conversion (B<i>, B<d>, B<u>) the output uses the "
6371 "locale's alternative output digits, if any. For example, since glibc 2.2.3 "
6372 "this will give Arabic-Indic digits in the Persian (\"fa_IR\") locale."
6376 #: build/C/man3/printf.3:388
6378 msgid "The field width"
6382 #: build/C/man3/printf.3:404
6384 "An optional decimal digit string (with nonzero first digit) specifying a "
6385 "minimum field width. If the converted value has fewer characters than the "
6386 "field width, it will be padded with spaces on the left (or right, if the "
6387 "left-adjustment flag has been given). Instead of a decimal digit string one "
6388 "may write \"*\" or \"*m$\" (for some decimal integer I<m>) to specify that "
6389 "the field width is given in the next argument, or in the I<m>-th argument, "
6390 "respectively, which must be of type I<int>. A negative field width is taken "
6391 "as a \\(aq-\\(aq flag followed by a positive field width. In no case does a "
6392 "nonexistent or small field width cause truncation of a field; if the result "
6393 "of a conversion is wider than the field width, the field is expanded to "
6394 "contain the conversion result."
6398 #: build/C/man3/printf.3:404
6400 msgid "The precision"
6404 #: build/C/man3/printf.3:440
6406 "An optional precision, in the form of a period (\\(aq.\\(aq) followed by an "
6407 "optional decimal digit string. Instead of a decimal digit string one may "
6408 "write \"*\" or \"*m$\" (for some decimal integer m) to specify that the "
6409 "precision is given in the next argument, or in the m-th argument, "
6410 "respectively, which must be of type I<int>. If the precision is given as "
6411 "just \\(aq.\\(aq, or the precision is negative, the precision is taken to be "
6412 "zero. This gives the minimum number of digits to appear for B<d>, B<i>, "
6413 "B<o>, B<u>, B<x>, and B<X> conversions, the number of digits to appear after "
6414 "the radix character for B<a>, B<A>, B<e>, B<E>, B<f>, and B<F> conversions, "
6415 "the maximum number of significant digits for B<g> and B<G> conversions, or "
6416 "the maximum number of characters to be printed from a string for B<s> and "
6421 #: build/C/man3/printf.3:440
6423 msgid "The length modifier"
6427 #: build/C/man3/printf.3:450
6429 "Here, \"integer conversion\" stands for B<d>, B<i>, B<o>, B<u>, B<x>, or "
6434 #: build/C/man3/printf.3:450 build/C/man3/scanf.3:291
6440 #: build/C/man3/printf.3:461
6442 "A following integer conversion corresponds to a I<signed char> or I<unsigned "
6443 "char> argument, or a following B<n> conversion corresponds to a pointer to a "
6444 "I<signed char> argument."
6448 #: build/C/man3/printf.3:461 build/C/man3/scanf.3:281
6454 #: build/C/man3/printf.3:472
6456 "A following integer conversion corresponds to a I<short int> or I<unsigned "
6457 "short int> argument, or a following B<n> conversion corresponds to a pointer "
6458 "to a I<short int> argument."
6462 #: build/C/man3/printf.3:472 build/C/man3/scanf.3:308
6468 #: build/C/man3/printf.3:491
6470 "(ell) A following integer conversion corresponds to a I<long int> or "
6471 "I<unsigned long int> argument, or a following B<n> conversion corresponds to "
6472 "a pointer to a I<long int> argument, or a following B<c> conversion "
6473 "corresponds to a I<wint_t> argument, or a following B<s> conversion "
6474 "corresponds to a pointer to I<wchar_t> argument."
6478 #: build/C/man3/printf.3:491
6484 #: build/C/man3/printf.3:503
6486 "(ell-ell). A following integer conversion corresponds to a I<long long int> "
6487 "or I<unsigned long long int> argument, or a following B<n> conversion "
6488 "corresponds to a pointer to a I<long long int> argument."
6492 #: build/C/man3/printf.3:503 build/C/man3/scanf.3:335
6498 #: build/C/man3/printf.3:519
6500 "A following B<a>, B<A>, B<e>, B<E>, B<f>, B<F>, B<g>, or B<G> conversion "
6501 "corresponds to a I<long double> argument. (C99 allows %LF, but SUSv2 does "
6506 #: build/C/man3/printf.3:519 build/C/man3/scanf.3:351
6512 #: build/C/man3/printf.3:525
6514 "(\"quad\". 4.4BSD and Linux libc5 only. Don't use.) This is a synonym for "
6519 #: build/C/man3/printf.3:525 build/C/man3/scanf.3:299
6525 #: build/C/man3/printf.3:532
6527 "A following integer conversion corresponds to an I<intmax_t> or I<uintmax_t> "
6532 #: build/C/man3/printf.3:532 build/C/man3/scanf.3:363
6538 #: build/C/man3/printf.3:543
6540 "A following integer conversion corresponds to a I<size_t> or I<ssize_t> "
6541 "argument. (Linux libc5 has B<Z> with this meaning. Don't use it.)"
6545 #: build/C/man3/printf.3:543 build/C/man3/scanf.3:356
6551 #: build/C/man3/printf.3:548
6552 msgid "A following integer conversion corresponds to a I<ptrdiff_t> argument."
6556 #: build/C/man3/printf.3:577
6558 "The SUSv2 only knows about the length modifiers B<h> (in B<hd>, B<hi>, "
6559 "B<ho>, B<hx>, B<hX>, B<hn>) and B<l> (in B<ld>, B<li>, B<lo>, B<lx>, B<lX>, "
6560 "B<ln>, B<lc>, B<ls>) and B<L> (in B<Le>, B<LE>, B<Lf>, B<Lg>, B<LG>)."
6564 #: build/C/man3/printf.3:577
6566 msgid "The conversion specifier"
6570 #: build/C/man3/printf.3:580
6572 "A character that specifies the type of conversion to be applied. The "
6573 "conversion specifiers and their meanings are:"
6577 #: build/C/man3/printf.3:580
6583 #: build/C/man3/printf.3:590
6585 "The I<int> argument is converted to signed decimal notation. The precision, "
6586 "if any, gives the minimum number of digits that must appear; if the "
6587 "converted value requires fewer digits, it is padded on the left with zeros. "
6588 "The default precision is 1. When 0 is printed with an explicit precision 0, "
6589 "the output is empty."
6593 #: build/C/man3/printf.3:590
6595 msgid "B<o>, B<u>, B<x>, B<X>"
6599 #: build/C/man3/printf.3:617
6601 "The I<unsigned int> argument is converted to unsigned octal (B<o>), unsigned "
6602 "decimal (B<u>), or unsigned hexadecimal (B<x> and B<X>) notation. The "
6603 "letters B<abcdef> are used for B<x> conversions; the letters B<ABCDEF> are "
6604 "used for B<X> conversions. The precision, if any, gives the minimum number "
6605 "of digits that must appear; if the converted value requires fewer digits, it "
6606 "is padded on the left with zeros. The default precision is 1. When 0 is "
6607 "printed with an explicit precision 0, the output is empty."
6611 #: build/C/man3/printf.3:617
6617 #: build/C/man3/printf.3:622
6618 msgid "The I<double> argument is rounded and converted in the style"
6622 #: build/C/man3/printf.3:637
6624 "[-]dB<\\&.>dddB<e>\\*(Pmdd where there is one digit before the decimal-point "
6625 "character and the number of digits after it is equal to the precision; if "
6626 "the precision is missing, it is taken as 6; if the precision is zero, no "
6627 "decimal-point character appears. An B<E> conversion uses the letter B<E> "
6628 "(rather than B<e>) to introduce the exponent. The exponent always contains "
6629 "at least two digits; if the value is zero, the exponent is 00."
6633 #: build/C/man3/printf.3:637
6639 #: build/C/man3/printf.3:648
6641 "The I<double> argument is rounded and converted to decimal notation in the "
6642 "style [-]dddB<\\&.>ddd, where the number of digits after the decimal-point "
6643 "character is equal to the precision specification. If the precision is "
6644 "missing, it is taken as 6; if the precision is explicitly zero, no "
6645 "decimal-point character appears. If a decimal point appears, at least one "
6646 "digit appears before it."
6650 #: build/C/man3/printf.3:659
6652 "(The SUSv2 does not know about B<F> and says that character string "
6653 "representations for infinity and NaN may be made available. The C99 "
6654 "standard specifies \"[-]inf\" or \"[-]infinity\" for infinity, and a string "
6655 "starting with \"nan\" for NaN, in the case of B<f> conversion, and "
6656 "\"[-]INF\" or \"[-]INFINITY\" or \"NAN*\" in the case of B<F> conversion.)"
6660 #: build/C/man3/printf.3:659
6666 #: build/C/man3/printf.3:684
6668 "The I<double> argument is converted in style B<f> or B<e> (or B<F> or B<E> "
6669 "for B<G> conversions). The precision specifies the number of significant "
6670 "digits. If the precision is missing, 6 digits are given; if the precision "
6671 "is zero, it is treated as 1. Style B<e> is used if the exponent from its "
6672 "conversion is less than -4 or greater than or equal to the precision. "
6673 "Trailing zeros are removed from the fractional part of the result; a decimal "
6674 "point appears only if it is followed by at least one digit."
6678 #: build/C/man3/printf.3:684
6684 #: build/C/man3/printf.3:708
6686 "(C99; not in SUSv2) For B<a> conversion, the I<double> argument is converted "
6687 "to hexadecimal notation (using the letters abcdef) in the style "
6688 "[-]B<0x>hB<\\&.>hhhhB<p>\\*(Pmd; for B<A> conversion the prefix B<0X>, the "
6689 "letters ABCDEF, and the exponent separator B<P> is used. There is one "
6690 "hexadecimal digit before the decimal point, and the number of digits after "
6691 "it is equal to the precision. The default precision suffices for an exact "
6692 "representation of the value if an exact representation in base 2 exists and "
6693 "otherwise is sufficiently large to distinguish values of type I<double>. "
6694 "The digit before the decimal point is unspecified for nonnormalized numbers, "
6695 "and nonzero but otherwise unspecified for normalized numbers."
6699 #: build/C/man3/printf.3:708 build/C/man3/scanf.3:456 build/C/man3/wprintf.3:132
6705 #: build/C/man3/printf.3:726
6707 "If no B<l> modifier is present, the I<int> argument is converted to an "
6708 "I<unsigned char>, and the resulting character is written. If an B<l> "
6709 "modifier is present, the I<wint_t> (wide character) argument is converted to "
6710 "a multibyte sequence by a call to the B<wcrtomb>(3) function, with a "
6711 "conversion state starting in the initial state, and the resulting multibyte "
6712 "string is written."
6716 #: build/C/man3/printf.3:726 build/C/man3/scanf.3:448 build/C/man3/wprintf.3:146
6722 #: build/C/man3/printf.3:741
6724 "If no B<l> modifier is present: The I<const char *> argument is expected to "
6725 "be a pointer to an array of character type (pointer to a string). "
6726 "Characters from the array are written up to (but not including) a "
6727 "terminating null byte (\\(aq\\e0\\(aq); if a precision is specified, no more "
6728 "than the number specified are written. If a precision is given, no null "
6729 "byte need be present; if the precision is not specified, or is greater than "
6730 "the size of the array, the array must contain a terminating null byte."
6734 #: build/C/man3/printf.3:768
6736 "If an B<l> modifier is present: The I<const wchar_t *> argument is expected "
6737 "to be a pointer to an array of wide characters. Wide characters from the "
6738 "array are converted to multibyte characters (each by a call to the "
6739 "B<wcrtomb>(3) function, with a conversion state starting in the initial "
6740 "state before the first wide character), up to and including a terminating "
6741 "null wide character. The resulting multibyte characters are written up to "
6742 "(but not including) the terminating null byte. If a precision is specified, "
6743 "no more bytes than the number specified are written, but no partial "
6744 "multibyte characters are written. Note that the precision determines the "
6745 "number of I<bytes> written, not the number of I<wide characters> or I<screen "
6746 "positions>. The array must contain a terminating null wide character, "
6747 "unless a precision is given and it is so small that the number of bytes "
6748 "written exceeds it before the end of the array is reached."
6752 #: build/C/man3/printf.3:768
6758 #: build/C/man3/printf.3:774
6759 msgid "(Not in C99, but in SUSv2.) Synonym for B<lc>. Don't use."
6763 #: build/C/man3/printf.3:774
6769 #: build/C/man3/printf.3:780
6770 msgid "(Not in C99, but in SUSv2.) Synonym for B<ls>. Don't use."
6774 #: build/C/man3/printf.3:780 build/C/man3/scanf.3:500
6780 #: build/C/man3/printf.3:788
6782 "The I<void *> pointer argument is printed in hexadecimal (as if by B<%#x> or "
6787 #: build/C/man3/printf.3:788 build/C/man3/scanf.3:508
6793 #: build/C/man3/printf.3:795
6795 "The number of characters written so far is stored into the integer indicated "
6796 "by the I<int *> (or variant) pointer argument. No argument is converted."
6800 #: build/C/man3/printf.3:795
6806 #: build/C/man3/printf.3:801
6808 "(Glibc extension.) Print output of I<strerror(errno)>. No argument is "
6813 #: build/C/man3/printf.3:801 build/C/man3/scanf.3:374
6819 #: build/C/man3/printf.3:807
6821 "A \\(aq%\\(aq is written. No argument is converted. The complete "
6822 "conversion specification is \\(aq%%\\(aq."
6826 #: build/C/man3/printf.3:822
6828 "The B<fprintf>(), B<printf>(), B<sprintf>(), B<vprintf>(), B<vfprintf>(), "
6829 "and B<vsprintf>() functions conform to C89 and C99. The B<snprintf>() and "
6830 "B<vsnprintf>() functions conform to C99."
6834 #: build/C/man3/printf.3:835
6836 "Concerning the return value of B<snprintf>(), SUSv2 and C99 contradict each "
6837 "other: when B<snprintf>() is called with I<size>=0 then SUSv2 stipulates an "
6838 "unspecified return value less than 1, while C99 allows I<str> to be NULL in "
6839 "this case, and gives the return value (as always) as the number of "
6840 "characters that would have been written in case the output string has been "
6845 #: build/C/man3/printf.3:849
6847 "Linux libc4 knows about the five C standard flags. It knows about the "
6848 "length modifiers B<h>, B<l>, B<L>, and the conversions B<c>, B<d>, B<e>, "
6849 "B<E>, B<f>, B<F>, B<g>, B<G>, B<i>, B<n>, B<o>, B<p>, B<s>, B<u>, B<x>, and "
6850 "B<X>, where B<F> is a synonym for B<f>. Additionally, it accepts B<D>, "
6851 "B<O>, and B<U> as synonyms for B<ld>, B<lo>, and B<lu>. (This is bad, and "
6852 "caused serious bugs later, when support for B<%D> disappeared.) No "
6853 "locale-dependent radix character, no thousands' separator, no NaN or "
6854 "infinity, no \"%m$\" and \"*m$\"."
6858 #: build/C/man3/printf.3:860
6860 "Linux libc5 knows about the five C standard flags and the \\(aq flag, "
6861 "locale, \"%m$\" and \"*m$\". It knows about the length modifiers B<h>, "
6862 "B<l>, B<L>, B<Z>, and B<q>, but accepts B<L> and B<q> both for I<long "
6863 "double> and for I<long long int> (this is a bug). It no longer recognizes "
6864 "B<F>, B<D>, B<O>, and B<U>, but adds the conversion character B<m>, which "
6865 "outputs I<strerror(errno)>."
6869 #: build/C/man3/printf.3:862
6870 msgid "glibc 2.0 adds conversion characters B<C> and B<S>."
6874 #: build/C/man3/printf.3:865
6876 "glibc 2.1 adds length modifiers B<hh>, B<j>, B<t>, and B<z> and conversion "
6877 "characters B<a> and B<A>."
6881 #: build/C/man3/printf.3:868
6883 "glibc 2.2 adds the conversion character B<F> with C99 semantics, and the "
6884 "flag character B<I>."
6888 #: build/C/man3/printf.3:870
6889 msgid "Some programs imprudently rely on code such as the following"
6893 #: build/C/man3/printf.3:872
6895 msgid " sprintf(buf, \"%s some further text\", buf);\n"
6898 #. http://sourceware.org/bugzilla/show_bug.cgi?id=7075
6900 #: build/C/man3/printf.3:888
6902 "to append text to I<buf>. However, the standards explicitly note that the "
6903 "results are undefined if source and destination buffers overlap when calling "
6904 "B<sprintf>(), B<snprintf>(), B<vsprintf>(), and B<vsnprintf>(). Depending "
6905 "on the version of B<gcc>(1) used, and the compiler options employed, calls "
6906 "such as the above will B<not> produce the expected results."
6910 #. UNIX V7 defines the three routines
6914 #. and has the flag \-, the width or precision *, the length modifier l,
6915 #. and the conversions doxfegcsu, and also D,O,U,X as synonyms for ld,lo,lu,lx.
6916 #. This is still true for 2.9.1BSD, but 2.10BSD has the flags
6917 #. #, + and <space> and no longer mentions D,O,U,X.
6922 #. and warns not to use D,O,U,X.
6923 #. 4.3BSD Reno has the flag 0, the length modifiers h and L,
6924 #. and the conversions n, p, E, G, X (with current meaning)
6925 #. and deprecates D,O,U.
6926 #. 4.4BSD introduces the functions
6929 #. .BR vsnprintf (),
6930 #. and the length modifier q.
6931 #. FreeBSD also has functions
6934 #. .BR vasprintf (),
6935 #. that allocate a buffer large enough for
6937 #. In glibc there are functions
6941 #. that print to a file descriptor instead of a stream.
6943 #: build/C/man3/printf.3:930
6945 "The glibc implementation of the functions B<snprintf>() and B<vsnprintf>() "
6946 "conforms to the C99 standard, that is, behaves as described above, since "
6947 "glibc version 2.1. Until glibc 2.0.6 they would return -1 when the output "
6952 #: build/C/man3/printf.3:947
6954 "Because B<sprintf>() and B<vsprintf>() assume an arbitrarily long string, "
6955 "callers must be careful not to overflow the actual space; this is often "
6956 "impossible to assure. Note that the length of the strings produced is "
6957 "locale-dependent and difficult to predict. Use B<snprintf>() and "
6958 "B<vsnprintf>() instead (or B<asprintf>(3) and B<vasprintf>(3))."
6962 #: build/C/man3/printf.3:960
6964 "Linux libc4.[45] does not have a B<snprintf>(), but provides a libbsd that "
6965 "contains an B<snprintf>() equivalent to B<sprintf>(), that is, one that "
6966 "ignores the I<size> argument. Thus, the use of B<snprintf>() with early "
6967 "libc4 leads to serious security problems."
6971 #. Some floating-point conversions under early libc4
6972 #. caused memory leaks.
6974 #: build/C/man3/printf.3:974
6976 "Code such as B<printf(>I<foo>B<);> often indicates a bug, since I<foo> may "
6977 "contain a % character. If I<foo> comes from untrusted user input, it may "
6978 "contain B<%n>, causing the B<printf>() call to write to memory and creating "
6983 #: build/C/man3/printf.3:977
6984 msgid "To print \\*(Pi to five decimal places:"
6988 #: build/C/man3/printf.3:983
6991 "#include E<lt>math.hE<gt>\n"
6992 "#include E<lt>stdio.hE<gt>\n"
6993 "fprintf(stdout, \"pi = %.5f\\en\", 4 * atan(1.0));\n"
6997 #: build/C/man3/printf.3:992
6999 "To print a date and time in the form \"Sunday, July 3, 10:02\", where "
7000 "I<weekday> and I<month> are pointers to strings:"
7004 #: build/C/man3/printf.3:998
7007 "#include E<lt>stdio.hE<gt>\n"
7008 "fprintf(stdout, \"%s, %s %d, %.2d:%.2d\\en\",\n"
7009 " weekday, month, day, hour, min);\n"
7013 #: build/C/man3/printf.3:1004
7015 "Many countries use the day-month-year order. Hence, an internationalized "
7016 "version must be able to print the arguments in an order specified by the "
7021 #: build/C/man3/printf.3:1010
7024 "#include E<lt>stdio.hE<gt>\n"
7025 "fprintf(stdout, format,\n"
7026 " weekday, month, day, hour, min);\n"
7030 #: build/C/man3/printf.3:1017
7032 "where I<format> depends on locale, and may permute the arguments. With the "
7037 #: build/C/man3/printf.3:1021
7039 msgid "\"%1$s, %3$d. %2$s, %4$d:%5$.2d\\en\"\n"
7043 #: build/C/man3/printf.3:1025
7044 msgid "one might obtain \"Sonntag, 3. Juli, 10:02\"."
7048 #: build/C/man3/printf.3:1028
7050 "To allocate a sufficiently large string and print into it (code correct for "
7051 "both glibc 2.0 and glibc 2.1):"
7055 #: build/C/man3/printf.3:1033
7058 "#include E<lt>stdio.hE<gt>\n"
7059 "#include E<lt>stdlib.hE<gt>\n"
7060 "#include E<lt>stdarg.hE<gt>\n"
7064 #: build/C/man3/printf.3:1041
7068 "make_message(const char *fmt, ...)\n"
7071 " int size = 100; /* Guess we need no more than 100 bytes. */\n"
7077 #: build/C/man3/printf.3:1044
7080 " if ((p = malloc(size)) == NULL)\n"
7085 #: build/C/man3/printf.3:1046
7087 msgid " while (1) {\n"
7091 #: build/C/man3/printf.3:1048
7093 msgid " /* Try to print in the allocated space. */\n"
7097 #: build/C/man3/printf.3:1052
7100 " va_start(ap, fmt);\n"
7101 " n = vsnprintf(p, size, fmt, ap);\n"
7106 #: build/C/man3/printf.3:1054
7108 msgid " /* If that worked, return the string. */\n"
7112 #: build/C/man3/printf.3:1057
7115 " if (n E<gt> -1 && n E<lt> size)\n"
7120 #: build/C/man3/printf.3:1059
7122 msgid " /* Else try again with more space. */\n"
7126 #: build/C/man3/printf.3:1064
7129 " if (n E<gt> -1) /* glibc 2.1 */\n"
7130 " size = n+1; /* precisely what is needed */\n"
7131 " else /* glibc 2.0 */\n"
7132 " size *= 2; /* twice the old size */\n"
7136 #: build/C/man3/printf.3:1073
7139 " if ((np = realloc (p, size)) == NULL) {\n"
7150 #: build/C/man3/printf.3:1082
7152 "B<printf>(1), B<asprintf>(3), B<dprintf>(3), B<scanf>(3), B<setlocale>(3), "
7153 "B<wcrtomb>(3), B<wprintf>(3), B<locale>(5)"
7157 #: build/C/man3/puts.3:24
7163 #: build/C/man3/puts.3:27
7164 msgid "fputc, fputs, putc, putchar, puts - output of characters and strings"
7168 #: build/C/man3/puts.3:32
7170 msgid "B<int fputc(int >I<c>B<, FILE *>I<stream>B<);>\n"
7174 #: build/C/man3/puts.3:34
7176 msgid "B<int fputs(const char *>I<s>B<, FILE *>I<stream>B<);>\n"
7180 #: build/C/man3/puts.3:36
7182 msgid "B<int putc(int >I<c>B<, FILE *>I<stream>B<);>\n"
7186 #: build/C/man3/puts.3:38
7188 msgid "B<int putchar(int >I<c>B<);>\n"
7192 #: build/C/man3/puts.3:40
7194 msgid "B<int puts(const char *>I<s>B<);>\n"
7198 #: build/C/man3/puts.3:49
7200 "B<fputc>() writes the character I<c>, cast to an I<unsigned char>, to "
7205 #: build/C/man3/puts.3:56
7207 "B<fputs>() writes the string I<s> to I<stream>, without its terminating "
7208 "null byte (\\(aq\\e0\\(aq)."
7212 #: build/C/man3/puts.3:63
7214 "B<putc>() is equivalent to B<fputc>() except that it may be implemented as "
7215 "a macro which evaluates I<stream> more than once."
7219 #: build/C/man3/puts.3:67
7220 msgid "B<putchar(>I<c>B<);> is equivalent to B<putc(>I<c>B<,>I<stdout>B<).>"
7224 #: build/C/man3/puts.3:74
7225 msgid "B<puts>() writes the string I<s> and a trailing newline to I<stdout>."
7229 #: build/C/man3/puts.3:79
7231 "Calls to the functions described here can be mixed with each other and with "
7232 "calls to other output functions from the I<stdio> library for the same "
7237 #: build/C/man3/puts.3:94
7239 "B<fputc>(), B<putc>() and B<putchar>() return the character written as an "
7240 "I<unsigned char> cast to an I<int> or B<EOF> on error."
7244 #: build/C/man3/puts.3:101
7246 "B<puts>() and B<fputs>() return a nonnegative number on success, or B<EOF> "
7251 #: build/C/man3/puts.3:110
7253 "It is not advisable to mix calls to output functions from the I<stdio> "
7254 "library with low-level calls to B<write>(2) for the file descriptor "
7255 "associated with the same output stream; the results will be undefined and "
7256 "very probably not what you want."
7260 #: build/C/man3/puts.3:121
7262 "B<write>(2), B<ferror>(3), B<fopen>(3), B<fputwc>(3), B<fputws>(3), "
7263 "B<fseek>(3), B<fwrite>(3), B<gets>(3), B<putwchar>(3), B<scanf>(3), "
7264 "B<unlocked_stdio>(3)"
7268 #: build/C/man2/read.2:35
7274 #: build/C/man2/read.2:38
7275 msgid "read - read from a file descriptor"
7279 #: build/C/man2/read.2:43
7281 msgid "B<ssize_t read(int >I<fd>B<, void *>I<buf>B<, size_t >I<count>B<);>\n"
7285 #: build/C/man2/read.2:52
7287 "B<read>() attempts to read up to I<count> bytes from file descriptor I<fd> "
7288 "into the buffer starting at I<buf>."
7292 #: build/C/man2/read.2:63
7294 "If I<count> is zero, B<read>() returns zero and has no other results. If "
7295 "I<count> is greater than B<SSIZE_MAX>, the result is unspecified."
7299 #: build/C/man2/read.2:77
7301 "On success, the number of bytes read is returned (zero indicates end of "
7302 "file), and the file position is advanced by this number. It is not an error "
7303 "if this number is smaller than the number of bytes requested; this may "
7304 "happen for example because fewer bytes are actually available right now "
7305 "(maybe because we were close to end-of-file, or because we are reading from "
7306 "a pipe, or from a terminal), or because B<read>() was interrupted by a "
7307 "signal. On error, -1 is returned, and I<errno> is set appropriately. In "
7308 "this case it is left unspecified whether the file position (if any) changes."
7312 #: build/C/man2/read.2:78 build/C/man3/scanf.3:546 build/C/man2/write.2:108
7318 #: build/C/man2/read.2:85
7320 "The file descriptor I<fd> refers to a file other than a socket and has been "
7321 "marked nonblocking (B<O_NONBLOCK>), and the read would block."
7325 #: build/C/man2/read.2:85 build/C/man2/write.2:115
7327 msgid "B<EAGAIN> or B<EWOULDBLOCK>"
7330 #. Actually EAGAIN on Linux
7332 #: build/C/man2/read.2:96
7334 "The file descriptor I<fd> refers to a socket and has been marked nonblocking "
7335 "(B<O_NONBLOCK>), and the read would block. POSIX.1-2001 allows either error "
7336 "to be returned for this case, and does not require these constants to have "
7337 "the same value, so a portable application should check for both "
7342 #: build/C/man2/read.2:100
7343 msgid "I<fd> is not a valid file descriptor or is not open for reading."
7347 #: build/C/man2/read.2:104 build/C/man2/write.2:139
7348 msgid "I<buf> is outside your accessible address space."
7352 #: build/C/man2/read.2:108
7354 "The call was interrupted by a signal before any data was read; see "
7359 #: build/C/man2/read.2:119
7361 "I<fd> is attached to an object which is unsuitable for reading; or the file "
7362 "was opened with the B<O_DIRECT> flag, and either the address specified in "
7363 "I<buf>, the value specified in I<count>, or the current file offset is not "
7368 #: build/C/man2/read.2:129
7370 "I<fd> was created via a call to B<timerfd_create>(2) and the wrong size "
7371 "buffer was given to B<read>(); see B<timerfd_create>(2) for further "
7376 #: build/C/man2/read.2:140
7378 "I/O error. This will happen for example when the process is in a background "
7379 "process group, tries to read from its controlling tty, and either it is "
7380 "ignoring or blocking B<SIGTTIN> or its process group is orphaned. It may "
7381 "also occur when there is a low-level I/O error while reading from a disk or "
7386 #: build/C/man2/read.2:144
7387 msgid "I<fd> refers to a directory."
7391 #: build/C/man2/read.2:155
7393 "Other errors may occur, depending on the object connected to I<fd>. POSIX "
7394 "allows a B<read>() that is interrupted after reading some data to return -1 "
7395 "(with I<errno> set to B<EINTR>) or to return the number of bytes already "
7400 #: build/C/man2/read.2:169
7402 "On NFS file systems, reading small amounts of data will only update the "
7403 "timestamp the first time, subsequent calls may not do so. This is caused by "
7404 "client side attribute caching, because most if not all NFS clients leave "
7405 "st_atime (last file access time) updates to the server and client side "
7406 "reads satisfied from the client's cache will not cause st_atime updates on "
7407 "the server as there are no server side reads. UNIX semantics can be "
7408 "obtained by disabling client side attribute caching, but in most situations "
7409 "this will substantially increase server load and decrease performance."
7413 #: build/C/man2/read.2:178
7415 "Many file systems and disks were considered to be fast enough that the "
7416 "implementation of B<O_NONBLOCK> was deemed unnecessary. So, B<O_NONBLOCK> "
7417 "may not be available on files and/or disks."
7421 #: build/C/man2/read.2:190
7423 "B<close>(2), B<fcntl>(2), B<ioctl>(2), B<lseek>(2), B<open>(2), B<pread>(2), "
7424 "B<readdir>(2), B<readlink>(2), B<readv>(2), B<select>(2), B<write>(2), "
7429 #: build/C/man2/readlink.2:41
7435 #: build/C/man2/readlink.2:41
7441 #: build/C/man2/readlink.2:44
7442 msgid "readlink - read value of a symbolic link"
7446 #: build/C/man2/readlink.2:48
7448 "B<ssize_t readlink(const char *>I<path>B<, char *>I<buf>B<, size_t "
7453 #: build/C/man2/readlink.2:56
7454 msgid "B<readlink>():"
7458 #: build/C/man2/readlink.2:59 build/C/man2/symlink.2:50
7460 "_BSD_SOURCE || _XOPEN_SOURCE\\ E<gt>=\\ 500 || _XOPEN_SOURCE\\ &&\\ "
7461 "_XOPEN_SOURCE_EXTENDED || _POSIX_C_SOURCE\\ E<gt>=\\ 200112L"
7465 #: build/C/man2/readlink.2:75
7467 "B<readlink>() places the contents of the symbolic link I<path> in the "
7468 "buffer I<buf>, which has size I<bufsiz>. B<readlink>() does not append a "
7469 "null byte to I<buf>. It will truncate the contents (to a length of "
7470 "I<bufsiz> characters), in case the buffer is too small to hold all of the "
7475 #: build/C/man2/readlink.2:83
7477 "On success, B<readlink>() returns the number of bytes placed in I<buf>. On "
7478 "error, -1 is returned and I<errno> is set to indicate the error."
7482 #: build/C/man2/readlink.2:89
7484 "Search permission is denied for a component of the path prefix. (See also "
7485 "B<path_resolution>(7).)"
7489 #: build/C/man2/readlink.2:93
7490 msgid "I<buf> extends outside the process's allocated address space."
7493 #. At the glibc level, bufsiz is unsigned, so this error can only occur
7494 #. if bufsiz==0. However, the in the kernel syscall, bufsiz is signed,
7495 #. and this error can also occur if bufsiz < 0.
7496 #. See: http://thread.gmane.org/gmane.linux.man/380
7497 #. Subject: [patch 0/3] [RFC] kernel/glibc mismatch of "readlink" syscall?
7499 #: build/C/man2/readlink.2:102
7500 msgid "I<bufsiz> is not positive."
7504 #: build/C/man2/readlink.2:105
7505 msgid "The named file is not a symbolic link."
7509 #: build/C/man2/readlink.2:108
7510 msgid "An I/O error occurred while reading from the file system."
7514 #: build/C/man2/readlink.2:111
7515 msgid "Too many symbolic links were encountered in translating the pathname."
7519 #: build/C/man2/readlink.2:114
7520 msgid "A pathname, or a component of a pathname, was too long."
7524 #: build/C/man2/readlink.2:117
7525 msgid "The named file does not exist."
7529 #: build/C/man2/readlink.2:123
7530 msgid "A component of the path prefix is not a directory."
7534 #: build/C/man2/readlink.2:128
7535 msgid "4.4BSD (B<readlink>() first appeared in 4.2BSD), POSIX.1-2001."
7539 #: build/C/man2/readlink.2:136
7541 "In versions of glibc up to and including glibc 2.4, the return type of "
7542 "B<readlink>() was declared as I<int>. Nowadays, the return type is "
7543 "declared as I<ssize_t>, as (newly) required in POSIX.1-2001."
7547 #: build/C/man2/readlink.2:155
7549 "Using a statically sized buffer might not provide enough room for the "
7550 "symbolic link contents. The required size for the buffer can be obtained "
7551 "from the I<stat.st_size> value returned by a call to B<lstat>(2) on the "
7552 "link. However, the number of bytes written by B<readlink>() should be "
7553 "checked to make sure that the size of the symbolic link did not increase "
7554 "between the calls. Dynamically allocating the buffer for B<readlink>() "
7555 "also addresses a common portability problem when using I<PATH_MAX> for the "
7556 "buffer size, as this constant is not guaranteed to be defined per POSIX if "
7557 "the system does not have such limit."
7561 #: build/C/man2/readlink.2:161
7563 "The following program allocates the buffer needed by B<readlink>() "
7564 "dynamically from the information provided by B<lstat>(), making sure there's "
7565 "no race condition between the calls."
7569 #: build/C/man2/readlink.2:168
7572 "#include E<lt>sys/types.hE<gt>\n"
7573 "#include E<lt>sys/stat.hE<gt>\n"
7574 "#include E<lt>stdio.hE<gt>\n"
7575 "#include E<lt>stdlib.hE<gt>\n"
7576 "#include E<lt>unistd.hE<gt>\n"
7580 #: build/C/man2/readlink.2:175
7584 "main(int argc, char *argv[])\n"
7586 " struct stat sb;\n"
7587 " char *linkname;\n"
7592 #: build/C/man2/readlink.2:180
7595 " if (argc != 2) {\n"
7596 " fprintf(stderr, \"Usage: %s E<lt>pathnameE<gt>\\en\", argv[0]);\n"
7597 " exit(EXIT_FAILURE);\n"
7602 #: build/C/man2/readlink.2:185
7605 " if (lstat(argv[1], &sb) == -1) {\n"
7606 " perror(\"lstat\");\n"
7607 " exit(EXIT_FAILURE);\n"
7612 #: build/C/man2/readlink.2:191
7615 " linkname = malloc(sb.st_size + 1);\n"
7616 " if (linkname == NULL) {\n"
7617 " fprintf(stderr, \"insufficient memory\\en\");\n"
7618 " exit(EXIT_FAILURE);\n"
7623 #: build/C/man2/readlink.2:193
7625 msgid " r = readlink(argv[1], linkname, sb.st_size + 1);\n"
7629 #: build/C/man2/readlink.2:198
7632 " if (r E<lt> 0) {\n"
7633 " perror(\"lstat\");\n"
7634 " exit(EXIT_FAILURE);\n"
7639 #: build/C/man2/readlink.2:204
7642 " if (r E<gt> sb.st_size) {\n"
7643 " fprintf(stderr, \"symlink increased in size \"\n"
7644 " \"between lstat() and readlink()\\en\");\n"
7645 " exit(EXIT_FAILURE);\n"
7650 #: build/C/man2/readlink.2:206
7652 msgid " linkname[sb.st_size] = \\(aq\\e0\\(aq;\n"
7656 #: build/C/man2/readlink.2:208
7659 " printf(\"\\(aq%s\\(aq points to \\(aq%s\\(aq\\en\", argv[1], "
7664 #: build/C/man2/readlink.2:219
7666 "B<readlink>(1), B<lstat>(2), B<readlinkat>(2), B<stat>(2), B<symlink>(2), "
7667 "B<path_resolution>(7), B<symlink>(7)"
7671 #: build/C/man2/readv.2:30
7677 #: build/C/man2/readv.2:30
7683 #: build/C/man2/readv.2:33
7684 msgid "readv, writev, preadv, pwritev - read or write data into multiple buffers"
7688 #: build/C/man2/readv.2:36
7690 msgid "B<#include E<lt>sys/uio.hE<gt>>\n"
7694 #: build/C/man2/readv.2:38
7697 "B<ssize_t readv(int >I<fd>B<, const struct iovec *>I<iov>B<, int "
7702 #: build/C/man2/readv.2:40
7705 "B<ssize_t writev(int >I<fd>B<, const struct iovec *>I<iov>B<, int "
7710 #: build/C/man2/readv.2:43
7713 "B<ssize_t preadv(int >I<fd>B<, const struct iovec *>I<iov>B<, int "
7715 "B< off_t >I<offset>B<);>\n"
7719 #: build/C/man2/readv.2:46
7722 "B<ssize_t pwritev(int >I<fd>B<, const struct iovec *>I<iov>B<, int "
7724 "B< off_t >I<offset>B<);>\n"
7728 #: build/C/man2/readv.2:56
7729 msgid "B<preadv>(), B<pwritev>(): _BSD_SOURCE"
7733 #: build/C/man2/readv.2:66
7735 "The B<readv>() system call reads I<iovcnt> buffers from the file associated "
7736 "with the file descriptor I<fd> into the buffers described by I<iov> "
7737 "(\"scatter input\")."
7741 #: build/C/man2/readv.2:76
7743 "The B<writev>() system call writes I<iovcnt> buffers of data described by "
7744 "I<iov> to the file associated with the file descriptor I<fd> (\"gather "
7749 #: build/C/man2/readv.2:85
7751 "The pointer I<iov> points to an array of I<iovec> structures, defined in "
7752 "I<E<lt>sys/uio.hE<gt>> as:"
7756 #: build/C/man2/readv.2:93
7760 " void *iov_base; /* Starting address */\n"
7761 " size_t iov_len; /* Number of bytes to transfer */\n"
7766 #: build/C/man2/readv.2:101
7768 "The B<readv>() system call works just like B<read>(2) except that multiple "
7769 "buffers are filled."
7773 #: build/C/man2/readv.2:107
7775 "The B<writev>() system call works just like B<write>(2) except that "
7776 "multiple buffers are written out."
7780 #: build/C/man2/readv.2:126
7782 "Buffers are processed in array order. This means that B<readv>() "
7783 "completely fills I<iov>[0] before proceeding to I<iov>[1], and so on. (If "
7784 "there is insufficient data, then not all buffers pointed to by I<iov> may be "
7785 "filled.) Similarly, B<writev>() writes out the entire contents of "
7786 "I<iov>[0] before proceeding to I<iov>[1], and so on."
7790 #: build/C/man2/readv.2:144
7792 "The data transfers performed by B<readv>() and B<writev>() are atomic: the "
7793 "data written by B<writev>() is written as a single block that is not "
7794 "intermingled with output from writes in other processes (but see B<pipe>(7) "
7795 "for an exception); analogously, B<readv>() is guaranteed to read a "
7796 "contiguous block of data from the file, regardless of read operations "
7797 "performed in other threads or processes that have file descriptors referring "
7798 "to the same open file description (see B<open>(2))."
7802 #: build/C/man2/readv.2:144
7804 msgid "preadv() and pwritev()"
7808 #: build/C/man2/readv.2:157
7810 "The B<preadv>() system call combines the functionality of B<readv>() and "
7811 "B<pread>(2). It performs the same task as B<readv>(), but adds a fourth "
7812 "argument, I<offset>, which specifies the file offset at which the input "
7813 "operation is to be performed."
7817 #: build/C/man2/readv.2:170
7819 "The B<pwritev>() system call combines the functionality of B<writev>() and "
7820 "B<pwrite>(2). It performs the same task as B<writev>(), but adds a fourth "
7821 "argument, I<offset>, which specifies the file offset at which the output "
7822 "operation is to be performed."
7826 #: build/C/man2/readv.2:175
7828 "The file offset is not changed by these system calls. The file referred to "
7829 "by I<fd> must be capable of seeking."
7833 #: build/C/man2/readv.2:186
7835 "On success, B<readv>() and B<preadv>() return the number of bytes read; "
7836 "B<writev>() and B<pwritev>() return the number of bytes written. On "
7837 "error, -1 is returned, and I<errno> is set appropriately."
7841 #: build/C/man2/readv.2:198
7843 "The errors are as given for B<read>(2) and B<write>(2). Furthermore, "
7844 "B<preadv>() and B<pwritev>() can also fail for the same reasons as "
7845 "B<lseek>(2). Additionally, the following error is defined:"
7849 #: build/C/man2/readv.2:207
7851 "The sum of the I<iov_len> values overflows an I<ssize_t> value. Or, the "
7852 "vector count I<iovcnt> is less than zero or greater than the permitted "
7857 #: build/C/man2/readv.2:212
7859 "B<preadv>() and B<pwritev>() first appeared in Linux 2.6.30; library "
7860 "support was added in glibc 2.10."
7863 #. The readv/writev system calls were buggy before Linux 1.3.40.
7864 #. (Says release.libc.)
7866 #: build/C/man2/readv.2:220
7868 "B<readv>(), B<writev>(): 4.4BSD (these system calls first appeared in "
7869 "4.2BSD), POSIX.1-2001. Linux libc5 used I<size_t> as the type of the "
7870 "I<iovcnt> argument, and I<int> as the return type."
7874 #: build/C/man2/readv.2:224
7875 msgid "B<preadv>(), B<pwritev>(): nonstandard, but present also on the modern BSDs."
7879 #: build/C/man2/readv.2:225
7885 #: build/C/man2/readv.2:256
7887 "POSIX.1-2001 allows an implementation to place a limit on the number of "
7888 "items that can be passed in I<iov>. An implementation can advertise its "
7889 "limit by defining B<IOV_MAX> in I<E<lt>limits.hE<gt>> or at run time via the "
7890 "return value from I<sysconf(_SC_IOV_MAX)>. On Linux, the limit advertised "
7891 "by these mechanisms is 1024, which is the true kernel limit. However, the "
7892 "glibc wrapper functions do some extra work if they detect that the "
7893 "underlying kernel system call failed because this limit was exceeded. In "
7894 "the case of B<readv>() the wrapper function allocates a temporary buffer "
7895 "large enough for all of the items specified by I<iov>, passes that buffer in "
7896 "a call to B<read>(2), copies data from the buffer to the locations specified "
7897 "by the I<iov_base> fields of the elements of I<iov>, and then frees the "
7898 "buffer. The wrapper function for B<writev>() performs the analogous task "
7899 "using a temporary buffer and a call to B<write>(2)."
7903 #: build/C/man2/readv.2:263
7905 "It is not advisable to mix calls to B<readv>() or B<writev>(), which "
7906 "operate on file descriptors, with the functions from the stdio library; the "
7907 "results will be undefined and probably not what you want."
7911 #: build/C/man2/readv.2:266
7912 msgid "The following code sample demonstrates the use of B<writev>():"
7916 #: build/C/man2/readv.2:273
7919 "char *str0 = \"hello \";\n"
7920 "char *str1 = \"world\\en\";\n"
7921 "struct iovec iov[2];\n"
7922 "ssize_t nwritten;\n"
7926 #: build/C/man2/readv.2:278
7929 "iov[0].iov_base = str0;\n"
7930 "iov[0].iov_len = strlen(str0);\n"
7931 "iov[1].iov_base = str1;\n"
7932 "iov[1].iov_len = strlen(str1);\n"
7936 #: build/C/man2/readv.2:280
7938 msgid "nwritten = writev(STDOUT_FILENO, iov, 2);\n"
7942 #: build/C/man2/readv.2:285
7943 msgid "B<pread>(2), B<read>(2), B<write>(2)"
7947 #: build/C/man3/remove.3:31
7953 #: build/C/man3/remove.3:31
7959 #: build/C/man3/remove.3:34
7960 msgid "remove - remove a file or directory"
7964 #: build/C/man3/remove.3:38
7965 msgid "B<int remove(const char *>I<pathname>B<);>"
7969 #: build/C/man3/remove.3:46
7971 "B<remove>() deletes a name from the file system. It calls B<unlink>(2) "
7972 "for files, and B<rmdir>(2) for directories."
7976 #: build/C/man3/remove.3:50
7978 "If the removed name was the last link to a file and no processes have the "
7979 "file open, the file is deleted and the space it was using is made available "
7984 #: build/C/man3/remove.3:55
7986 "If the name was the last link to a file, but any processes still have the "
7987 "file open, the file will remain in existence until the last file descriptor "
7988 "referring to it is closed."
7992 #: build/C/man3/remove.3:57
7993 msgid "If the name referred to a symbolic link, the link is removed."
7997 #: build/C/man3/remove.3:60
7999 "If the name referred to a socket, FIFO, or device, the name is removed, but "
8000 "processes which have the object open may continue to use it."
8004 #: build/C/man3/remove.3:70
8005 msgid "The errors that occur are those for B<unlink>(2) and B<rmdir>(2)."
8009 #: build/C/man3/remove.3:72
8010 msgid "C89, C99, 4.3BSD, POSIX.1-2001."
8014 #: build/C/man3/remove.3:78
8016 "Under libc4 and libc5, B<remove>() was an alias for B<unlink>(2) (and "
8017 "hence would not remove directories)."
8021 #: build/C/man3/remove.3:81 build/C/man2/unlink.2:148
8023 "Infelicities in the protocol underlying NFS can cause the unexpected "
8024 "disappearance of files which are still being used."
8028 #: build/C/man3/remove.3:91
8030 "B<rm>(1), B<unlink>(1), B<link>(2), B<mknod>(2), B<open>(2), B<rename>(2), "
8031 "B<rmdir>(2), B<unlink>(2), B<mkfifo>(3), B<symlink>(7)"
8035 #: build/C/man2/rename.2:32
8041 #: build/C/man2/rename.2:32
8047 #: build/C/man2/rename.2:35
8048 msgid "rename - change the name or location of a file"
8052 #: build/C/man2/rename.2:39
8053 msgid "B<int rename(const char *>I<oldpath>B<, const char *>I<newpath>B<);>"
8057 #: build/C/man2/rename.2:48
8059 "B<rename>() renames a file, moving it between directories if required. Any "
8060 "other hard links to the file (as created using B<link>(2)) are unaffected. "
8061 "Open file descriptors for I<oldpath> are also unaffected."
8065 #: build/C/man2/rename.2:56
8067 "If I<newpath> already exists it will be atomically replaced (subject to a "
8068 "few conditions; see ERRORS below), so that there is no point at which "
8069 "another process attempting to access I<newpath> will find it missing."
8073 #: build/C/man2/rename.2:64
8075 "If I<oldpath> and I<newpath> are existing hard links referring to the same "
8076 "file, then B<rename>() does nothing, and returns a success status."
8080 #: build/C/man2/rename.2:72
8082 "If I<newpath> exists but the operation fails for some reason B<rename>() "
8083 "guarantees to leave an instance of I<newpath> in place."
8087 #: build/C/man2/rename.2:78
8089 "I<oldpath> can specify a directory. In this case, I<newpath> must either "
8090 "not exist, or it must specify an empty directory."
8094 #: build/C/man2/rename.2:85
8096 "However, when overwriting there will probably be a window in which both "
8097 "I<oldpath> and I<newpath> refer to the file being renamed."
8101 #: build/C/man2/rename.2:91
8103 "If I<oldpath> refers to a symbolic link the link is renamed; if I<newpath> "
8104 "refers to a symbolic link the link will be overwritten."
8108 #: build/C/man2/rename.2:116
8110 "Write permission is denied for the directory containing I<oldpath> or "
8111 "I<newpath>, or, search permission is denied for one of the directories in "
8112 "the path prefix of I<oldpath> or I<newpath>, or I<oldpath> is a directory "
8113 "and does not allow write permission (needed to update the I<..> entry). "
8114 "(See also B<path_resolution>(7).)"
8118 #: build/C/man2/rename.2:116 build/C/man2/rmdir.2:55 build/C/man2/unlink.2:71
8124 #: build/C/man2/rename.2:133
8126 "The rename fails because I<oldpath> or I<newpath> is a directory that is in "
8127 "use by some process (perhaps as current working directory, or as root "
8128 "directory, or because it was open for reading) or is in use by the system "
8129 "(for example as mount point), while the system considers this an error. "
8130 "(Note that there is no requirement to return B<EBUSY> in such "
8131 "cases\\(emthere is nothing wrong with doing the rename anyway\\(embut it is "
8132 "allowed to return B<EBUSY> if the system cannot otherwise handle such "
8137 #: build/C/man2/rename.2:140
8139 "The new pathname contained a path prefix of the old, or, more generally, an "
8140 "attempt was made to make a directory a subdirectory of itself."
8144 #: build/C/man2/rename.2:146
8145 msgid "I<newpath> is an existing directory, but I<oldpath> is not a directory."
8149 #: build/C/man2/rename.2:157
8151 "I<oldpath> already has the maximum number of links to it, or it was a "
8152 "directory and the directory containing I<newpath> has the maximum number of "
8157 #: build/C/man2/rename.2:173
8159 "The link named by I<oldpath> does not exist; or, a directory component in "
8160 "I<newpath> does not exist; or, I<oldpath> or I<newpath> is an empty string."
8164 #: build/C/man2/rename.2:190
8166 "A component used as a directory in I<oldpath> or I<newpath> is not, in fact, "
8167 "a directory. Or, I<oldpath> is a directory, and I<newpath> exists but is "
8172 #: build/C/man2/rename.2:190
8174 msgid "B<ENOTEMPTY> or B<EEXIST>"
8178 #: build/C/man2/rename.2:194
8180 "I<newpath> is a nonempty directory, that is, contains entries other than "
8185 #: build/C/man2/rename.2:194 build/C/man2/unlink.2:126
8187 msgid "B<EPERM> or B<EACCES>"
8191 #: build/C/man2/rename.2:218
8193 "The directory containing I<oldpath> has the sticky bit (B<S_ISVTX>) set and "
8194 "the process's effective user ID is neither the user ID of the file to be "
8195 "deleted nor that of the directory containing it, and the process is not "
8196 "privileged (Linux: does not have the B<CAP_FOWNER> capability); or "
8197 "I<newpath> is an existing file and the directory containing it has the "
8198 "sticky bit set and the process's effective user ID is neither the user ID of "
8199 "the file to be replaced nor that of the directory containing it, and the "
8200 "process is not privileged (Linux: does not have the B<CAP_FOWNER> "
8201 "capability); or the file system containing I<pathname> does not support "
8202 "renaming of the type requested."
8206 #: build/C/man2/rename.2:229
8208 "I<oldpath> and I<newpath> are not on the same mounted file system. (Linux "
8209 "permits a file system to be mounted at multiple points, but B<rename>() "
8210 "does not work across different mount points, even if the same file system is "
8215 #: build/C/man2/rename.2:231
8216 msgid "4.3BSD, C89, C99, POSIX.1-2001."
8220 #: build/C/man2/rename.2:242
8222 "On NFS file systems, you can not assume that if the operation failed the "
8223 "file was not renamed. If the server does the rename operation and then "
8224 "crashes, the retransmitted RPC which will be processed when the server is up "
8225 "again causes a failure. The application is expected to deal with this. See "
8226 "B<link>(2) for a similar problem."
8230 #: build/C/man2/rename.2:250
8232 "B<mv>(1), B<chmod>(2), B<link>(2), B<renameat>(2), B<symlink>(2), "
8233 "B<unlink>(2), B<path_resolution>(7), B<symlink>(7)"
8237 #: build/C/man2/rmdir.2:30
8243 #: build/C/man2/rmdir.2:30
8249 #: build/C/man2/rmdir.2:33
8250 msgid "rmdir - delete a directory"
8254 #: build/C/man2/rmdir.2:37
8255 msgid "B<int rmdir(const char *>I<pathname>B<);>"
8259 #: build/C/man2/rmdir.2:40
8260 msgid "B<rmdir>() deletes a directory, which must be empty."
8264 #: build/C/man2/rmdir.2:55
8266 "Write access to the directory containing I<pathname> was not allowed, or one "
8267 "of the directories in the path prefix of I<pathname> did not allow search "
8268 "permission. (See also B<path_resolution>(7)."
8272 #: build/C/man2/rmdir.2:64
8274 "I<pathname> is currently in use by the system or some process that prevents "
8275 "its removal. On Linux this means I<pathname> is currently used as a mount "
8276 "point or is the root directory of the calling process."
8280 #: build/C/man2/rmdir.2:73
8281 msgid "I<pathname> has I<.> as last component."
8285 #: build/C/man2/rmdir.2:77
8286 msgid "Too many symbolic links were encountered in resolving I<pathname>."
8290 #: build/C/man2/rmdir.2:85
8292 "A directory component in I<pathname> does not exist or is a dangling "
8297 #: build/C/man2/rmdir.2:94
8299 "I<pathname>, or a component used as a directory in I<pathname>, is not, in "
8300 "fact, a directory."
8304 #: build/C/man2/rmdir.2:94
8306 msgid "B<ENOTEMPTY>"
8310 #: build/C/man2/rmdir.2:107
8312 "I<pathname> contains entries other than I<.> and I<..> ; or, I<pathname> has "
8313 "I<..> as its final component. POSIX.1-2001 also allows B<EEXIST> for this "
8318 #: build/C/man2/rmdir.2:118
8320 "The directory containing I<pathname> has the sticky bit (B<S_ISVTX>) set "
8321 "and the process's effective user ID is neither the user ID of the file to be "
8322 "deleted nor that of the directory containing it, and the process is not "
8323 "privileged (Linux: does not have the B<CAP_FOWNER> capability)."
8327 #: build/C/man2/rmdir.2:123
8329 "The file system containing I<pathname> does not support the removal of "
8334 #: build/C/man2/rmdir.2:127
8335 msgid "I<pathname> refers to a directory on a read-only file system."
8339 #: build/C/man2/rmdir.2:132
8341 "Infelicities in the protocol underlying NFS can cause the unexpected "
8342 "disappearance of directories which are still being used."
8346 #: build/C/man2/rmdir.2:140
8348 "B<rm>(1), B<rmdir>(1), B<chdir>(2), B<chmod>(2), B<mkdir>(2), B<rename>(2), "
8349 "B<unlink>(2), B<unlinkat>(2)"
8353 #: build/C/man3/scanf.3:50
8359 #: build/C/man3/scanf.3:53
8360 msgid "scanf, fscanf, sscanf, vscanf, vsscanf, vfscanf - input format conversion"
8364 #: build/C/man3/scanf.3:60
8367 "B<int scanf(const char *>I<format>B<, ...);>\n"
8368 "B<int fscanf(FILE *>I<stream>B<, const char *>I<format>B<, ...);>\n"
8369 "B<int sscanf(const char *>I<str>B<, const char *>I<format>B<, ...);>\n"
8373 #: build/C/man3/scanf.3:62
8375 msgid "B<#include E<lt>stdarg.hE<gt>>\n"
8379 #: build/C/man3/scanf.3:66
8382 "B<int vscanf(const char *>I<format>B<, va_list >I<ap>B<);>\n"
8383 "B<int vsscanf(const char *>I<str>B<, const char *>I<format>B<, va_list "
8385 "B<int vfscanf(FILE *>I<stream>B<, const char *>I<format>B<, va_list "
8390 #: build/C/man3/scanf.3:77
8391 msgid "B<vscanf>(), B<vsscanf>(), B<vfscanf>():"
8395 #: build/C/man3/scanf.3:80
8397 "_XOPEN_SOURCE\\ E<gt>=\\ 600 || _ISOC99_SOURCE || _POSIX_C_SOURCE\\ E<gt>=\\ "
8402 #: build/C/man3/scanf.3:102
8404 "The B<scanf>() family of functions scans input according to I<format> as "
8405 "described below. This format may contain I<conversion specifications>; the "
8406 "results from such conversions, if any, are stored in the locations pointed "
8407 "to by the I<pointer> arguments that follow I<format>. Each I<pointer> "
8408 "argument must be of a type that is appropriate for the value returned by the "
8409 "corresponding conversion specification."
8413 #: build/C/man3/scanf.3:113
8415 "If the number of conversion specifications in I<format> exceeds the number "
8416 "of I<pointer> arguments, the results are undefined. If the number of "
8417 "I<pointer> arguments exceeds the number of conversion specifications, then "
8418 "the excess I<pointer> arguments are evaluated, but are otherwise ignored."
8422 #: build/C/man3/scanf.3:125
8424 "The B<scanf>() function reads input from the standard input stream "
8425 "I<stdin>, B<fscanf>() reads input from the stream pointer I<stream>, and "
8426 "B<sscanf>() reads its input from the character string pointed to by I<str>."
8430 #: build/C/man3/scanf.3:143
8432 "The B<vfscanf>() function is analogous to B<vfprintf>(3) and reads input "
8433 "from the stream pointer I<stream> using a variable argument list of pointers "
8434 "(see B<stdarg>(3). The B<vscanf>() function scans a variable argument list "
8435 "from the standard input and the B<vsscanf>() function scans it from a "
8436 "string; these are analogous to the B<vprintf>(3) and B<vsprintf>(3) "
8437 "functions respectively."
8441 #: build/C/man3/scanf.3:157
8443 "The I<format> string consists of a sequence of I<directives> which describe "
8444 "how to process the sequence of input characters. If processing of a "
8445 "directive fails, no further input is read, and B<scanf>() returns. A "
8446 "\"failure\" can be either of the following: I<input failure>, meaning that "
8447 "input characters were unavailable, or I<matching failure>, meaning that the "
8448 "input was inappropriate (see below)."
8452 #: build/C/man3/scanf.3:159
8453 msgid "A directive is one of the following:"
8457 #: build/C/man3/scanf.3:159 build/C/man3/scanf.3:165 build/C/man3/scanf.3:169 build/C/man3/scanf.3:188 build/C/man3/scanf.3:199 build/C/man3/scanf.3:217 build/C/man3/scanf.3:229 build/C/man3/scanf.3:243
8463 #: build/C/man3/scanf.3:165
8465 "A sequence of white-space characters (space, tab, newline, etc.; see "
8466 "B<isspace>(3)). This directive matches any amount of white space, including "
8467 "none, in the input."
8471 #: build/C/man3/scanf.3:169
8473 "An ordinary character (i.e., one other than white space or \\(aq%\\(aq). "
8474 "This character must exactly match the next character of input."
8478 #: build/C/man3/scanf.3:180
8480 "A conversion specification, which commences with a \\(aq%\\(aq (percent) "
8481 "character. A sequence of characters from the input is converted according "
8482 "to this specification, and the result is placed in the corresponding "
8483 "I<pointer> argument. If the next item of input does not match the "
8484 "conversion specification, the conversion fails\\(emthis is a I<matching "
8489 #: build/C/man3/scanf.3:188
8491 "Each I<conversion specification> in I<format> begins with either the "
8492 "character \\(aq%\\(aq or the character sequence \"B<%>I<n>B<$>\" (see below "
8493 "for the distinction) followed by:"
8497 #: build/C/man3/scanf.3:199
8499 "An optional \\(aq*\\(aq assignment-suppression character: B<scanf>() reads "
8500 "input as directed by the conversion specification, but discards the input. "
8501 "No corresponding I<pointer> argument is required, and this specification is "
8502 "not included in the count of successful assignments returned by B<scanf>()."
8506 #: build/C/man3/scanf.3:217
8508 "An optional \\(aqa\\(aq character. This is used with string conversions, "
8509 "and relieves the caller of the need to allocate a corresponding buffer to "
8510 "hold the input: instead, B<scanf>() allocates a buffer of sufficient size, "
8511 "and assigns the address of this buffer to the corresponding I<pointer> "
8512 "argument, which should be a pointer to a I<char *> variable (this variable "
8513 "does not need to be initialized before the call). The caller should "
8514 "subsequently B<free>(3) this buffer when it is no longer required. This is "
8515 "a GNU extension; C99 employs the \\(aqa\\(aq character as a conversion "
8516 "specifier (and it can also be used as such in the GNU implementation)."
8520 #: build/C/man3/scanf.3:229
8522 "An optional decimal integer which specifies the I<maximum field width>. "
8523 "Reading of characters stops either when this maximum is reached or when a "
8524 "nonmatching character is found, whichever happens first. Most conversions "
8525 "discard initial white space characters (the exceptions are noted below), and "
8526 "these discarded characters don't count toward the maximum field width. "
8527 "String input conversions store a terminating null byte (\\(aq\\e0\\(aq) to "
8528 "mark the end of the input; the maximum field width does not include this "
8533 #: build/C/man3/scanf.3:243
8535 "An optional I<type modifier character>. For example, the B<l> type modifier "
8536 "is used with integer conversions such as B<%d> to specify that the "
8537 "corresponding I<pointer> argument refers to a I<long int> rather than a "
8538 "pointer to an I<int>."
8542 #: build/C/man3/scanf.3:248
8544 "A I<conversion specifier> that specifies the type of input conversion to be "
8549 #: build/C/man3/scanf.3:277
8551 "The conversion specifications in I<format> are of two forms, either "
8552 "beginning with \\(aq%\\(aq or beginning with \"B<%>I<n>B<$>\". The two "
8553 "forms should not be mixed in the same I<format> string, except that a string "
8554 "containing \"B<%>I<n>B<$>\" specifications can include B<%%> and B<%*>. If "
8555 "I<format> contains \\(aq%\\(aq specifications then these correspond in order "
8556 "with successive I<pointer> arguments. In the \"B<%>I<n>B<$>\" form (which "
8557 "is specified in POSIX.1-2001, but not C99), I<n> is a decimal integer that "
8558 "specifies that the converted input should be placed in the location referred "
8559 "to by the I<n>-th I<pointer> argument following I<format>."
8563 #: build/C/man3/scanf.3:277
8569 #: build/C/man3/scanf.3:281
8571 "The following I<type modifier characters> can appear in a conversion "
8576 #: build/C/man3/scanf.3:291
8578 "Indicates that the conversion will be one of B<d>, B<i>, B<o>, B<u>, B<x>, "
8579 "B<X>, or B<n> and the next pointer is a pointer to a I<short int> or "
8580 "I<unsigned short int> (rather than I<int>)."
8584 #: build/C/man3/scanf.3:299
8586 "As for B<h>, but the next pointer is a pointer to a I<signed char> or "
8591 #: build/C/man3/scanf.3:308
8593 "As for B<h>, but the next pointer is a pointer to an I<intmax_t> or a "
8594 "I<uintmax_t>. This modifier was introduced in C99."
8597 #. This use of l was introduced in Amendment 1 to ISO C90.
8599 #: build/C/man3/scanf.3:335
8601 "Indicates either that the conversion will be one of B<d>, B<i>, B<o>, B<u>, "
8602 "B<x>, B<X>, or B<n> and the next pointer is a pointer to a I<long int> or "
8603 "I<unsigned long int> (rather than I<int>), or that the conversion will be "
8604 "one of B<e>, B<f>, or B<g> and the next pointer is a pointer to I<double> "
8605 "(rather than I<float>). Specifying two B<l> characters is equivalent to "
8606 "B<L>. If used with B<%c> or B<%s> the corresponding parameter is considered "
8607 "as a pointer to a wide character or wide-character string respectively."
8610 #. MTK, Jul 05: The following is no longer true for modern
8611 #. ANSI C (i.e., C99):
8612 #. (Note that long long is not an
8614 #. type. Any program using this will not be portable to all
8617 #: build/C/man3/scanf.3:351
8619 "Indicates that the conversion will be either B<e>, B<f>, or B<g> and the "
8620 "next pointer is a pointer to I<long double> or the conversion will be B<d>, "
8621 "B<i>, B<o>, B<u>, or B<x> and the next pointer is a pointer to I<long long>."
8625 #: build/C/man3/scanf.3:356
8626 msgid "equivalent to B<L>. This specifier does not exist in ANSI C."
8630 #: build/C/man3/scanf.3:363
8632 "As for B<h>, but the next pointer is a pointer to a I<ptrdiff_t>. This "
8633 "modifier was introduced in C99."
8637 #: build/C/man3/scanf.3:370
8639 "As for B<h>, but the next pointer is a pointer to a I<size_t>. This "
8640 "modifier was introduced in C99."
8644 #: build/C/man3/scanf.3:374
8645 msgid "The following I<conversion specifiers> are available:"
8649 #: build/C/man3/scanf.3:383
8651 "Matches a literal \\(aq%\\(aq. That is, B<%\\&%> in the format string "
8652 "matches a single input \\(aq%\\(aq character. No conversion is done (but "
8653 "initial white space characters are discarded), and assignment does not "
8658 #: build/C/man3/scanf.3:383
8664 #: build/C/man3/scanf.3:388
8666 "Matches an optionally signed decimal integer; the next pointer must be a "
8667 "pointer to I<int>."
8671 #: build/C/man3/scanf.3:388
8677 #: build/C/man3/scanf.3:397
8679 "Equivalent to I<ld>; this exists only for backward compatibility. (Note: "
8680 "thus only in libc4. In libc5 and glibc the B<%D> is silently ignored, "
8681 "causing old programs to fail mysteriously.)"
8685 #: build/C/man3/scanf.3:397
8691 #: build/C/man3/scanf.3:409
8693 "Matches an optionally signed integer; the next pointer must be a pointer to "
8694 "I<int>. The integer is read in base 16 if it begins with I<0x> or I<0X>, in "
8695 "base 8 if it begins with I<0>, and in base 10 otherwise. Only characters "
8696 "that correspond to the base are used."
8700 #: build/C/man3/scanf.3:409
8706 #: build/C/man3/scanf.3:413
8708 "Matches an unsigned octal integer; the next pointer must be a pointer to "
8713 #: build/C/man3/scanf.3:413
8719 #: build/C/man3/scanf.3:418
8721 "Matches an unsigned decimal integer; the next pointer must be a pointer to "
8726 #: build/C/man3/scanf.3:423
8728 "Matches an unsigned hexadecimal integer; the next pointer must be a pointer "
8729 "to I<unsigned int>."
8733 #: build/C/man3/scanf.3:423
8739 #: build/C/man3/scanf.3:427
8740 msgid "Equivalent to B<x>."
8744 #: build/C/man3/scanf.3:427
8750 #: build/C/man3/scanf.3:432
8752 "Matches an optionally signed floating-point number; the next pointer must be "
8753 "a pointer to I<float>."
8757 #: build/C/man3/scanf.3:432
8763 #: build/C/man3/scanf.3:436 build/C/man3/scanf.3:440 build/C/man3/scanf.3:444
8764 msgid "Equivalent to B<f>."
8768 #: build/C/man3/scanf.3:436
8774 #: build/C/man3/scanf.3:440
8780 #: build/C/man3/scanf.3:448
8781 msgid "(C99) Equivalent to B<f>."
8785 #: build/C/man3/scanf.3:456
8787 "Matches a sequence of non-white-space characters; the next pointer must be a "
8788 "pointer to character array that is long enough to hold the input sequence "
8789 "and the terminating null byte (\\(aq\\e0\\(aq), which is added "
8790 "automatically. The input string stops at white space or at the maximum "
8791 "field width, whichever occurs first."
8795 #: build/C/man3/scanf.3:467
8797 "Matches a sequence of characters whose length is specified by the I<maximum "
8798 "field width> (default 1); the next pointer must be a pointer to I<char>, and "
8799 "there must be enough room for all the characters (no terminating null byte "
8800 "is added). The usual skip of leading white space is suppressed. To skip "
8801 "white space first, use an explicit space in the format."
8805 #: build/C/man3/scanf.3:467
8811 #: build/C/man3/scanf.3:500
8813 "Matches a nonempty sequence of characters from the specified set of accepted "
8814 "characters; the next pointer must be a pointer to I<char>, and there must be "
8815 "enough room for all the characters in the string, plus a terminating null "
8816 "byte. The usual skip of leading white space is suppressed. The string is "
8817 "to be made up of characters in (or not in) a particular set; the set is "
8818 "defined by the characters between the open bracket B<[> character and a "
8819 "close bracket B<]> character. The set I<excludes> those characters if the "
8820 "first character after the open bracket is a circumflex (B<^>). To include a "
8821 "close bracket in the set, make it the first character after the open bracket "
8822 "or the circumflex; any other position will end the set. The hyphen "
8823 "character B<-> is also special; when placed between two other characters, it "
8824 "adds all intervening characters to the set. To include a hyphen, make it "
8825 "the last character before the final close bracket. For instance, "
8826 "B<[^]0-9-]> means the set \"everything except close bracket, zero through "
8827 "nine, and hyphen\". The string ends with the appearance of a character not "
8828 "in the (or, with a circumflex, in) set or when the field width runs out."
8832 #: build/C/man3/scanf.3:508
8834 "Matches a pointer value (as printed by B<%p> in B<printf>(3); the next "
8835 "pointer must be a pointer to a pointer to I<void>."
8839 #: build/C/man3/scanf.3:528
8841 "Nothing is expected; instead, the number of characters consumed thus far "
8842 "from the input is stored through the next pointer, which must be a pointer "
8843 "to I<int>. This is I<not> a conversion, although it can be suppressed with "
8844 "the B<*> assignment-suppression character. The C standard says: \"Execution "
8845 "of a B<%n> directive does not increment the assignment count returned at the "
8846 "completion of execution\" but the Corrigendum seems to contradict this. "
8847 "Probably it is wise not to make any assumptions on the effect of B<%n> "
8848 "conversions on the return value."
8852 #: build/C/man3/scanf.3:533
8854 "These functions return the number of input items successfully matched and "
8855 "assigned, which can be fewer than provided for, or even zero in the event of "
8856 "an early matching failure."
8860 #: build/C/man3/scanf.3:545
8862 "The value B<EOF> is returned if the end of input is reached before either "
8863 "the first successful conversion or a matching failure occurs. B<EOF> is "
8864 "also returned if a read error occurs, in which case the error indicator for "
8865 "the stream (see B<ferror>(3)) is set, and I<errno> is set indicate the "
8870 #: build/C/man3/scanf.3:551
8872 "The file descriptor underlying I<stream> is marked nonblocking, and the read "
8873 "operation would block."
8877 #: build/C/man3/scanf.3:556
8879 "The file descriptor underlying I<stream> is invalid, or not open for "
8884 #: build/C/man3/scanf.3:559
8885 msgid "Input byte sequence does not form a valid character."
8889 #: build/C/man3/scanf.3:563
8890 msgid "The read operation was interrupted by a signal; see B<signal>(7)."
8894 #: build/C/man3/scanf.3:568
8895 msgid "Not enough arguments; or I<format> is NULL."
8899 #: build/C/man3/scanf.3:571
8900 msgid "Out of memory."
8904 #: build/C/man3/scanf.3:571
8910 #: build/C/man3/scanf.3:575
8912 "The result of an integer conversion would exceed the size that can be stored "
8913 "in the corresponding integer type."
8917 #: build/C/man3/scanf.3:585
8919 "The functions B<fscanf>(), B<scanf>(), and B<sscanf>() conform to C89 and "
8920 "C99 and POSIX.1-2001. These standards do not specify the B<ERANGE> error."
8924 #: build/C/man3/scanf.3:595
8926 "The B<q> specifier is the 4.4BSD notation for I<long long>, while B<ll> or "
8927 "the usage of B<L> in integer conversions is the GNU notation."
8931 #: build/C/man3/scanf.3:606
8933 "The Linux version of these functions is based on the I<GNU> I<libio> "
8934 "library. Take a look at the I<info> documentation of I<GNU> I<libc "
8935 "(glibc-1.08)> for a more concise description."
8938 #. This feature seems to be present at least as far back as glibc 2.0.
8940 #: build/C/man3/scanf.3:624
8942 "The GNU C library supports a nonstandard extension that causes the library "
8943 "to dynamically allocate a string of sufficient size for input strings for "
8944 "the B<%s> and B<%a[>I<range>B<]> conversion specifiers. To make use of this "
8945 "feature, specify B<a> as a length modifier (thus B<%as> or "
8946 "B<%a[>I<range>B<]>). The caller must B<free>(3) the returned string, as in "
8947 "the following example:"
8951 #: build/C/man3/scanf.3:629
8959 #: build/C/man3/scanf.3:640
8963 "n = scanf(\"%a[a-z]\", &p);\n"
8965 " printf(\"read: %s\\en\", p);\n"
8967 "} else if (errno != 0) {\n"
8968 " perror(\"scanf\");\n"
8970 " fprintf(stderr, \"No matching characters\\en\");\n"
8975 #: build/C/man3/scanf.3:648
8977 "As shown in the above example, it is only necessary to call B<free>(3) if "
8978 "the B<scanf>() call successfully read a string."
8982 #: build/C/man3/scanf.3:660
8984 "The B<a> modifier is not available if the program is compiled with I<gcc "
8985 "-std=c99> or I<gcc -D_ISOC99_SOURCE> (unless B<_GNU_SOURCE> is also "
8986 "specified), in which case the B<a> is interpreted as a specifier for "
8987 "floating-point numbers (see above)."
8991 #: build/C/man3/scanf.3:669
8993 "Since version 2.7, glibc also provides the B<m> modifier for the same "
8994 "purpose as the B<a> modifier. The B<m> modifier has the following "
8999 #: build/C/man3/scanf.3:674
9000 msgid "It may also be applied to B<%c> conversion specifiers (e.g., B<%3mc>)."
9004 #: build/C/man3/scanf.3:680
9006 "It avoids ambiguity with respect to the B<%a> floating-point conversion "
9007 "specifier (and is unaffected by I<gcc -std=c99> etc.)"
9011 #: build/C/man3/scanf.3:682
9012 msgid "It is specified in the upcoming revision of the POSIX.1 standard."
9016 #: build/C/man3/scanf.3:695
9018 "All functions are fully C89 conformant, but provide the additional "
9019 "specifiers B<q> and B<a> as well as an additional behavior of the B<L> and "
9020 "B<l> specifiers. The latter may be considered to be a bug, as it changes "
9021 "the behavior of specifiers defined in C89."
9025 #: build/C/man3/scanf.3:711
9027 "Some combinations of the type modifiers and conversion specifiers defined by "
9028 "ANSI C do not make sense (e.g. B<%Ld>). While they may have a well-defined "
9029 "behavior on Linux, this need not to be so on other architectures. Therefore "
9030 "it usually is better to use modifiers that are not defined by ANSI C at all, "
9031 "that is, use B<q> instead of B<L> in combination with B<d>, B<i>, B<o>, "
9032 "B<u>, B<x>, and B<X> conversions or B<ll>."
9036 #: build/C/man3/scanf.3:717
9038 "The usage of B<q> is not the same as on 4.4BSD, as it may be used in float "
9039 "conversions equivalently to B<L>."
9043 #: build/C/man3/scanf.3:723
9045 "B<getc>(3), B<printf>(3), B<setlocale>(3), B<strtod>(3), B<strtol>(3), "
9050 #: build/C/man3/setbuf.3:46
9056 #: build/C/man3/setbuf.3:46
9062 #: build/C/man3/setbuf.3:49
9063 msgid "setbuf, setbuffer, setlinebuf, setvbuf - stream buffering operations"
9067 #: build/C/man3/setbuf.3:54
9069 msgid "B<void setbuf(FILE *>I<stream>B<, char *>I<buf>B<);>\n"
9073 #: build/C/man3/setbuf.3:56
9075 msgid "B<void setbuffer(FILE *>I<stream>B<, char *>I<buf>B<, size_t >I<size>B<);>\n"
9079 #: build/C/man3/setbuf.3:58
9081 msgid "B<void setlinebuf(FILE *>I<stream>B<);>\n"
9085 #: build/C/man3/setbuf.3:61
9088 "B<int setvbuf(FILE *>I<stream>B<, char *>I<buf>B<, int >I<mode>B<, size_t "
9093 #: build/C/man3/setbuf.3:71
9094 msgid "B<setbuffer>(), B<setlinebuf>(): _BSD_SOURCE"
9098 #: build/C/man3/setbuf.3:94
9100 "The three types of buffering available are unbuffered, block buffered, and "
9101 "line buffered. When an output stream is unbuffered, information appears on "
9102 "the destination file or terminal as soon as written; when it is block "
9103 "buffered many characters are saved up and written as a block; when it is "
9104 "line buffered characters are saved up until a newline is output or input is "
9105 "read from any stream attached to a terminal device (typically I<stdin>). "
9106 "The function B<fflush>(3) may be used to force the block out early. (See "
9107 "B<fclose>(3).) Normally all files are block buffered. When the first I/O "
9108 "operation occurs on a file, B<malloc>(3) is called, and a buffer is "
9109 "obtained. If a stream refers to a terminal (as I<stdout> normally does) it "
9110 "is line buffered. The standard error stream I<stderr> is always unbuffered "
9115 #: build/C/man3/setbuf.3:101
9117 "The B<setvbuf>() function may be used on any open stream to change its "
9118 "buffer. The I<mode> argument must be one of the following three macros:"
9122 #: build/C/man3/setbuf.3:102
9128 #: build/C/man3/setbuf.3:105
9133 #: build/C/man3/setbuf.3:105
9139 #: build/C/man3/setbuf.3:108
9140 msgid "line buffered"
9144 #: build/C/man3/setbuf.3:108
9150 #: build/C/man3/setbuf.3:111
9151 msgid "fully buffered"
9155 #: build/C/man3/setbuf.3:127
9157 "Except for unbuffered files, the I<buf> argument should point to a buffer at "
9158 "least I<size> bytes long; this buffer will be used instead of the current "
9159 "buffer. If the argument I<buf> is NULL, only the mode is affected; a new "
9160 "buffer will be allocated on the next read or write operation. The "
9161 "B<setvbuf>() function may only be used after opening a stream and before "
9162 "any other operations have been performed on it."
9166 #: build/C/man3/setbuf.3:133
9168 "The other three calls are, in effect, simply aliases for calls to "
9169 "B<setvbuf>(). The B<setbuf>() function is exactly equivalent to the call"
9173 #: build/C/man3/setbuf.3:136
9174 msgid "setvbuf(stream, buf, buf ? _IOFBF : _IONBF, BUFSIZ);"
9178 #: build/C/man3/setbuf.3:146
9180 "The B<setbuffer>() function is the same, except that the size of the buffer "
9181 "is up to the caller, rather than being determined by the default B<BUFSIZ>. "
9182 "The B<setlinebuf>() function is exactly equivalent to the call:"
9186 #: build/C/man3/setbuf.3:149
9187 msgid "setvbuf(stream, (char *) NULL, _IOLBF, 0);"
9191 #: build/C/man3/setbuf.3:160
9193 "The function B<setvbuf>() returns 0 on success. It returns nonzero on "
9194 "failure (I<mode> is invalid or the request cannot be honored). It may set "
9195 "I<errno> on failure."
9199 #: build/C/man3/setbuf.3:162
9200 msgid "The other functions do not return a value."
9204 #: build/C/man3/setbuf.3:168
9205 msgid "The B<setbuf>() and B<setvbuf>() functions conform to C89 and C99."
9209 #: build/C/man3/setbuf.3:178
9211 "The B<setbuffer>() and B<setlinebuf>() functions are not portable to "
9212 "versions of BSD before 4.2BSD, and are available under Linux since libc "
9213 "4.5.21. On 4.2BSD and 4.3BSD systems, B<setbuf>() always uses a suboptimal "
9214 "buffer size and should be avoided."
9218 #: build/C/man3/setbuf.3:185
9220 "You must make sure that the space that I<buf> points to still exists by the "
9221 "time I<stream> is closed, which also happens at program termination. For "
9222 "example, the following is invalid:"
9226 #: build/C/man3/setbuf.3:188
9228 msgid "#include E<lt>stdio.hE<gt>\n"
9232 #: build/C/man3/setbuf.3:197
9238 " char buf[BUFSIZ];\n"
9239 " setbuf(stdin, buf);\n"
9240 " printf(\"Hello, world!\\en\");\n"
9246 #: build/C/man3/setbuf.3:205
9248 "B<fclose>(3), B<fflush>(3), B<fopen>(3), B<fread>(3), B<malloc>(3), "
9249 "B<printf>(3), B<puts>(3)"
9253 #: build/C/man3/stdin.3:9
9259 #: build/C/man3/stdin.3:9 build/C/man3/tmpfile.3:29
9265 #: build/C/man3/stdin.3:12
9266 msgid "stdin, stdout, stderr - standard I/O streams"
9270 #: build/C/man3/stdin.3:19
9273 "B<extern FILE *>I<stdin>B<;>\n"
9274 "B<extern FILE *>I<stdout>B<;>\n"
9275 "B<extern FILE *>I<stderr>B<;>\n"
9279 #: build/C/man3/stdin.3:31
9281 "Under normal circumstances every UNIX program has three streams opened for "
9282 "it when it starts up, one for input, one for output, and one for printing "
9283 "diagnostic or error messages. These are typically attached to the user's "
9284 "terminal (see B<tty>(4) but might instead refer to files or other devices, "
9285 "depending on what the parent process chose to set up. (See also the "
9286 "\"Redirection\" section of B<sh>(1).)"
9290 #: build/C/man3/stdin.3:41
9292 "The input stream is referred to as \"standard input\"; the output stream is "
9293 "referred to as \"standard output\"; and the error stream is referred to as "
9294 "\"standard error\". These terms are abbreviated to form the symbols used to "
9295 "refer to these files, namely I<stdin>, I<stdout>, and I<stderr>."
9299 #: build/C/man3/stdin.3:50
9301 "Each of these symbols is a B<stdio>(3) macro of type pointer to I<FILE>, "
9302 "and can be used with functions like B<fprintf>(3) or B<fread>(3)."
9306 #: build/C/man3/stdin.3:59
9308 "Since I<FILE>s are a buffering wrapper around UNIX file descriptors, the "
9309 "same underlying files may also be accessed using the raw UNIX file "
9310 "interface, that is, the functions like B<read>(2) and B<lseek>(2)."
9314 #: build/C/man3/stdin.3:78
9316 "On program startup, the integer file descriptors associated with the streams "
9317 "I<stdin>, I<stdout>, and I<stderr> are 0, 1, and 2, respectively. The "
9318 "preprocessor symbols B<STDIN_FILENO>, B<STDOUT_FILENO>, and B<STDERR_FILENO> "
9319 "are defined with these values in I<E<lt>unistd.hE<gt>>. (Applying "
9320 "B<freopen>(3) to one of these streams can change the file descriptor number "
9321 "associated with the stream.)"
9325 #: build/C/man3/stdin.3:91
9327 "Note that mixing use of I<FILE>s and raw file descriptors can produce "
9328 "unexpected results and should generally be avoided. (For the masochistic "
9329 "among you: POSIX.1, section 8.2.3, describes in detail how this interaction "
9330 "is supposed to work.) A general rule is that file descriptors are handled "
9331 "in the kernel, while stdio is just a library. This means for example, that "
9332 "after an B<exec>(3), the child inherits all open file descriptors, but all "
9333 "old streams have become inaccessible."
9337 #: build/C/man3/stdin.3:109
9339 "Since the symbols I<stdin>, I<stdout>, and I<stderr> are specified to be "
9340 "macros, assigning to them is nonportable. The standard streams can be made "
9341 "to refer to different files with help of the library function B<freopen>(3), "
9342 "specially introduced to make it possible to reassign I<stdin>, I<stdout>, "
9343 "and I<stderr>. The standard streams are closed by a call to B<exit>(3) and "
9344 "by normal program termination."
9348 #: build/C/man3/stdin.3:118
9350 "The I<stdin>, I<stdout>, and I<stderr> macros conform to C89 and this "
9351 "standard also stipulates that these three streams shall be open at program "
9356 #: build/C/man3/stdin.3:150
9358 "The stream I<stderr> is unbuffered. The stream I<stdout> is line-buffered "
9359 "when it points to a terminal. Partial lines will not appear until "
9360 "B<fflush>(3) or B<exit>(3) is called, or a newline is printed. This can "
9361 "produce unexpected results, especially with debugging output. The buffering "
9362 "mode of the standard streams (or any other stream) can be changed using the "
9363 "B<setbuf>(3) or B<setvbuf>(3) call. Note that in case I<stdin> is "
9364 "associated with a terminal, there may also be input buffering in the "
9365 "terminal driver, entirely unrelated to stdio buffering. (Indeed, normally "
9366 "terminal input is line buffered in the kernel.) This kernel input handling "
9367 "can be modified using calls like B<tcsetattr>(3); see also B<stty>(1), and "
9372 #: build/C/man3/stdin.3:155
9373 msgid "B<csh>(1), B<sh>(1), B<open>(2), B<fopen>(3), B<stdio>(3)"
9377 #: build/C/man3/stdio.3:37
9383 #: build/C/man3/stdio.3:37
9389 #: build/C/man3/stdio.3:40
9390 msgid "stdio - standard input/output library functions"
9394 #: build/C/man3/stdio.3:44
9395 msgid "B<FILE *>I<stdin>B<;>"
9399 #: build/C/man3/stdio.3:46
9400 msgid "B<FILE *>I<stdout>B<;>"
9404 #: build/C/man3/stdio.3:48
9405 msgid "B<FILE *>I<stderr>B<;>"
9409 #: build/C/man3/stdio.3:55
9411 "The standard I/O library provides a simple and efficient buffered stream I/O "
9412 "interface. Input and output is mapped into logical data streams and the "
9413 "physical I/O characteristics are concealed. The functions and macros are "
9414 "listed below; more information is available from the individual man pages."
9418 #: build/C/man3/stdio.3:78
9420 "A stream is associated with an external file (which may be a physical "
9421 "device) by I<opening> a file, which may involve creating a new file. "
9422 "Creating an existing file causes its former contents to be discarded. If a "
9423 "file can support positioning requests (such as a disk file, as opposed to a "
9424 "terminal) then a I<file position indicator> associated with the stream is "
9425 "positioned at the start of the file (byte zero), unless the file is opened "
9426 "with append mode. If append mode is used, it is unspecified whether the "
9427 "position indicator will be placed at the start or the end of the file. The "
9428 "position indicator is maintained by subsequent reads, writes and positioning "
9429 "requests. All input occurs as if the characters were read by successive "
9430 "calls to the B<fgetc>(3) function; all output takes place as if all "
9431 "characters were written by successive calls to the B<fputc>(3) function."
9435 #: build/C/man3/stdio.3:88
9437 "A file is disassociated from a stream by I<closing> the file. Output "
9438 "streams are flushed (any unwritten buffer contents are transferred to the "
9439 "host environment) before the stream is disassociated from the file. The "
9440 "value of a pointer to a I<FILE> object is indeterminate after a file is "
9445 #: build/C/man3/stdio.3:101
9447 "A file may be subsequently reopened, by the same or another program "
9448 "execution, and its contents reclaimed or modified (if it can be repositioned "
9449 "at the start). If the main function returns to its original caller, or the "
9450 "B<exit>(3) function is called, all open files are closed (hence all output "
9451 "streams are flushed) before program termination. Other methods of program "
9452 "termination, such as B<abort>(3) do not bother about closing files "
9457 #: build/C/man3/stdio.3:117
9459 "At program startup, three text streams are predefined and need not be opened "
9460 "explicitly: I<standard input> (for reading conventional input), I<standard "
9461 "output> (for writing conventional input), and I<standard error> (for writing "
9462 "diagnostic output). These streams are abbreviated I<stdin>,I<stdout> and "
9463 "I<stderr>. When opened, the standard error stream is not fully buffered; "
9464 "the standard input and output streams are fully buffered if and only if the "
9465 "streams do not to refer to an interactive device."
9469 #: build/C/man3/stdio.3:127
9471 "Output streams that refer to terminal devices are always line buffered by "
9472 "default; pending output to such streams is written automatically whenever an "
9473 "input stream that refers to a terminal device is read. In cases where a "
9474 "large amount of computation is done after printing part of a line on an "
9475 "output terminal, it is necessary to B<fflush>(3) the standard output before "
9476 "going off and computing so that the output will appear."
9480 #: build/C/man3/stdio.3:141
9482 "The I<stdio> library is a part of the library B<libc> and routines are "
9483 "automatically loaded as needed by the compilers B<cc>(1) and B<pc>(1). The "
9484 "SYNOPSIS sections of the following manual pages indicate which include files "
9485 "are to be used, what the compiler declaration for the function looks like "
9486 "and which external variables are of interest."
9489 #. Not on Linux: .BR fropen ,
9490 #. Not on Linux: .BR fwopen ,
9492 #: build/C/man3/stdio.3:181
9494 "The following are defined as macros; these names may not be reused without "
9495 "first removing their current definitions with B<#undef>: B<BUFSIZ>, B<EOF>, "
9496 "B<FILENAME_MAX>, B<FOPEN_MAX>, B<L_cuserid>, B<L_ctermid>, B<L_tmpnam>, "
9497 "B<NULL>, B<SEEK_END>, B<SEEK_SET>, B<SEEK_CUR>, B<TMP_MAX>, B<clearerr>, "
9498 "B<feof>, B<ferror>, B<fileno>, B<getc>, B<getchar>, B<putc>, B<putchar>, "
9499 "B<stderr>, B<stdin>, B<stdout>. Function versions of the macro functions "
9500 "B<feof>, B<ferror>, B<clearerr>, B<fileno>, B<getc>, B<getchar>, B<putc>, "
9501 "and B<putchar> exist and will be used if the macros definitions are "
9502 "explicitly removed."
9506 #: build/C/man3/stdio.3:181
9508 msgid "List of Functions"
9512 #: build/C/man3/stdio.3:186
9514 msgid "Function\tDescription\n"
9518 #: build/C/man3/stdio.3:187
9524 #: build/C/man3/stdio.3:188
9526 msgid "clearerr\tcheck and reset stream status\n"
9530 #: build/C/man3/stdio.3:189
9532 msgid "fclose\tclose a stream\n"
9536 #: build/C/man3/stdio.3:190
9538 msgid "fdopen\tstream open functions\n"
9542 #: build/C/man3/stdio.3:191
9544 msgid "feof\tcheck and reset stream status\n"
9548 #: build/C/man3/stdio.3:192
9550 msgid "ferror\tcheck and reset stream status\n"
9554 #: build/C/man3/stdio.3:193
9556 msgid "fflush\tflush a stream\n"
9560 #: build/C/man3/stdio.3:194
9562 msgid "fgetc\tget next character or word from input stream\n"
9566 #: build/C/man3/stdio.3:195
9568 msgid "fgetpos\treposition a stream\n"
9572 #: build/C/man3/stdio.3:196
9574 msgid "fgets\tget a line from a stream\n"
9578 #: build/C/man3/stdio.3:197
9580 msgid "fileno\treturn the integer descriptor of the argument stream\n"
9584 #: build/C/man3/stdio.3:198
9586 msgid "fopen\tstream open functions\n"
9590 #: build/C/man3/stdio.3:199
9592 msgid "fprintf\tformatted output conversion\n"
9596 #: build/C/man3/stdio.3:200
9598 msgid "fpurge\tflush a stream\n"
9602 #: build/C/man3/stdio.3:201
9604 msgid "fputc\toutput a character or word to a stream\n"
9608 #: build/C/man3/stdio.3:202
9610 msgid "fputs\toutput a line to a stream\n"
9614 #: build/C/man3/stdio.3:203
9616 msgid "fread\tbinary stream input/output\n"
9620 #: build/C/man3/stdio.3:204
9622 msgid "freopen\tstream open functions\n"
9626 #: build/C/man3/stdio.3:205
9628 msgid "fscanf\tinput format conversion\n"
9632 #: build/C/man3/stdio.3:206
9634 msgid "fseek\treposition a stream\n"
9638 #: build/C/man3/stdio.3:207
9640 msgid "fsetpos\treposition a stream\n"
9644 #: build/C/man3/stdio.3:208
9646 msgid "ftell\treposition a stream\n"
9650 #: build/C/man3/stdio.3:209
9652 msgid "fwrite\tbinary stream input/output\n"
9656 #: build/C/man3/stdio.3:210
9658 msgid "getc\tget next character or word from input stream\n"
9662 #: build/C/man3/stdio.3:211
9664 msgid "getchar\tget next character or word from input stream\n"
9668 #: build/C/man3/stdio.3:212
9670 msgid "gets\tget a line from a stream\n"
9674 #: build/C/man3/stdio.3:213
9676 msgid "getw\tget next character or word from input stream\n"
9680 #: build/C/man3/stdio.3:214
9682 msgid "mktemp\tmake temporary filename (unique)\n"
9686 #: build/C/man3/stdio.3:215
9688 msgid "perror\tsystem error messages\n"
9692 #: build/C/man3/stdio.3:216
9694 msgid "printf\tformatted output conversion\n"
9698 #: build/C/man3/stdio.3:217
9700 msgid "putc\toutput a character or word to a stream\n"
9704 #: build/C/man3/stdio.3:218
9706 msgid "putchar\toutput a character or word to a stream\n"
9710 #: build/C/man3/stdio.3:219
9712 msgid "puts\toutput a line to a stream\n"
9716 #: build/C/man3/stdio.3:220
9718 msgid "putw\toutput a character or word to a stream\n"
9722 #: build/C/man3/stdio.3:221
9724 msgid "remove\tremove directory entry\n"
9728 #: build/C/man3/stdio.3:222
9730 msgid "rewind\treposition a stream\n"
9734 #: build/C/man3/stdio.3:223
9736 msgid "scanf\tinput format conversion\n"
9740 #: build/C/man3/stdio.3:224
9742 msgid "setbuf\tstream buffering operations\n"
9746 #: build/C/man3/stdio.3:225
9748 msgid "setbuffer\tstream buffering operations\n"
9752 #: build/C/man3/stdio.3:226
9754 msgid "setlinebuf\tstream buffering operations\n"
9758 #: build/C/man3/stdio.3:227
9760 msgid "setvbuf\tstream buffering operations\n"
9764 #: build/C/man3/stdio.3:228
9766 msgid "sprintf\tformatted output conversion\n"
9770 #: build/C/man3/stdio.3:229
9772 msgid "sscanf\tinput format conversion\n"
9776 #: build/C/man3/stdio.3:230
9778 msgid "strerror\tsystem error messages\n"
9782 #: build/C/man3/stdio.3:231
9784 msgid "sys_errlist\tsystem error messages\n"
9788 #: build/C/man3/stdio.3:232
9790 msgid "sys_nerr\tsystem error messages\n"
9794 #: build/C/man3/stdio.3:233
9796 msgid "tempnam\ttemporary file routines\n"
9800 #: build/C/man3/stdio.3:234
9802 msgid "tmpfile\ttemporary file routines\n"
9806 #: build/C/man3/stdio.3:235
9808 msgid "tmpnam\ttemporary file routines\n"
9812 #: build/C/man3/stdio.3:236
9814 msgid "ungetc\tun-get character from input stream\n"
9818 #: build/C/man3/stdio.3:237
9820 msgid "vfprintf\tformatted output conversion\n"
9824 #: build/C/man3/stdio.3:238
9826 msgid "vfscanf\tinput format conversion\n"
9830 #: build/C/man3/stdio.3:239
9832 msgid "vprintf\tformatted output conversion\n"
9836 #: build/C/man3/stdio.3:240
9838 msgid "vscanf\tinput format conversion\n"
9842 #: build/C/man3/stdio.3:241
9844 msgid "vsprintf\tformatted output conversion\n"
9848 #: build/C/man3/stdio.3:242
9850 msgid "vsscanf\tinput format conversion\n"
9854 #: build/C/man3/stdio.3:248
9855 msgid "The I<stdio> library conforms to C89."
9859 #: build/C/man3/stdio.3:254
9861 "B<close>(2), B<open>(2), B<read>(2), B<write>(2), B<stdout>(3), "
9862 "B<unlocked_stdio>(3)"
9866 #: build/C/man3/stdio_ext.3:23
9872 #: build/C/man3/stdio_ext.3:23
9878 #: build/C/man3/stdio_ext.3:28
9880 "__fbufsize, __flbf, __fpending, __fpurge, __freadable, __freading, "
9881 "__fsetlocking, __fwritable, __fwriting, _flushlbf - interfaces to stdio FILE "
9886 #: build/C/man3/stdio_ext.3:32
9887 msgid "B<#include E<lt>stdio_ext.hE<gt>>"
9891 #: build/C/man3/stdio_ext.3:34
9892 msgid "B<size_t __fbufsize(FILE *>I<stream>B<);>"
9896 #: build/C/man3/stdio_ext.3:36
9897 msgid "B<size_t __fpending(FILE *>I<stream>B<);>"
9901 #: build/C/man3/stdio_ext.3:38
9902 msgid "B<int __flbf(FILE *>I<stream>B<);>"
9906 #: build/C/man3/stdio_ext.3:40
9907 msgid "B<int __freadable(FILE *>I<stream>B<);>"
9911 #: build/C/man3/stdio_ext.3:42
9912 msgid "B<int __fwritable(FILE *>I<stream>B<);>"
9916 #: build/C/man3/stdio_ext.3:44
9917 msgid "B<int __freading(FILE *>I<stream>B<);>"
9921 #: build/C/man3/stdio_ext.3:46
9922 msgid "B<int __fwriting(FILE *>I<stream>B<);>"
9926 #: build/C/man3/stdio_ext.3:48
9927 msgid "B<int __fsetlocking(FILE *>I<stream>B<, int >I<type>B<);>"
9931 #: build/C/man3/stdio_ext.3:50
9932 msgid "B<void _flushlbf(void);>"
9936 #: build/C/man3/stdio_ext.3:52
9937 msgid "B<void __fpurge(FILE *>I<stream>B<);>"
9941 #: build/C/man3/stdio_ext.3:57
9943 "Solaris introduced routines to allow portable access to the internals of the "
9944 "I<FILE> structure, and glibc also implemented these."
9948 #: build/C/man3/stdio_ext.3:62
9950 "The B<__fbufsize>() function returns the size of the buffer currently used "
9951 "by the given stream."
9955 #: build/C/man3/stdio_ext.3:69
9957 "The B<__fpending>() function returns the number of bytes in the output "
9958 "buffer. For wide-oriented streams the unit is wide characters. This "
9959 "function is undefined on buffers in reading mode, or opened read-only."
9963 #: build/C/man3/stdio_ext.3:74
9965 "The B<__flbf>() function returns a nonzero value if the stream is "
9966 "line-buffered, and zero otherwise."
9970 #: build/C/man3/stdio_ext.3:79
9972 "The B<__freadable>() function returns a nonzero value if the stream allows "
9973 "reading, and zero otherwise."
9977 #: build/C/man3/stdio_ext.3:84
9979 "The B<__fwritable>() function returns a nonzero value if the stream allows "
9980 "writing, and zero otherwise."
9984 #: build/C/man3/stdio_ext.3:90
9986 "The B<__freading>() function returns a nonzero value if the stream is "
9987 "read-only, or if the last operation on the stream was a read operation, and "
9992 #: build/C/man3/stdio_ext.3:96
9994 "The B<__fwriting>() function returns a nonzero value if the stream is "
9995 "write-only (or append-only), or if the last operation on the stream was a "
9996 "write operation, and zero otherwise."
10000 #: build/C/man3/stdio_ext.3:104
10002 "The B<__fsetlocking>() function can be used to select the desired type of "
10003 "locking on the stream. It returns the current type. The I<type> argument "
10004 "can take the following three values:"
10008 #: build/C/man3/stdio_ext.3:104
10010 msgid "B<FSETLOCKING_INTERNAL>"
10013 #. type: Plain text
10014 #: build/C/man3/stdio_ext.3:109
10016 "Perform implicit locking around every operation on the given stream (except "
10017 "for the *_unlocked ones). This is the default."
10021 #: build/C/man3/stdio_ext.3:109
10023 msgid "B<FSETLOCKING_BYCALLER>"
10026 #. type: Plain text
10027 #: build/C/man3/stdio_ext.3:116
10029 "The caller will take care of the locking (possibly using B<flockfile>(3) in "
10030 "case there is more than one thread), and the stdio routines will not do "
10031 "locking until the state is reset to B<FSETLOCKING_INTERNAL>."
10035 #: build/C/man3/stdio_ext.3:116
10037 msgid "B<FSETLOCKING_QUERY>"
10040 #. type: Plain text
10041 #: build/C/man3/stdio_ext.3:120
10042 msgid "Don't change the type of locking. (Only return it.)"
10045 #. type: Plain text
10046 #: build/C/man3/stdio_ext.3:126
10048 "The B<_flushlbf>() function flushes all line-buffered streams. (Presumably "
10049 "so that output to a terminal is forced out, say before reading keyboard "
10053 #. type: Plain text
10054 #: build/C/man3/stdio_ext.3:130
10055 msgid "The B<__fpurge>() function discards the contents of the stream's buffer."
10058 #. type: Plain text
10059 #: build/C/man3/stdio_ext.3:132
10060 msgid "B<flockfile>(3), B<fpurge>(3)"
10064 #: build/C/man2/symlink.2:32 build/C/man7/symlink.7:35
10070 #: build/C/man2/symlink.2:32
10075 #. type: Plain text
10076 #: build/C/man2/symlink.2:35
10077 msgid "symlink - make a new name for a file"
10080 #. type: Plain text
10081 #: build/C/man2/symlink.2:39
10082 msgid "B<int symlink(const char *>I<oldpath>B<, const char *>I<newpath>B<);>"
10085 #. type: Plain text
10086 #: build/C/man2/symlink.2:47
10087 msgid "B<symlink>():"
10090 #. type: Plain text
10091 #: build/C/man2/symlink.2:58
10093 "B<symlink>() creates a symbolic link named I<newpath> which contains the "
10094 "string I<oldpath>."
10097 #. type: Plain text
10098 #: build/C/man2/symlink.2:62
10100 "Symbolic links are interpreted at run time as if the contents of the link "
10101 "had been substituted into the path being followed to find a file or "
10105 #. type: Plain text
10106 #: build/C/man2/symlink.2:67
10108 "Symbolic links may contain I<..> path components, which (if used at the "
10109 "start of the link) refer to the parent directories of that in which the link "
10113 #. type: Plain text
10114 #: build/C/man2/symlink.2:71
10116 "A symbolic link (also known as a soft link) may point to an existing file or "
10117 "to a nonexistent one; the latter case is known as a dangling link."
10120 #. type: Plain text
10121 #: build/C/man2/symlink.2:78
10123 "The permissions of a symbolic link are irrelevant; the ownership is ignored "
10124 "when following the link, but is checked when removal or renaming of the link "
10125 "is requested and the link is in a directory with the sticky bit (B<S_ISVTX>) "
10129 #. type: Plain text
10130 #: build/C/man2/symlink.2:99
10132 "Write access to the directory containing I<newpath> is denied, or one of the "
10133 "directories in the path prefix of I<newpath> did not allow search "
10134 "permission. (See also B<path_resolution>(7).)"
10137 #. type: Plain text
10138 #: build/C/man2/symlink.2:113
10139 msgid "Too many symbolic links were encountered in resolving I<newpath>."
10142 #. type: Plain text
10143 #: build/C/man2/symlink.2:123
10145 "A directory component in I<newpath> does not exist or is a dangling symbolic "
10146 "link, or I<oldpath> is the empty string."
10149 #. type: Plain text
10150 #: build/C/man2/symlink.2:135
10151 msgid "A component used as a directory in I<newpath> is not, in fact, a directory."
10154 #. type: Plain text
10155 #: build/C/man2/symlink.2:140
10157 "The file system containing I<newpath> does not support the creation of "
10161 #. type: Plain text
10162 #: build/C/man2/symlink.2:144
10163 msgid "I<newpath> is on a read-only file system."
10166 #. type: Plain text
10167 #: build/C/man2/symlink.2:154
10168 msgid "No checking of I<oldpath> is done."
10171 #. type: Plain text
10172 #: build/C/man2/symlink.2:159
10174 "Deleting the name referred to by a symlink will actually delete the file "
10175 "(unless it also has other hard links). If this behavior is not desired, use "
10179 #. type: Plain text
10180 #: build/C/man2/symlink.2:170
10182 "B<ln>(1), B<lchown>(2), B<link>(2), B<lstat>(2), B<open>(2), B<readlink>(2), "
10183 "B<rename>(2), B<symlinkat>(2), B<unlink>(2), B<path_resolution>(7), "
10188 #: build/C/man7/symlink.7:35
10193 #. type: Plain text
10194 #: build/C/man7/symlink.7:38
10195 msgid "symlink - symbolic link handling"
10199 #: build/C/man7/symlink.7:38
10201 msgid "SYMBOLIC LINK HANDLING"
10204 #. type: Plain text
10205 #: build/C/man7/symlink.7:42
10207 "Symbolic links are files that act as pointers to other files. To understand "
10208 "their behavior, you must first understand how hard links work."
10211 #. type: Plain text
10212 #: build/C/man7/symlink.7:58
10214 "A hard link to a file is indistinguishable from the original file because it "
10215 "is a reference to the object underlying the original filename. (To be "
10216 "precise: each of the hard links to a file is a reference to the same "
10217 "I<i-node number>, where an i-node number is an index into the i-node table, "
10218 "which contains metadata about all files on a file system. See B<stat>(2).) "
10219 "Changes to a file are independent of the name used to reference the file. "
10220 "Hard links may not refer to directories (to prevent the possibility of loops "
10221 "within the file system tree, which would confuse many programs) and may not "
10222 "refer to files on different file systems (because i-node numbers are not "
10223 "unique across file systems)."
10226 #. type: Plain text
10227 #: build/C/man7/symlink.7:65
10229 "A symbolic link is a special type of file whose contents are a string that "
10230 "is the pathname another file, the file to which the link refers. In other "
10231 "words, a symbolic link is a pointer to another name, and not to an "
10232 "underlying object. For this reason, symbolic links may refer to directories "
10233 "and may cross file system boundaries."
10236 #. type: Plain text
10237 #: build/C/man7/symlink.7:71
10239 "There is no requirement that the pathname referred to by a symbolic link "
10240 "should exist. A symbolic link that refers to a pathname that does not exist "
10241 "is said to be a I<dangling link>."
10244 #. type: Plain text
10245 #: build/C/man7/symlink.7:83
10247 "Because a symbolic link and its referenced object coexist in the file system "
10248 "name space, confusion can arise in distinguishing between the link itself "
10249 "and the referenced object. On historical systems, commands and system calls "
10250 "adopted their own link-following conventions in a somewhat ad-hoc fashion. "
10251 "Rules for a more uniform approach, as they are implemented on Linux and "
10252 "other systems, are outlined here. It is important that site-local "
10253 "applications also conform to these rules, so that the user interface can be "
10254 "as consistent as possible."
10258 #: build/C/man7/symlink.7:83
10260 msgid "Symbolic link ownership, permissions, and timestamps"
10263 #. type: Plain text
10264 #: build/C/man7/symlink.7:91
10266 "The owner and group of an existing symbolic link can be changed using "
10267 "B<lchown>(2). The only time that the ownership of a symbolic link matters "
10268 "is when the link is being removed or renamed in a directory that has the "
10269 "sticky bit set (see B<stat>(2))."
10272 #. type: Plain text
10273 #: build/C/man7/symlink.7:97
10275 "The last access and last modification timestamps of a symbolic link can be "
10276 "changed using B<utimensat>(2) or B<lutimes>(3)."
10279 #. Linux does not currently implement an lchmod(2).
10283 #. system differs from historical
10285 #. systems in that the system call
10287 #. has been changed to follow symbolic links.
10290 #. system call was added later when the limitations of the new
10292 #. became apparent.
10293 #. type: Plain text
10294 #: build/C/man7/symlink.7:116
10296 "On Linux, the permissions of a symbolic link are not used in any operations; "
10297 "the permissions are always 0777 (read, write, and execute for all user "
10298 "categories), and can't be changed."
10302 #: build/C/man7/symlink.7:116
10304 msgid "Handling of symbolic links by system calls and commands"
10307 #. type: Plain text
10308 #: build/C/man7/symlink.7:131
10310 "Symbolic links are handled either by operating on the link itself, or by "
10311 "operating on the object referred to by the link. In the latter case, an "
10312 "application or system call is said to I<follow> the link. Symbolic links "
10313 "may refer to other symbolic links, in which case the links are dereferenced "
10314 "until an object that is not a symbolic link is found, a symbolic link that "
10315 "refers to a file which does not exist is found, or a loop is detected. "
10316 "(Loop detection is done by placing an upper limit on the number of links "
10317 "that may be followed, and an error results if this limit is exceeded.)"
10320 #. type: Plain text
10321 #: build/C/man7/symlink.7:134
10323 "There are three separate areas that need to be discussed. They are as "
10328 #: build/C/man7/symlink.7:134
10333 #. type: Plain text
10334 #: build/C/man7/symlink.7:136
10335 msgid "Symbolic links used as filename arguments for system calls."
10339 #: build/C/man7/symlink.7:136
10344 #. type: Plain text
10345 #: build/C/man7/symlink.7:139
10347 "Symbolic links specified as command-line arguments to utilities that are not "
10348 "traversing a file tree."
10352 #: build/C/man7/symlink.7:139
10357 #. type: Plain text
10358 #: build/C/man7/symlink.7:143
10360 "Symbolic links encountered by utilities that are traversing a file tree "
10361 "(either specified on the command line or encountered as part of the file "
10366 #: build/C/man7/symlink.7:143
10368 msgid "System calls"
10371 #. type: Plain text
10372 #: build/C/man7/symlink.7:146
10374 "The first area is symbolic links used as filename arguments for system "
10378 #. type: Plain text
10379 #: build/C/man7/symlink.7:156
10381 "Except as noted below, all system calls follow symbolic links. For example, "
10382 "if there were a symbolic link I<slink> which pointed to a file named "
10383 "I<afile>, the system call I<open(\"slink\" ...\\&)> would return a file "
10384 "descriptor referring to the file I<afile>."
10387 #. Maybe one day: .BR fchownat (2)
10388 #. type: Plain text
10389 #: build/C/man7/symlink.7:206
10391 "Various system calls do not follow links, and operate on the symbolic link "
10392 "itself. They are: B<lchown>(2), B<lgetxattr>(2), B<llistxattr>(2), "
10393 "B<lremovexattr>(2), B<lsetxattr>(2), B<lstat>(2), B<readlink>(2), "
10394 "B<rename>(2), B<rmdir>(2), and B<unlink>(2). Certain other system calls "
10395 "optionally follow symbolic links. They are: B<faccessat>(2), "
10396 "B<fchownat>(2), B<fstatat>(2), B<linkat>(2), B<open>(2), B<openat>(2), and "
10397 "B<utimensat>(2); see their manual pages for details. Because B<remove>(3) "
10398 "is an alias for B<unlink>(2), that library function also does not follow "
10399 "symbolic links. When B<rmdir>(2) is applied to a symbolic link, it fails "
10400 "with the error B<ENOTDIR>. The B<link>(2) warrants special discussion. "
10401 "POSIX.1-2001 specifies that B<link>(2) should dereference I<oldpath> if it "
10402 "is a symbolic link. However, Linux does not do this. (By default Solaris "
10403 "is the same, but the POSIX.1-2001 specified behavior can be obtained with "
10404 "suitable compiler options.) The upcoming POSIX.1 revision changes the "
10405 "specification to allow either behavior in an implementation."
10409 #: build/C/man7/symlink.7:206
10411 msgid "Commands not traversing a file tree"
10414 #. type: Plain text
10415 #: build/C/man7/symlink.7:209
10417 "The second area is symbolic links, specified as command-line filename "
10418 "arguments, to commands which are not traversing a file tree."
10421 #. type: Plain text
10422 #: build/C/man7/symlink.7:220
10424 "Except as noted below, commands follow symbolic links named as command-line "
10425 "arguments. For example, if there were a symbolic link I<slink> which "
10426 "pointed to a file named I<afile>, the command I<cat slink> would display the "
10427 "contents of the file I<afile>."
10430 #. type: Plain text
10431 #: build/C/man7/symlink.7:228
10433 "It is important to realize that this rule includes commands which may "
10434 "optionally traverse file trees, e.g., the command I<chown file> is included "
10435 "in this rule, while the command I<chown\\ -R file>, which performs a tree "
10436 "traversal, is not. (The latter is described in the third area, below.)"
10439 #. type: Plain text
10440 #: build/C/man7/symlink.7:246
10442 "If it is explicitly intended that the command operate on the symbolic link "
10443 "instead of following the symbolic link, e.g., it is desired that I<chown "
10444 "slink> change the ownership of the file that I<slink> is, whether it is a "
10445 "symbolic link or not, the I<-h> option should be used. In the above "
10446 "example, I<chown root slink> would change the ownership of the file referred "
10447 "to by I<slink>, while I<chown\\ -h root slink> would change the ownership of "
10451 #. type: Plain text
10452 #: build/C/man7/symlink.7:248
10453 msgid "There are some exceptions to this rule:"
10456 #. type: Plain text
10457 #: build/C/man7/symlink.7:258
10459 "The B<mv>(1) and B<rm>(1) commands do not follow symbolic links named as "
10460 "arguments, but respectively attempt to rename and delete them. (Note, if "
10461 "the symbolic link references a file via a relative path, moving it to "
10462 "another directory may very well cause it to stop working, since the path may "
10463 "no longer be correct.)"
10466 #. type: Plain text
10467 #: build/C/man7/symlink.7:288
10469 "The B<ls>(1) command is also an exception to this rule. For compatibility "
10470 "with historic systems (when B<ls>(1) is not doing a tree walk, i.e., the "
10471 "I<-R> option is not specified), the B<ls>(1) command follows symbolic links "
10472 "named as arguments if the I<-H> or I<-L> option is specified, or if the "
10473 "I<-F>, I<-d>, or I<-l> options are not specified. (The B<ls>(1) command is "
10474 "the only command where the I<-H> and I<-L> options affect its behavior even "
10475 "though it is not doing a walk of a file tree.)"
10479 #. The 4.4BSD system differs from historical 4BSD systems in that the
10483 #. commands follow symbolic links specified on the command line.
10484 #. type: Plain text
10485 #: build/C/man7/symlink.7:306
10487 "The B<file>(1) command is also an exception to this rule. The B<file>(1) "
10488 "command does not follow symbolic links named as argument by default. The "
10489 "B<file>(1) command does follow symbolic links named as argument if the "
10490 "I<-L> option is specified."
10494 #: build/C/man7/symlink.7:306
10496 msgid "Commands traversing a file tree"
10499 #. type: Plain text
10500 #: build/C/man7/symlink.7:319
10502 "The following commands either optionally or always traverse file trees: "
10503 "B<chgrp>(1), B<chmod>(1), B<chown>(1), B<cp>(1), B<du>(1), B<find>(1), "
10504 "B<ls>(1), B<pax>(1), B<rm>(1), and B<tar>(1)."
10507 #. type: Plain text
10508 #: build/C/man7/symlink.7:323
10510 "It is important to realize that the following rules apply equally to "
10511 "symbolic links encountered during the file tree traversal and symbolic links "
10512 "listed as command-line arguments."
10515 #. type: Plain text
10516 #: build/C/man7/symlink.7:328
10518 "The I<first rule> applies to symbolic links that reference files other than "
10519 "directories. Operations that apply to symbolic links are performed on the "
10520 "links themselves, but otherwise the links are ignored."
10523 #. type: Plain text
10524 #: build/C/man7/symlink.7:340
10526 "The command I<rm\\ -r slink directory> will remove I<slink>, as well as any "
10527 "symbolic links encountered in the tree traversal of I<directory>, because "
10528 "symbolic links may be removed. In no case will B<rm>(1) affect the file "
10529 "referred to by I<slink>."
10532 #. type: Plain text
10533 #: build/C/man7/symlink.7:345
10535 "The I<second rule> applies to symbolic links that refer to directories. "
10536 "Symbolic links that refer to directories are never followed by default. "
10537 "This is often referred to as a \"physical\" walk, as opposed to a "
10538 "\"logical\" walk (where symbolic links the refer to directories are "
10542 #. type: Plain text
10543 #: build/C/man7/symlink.7:348
10545 "Certain conventions are (should be) followed as consistently as possible by "
10546 "commands that perform file tree walks:"
10549 #. type: Plain text
10550 #: build/C/man7/symlink.7:361
10552 "A command can be made to follow any symbolic links named on the command "
10553 "line, regardless of the type of file they reference, by specifying the I<-H> "
10554 "(for \"half-logical\") flag. This flag is intended to make the command-line "
10555 "name space look like the logical name space. (Note, for commands that do "
10556 "not always do file tree traversals, the I<-H> flag will be ignored if the "
10557 "I<-R> flag is not also specified.)"
10560 #. type: Plain text
10561 #: build/C/man7/symlink.7:377
10563 "For example, the command I<chown\\ -HR user slink> will traverse the file "
10564 "hierarchy rooted in the file pointed to by I<slink>. Note, the I<-H> is not "
10565 "the same as the previously discussed I<-h> flag. The I<-H> flag causes "
10566 "symbolic links specified on the command line to be dereferenced for the "
10567 "purposes of both the action to be performed and the tree walk, and it is as "
10568 "if the user had specified the name of the file to which the symbolic link "
10572 #. type: Plain text
10573 #: build/C/man7/symlink.7:391
10575 "A command can be made to follow any symbolic links named on the command "
10576 "line, as well as any symbolic links encountered during the traversal, "
10577 "regardless of the type of file they reference, by specifying the I<-L> (for "
10578 "\"logical\") flag. This flag is intended to make the entire name space look "
10579 "like the logical name space. (Note, for commands that do not always do file "
10580 "tree traversals, the I<-L> flag will be ignored if the I<-R> flag is not "
10584 #. type: Plain text
10585 #: build/C/man7/symlink.7:406
10587 "For example, the command I<chown\\ -LR user slink> will change the owner of "
10588 "the file referred to by I<slink>. If I<slink> refers to a directory, "
10589 "B<chown> will traverse the file hierarchy rooted in the directory that it "
10590 "references. In addition, if any symbolic links are encountered in any file "
10591 "tree that B<chown> traverses, they will be treated in the same fashion as "
10595 #. type: Plain text
10596 #: build/C/man7/symlink.7:413
10598 "A command can be made to provide the default behavior by specifying the "
10599 "I<-P> (for \"physical\") flag. This flag is intended to make the entire "
10600 "name space look like the physical name space."
10603 #. type: Plain text
10604 #: build/C/man7/symlink.7:431
10606 "For commands that do not by default do file tree traversals, the I<-H>, "
10607 "I<-L>, and I<-P> flags are ignored if the I<-R> flag is not also specified. "
10608 "In addition, you may specify the I<-H>, I<-L>, and I<-P> options more than "
10609 "once; the last one specified determines the command's behavior. This is "
10610 "intended to permit you to alias commands to behave one way or the other, and "
10611 "then override that behavior on the command line."
10614 #. type: Plain text
10615 #: build/C/man7/symlink.7:437
10616 msgid "The B<ls>(1) and B<rm>(1) commands have exceptions to these rules:"
10619 #. type: Plain text
10620 #: build/C/man7/symlink.7:450
10622 "The B<rm>(1) command operates on the symbolic link, and not the file it "
10623 "references, and therefore never follows a symbolic link. The B<rm>(1) "
10624 "command does not support the I<-H>, I<-L>, or I<-P> options."
10627 #. type: Plain text
10628 #: build/C/man7/symlink.7:470
10630 "To maintain compatibility with historic systems, the B<ls>(1) command acts "
10631 "a little differently. If you do not specify the I<-F>, I<-d> or I<-l> "
10632 "options, B<ls>(1) will follow symbolic links specified on the command "
10633 "line. If the I<-L> flag is specified, B<ls>(1) follows all symbolic links, "
10634 "regardless of their type, whether specified on the command line or "
10635 "encountered in the tree walk."
10638 #. type: Plain text
10639 #: build/C/man7/symlink.7:487
10641 "B<chgrp>(1), B<chmod>(1), B<find>(1), B<ln>(1), B<ls>(1), B<mv>(1), "
10642 "B<rm>(1), B<lchown>(2), B<link>(2), B<lstat>(2), B<readlink>(2), "
10643 "B<rename>(2), B<symlink>(2), B<unlink>(2), B<utimensat>(2), B<lutimes>(3), "
10644 "B<path_resolution>(7)"
10648 #: build/C/man3/tempnam.3:23
10654 #: build/C/man3/tempnam.3:23
10659 #. type: Plain text
10660 #: build/C/man3/tempnam.3:26
10661 msgid "tempnam - create a name for a temporary file"
10664 #. type: Plain text
10665 #: build/C/man3/tempnam.3:31
10667 msgid "B<char *tempnam(const char *>I<dir>B<, const char *>I<pfx>B<);>\n"
10670 #. type: Plain text
10671 #: build/C/man3/tempnam.3:40
10672 msgid "B<tempnam>(): _BSD_SOURCE || _SVID_SOURCE"
10675 #. type: Plain text
10676 #: build/C/man3/tempnam.3:54
10678 "The B<tempnam>() function returns a pointer to a string that is a valid "
10679 "filename, and such that a file with this name did not exist when "
10680 "B<tempnam>() checked. The filename suffix of the pathname generated will "
10681 "start with I<pfx> in case I<pfx> is a non-NULL string of at most five "
10682 "bytes. The directory prefix part of the pathname generated is required to "
10683 "be \"appropriate\" (often that at least implies writable)."
10686 #. type: Plain text
10687 #: build/C/man3/tempnam.3:57
10688 msgid "Attempts to find an appropriate directory go through the following steps:"
10692 #: build/C/man3/tempnam.3:57
10697 #. type: Plain text
10698 #: build/C/man3/tempnam.3:63
10700 "In case the environment variable B<TMPDIR> exists and contains the name of "
10701 "an appropriate directory, that is used."
10705 #: build/C/man3/tempnam.3:63
10710 #. type: Plain text
10711 #: build/C/man3/tempnam.3:68
10712 msgid "Otherwise, if the I<dir> argument is non-NULL and appropriate, it is used."
10716 #: build/C/man3/tempnam.3:68
10721 #. type: Plain text
10722 #: build/C/man3/tempnam.3:75
10724 "Otherwise, I<P_tmpdir> (as defined in I<E<lt>stdio.hE<gt>>) is used when "
10729 #: build/C/man3/tempnam.3:75
10734 #. type: Plain text
10735 #: build/C/man3/tempnam.3:78
10736 msgid "Finally an implementation-defined directory may be used."
10739 #. type: Plain text
10740 #: build/C/man3/tempnam.3:85
10742 "The string returned by B<tempnam>() is allocated using B<malloc>(3) and "
10743 "hence should be freed by B<free>(3)."
10746 #. type: Plain text
10747 #: build/C/man3/tempnam.3:90
10749 "The B<tempnam>() function returns a pointer to a unique temporary filename, "
10750 "or NULL if a unique name cannot be generated."
10753 #. type: Plain text
10754 #: build/C/man3/tempnam.3:94
10755 msgid "Allocation of storage failed."
10758 #. type: Plain text
10759 #: build/C/man3/tempnam.3:99
10760 msgid "SVr4, 4.3BSD, POSIX.1-2001. POSIX.1-2008 marks B<tempnam>() as obsolete."
10763 #. type: Plain text
10764 #: build/C/man3/tempnam.3:118
10766 "Although B<tempnam>() generates names that are difficult to guess, it is "
10767 "nevertheless possible that between the time that B<tempnam>() returns a "
10768 "pathname, and the time that the program opens it, another program might "
10769 "create that pathname using B<open>(2), or create it as a symbolic link. "
10770 "This can lead to security holes. To avoid such possibilities, use the "
10771 "B<open>(2) B<O_EXCL> flag to open the pathname. Or better yet, use "
10772 "B<mkstemp>(3) or B<tmpfile>(3)."
10775 #. type: Plain text
10776 #: build/C/man3/tempnam.3:126
10778 "SUSv2 does not mention the use of B<TMPDIR>; glibc will use it only when the "
10779 "program is not set-user-ID. On SVr4, the directory used under B<d)> is "
10780 "I</tmp> (and this is what glibc does)."
10783 #. type: Plain text
10784 #: build/C/man3/tempnam.3:131
10786 "Because it dynamically allocates memory used to return the pathname, "
10787 "B<tempnam>() is reentrant, and thus thread safe, unlike B<tmpnam>(3)."
10790 #. type: Plain text
10791 #: build/C/man3/tempnam.3:144
10793 "The B<tempnam>() function generates a different string each time it is "
10794 "called, up to B<TMP_MAX> (defined in I<E<lt>stdio.hE<gt>>) times. If it is "
10795 "called more than B<TMP_MAX> times, the behavior is implementation defined."
10798 #. type: Plain text
10799 #: build/C/man3/tempnam.3:148
10800 msgid "B<tempnam>() uses at most the first five bytes from I<pfx>."
10803 #. type: Plain text
10804 #: build/C/man3/tempnam.3:154
10806 "The glibc implementation of B<tempnam>() will fail with the error B<EEXIST> "
10807 "upon failure to find a unique name."
10810 #. type: Plain text
10811 #: build/C/man3/tempnam.3:157
10813 "The precise meaning of \"appropriate\" is undefined; it is unspecified how "
10814 "accessibility of a directory is determined."
10817 #. type: Plain text
10818 #: build/C/man3/tempnam.3:164 build/C/man3/tmpnam.3:151
10819 msgid "Never use this function. Use B<mkstemp>(3) or B<tmpfile>(3) instead."
10822 #. type: Plain text
10823 #: build/C/man3/tempnam.3:168
10824 msgid "B<mkstemp>(3), B<mktemp>(3), B<tmpfile>(3), B<tmpnam>(3)"
10828 #: build/C/man3/tmpfile.3:29
10833 #. type: Plain text
10834 #: build/C/man3/tmpfile.3:32
10835 msgid "tmpfile - create a temporary file"
10838 #. type: Plain text
10839 #: build/C/man3/tmpfile.3:37
10841 msgid "B<FILE *tmpfile(void);>\n"
10844 #. type: Plain text
10845 #: build/C/man3/tmpfile.3:45
10847 "The B<tmpfile>() function opens a unique temporary file in binary "
10848 "read/write (w+b) mode. The file will be automatically deleted when it is "
10849 "closed or the program terminates."
10852 #. type: Plain text
10853 #: build/C/man3/tmpfile.3:52
10855 "The B<tmpfile>() function returns a stream descriptor, or NULL if a unique "
10856 "filename cannot be generated or the unique file cannot be opened. In the "
10857 "latter case, I<errno> is set to indicate the error."
10860 #. type: Plain text
10861 #: build/C/man3/tmpfile.3:56
10862 msgid "Search permission denied for directory in file's path prefix."
10865 #. type: Plain text
10866 #: build/C/man3/tmpfile.3:59
10867 msgid "Unable to generate a unique filename."
10870 #. type: Plain text
10871 #: build/C/man3/tmpfile.3:62
10872 msgid "The call was interrupted by a signal."
10875 #. type: Plain text
10876 #: build/C/man3/tmpfile.3:65
10877 msgid "Too many file descriptors in use by the process."
10880 #. type: Plain text
10881 #: build/C/man3/tmpfile.3:68
10882 msgid "Too many files open in the system."
10885 #. type: Plain text
10886 #: build/C/man3/tmpfile.3:71
10887 msgid "There was no room in the directory to add the new filename."
10890 #. type: Plain text
10891 #: build/C/man3/tmpfile.3:74
10892 msgid "Read-only file system."
10895 #. type: Plain text
10896 #: build/C/man3/tmpfile.3:76
10897 msgid "SVr4, 4.3BSD, C89, C99, SUSv2, POSIX.1-2001."
10900 #. type: Plain text
10901 #: build/C/man3/tmpfile.3:80
10903 "POSIX.1-2001 specifies: an error message may be written to I<stdout> if the "
10904 "stream cannot be opened."
10907 #. type: Plain text
10908 #: build/C/man3/tmpfile.3:86
10910 "The standard does not specify the directory that B<tmpfile>() will use. "
10911 "Glibc will try the path prefix I<P_tmpdir> defined in I<E<lt>stdio.hE<gt>>, "
10912 "and if that fails the directory I</tmp>."
10915 #. type: Plain text
10916 #: build/C/man3/tmpfile.3:91
10917 msgid "B<exit>(3), B<mkstemp>(3), B<mktemp>(3), B<tempnam>(3), B<tmpnam>(3)"
10921 #: build/C/man3/tmpnam.3:25
10927 #: build/C/man3/tmpnam.3:25
10932 #. type: Plain text
10933 #: build/C/man3/tmpnam.3:28
10934 msgid "tmpnam, tmpnam_r - create a name for a temporary file"
10937 #. type: Plain text
10938 #: build/C/man3/tmpnam.3:33
10940 msgid "B<char *tmpnam(char *>I<s>B<);>\n"
10943 #. type: Plain text
10944 #: build/C/man3/tmpnam.3:56
10946 "The B<tmpnam>() function returns a pointer to a string that is a valid "
10947 "filename, and such that a file with this name did not exist at some point in "
10948 "time, so that naive programmers may think it a suitable name for a temporary "
10949 "file. If the argument I<s> is NULL this name is generated in an internal "
10950 "static buffer and may be overwritten by the next call to B<tmpnam>(). If "
10951 "I<s> is not NULL, the name is copied to the character array (of length at "
10952 "least I<L_tmpnam>) pointed to by I<s> and the value I<s> is returned in "
10956 #. type: Plain text
10957 #: build/C/man3/tmpnam.3:68
10959 "The pathname that is created, has a directory prefix I<P_tmpdir>. (Both "
10960 "I<L_tmpnam> and I<P_tmpdir> are defined in I<E<lt>stdio.hE<gt>>, just like "
10961 "the B<TMP_MAX> mentioned below.)"
10964 #. type: Plain text
10965 #: build/C/man3/tmpnam.3:73
10967 "The B<tmpnam>() function returns a pointer to a unique temporary filename, "
10968 "or NULL if a unique name cannot be generated."
10971 #. type: Plain text
10972 #: build/C/man3/tmpnam.3:75
10973 msgid "No errors are defined."
10976 #. type: Plain text
10977 #: build/C/man3/tmpnam.3:80
10979 "SVr4, 4.3BSD, C89, C99, POSIX.1-2001. POSIX.1-2008 marks B<tmpnam>() as "
10983 #. type: Plain text
10984 #: build/C/man3/tmpnam.3:91
10986 "The B<tmpnam>() function generates a different string each time it is "
10987 "called, up to B<TMP_MAX> times. If it is called more than B<TMP_MAX> times, "
10988 "the behavior is implementation defined."
10991 #. type: Plain text
10992 #: build/C/man3/tmpnam.3:110
10994 "Although B<tmpnam>() generates names that are difficult to guess, it is "
10995 "nevertheless possible that between the time that B<tmpnam>() returns a "
10996 "pathname, and the time that the program opens it, another program might "
10997 "create that pathname using B<open>(2), or create it as a symbolic link. "
10998 "This can lead to security holes. To avoid such possibilities, use the "
10999 "B<open>(2) B<O_EXCL> flag to open the pathname. Or better yet, use "
11000 "B<mkstemp>(3) or B<tmpfile>(3)."
11003 #. type: Plain text
11004 #: build/C/man3/tmpnam.3:118
11006 "Portable applications that use threads cannot call B<tmpnam>() with a NULL "
11007 "argument if either B<_POSIX_THREADS> or B<_POSIX_THREAD_SAFE_FUNCTIONS> is "
11011 #. type: Plain text
11012 #: build/C/man3/tmpnam.3:122
11013 msgid "A POSIX draft proposed to use a function B<tmpnam_r>() defined by"
11016 #. type: Plain text
11017 #: build/C/man3/tmpnam.3:130
11021 "tmpnam_r(char *s)\n"
11023 " return s ? tmpnam(s) : NULL;\n"
11027 #. type: Plain text
11028 #: build/C/man3/tmpnam.3:144
11030 "apparently as a warning not to use NULL. A few systems implement it. To "
11031 "get a glibc prototype for this function from I<E<lt>stdio.hE<gt>>, define "
11032 "B<_SVID_SOURCE> or B<_BSD_SOURCE> (before including I<any> header file)."
11035 #. type: Plain text
11036 #: build/C/man3/tmpnam.3:155
11037 msgid "B<mkstemp>(3), B<mktemp>(3), B<tempnam>(3), B<tmpfile>(3)"
11041 #: build/C/man2/unlink.2:32
11047 #: build/C/man2/unlink.2:32
11052 #. type: Plain text
11053 #: build/C/man2/unlink.2:35
11054 msgid "unlink - delete a name and possibly the file it refers to"
11057 #. type: Plain text
11058 #: build/C/man2/unlink.2:39
11059 msgid "B<int unlink(const char *>I<pathname>B<);>"
11062 #. type: Plain text
11063 #: build/C/man2/unlink.2:45
11065 "B<unlink>() deletes a name from the file system. If that name was the last "
11066 "link to a file and no processes have the file open the file is deleted and "
11067 "the space it was using is made available for reuse."
11070 #. type: Plain text
11071 #: build/C/man2/unlink.2:49
11073 "If the name was the last link to a file but any processes still have the "
11074 "file open the file will remain in existence until the last file descriptor "
11075 "referring to it is closed."
11078 #. type: Plain text
11079 #: build/C/man2/unlink.2:51
11080 msgid "If the name referred to a symbolic link the link is removed."
11083 #. type: Plain text
11084 #: build/C/man2/unlink.2:55
11086 "If the name referred to a socket, fifo or device the name for it is removed "
11087 "but processes which have the object open may continue to use it."
11090 #. type: Plain text
11091 #: build/C/man2/unlink.2:71
11093 "Write access to the directory containing I<pathname> is not allowed for the "
11094 "process's effective UID, or one of the directories in I<pathname> did not "
11095 "allow search permission. (See also B<path_resolution>(7).)"
11098 #. type: Plain text
11099 #: build/C/man2/unlink.2:80
11101 "The file I<pathname> cannot be unlinked because it is being used by the "
11102 "system or another process; for example, it is a mount point or the NFS "
11103 "client software created it to represent an active but otherwise nameless "
11104 "inode (\"NFS silly renamed\")."
11107 #. type: Plain text
11108 #: build/C/man2/unlink.2:92
11110 "I<pathname> refers to a directory. (This is the non-POSIX value returned by "
11111 "Linux since 2.1.132.)"
11114 #. type: Plain text
11115 #: build/C/man2/unlink.2:96
11116 msgid "Too many symbolic links were encountered in translating I<pathname>."
11119 #. type: Plain text
11120 #: build/C/man2/unlink.2:106
11122 "A component in I<pathname> does not exist or is a dangling symbolic link, or "
11123 "I<pathname> is empty."
11126 #. type: Plain text
11127 #: build/C/man2/unlink.2:114
11128 msgid "A component used as a directory in I<pathname> is not, in fact, a directory."
11131 #. type: Plain text
11132 #: build/C/man2/unlink.2:123
11134 "The system does not allow unlinking of directories, or unlinking of "
11135 "directories requires privileges that the calling process doesn't have. "
11136 "(This is the POSIX prescribed error return; as noted above, Linux returns "
11137 "B<EISDIR> for this case.)"
11141 #: build/C/man2/unlink.2:123
11143 msgid "B<EPERM> (Linux only)"
11146 #. type: Plain text
11147 #: build/C/man2/unlink.2:126
11148 msgid "The file system does not allow unlinking of files."
11151 #. type: Plain text
11152 #: build/C/man2/unlink.2:137
11154 "The directory containing I<pathname> has the sticky bit (B<S_ISVTX>) set "
11155 "and the process's effective UID is neither the UID of the file to be deleted "
11156 "nor that of the directory containing it, and the process is not privileged "
11157 "(Linux: does not have the B<CAP_FOWNER> capability)."
11160 #. type: Plain text
11161 #: build/C/man2/unlink.2:141
11162 msgid "I<pathname> refers to a file on a read-only file system."
11165 #. type: Plain text
11166 #: build/C/man2/unlink.2:160
11168 "B<rm>(1), B<chmod>(2), B<link>(2), B<mknod>(2), B<open>(2), B<rename>(2), "
11169 "B<rmdir>(2), B<unlinkat>(2), B<mkfifo>(3), B<remove>(3), "
11170 "B<path_resolution>(7), B<symlink>(7)"
11174 #: build/C/man3/unlocked_stdio.3:23
11176 msgid "UNLOCKED_STDIO"
11179 #. type: Plain text
11180 #: build/C/man3/unlocked_stdio.3:27
11182 "getc_unlocked, getchar_unlocked, putc_unlocked, putchar_unlocked - "
11183 "nonlocking stdio functions"
11186 #. type: Plain text
11187 #: build/C/man3/unlocked_stdio.3:35
11190 "B<int getc_unlocked(FILE *>I<stream>B<);>\n"
11191 "B<int getchar_unlocked(void);>\n"
11192 "B<int putc_unlocked(int >I<c>B<, FILE *>I<stream>B<);>\n"
11193 "B<int putchar_unlocked(int >I<c>B<);>\n"
11196 #. type: Plain text
11197 #: build/C/man3/unlocked_stdio.3:47
11200 "B<void clearerr_unlocked(FILE *>I<stream>B<);>\n"
11201 "B<int feof_unlocked(FILE *>I<stream>B<);>\n"
11202 "B<int ferror_unlocked(FILE *>I<stream>B<);>\n"
11203 "B<int fileno_unlocked(FILE *>I<stream>B<);>\n"
11204 "B<int fflush_unlocked(FILE *>I<stream>B<);>\n"
11205 "B<int fgetc_unlocked(FILE *>I<stream>B<);>\n"
11206 "B<int fputc_unlocked(int >I<c>B<, FILE *>I<stream>B<);>\n"
11207 "B<size_t fread_unlocked(void *>I<ptr>B<, size_t >I<size>B<, size_t "
11209 "B< FILE *>I<stream>B<);>\n"
11210 "B<size_t fwrite_unlocked(const void *>I<ptr>B<, size_t >I<size>B<, size_t "
11212 "B< FILE *>I<stream>B<);>\n"
11215 #. type: Plain text
11216 #: build/C/man3/unlocked_stdio.3:50
11219 "B<char *fgets_unlocked(char *>I<s>B<, int >I<n>B<, FILE *>I<stream>B<);>\n"
11220 "B<int fputs_unlocked(const char *>I<s>B<, FILE *>I<stream>B<);>\n"
11223 #. type: Plain text
11224 #: build/C/man3/unlocked_stdio.3:61
11227 "B<wint_t getwc_unlocked(FILE *>I<stream>B<);>\n"
11228 "B<wint_t getwchar_unlocked(void);>\n"
11229 "B<wint_t fgetwc_unlocked(FILE *>I<stream>B<);>\n"
11230 "B<wint_t fputwc_unlocked(wchar_t >I<wc>B<, FILE *>I<stream>B<);>\n"
11231 "B<wint_t putwc_unlocked(wchar_t >I<wc>B<, FILE *>I<stream>B<);>\n"
11232 "B<wint_t putwchar_unlocked(wchar_t >I<wc>B<);>\n"
11233 "B<wchar_t *fgetws_unlocked(wchar_t *>I<ws>B<, int >I<n>B<, FILE "
11234 "*>I<stream>B<);>\n"
11235 "B<int fputws_unlocked(const wchar_t *>I<ws>B<, FILE *>I<stream>B<);>\n"
11238 #. type: Plain text
11239 #: build/C/man3/unlocked_stdio.3:73
11241 "B<getc_unlocked>(), B<getchar_unlocked>(), B<putc_unlocked>(), "
11242 "B<putchar_unlocked>():"
11245 #. type: Plain text
11246 #: build/C/man3/unlocked_stdio.3:76
11248 "_POSIX_C_SOURCE\\ E<gt>=\\ 1 || _XOPEN_SOURCE || _POSIX_SOURCE || "
11249 "_BSD_SOURCE || _SVID_SOURCE"
11252 #. type: Plain text
11253 #: build/C/man3/unlocked_stdio.3:87
11255 "B<clearerr_unlocked>(), B<feof_unlocked>(), B<ferror_unlocked>(), "
11256 "B<fileno_unlocked>(), B<fflush_unlocked>(), B<fgetc_unlocked>(), "
11257 "B<fputc_unlocked>(), B<fread_unlocked>(), B<fwrite_unlocked>():"
11260 #. type: Plain text
11261 #: build/C/man3/unlocked_stdio.3:89
11262 msgid "_BSD_SOURCE || _SVID_SOURCE"
11265 #. type: Plain text
11266 #: build/C/man3/unlocked_stdio.3:100
11268 "B<fgets_unlocked>(), B<fputs_unlocked>(), B<getwc_unlocked>(), "
11269 "B<getwchar_unlocked>(), B<fgetwc_unlocked>(), B<fputwc_unlocked>(), "
11270 "B<putwchar_unlocked>(), B<fgetws_unlocked>(), B<fputws_unlocked>():"
11273 #. type: Plain text
11274 #: build/C/man3/unlocked_stdio.3:111
11276 "Each of these functions has the same behavior as its counterpart without the "
11277 "\"_unlocked\" suffix, except that they do not use locking (they do not set "
11278 "locks themselves, and do not test for the presence of locks set by others) "
11279 "and hence are thread-unsafe. See B<flockfile>(3)."
11282 #. type: Plain text
11283 #: build/C/man3/unlocked_stdio.3:118
11285 "The four functions B<getc_unlocked>(), B<getchar_unlocked>(), "
11286 "B<putc_unlocked>(), B<putchar_unlocked>() are in POSIX.1-2001."
11289 #. E.g., in HP-UX 10.0. In HP-UX 10.30 they are called obsolescent, and
11290 #. moved to a compatibility library.
11291 #. Available in HP-UX 10.0: clearerr_unlocked, fclose_unlocked,
11292 #. feof_unlocked, ferror_unlocked, fflush_unlocked, fgets_unlocked,
11293 #. fgetwc_unlocked, fgetws_unlocked, fileno_unlocked, fputs_unlocked,
11294 #. fputwc_unlocked, fputws_unlocked, fread_unlocked, fseek_unlocked,
11295 #. ftell_unlocked, fwrite_unlocked, getc_unlocked, getchar_unlocked,
11296 #. getw_unlocked, getwc_unlocked, getwchar_unlocked, putc_unlocked,
11297 #. putchar_unlocked, puts_unlocked, putws_unlocked, putw_unlocked,
11298 #. putwc_unlocked, putwchar_unlocked, rewind_unlocked, setvbuf_unlocked,
11299 #. ungetc_unlocked, ungetwc_unlocked.
11300 #. type: Plain text
11301 #: build/C/man3/unlocked_stdio.3:134
11303 "The nonstandard B<*_unlocked>() variants occur on a few UNIX systems, and "
11304 "are available in recent glibc. They should probably not be used."
11307 #. type: Plain text
11308 #: build/C/man3/unlocked_stdio.3:136
11309 msgid "B<flockfile>(3), B<stdio>(3)"
11313 #: build/C/man3/wprintf.3:14
11319 #: build/C/man3/wprintf.3:14
11324 #. type: Plain text
11325 #: build/C/man3/wprintf.3:18
11327 "wprintf, fwprintf, swprintf, vwprintf, vfwprintf, vswprintf - formatted "
11328 "wide-character output conversion"
11331 #. type: Plain text
11332 #: build/C/man3/wprintf.3:22
11335 "B<#include E<lt>stdio.hE<gt>>\n"
11336 "B<#include E<lt>wchar.hE<gt>>\n"
11339 #. type: Plain text
11340 #: build/C/man3/wprintf.3:27
11343 "B<int wprintf(const wchar_t *>I<format>B<, ...);>\n"
11344 "B<int fwprintf(FILE *>I<stream>B<, const wchar_t *>I<format>B<, ...);>\n"
11345 "B<int swprintf(wchar_t *>I<wcs>B<, size_t >I<maxlen>B<,>\n"
11346 "B< const wchar_t *>I<format>B<, ...);>\n"
11349 #. type: Plain text
11350 #: build/C/man3/wprintf.3:32
11353 "B<int vwprintf(const wchar_t *>I<format>B<, va_list >I<args>B<);>\n"
11354 "B<int vfwprintf(FILE *>I<stream>B<, const wchar_t *>I<format>B<, va_list "
11356 "B<int vswprintf(wchar_t *>I<wcs>B<, size_t >I<maxlen>B<,>\n"
11357 "B< const wchar_t *>I<format>B<, va_list >I<args>B<);>\n"
11361 #. .BR fwprintf (),
11362 #. .BR swprintf (),
11363 #. .BR vwprintf (),
11364 #. .BR vfwprintf (),
11365 #. .BR vswprintf ():
11366 #. type: Plain text
11367 #: build/C/man3/wprintf.3:49
11368 msgid "_XOPEN_SOURCE\\ E<gt>=\\ 500 || _ISOC99_SOURCE ||"
11371 #. type: Plain text
11372 #: build/C/man3/wprintf.3:51
11373 msgid "_ISOC95_SOURCE /* Since glibc 2.12 */ ||"
11376 #. type: Plain text
11377 #: build/C/man3/wprintf.3:53
11378 msgid "_POSIX_C_SOURCE\\ E<gt>=\\ 200112L;"
11381 #. type: Plain text
11382 #: build/C/man3/wprintf.3:56
11383 msgid "or I<cc\\ -std=c99>"
11386 #. type: Plain text
11387 #: build/C/man3/wprintf.3:67
11389 "The B<wprintf>() family of functions is the wide-character equivalent of "
11390 "the B<printf>(3) family of functions. It performs formatted output of wide "
11394 #. type: Plain text
11395 #: build/C/man3/wprintf.3:77
11397 "The B<wprintf>() and B<vwprintf>() functions perform wide-character output "
11398 "to I<stdout>. I<stdout> must not be byte oriented; see B<fwide>(3) for "
11399 "more information."
11402 #. type: Plain text
11403 #: build/C/man3/wprintf.3:87
11405 "The B<fwprintf>() and B<vfwprintf>() functions perform wide-character "
11406 "output to I<stream>. I<stream> must not be byte oriented; see B<fwide>(3) "
11407 "for more information."
11410 #. type: Plain text
11411 #: build/C/man3/wprintf.3:98
11413 "The B<swprintf>() and B<vswprintf>() functions perform wide-character "
11414 "output to an array of wide characters. The programmer must ensure that "
11415 "there is room for at least I<maxlen> wide characters at I<wcs>."
11418 #. type: Plain text
11419 #: build/C/man3/wprintf.3:109
11421 "These functions are like the B<printf>(3), B<vprintf>(3), B<fprintf>(3), "
11422 "B<vfprintf>(3), B<sprintf>(3), B<vsprintf>(3) functions except for the "
11423 "following differences:"
11427 #: build/C/man3/wprintf.3:109 build/C/man3/wprintf.3:112 build/C/man3/wprintf.3:115
11432 #. type: Plain text
11433 #: build/C/man3/wprintf.3:112
11434 msgid "The I<format> string is a wide-character string."
11437 #. type: Plain text
11438 #: build/C/man3/wprintf.3:115
11439 msgid "The output consists of wide characters, not bytes."
11442 #. type: Plain text
11443 #: build/C/man3/wprintf.3:130
11445 "B<swprintf>() and B<vswprintf>() take a I<maxlen> argument, B<sprintf>(3) "
11446 "and B<vsprintf>(3) do not. (B<snprintf>(3) and B<vsnprintf>(3) take a "
11447 "I<maxlen> argument, but these functions do not return -1 upon buffer "
11448 "overflow on Linux.)"
11451 #. type: Plain text
11452 #: build/C/man3/wprintf.3:132
11453 msgid "The treatment of the conversion characters B<c> and B<s> is different:"
11456 #. type: Plain text
11457 #: build/C/man3/wprintf.3:146
11459 "If no B<l> modifier is present, the I<int> argument is converted to a wide "
11460 "character by a call to the B<btowc>(3) function, and the resulting wide "
11461 "character is written. If an B<l> modifier is present, the I<wint_t> (wide "
11462 "character) argument is written."
11465 #. type: Plain text
11466 #: build/C/man3/wprintf.3:185
11468 "If no B<l> modifier is present: The I<const\\ char\\ *> argument is expected "
11469 "to be a pointer to an array of character type (pointer to a string) "
11470 "containing a multibyte character sequence beginning in the initial shift "
11471 "state. Characters from the array are converted to wide characters (each by "
11472 "a call to the B<mbrtowc>(3) function with a conversion state starting in "
11473 "the initial state before the first byte). The resulting wide characters are "
11474 "written up to (but not including) the terminating null wide character. If a "
11475 "precision is specified, no more wide characters than the number specified "
11476 "are written. Note that the precision determines the number of I<wide "
11477 "characters> written, not the number of I<bytes> or I<screen positions>. The "
11478 "array must contain a terminating null byte, unless a precision is given and "
11479 "it is so small that the number of converted wide characters reaches it "
11480 "before the end of the array is reached. If an B<l> modifier is present: The "
11481 "I<const\\ wchar_t\\ *> argument is expected to be a pointer to an array of "
11482 "wide characters. Wide characters from the array are written up to (but not "
11483 "including) a terminating null wide character. If a precision is specified, "
11484 "no more than the number specified are written. The array must contain a "
11485 "terminating null wide character, unless a precision is given and it is "
11486 "smaller than or equal to the number of wide characters in the array."
11489 #. type: Plain text
11490 #: build/C/man3/wprintf.3:193
11492 "The functions return the number of wide characters written, excluding the "
11493 "terminating null wide character in case of the functions B<swprintf>() and "
11494 "B<vswprintf>(). They return -1 when an error occurs."
11497 #. type: Plain text
11498 #: build/C/man3/wprintf.3:195
11502 #. type: Plain text
11503 #: build/C/man3/wprintf.3:203
11505 "The behavior of B<wprintf>() et al. depends on the B<LC_CTYPE> category of "
11506 "the current locale."
11509 #. type: Plain text
11510 #: build/C/man3/wprintf.3:229
11512 "If the I<format> string contains non-ASCII wide characters, the program will "
11513 "only work correctly if the B<LC_CTYPE> category of the current locale at run "
11514 "time is the same as the B<LC_CTYPE> category of the current locale at "
11515 "compile time. This is because the I<wchar_t> representation is platform- "
11516 "and locale-dependent. (The glibc represents wide characters using their "
11517 "Unicode (ISO-10646) code point, but other platforms don't do this. Also, "
11518 "the use of C99 universal character names of the form \\eunnnn does not solve "
11519 "this problem.) Therefore, in internationalized programs, the I<format> "
11520 "string should consist of ASCII wide characters only, or should be "
11521 "constructed at run time in an internationalized way (e.g., using "
11522 "B<gettext>(3) or B<iconv>(3), followed by B<mbstowcs>(3))."
11525 #. type: Plain text
11526 #: build/C/man3/wprintf.3:234
11527 msgid "B<fprintf>(3), B<fputwc>(3), B<fwide>(3), B<printf>(3), B<snprintf>(3)"
11531 #: build/C/man2/write.2:39
11537 #: build/C/man2/write.2:39
11542 #. type: Plain text
11543 #: build/C/man2/write.2:42
11544 msgid "write - write to a file descriptor"
11547 #. type: Plain text
11548 #: build/C/man2/write.2:46
11549 msgid "B<ssize_t write(int >I<fd>B<, const void *>I<buf>B<, size_t >I<count>B<);>"
11552 #. type: Plain text
11553 #: build/C/man2/write.2:54
11555 "B<write>() writes up to I<count> bytes from the buffer pointed I<buf> to "
11556 "the file referred to by the file descriptor I<fd>."
11559 #. type: Plain text
11560 #: build/C/man2/write.2:68
11562 "The number of bytes written may be less than I<count> if, for example, there "
11563 "is insufficient space on the underlying physical medium, or the "
11564 "B<RLIMIT_FSIZE> resource limit is encountered (see B<setrlimit>(2)), or the "
11565 "call was interrupted by a signal handler after having written less than "
11566 "I<count> bytes. (See also B<pipe>(7).)"
11569 #. type: Plain text
11570 #: build/C/man2/write.2:82
11572 "For a seekable file (i.e., one to which B<lseek>(2) may be applied, for "
11573 "example, a regular file) writing takes place at the current file offset, "
11574 "and the file offset is incremented by the number of bytes actually written. "
11575 "If the file was B<open>(2)ed with B<O_APPEND>, the file offset is first set "
11576 "to the end of the file before writing. The adjustment of the file offset "
11577 "and the write operation are performed as an atomic step."
11580 #. type: Plain text
11581 #: build/C/man2/write.2:89
11583 "POSIX requires that a B<read>(2) which can be proved to occur after a "
11584 "B<write>() has returned returns the new data. Note that not all file "
11585 "systems are POSIX conforming."
11588 #. type: Plain text
11589 #: build/C/man2/write.2:94
11591 "On success, the number of bytes written is returned (zero indicates nothing "
11592 "was written). On error, -1 is returned, and I<errno> is set appropriately."
11595 #. type: Plain text
11596 #: build/C/man2/write.2:107
11598 "If I<count> is zero and I<fd> refers to a regular file, then B<write>() may "
11599 "return a failure status if one of the errors below is detected. If no "
11600 "errors are detected, 0 will be returned without causing any other effect. "
11601 "If I<count> is zero and I<fd> refers to a file other than a regular file, "
11602 "the results are not specified."
11605 #. type: Plain text
11606 #: build/C/man2/write.2:115
11608 "The file descriptor I<fd> refers to a file other than a socket and has been "
11609 "marked nonblocking (B<O_NONBLOCK>), and the write would block."
11612 #. Actually EAGAIN on Linux
11613 #. type: Plain text
11614 #: build/C/man2/write.2:126
11616 "The file descriptor I<fd> refers to a socket and has been marked nonblocking "
11617 "(B<O_NONBLOCK>), and the write would block. POSIX.1-2001 allows either "
11618 "error to be returned for this case, and does not require these constants to "
11619 "have the same value, so a portable application should check for both "
11623 #. type: Plain text
11624 #: build/C/man2/write.2:130
11625 msgid "I<fd> is not a valid file descriptor or is not open for writing."
11629 #: build/C/man2/write.2:130
11631 msgid "B<EDESTADDRREQ>"
11634 #. type: Plain text
11635 #: build/C/man2/write.2:135
11637 "I<fd> refers to a datagram socket for which a peer address has not been set "
11638 "using B<connect>(2)."
11641 #. type: Plain text
11642 #: build/C/man2/write.2:144
11644 "An attempt was made to write a file that exceeds the implementation-defined "
11645 "maximum file size or the process's file size limit, or to write at a "
11646 "position past the maximum allowed offset."
11649 #. type: Plain text
11650 #: build/C/man2/write.2:148
11652 "The call was interrupted by a signal before any data was written; see "
11656 #. type: Plain text
11657 #: build/C/man2/write.2:159
11659 "I<fd> is attached to an object which is unsuitable for writing; or the file "
11660 "was opened with the B<O_DIRECT> flag, and either the address specified in "
11661 "I<buf>, the value specified in I<count>, or the current file offset is not "
11662 "suitably aligned."
11665 #. type: Plain text
11666 #: build/C/man2/write.2:162
11667 msgid "A low-level I/O error occurred while modifying the inode."
11670 #. type: Plain text
11671 #: build/C/man2/write.2:167
11673 "The device containing the file referred to by I<fd> has no room for the "
11678 #: build/C/man2/write.2:167
11683 #. type: Plain text
11684 #: build/C/man2/write.2:176
11686 "I<fd> is connected to a pipe or socket whose reading end is closed. When "
11687 "this happens the writing process will also receive a B<SIGPIPE> signal. "
11688 "(Thus, the write return value is seen only if the program catches, blocks or "
11689 "ignores this signal.)"
11692 #. type: Plain text
11693 #: build/C/man2/write.2:179
11694 msgid "Other errors may occur, depending on the object connected to I<fd>."
11697 #. type: Plain text
11698 #: build/C/man2/write.2:188
11700 "Under SVr4 a write may be interrupted and return B<EINTR> at any point, not "
11701 "just before any data is written."
11704 #. type: Plain text
11705 #: build/C/man2/write.2:197
11707 "A successful return from B<write>() does not make any guarantee that data "
11708 "has been committed to disk. In fact, on some buggy implementations, it does "
11709 "not even guarantee that space has successfully been reserved for the data. "
11710 "The only way to be sure is to call B<fsync>(2) after you are done writing "
11714 #. type: Plain text
11715 #: build/C/man2/write.2:205
11717 "If a B<write>() is interrupted by a signal handler before any bytes are "
11718 "written, then the call fails with the error B<EINTR>; if it is interrupted "
11719 "after at least one byte has been written, the call succeeds, and returns the "
11720 "number of bytes written."
11723 #. type: Plain text
11724 #: build/C/man2/write.2:216
11726 "B<close>(2), B<fcntl>(2), B<fsync>(2), B<ioctl>(2), B<lseek>(2), B<open>(2), "
11727 "B<pwrite>(2), B<read>(2), B<select>(2), B<writev>(2), B<fwrite>(3)"