usr/src/lib/libc/stdio/gets.3

.\"	@(#)gets.3	6.1 (Berkeley) %G%
.\"
.TH GETS 3S  ""
.AT 3
.SH NAME
gets, fgets \- get a string from a stream
.SH SYNOPSIS
.B #include <stdio.h>
.PP
.B char *gets(s)
.br
.B char *s;
.PP
.B char *fgets(s, n, stream)
.br
.B char *s;
.br
.SM
.B FILE
.B *stream;
.SH DESCRIPTION
.I Gets
reads a string into
.I s
from the standard input stream
.BR stdin .
The string is terminated by a newline
character, which is replaced in
.I s
by a null character.
.I Gets
returns its argument.
.PP
.I Fgets
reads
.IR n \-1
characters, or up through a newline
character, whichever comes first,
from the
.I stream
into the string
.IR s .
The last character read into
.I s
is followed by a null character.
.I Fgets
returns its first argument.
.SH "SEE ALSO"
puts(3S),
getc(3S),
scanf(3S),
fread(3S),
ferror(3S)
.SH DIAGNOSTICS
.I Gets
and
.I fgets
return the constant pointer
.SM
.B NULL
upon end of file or error.
.SH BUGS
.I Gets
deletes a newline,
.I fgets
keeps it,
all in the name of backward compatibility.
Commit	Line	Data
	1	.\" @(#)gets.3 6.1 (Berkeley) %G%
	2	.\"
	3	.TH GETS 3S ""
	4	.AT 3
	5	.SH NAME
	6	gets, fgets \- get a string from a stream
	7	.SH SYNOPSIS
	8	.B #include <stdio.h>
	9	.PP
	10	.B char *gets(s)
	11	.br
	12	.B char *s;
	13	.PP
	14	.B char *fgets(s, n, stream)
	15	.br
	16	.B char *s;
	17	.br
	18	.SM
	19	.B FILE
	20	.B *stream;
	21	.SH DESCRIPTION
	22	.I Gets
	23	reads a string into
	24	.I s
	25	from the standard input stream
	26	.BR stdin .
	27	The string is terminated by a newline
	28	character, which is replaced in
	29	.I s
	30	by a null character.
	31	.I Gets
	32	returns its argument.
	33	.PP
	34	.I Fgets
	35	reads
	36	.IR n \-1
	37	characters, or up through a newline
	38	character, whichever comes first,
	39	from the
	40	.I stream
	41	into the string
	42	.IR s .
	43	The last character read into
	44	.I s
	45	is followed by a null character.
	46	.I Fgets
	47	returns its first argument.
	48	.SH "SEE ALSO"
	49	puts(3S),
	50	getc(3S),
	51	scanf(3S),
	52	fread(3S),
	53	ferror(3S)
	54	.SH DIAGNOSTICS
	55	.I Gets
	56	and
	57	.I fgets
	58	return the constant pointer
	59	.SM
	60	.B NULL
	61	upon end of file or error.
	62	.SH BUGS
	63	.I Gets
	64	deletes a newline,
	65	.I fgets
	66	keeps it,
	67	all in the name of backward compatibility.