summaryrefslogtreecommitdiffstats
path: root/man3const/EOF.3const
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--man3const/EOF.3const42
1 files changed, 42 insertions, 0 deletions
diff --git a/man3const/EOF.3const b/man3const/EOF.3const
new file mode 100644
index 0000000..ae64401
--- /dev/null
+++ b/man3const/EOF.3const
@@ -0,0 +1,42 @@
+.\" Copyright (c) 2022 by Alejandro Colomar <alx@kernel.org>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.\"
+.TH EOF 3const 2023-02-05 "Linux man-pages 6.05.01"
+.SH NAME
+EOF \- end of file or error indicator
+.SH LIBRARY
+Standard C library
+.RI ( libc )
+.SH SYNOPSIS
+.nf
+.B #include <stdio.h>
+.PP
+.BR "#define EOF " "/* ... */"
+.fi
+.SH DESCRIPTION
+.B EOF
+represents the end of an input file, or an error indication.
+It is a negative value, of type
+.IR int .
+.PP
+.B EOF
+is not a character
+(it can't be represented by
+.IR "unsigned char" ).
+It is instead a sentinel value outside of the valid range for valid characters.
+.SH CONFORMING TO
+C99 and later;
+POSIX.1-2001 and later.
+.SH CAVEATS
+Programs can't pass this value to an output function
+to "write" the end of a file.
+That would likely result in undefined behavior.
+Instead,
+closing the writing stream or file descriptor
+that refers to such file
+is the way to signal the end of that file.
+.SH SEE ALSO
+.BR feof (3),
+.BR fgetc (3)