summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/fputs.3p
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3p/fputs.3p
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3p/fputs.3p')
-rw-r--r--upstream/archlinux/man3p/fputs.3p156
1 files changed, 156 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/fputs.3p b/upstream/archlinux/man3p/fputs.3p
new file mode 100644
index 00000000..9fe6576e
--- /dev/null
+++ b/upstream/archlinux/man3p/fputs.3p
@@ -0,0 +1,156 @@
+'\" et
+.TH FPUTS "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+This manual page is part of the POSIX Programmer's Manual.
+The Linux implementation of this interface may differ (consult
+the corresponding Linux manual page for details of Linux behavior),
+or the interface may not be implemented on Linux.
+.\"
+.SH NAME
+fputs
+\(em put a string on a stream
+.SH SYNOPSIS
+.LP
+.nf
+#include <stdio.h>
+.P
+int fputs(const char *restrict \fIs\fP, FILE *restrict \fIstream\fP);
+.fi
+.SH DESCRIPTION
+The functionality described on this reference page is aligned with the
+ISO\ C standard. Any conflict between the requirements described here and the
+ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
+.P
+The
+\fIfputs\fR()
+function shall write the null-terminated string pointed to by
+.IR s
+to the stream pointed to by
+.IR stream .
+The terminating null byte shall not be written.
+.P
+The last data modification and last file status change timestamps
+of the file shall be marked for update between the successful
+execution of
+\fIfputs\fR()
+and the next successful completion of a call to
+\fIfflush\fR()
+or
+\fIfclose\fR()
+on the same stream or a call to
+\fIexit\fR()
+or
+\fIabort\fR().
+.SH "RETURN VALUE"
+Upon successful completion,
+\fIfputs\fR()
+shall return a non-negative number. Otherwise, it shall return EOF,
+set an error indicator for the stream,
+and set
+.IR errno
+to indicate the error.
+.SH ERRORS
+Refer to
+.IR "\fIfputc\fR\^(\|)".
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+.SS "Printing to Standard Output"
+.P
+The following example gets the current time, converts it to a string
+using
+\fIlocaltime\fR()
+and
+\fIasctime\fR(),
+and prints it to standard output using
+\fIfputs\fR().
+It then prints the number of minutes to an event for which it is
+waiting.
+.sp
+.RS 4
+.nf
+
+#include <time.h>
+#include <stdio.h>
+\&...
+time_t now;
+int minutes_to_event;
+\&...
+time(&now);
+printf("The time is ");
+fputs(asctime(localtime(&now)), stdout);
+printf("There are still %d minutes to the event.\en",
+ minutes_to_event);
+\&...
+.fi
+.P
+.RE
+.SH "APPLICATION USAGE"
+The
+\fIputs\fR()
+function appends a
+<newline>
+while
+\fIfputs\fR()
+does not.
+.P
+This volume of POSIX.1\(hy2017 requires that successful completion simply return a non-negative
+integer. There are at least three known different implementation
+conventions for this requirement:
+.IP " *" 4
+Return a constant value.
+.IP " *" 4
+Return the last character written.
+.IP " *" 4
+Return the number of bytes written. Note that this implementation
+convention cannot be adhered to for strings longer than
+{INT_MAX}
+bytes as the value would not be representable in the return type of the
+function. For backwards-compatibility, implementations can return the
+number of bytes for strings of up to
+{INT_MAX}
+bytes, and return
+{INT_MAX}
+for all longer strings.
+.SH RATIONALE
+The
+\fIfputs\fR()
+function is one whose source code was specified in the referenced \fIThe C Programming Language\fP. In the
+original edition, the function had no defined return value, yet many
+practical implementations would, as a side-effect, return the value of the
+last character written as that was the value remaining in the accumulator
+used as a return value. In the second edition of the book, either the
+fixed value 0 or EOF would be returned depending upon the return value of
+\fIferror\fR();
+however, for compatibility with extant implementations, several
+implementations would, upon success, return a positive value representing
+the last byte written.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.IR "Section 2.5" ", " "Standard I/O Streams",
+.IR "\fIfopen\fR\^(\|)",
+.IR "\fIputc\fR\^(\|)",
+.IR "\fIputs\fR\^(\|)"
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<stdio.h>\fP"
+.\"
+.SH COPYRIGHT
+Portions of this text are reprinted and reproduced in electronic form
+from IEEE Std 1003.1-2017, Standard for Information Technology
+-- Portable Operating System Interface (POSIX), The Open Group Base
+Specifications Issue 7, 2018 Edition,
+Copyright (C) 2018 by the Institute of
+Electrical and Electronics Engineers, Inc and The Open Group.
+In the event of any discrepancy between this version and the original IEEE and
+The Open Group Standard, the original IEEE and The Open Group Standard
+is the referee document. The original Standard can be obtained online at
+http://www.opengroup.org/unix/online.html .
+.PP
+Any typographical or formatting errors that appear
+in this page are most likely
+to have been introduced during the conversion of the source files to
+man page format. To report such errors, see
+https://www.kernel.org/doc/man-pages/reporting_bugs.html .