Sync libc/stdio with FreeBSD:
[dragonfly.git] / lib / libc / stdio / fputs.3
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 .\" 4. 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: src/lib/libc/stdio/fputs.3,v 1.14 2007/04/19 14:01:04 phk Exp $
34 .\" $DragonFly: src/lib/libc/stdio/fputs.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
35 .\"
36 .Dd June 4, 1993
37 .Dt FPUTS 3
38 .Os
39 .Sh NAME
40 .Nm fputs ,
41 .Nm puts
42 .Nd output a line to a stream
43 .Sh LIBRARY
44 .Lb libc
45 .Sh SYNOPSIS
46 .In 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
52 The function
53 .Fn fputs
54 writes the string pointed to by
55 .Fa str
56 to the stream pointed to by
57 .Fa stream .
58 .\" The terminating
59 .\" .Dv NUL
60 .\" character is not written.
61 .Pp
62 The function
63 .Fn puts
64 writes the string
65 .Fa str ,
66 and a terminating newline character,
67 to the stream
68 .Dv stdout .
69 .Sh RETURN VALUES
70 The functions
71 .Fn fputs
72 and
73 .Fn puts
74 return a nonnegative integer on success and
75 .Dv EOF
76 on error.
77 .Sh ERRORS
78 .Bl -tag -width Er
79 .It Bq Er EBADF
80 The
81 .Fa stream
82 argument
83 is not a writable stream.
84 .El
85 .Pp
86 The functions
87 .Fn fputs
88 and
89 .Fn puts
90 may also fail and set
91 .Va errno
92 for any of the errors specified for the routines
93 .Xr write 2 .
94 .Sh SEE ALSO
95 .Xr ferror 3 ,
96 .Xr fputws 3 ,
97 .Xr putc 3 ,
98 .Xr stdio 3
99 .Sh STANDARDS
100 The functions
101 .Fn fputs
102 and
103 .Fn puts
104 conform to
105 .St -isoC .