xref: /freebsd/lib/libc/stdio/fputs.3 (revision a1a4f1a0d87b594d3f17a97dc0127eec1417e6f6)
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 SYNOPSIS
47.Fd #include <stdio.h>
48.Ft int
49.Fn fputs "const char *str" "FILE *stream"
50.Ft int
51.Fn puts "const char *str"
52.Sh DESCRIPTION
53The function
54.Fn fputs
55writes the string pointed to by
56.Fa str
57to the stream pointed to by
58.Fa stream .
59.\" The terminating
60.\" .Dv NUL
61.\" character is not written.
62.Pp
63The function
64.Fn puts
65writes the string
66.Fa str ,
67and a terminating newline character,
68to the stream
69.Em stdout .
70.Sh RETURN VALUES
71The
72.Fn fputs
73function
74returns 0 on success and
75.Dv EOF
76on error;
77.Fn puts
78returns a nonnegative integer on success and
79.Dv EOF
80on error.
81.Sh ERRORS
82.Bl -tag -width [EBADF]
83.It Bq Er EBADF
84The
85.Fa stream
86supplied
87is not a writable stream.
88.El
89.Pp
90The functions
91.Fn fputs
92and
93.Fn puts
94may also fail and set
95.Va errno
96for any of the errors specified for the routines
97.Xr write 2 .
98.Sh SEE ALSO
99.Xr ferror 3 ,
100.Xr putc 3 ,
101.Xr stdio 3
102.Sh STANDARDS
103The functions
104.Fn fputs
105and
106.Fn puts
107conform to
108.St -ansiC .
109