BSD 4_4_Lite1 release

[unix-history] / usr / src / lib / libc / stdio / fgetln.3

diff --git a/usr/src/lib/libc/stdio/fgetln.3 b/usr/src/lib/libc/stdio/fgetln.3
index 39a5c3a..60089ea 100644 (file)
--- a/usr/src/lib/libc/stdio/fgetln.3
+++ b/usr/src/lib/libc/stdio/fgetln.3
@@ -1,76 +1,123 @@
-.\" Copyright (c) 1990 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1990, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\" %sccs.include.redist.man%
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)fgetln.3    5.1 (Berkeley) %G%
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH FGETLINE 3 ""
-.UC 7
-.SH NAME
-fgetline \- get a line from a stream
-.SH SYNOPSIS
-.nf
-.ft B
-#include <stdio.h>
-
-char *
-fgetline(FILE *stream, size_t *len);
-.ft R
-.fi
-.SH DESCRIPTION
-.I Fgetline
-returns a pointer to the next line from the stream pointed to by
-.IR stream .
-The newline character at the end of the line is replaced by a '\e0'
+.\"     @(#)fgetln.3   8.3 (Berkeley) 4/19/94
+.\"
+.Dd April 19, 1994
+.Dt FGETLN 3
+.Os
+.Sh NAME
+.Nm fgetln
+.Nd get a line from a stream
+.Sh SYNOPSIS
+.Fd #include <stdio.h>
+.Ft char *
+.Fn fgetln "FILE *stream" "size_t *len"
+.Sh DESCRIPTION
+The
+.Fn fgetln
+function
+returns a pointer to the next line from the stream referenced by
+.Fa stream .
+This line is
+.Em not
+a C string as it does not end with a terminating
+.Dv NUL

 character.
 character.

-.PP
-If
-.I len
-is non-NULL, the length of the line, not counting the terminating
-NUL, is stored in the memory location it references.
-.SH "SEE ALSO"
-ferror(3), fgets(3), fopen(3), putc(3)
-.SH "RETURN VALUE"
+The length of the line, including the final newline,
+is stored in the memory location to which
+.Fa len
+points.
+(Note, however, that if the line is the last
+in a file that does not end in a newline,
+the returned text will not contain a newline.)
+.Sh RETURN VALUES

 Upon successful completion a pointer is returned;
 Upon successful completion a pointer is returned;

-this pointer becomes invalid after the next I/O operation on
-.I stream
+this pointer becomes invalid after the next
+.Tn I/O
+operation on
+.Fa stream

 (whether successful or not)
 or as soon as the stream is closed.
 (whether successful or not)
 or as soon as the stream is closed.

-Otherwise, NULL is returned.
-.I Fgetline
-does not distinguish between end-of-file and error, and callers must use
-.I feof
+Otherwise,
+.Dv NULL
+is returned.
+The
+.Fn fgetln
+function
+does not distinguish between end-of-file and error; the routines
+.Xr feof 3

 and
 and

-.I ferror
+.Xr ferror 3
+must be used

 to determine which occurred.
 to determine which occurred.

-If an error occurrs, the global variable
-.I errno
+If an error occurs, the global variable
+.Va errno

 is set to indicate the error.
 The end-of-file condition is remembered, even on a terminal, and all
 is set to indicate the error.
 The end-of-file condition is remembered, even on a terminal, and all

-subsequent attempts to read will return NULL until the condition is
+subsequent attempts to read will return
+.Dv NULL
+until the condition is

 cleared with
 cleared with

-.IR clearerr .
-.PP
-It is not possible to tell whether the final line of an input file
-was terminated with a newline.
-.PP
+.Xr clearerr 3 .
+.Pp

 The text to which the returned pointer points may be modified,
 The text to which the returned pointer points may be modified,

-provided that no changes are made beyond the terminating NUL.
+provided that no changes are made beyond the returned size.

 These changes are lost as soon as the pointer becomes invalid.
 These changes are lost as soon as the pointer becomes invalid.

-.SH ERRORS
-.TP 15
-[EBADF]
-.I Stream
+.Sh ERRORS
+.Bl -tag -width [EBADF]
+.It Bq Er EBADF
+The argument
+.Fa stream

 is not a stream open for reading.
 is not a stream open for reading.

-.PP
-.I Fgetline
+.El
+.Pp
+The
+.Fn fgetln
+function

 may also fail and set
 may also fail and set

-.I errno
+.Va errno

 for any of the errors specified for the routines
 for any of the errors specified for the routines

-.IR fflush (3),
-.IR malloc (3),
-.IR read (2),
-.IR stat (2),
+.Xr fflush 3 ,
+.Xr malloc 3 ,
+.Xr read 2 ,
+.Xr stat 2 ,

 or
 or

-.IR realloc (3).
+.Xr realloc 3 .
+.Sh SEE ALSO
+.Xr ferror 3 ,
+.Xr fgets 3 ,
+.Xr fopen 3 ,
+.Xr putc 3
+.Sh HISTORY
+The
+.Fn fgetln
+function first appeared in 4.4BSD.