xref: /openbsd/lib/libc/stdio/fputs.3 (revision 3d8817e4)
1.\"	$OpenBSD: fputs.3,v 1.8 2007/05/31 19:19:31 jmc 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: May 31 2007 $
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.Fd #include <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.\" The terminating
55.\" .Tn NUL
56.\" character is not written.
57.Pp
58The function
59.Fn puts
60writes the string
61.Fa str ,
62and a terminating newline character,
63to the stream
64.Em stdout .
65.Sh RETURN VALUES
66The
67.Fn fputs
68function returns 0 on success and
69.Dv EOF
70on error;
71.Fn puts
72returns a non-negative integer on success and
73.Dv EOF
74on error.
75.Sh ERRORS
76.Bl -tag -width Er
77.It Bq Er EBADF
78The
79.Fa stream
80supplied
81is not a writable stream.
82.El
83.Pp
84The functions
85.Fn fputs
86and
87.Fn puts
88may also fail and set
89.Va errno
90for any of the errors specified for the routines
91.Xr write 2 .
92.Sh SEE ALSO
93.Xr ferror 3 ,
94.Xr putc 3 ,
95.Xr stdio 3
96.Sh STANDARDS
97The functions
98.Fn fputs
99and
100.Fn puts
101conform to
102.St -ansiC .
103