p
/
termo
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Don't document the termkey_free() function as it doesn't restore termios; document termkey_destroy() instead

This commit is contained in:
Paul LeoNerd Evans 2008-11-06 19:50:53 +00:00
parent 9aaf16888c
commit 023943c738
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -57,6 +57,6 @@ install-man:
for F in *.3; do \ for F in *.3; do \
gzip <$$F >$(DESTDIR)$(MAN3DIR)/$$F.gz; \ gzip <$$F >$(DESTDIR)$(MAN3DIR)/$$F.gz; \
done done
ln -sf termkey_new.3.gz $(DESTDIR)$(MAN3DIR)/termkey_free.3.gz ln -sf termkey_new.3.gz $(DESTDIR)$(MAN3DIR)/termkey_destroy.3.gz
ln -sf termkey_getkey.3.gz $(DESTDIR)$(MAN3DIR)/termkey_getkey_force.3.gz ln -sf termkey_getkey.3.gz $(DESTDIR)$(MAN3DIR)/termkey_getkey_force.3.gz
ln -sf termkey_setwaittime.3.gz $(DESTDIR)$(MAN3DIR)/termkey_getwaittime.3.gz ln -sf termkey_setwaittime.3.gz $(DESTDIR)$(MAN3DIR)/termkey_getwaittime.3.gz

2
termkey_get_keyname.3
View File

@ -10,7 +10,7 @@ termkey_get_keyname \- return a string name for a symbolic key
.sp .sp
Link with \fI-ltermkey\fP. Link with \fI-ltermkey\fP.
.SH DESCRIPTION .SH DESCRIPTION
\fBtermkey_get_keyname\fP returns a human-readable string name for the symbolic key value given by \fBsym\fP. The returned string is owned by the termkey instance \fItk\fP so should not be modified or freed. The returned pointer is guaranteed to be valid until the termkey instance is released using \fBtermkey_free\fP(3). \fBtermkey_get_keyname\fP returns a human-readable string name for the symbolic key value given by \fBsym\fP. The returned string is owned by the termkey instance \fItk\fP so should not be modified or freed. The returned pointer is guaranteed to be valid until the termkey instance is released using \fBtermkey_destroy\fP(3).
.SH "RETURN VALUE" .SH "RETURN VALUE"
\fBtermkey_get_key\fP() returns a pointer to a string. \fBtermkey_get_key\fP() returns a pointer to a string.
.SH "SEE ALSO" .SH "SEE ALSO"

8
termkey_new.3
View File

@ -1,20 +1,20 @@
.TH TERMKEY_NEW 3 .TH TERMKEY_NEW 3
.SH NAME .SH NAME
termkey_new, termkey_free \- create or destroy new termkey instance termkey_new, termkey_destroy \- create or destroy new termkey instance
.SH SYNOPSIS .SH SYNOPSIS
.nf .nf
.B #include <termkey.h> .B #include <termkey.h>
.sp .sp
.BI "termkey_tk *termkey_new(int " fd ", int " flags ); .BI "termkey_tk *termkey_new(int " fd ", int " flags );
.br .br
.BI "void termkey_free(termkey_t *" tk ); .BI "void termkey_destroy(termkey_t *" tk );
.fi .fi
.sp .sp
Link with \fI\-ltermkey\fP. Link with \fI\-ltermkey\fP.
.SH DESCRIPTION .SH DESCRIPTION
\fBtermkey_new\fP() creates a new termkey instance connected to the file handle opened by \fIfd\fP using the \fIflags\fP. The \fBtermkey_tk\fP structure should be considered opaque; its contents are not intended for use outside of the library. \fBtermkey_new\fP() creates a new termkey instance connected to the file handle opened by \fIfd\fP using the \fIflags\fP. The \fBtermkey_tk\fP structure should be considered opaque; its contents are not intended for use outside of the library.
.PP .PP
\fBtermkey_free\fP() destroys the given instance and releases any resources controlled by it. It will not close the underlying filehandle given as the \fIfd\fP argument to \fBtermkey_new\fP(). \fBtermkey_destroy\fP() destroys the given instance and releases any resources controlled by it. It will not close the underlying filehandle given as the \fIfd\fP argument to \fBtermkey_new\fP().
.PP .PP
The following values may be given as the \fIflags\fP bitmask: The following values may be given as the \fIflags\fP bitmask:
.TP .TP
@ -37,7 +37,7 @@ Even if the terminal file descriptor \fIfd\fP represents a
.SM TTY .SM TTY
device, do not call the \fBtcsetattr\fP() \fBtermios\fP function on it to set it to canonical input mode. device, do not call the \fBtcsetattr\fP() \fBtermios\fP function on it to set it to canonical input mode.
.SH "RETURN VALUE" .SH "RETURN VALUE"
If successful, \fBtermkey_new\fP() returns a pointer to the new instance. On failure, \fBNULL\fP is returned. \fBtermkey_free\fP() returns no value. If successful, \fBtermkey_new\fP() returns a pointer to the new instance. On failure, \fBNULL\fP is returned. \fBtermkey_destroy\fP() returns no value.
.SH "SEE ALSO" .SH "SEE ALSO"
.BR termkey_waitkey (3), .BR termkey_waitkey (3),
.BR termkey_advisereadable (3), .BR termkey_advisereadable (3),