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