lib/libc/stdio/fputs.3

   1 .\"     $NetBSD: fputs.3,v 1.11 2003/08/07 16:43:24 agc 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. Neither the name of the University nor the names of its contributors
  19 .\"    may be used to endorse or promote products derived from this software
  20 .\"    without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32 .\" SUCH DAMAGE.
  33 .\"
  34 .\"     @(#)fputs.3     8.1 (Berkeley) 6/4/93
  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 * restrict str" "FILE * restrict 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 .Em stdout .
  69 .Sh RETURN VALUES
  70 The
  71 .Fn fputs
  72 function
  73 returns 0 on success and
  74 .Dv EOF
  75 on error;
  76 .Fn puts
  77 returns a nonnegative integer on success and
  78 .Dv EOF
  79 on error.
  80 .Sh ERRORS
  81 .Bl -tag -width Er
  82 .It Bq Er EBADF
  83 The
  84 .Fa stream
  85 supplied
  86 is not a writable stream.
  87 .El
  88 .Pp
  89 The functions
  90 .Fn fputs
  91 and
  92 .Fn puts
  93 may also fail and set
  94 .Va errno
  95 for any of the errors specified for the routines
  96 .Xr write 2 .
  97 .Sh SEE ALSO
  98 .Xr ferror 3 ,
  99 .Xr putc 3 ,
 100 .Xr stdio 3
 101 .Sh STANDARDS
 102 The functions
 103 .Fn fputs
 104 and
 105 .Fn puts
 106 conform to
 107 .St -ansiC .