xref: /freebsd/lib/libc/stdio/fputs.3 (revision aa24f48b361effe51163877d84f1b70d32b77e04)
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. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)fputs.3	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD$
34.\"
35.Dd June 4, 1993
36.Dt FPUTS 3
37.Os
38.Sh NAME
39.Nm fputs ,
40.Nm puts
41.Nd output a line to a stream
42.Sh LIBRARY
43.Lb libc
44.Sh SYNOPSIS
45.In stdio.h
46.Ft int
47.Fn fputs "const char *str" "FILE *stream"
48.Ft int
49.Fn puts "const char *str"
50.Sh DESCRIPTION
51The function
52.Fn fputs
53writes the string pointed to by
54.Fa str
55to the stream pointed to by
56.Fa stream .
57.\" The terminating
58.\" .Dv NUL
59.\" character is not written.
60.Pp
61The function
62.Fn puts
63writes the string
64.Fa str ,
65and a terminating newline character,
66to the stream
67.Dv stdout .
68.Sh RETURN VALUES
69The functions
70.Fn fputs
71and
72.Fn puts
73return a nonnegative integer on success and
74.Dv EOF
75on error.
76.Sh ERRORS
77.Bl -tag -width Er
78.It Bq Er EBADF
79The
80.Fa stream
81argument
82is not a writable stream.
83.El
84.Pp
85The functions
86.Fn fputs
87and
88.Fn puts
89may also fail and set
90.Va errno
91for any of the errors specified for the routines
92.Xr write 2 .
93.Sh SEE ALSO
94.Xr ferror 3 ,
95.Xr fputws 3 ,
96.Xr putc 3 ,
97.Xr stdio 3
98.Sh STANDARDS
99The functions
100.Fn fputs
101and
102.Fn puts
103conform to
104.St -isoC .
105