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