xref: /freebsd/lib/libc/stdio/fputs.3 (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
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.\" $FreeBSD$
38.\"
39.Dd June 4, 1993
40.Dt FPUTS 3
41.Os
42.Sh NAME
43.Nm fputs ,
44.Nm puts
45.Nd output a line to a stream
46.Sh LIBRARY
47.Lb libc
48.Sh SYNOPSIS
49.In stdio.h
50.Ft int
51.Fn fputs "const char *str" "FILE *stream"
52.Ft int
53.Fn puts "const char *str"
54.Sh DESCRIPTION
55The function
56.Fn fputs
57writes the string pointed to by
58.Fa str
59to the stream pointed to by
60.Fa stream .
61.\" The terminating
62.\" .Dv NUL
63.\" character is not written.
64.Pp
65The function
66.Fn puts
67writes the string
68.Fa str ,
69and a terminating newline character,
70to the stream
71.Dv stdout .
72.Sh RETURN VALUES
73The
74.Fn fputs
75function
76returns 0 on success and
77.Dv EOF
78on error;
79.Fn puts
80returns a nonnegative integer on success and
81.Dv EOF
82on error.
83.Sh ERRORS
84.Bl -tag -width Er
85.It Bq Er EBADF
86The
87.Fa stream
88argument
89is not a writable stream.
90.El
91.Pp
92The functions
93.Fn fputs
94and
95.Fn puts
96may also fail and set
97.Va errno
98for any of the errors specified for the routines
99.Xr write 2 .
100.Sh SEE ALSO
101.Xr ferror 3 ,
102.Xr fputws 3 ,
103.Xr putc 3 ,
104.Xr stdio 3
105.Sh STANDARDS
106The functions
107.Fn fputs
108and
109.Fn puts
110conform to
111.St -isoC .
112