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 .\" 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: src/lib/libc/stdio/fputs.3,v 1.4.2.4 2001/12/14 18:33:57 ru Exp $
  38 .\" $DragonFly: src/lib/libc/stdio/fputs.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  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 *str" "FILE *stream"
  53 .Ft int
  54 .Fn puts "const char *str"
  55 .Sh DESCRIPTION
  56 The function
  57 .Fn fputs
  58 writes the string pointed to by
  59 .Fa str
  60 to the stream pointed to by
  61 .Fa stream .
  62 .\" The terminating
  63 .\" .Dv NUL
  64 .\" character is not written.
  65 .Pp
  66 The function
  67 .Fn puts
  68 writes the string
  69 .Fa str ,
  70 and a terminating newline character,
  71 to the stream
  72 .Em stdout .
  73 .Sh RETURN VALUES
  74 The
  75 .Fn fputs
  76 function
  77 returns 0 on success and
  78 .Dv EOF
  79 on error;
  80 .Fn puts
  81 returns a nonnegative integer on success and
  82 .Dv EOF
  83 on error.
  84 .Sh ERRORS
  85 .Bl -tag -width Er
  86 .It Bq Er EBADF
  87 The
  88 .Fa stream
  89 supplied
  90 is not a writable stream.
  91 .El
  92 .Pp
  93 The functions
  94 .Fn fputs
  95 and
  96 .Fn puts
  97 may also fail and set
  98 .Va errno
  99 for 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
 106 The functions
 107 .Fn fputs
 108 and
 109 .Fn puts
 110 conform to
 111 .St -isoC .