xref: /openbsd/lib/libc/stdio/fputs.3 (revision 5dea098c)
1.\"	$OpenBSD: fputs.3,v 1.13 2017/12/01 11:18:40 schwarze Exp $
2.\"
3.\" Copyright (c) 1990, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Chris Torek and the American National Standards Committee X3,
8.\" on Information Processing Systems.
9.\"
10.\" Redistribution and use in source and binary forms, with or without
11.\" modification, are permitted provided that the following conditions
12.\" are met:
13.\" 1. Redistributions of source code must retain the above copyright
14.\"    notice, this list of conditions and the following disclaimer.
15.\" 2. Redistributions in binary form must reproduce the above copyright
16.\"    notice, this list of conditions and the following disclaimer in the
17.\"    documentation and/or other materials provided with the distribution.
18.\" 3. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.Dd $Mdocdate: December 1 2017 $
35.Dt FPUTS 3
36.Os
37.Sh NAME
38.Nm fputs ,
39.Nm puts
40.Nd output a line to a stream
41.Sh SYNOPSIS
42.In stdio.h
43.Ft int
44.Fn fputs "const char *str" "FILE *stream"
45.Ft int
46.Fn puts "const char *str"
47.Sh DESCRIPTION
48The function
49.Fn fputs
50writes the string pointed to by
51.Fa str
52to the stream pointed to by
53.Fa stream .
54.Pp
55The function
56.Fn puts
57writes the string
58.Fa str ,
59and a terminating newline character,
60to the stream
61.Em stdout .
62.Sh RETURN VALUES
63Upon successful completion a non-negative integer is returned.
64Otherwise,
65.Dv EOF
66is returned, the global variable
67.Va errno
68is set to indicate the error,
69and the error indicator is set for the stream.
70.Sh ERRORS
71.Bl -tag -width Er
72.It Bq Er EBADF
73The
74.Fa stream
75supplied
76is not a writable stream.
77.El
78.Pp
79The functions
80.Fn fputs
81and
82.Fn puts
83may also fail and set
84.Va errno
85for any of the errors specified for the routines
86.Xr write 2 .
87.Sh SEE ALSO
88.Xr ferror 3 ,
89.Xr fputws 3 ,
90.Xr putc 3 ,
91.Xr stdio 3
92.Sh STANDARDS
93The functions
94.Fn fputs
95and
96.Fn puts
97conform to
98.St -ansiC .
99.Sh HISTORY
100The function
101.Fn puts
102first appeared in
103.At v6
104and
105.Fn fputs
106in
107.At v7 .
108