=== modified file 'termkey_get_keyname.3' --- termkey_get_keyname.3 2011-03-31 14:42:32 +0000 +++ termkey_get_keyname.3 2009-07-15 19:40:44 +0000 @@ -18,4 +18,4 @@ .BR termkey_getkey (3), .BR termkey_waitkey (3), .BR termkey_keyname2sym (3), -.BR termkey_strfkey (3) +.BR termkey_snprint_key (3) === modified file 'termkey_keyname2sym.3' --- termkey_keyname2sym.3 2011-03-31 14:42:32 +0000 +++ termkey_keyname2sym.3 2009-07-15 19:40:44 +0000 @@ -18,4 +18,4 @@ .SH "SEE ALSO" .BR termkey_new (3), .BR termkey_get_keyname (3), -.BR termkey_strfkey (3) +.BR termkey_snprint_key (3) === renamed file 'termkey_strfkey.3' => 'termkey_snprint_key.3' --- termkey_strfkey.3 2011-03-31 14:42:32 +0000 +++ termkey_snprint_key.3 2009-11-27 15:07:05 +0000 @@ -1,17 +1,17 @@ -.TH TERMKEY_STRFKEY 3 +.TH TERMKEY_SNPRINT_KEY 3 .SH NAME -termkey_strfkey \- format a string representing a key event +termkey_snprint_key \- format a string representing a key event .SH SYNOPSIS .nf .B #include .sp -.BI "size_t termkey_strfkey(TermKey *" tk ", char *" buffer ", size_t " len ", +.BI "size_t termkey_snprint_key(TermKey *" tk ", char *" buffer ", size_t " len ", .BI " TermKeyKey " key ", TermKeyFormat " format ); .fi .sp Link with \fI-ltermkey\fP. .SH DESCRIPTION -\fBtermkey_strfkey\fP formats a string buffer to contain a human-readable representation of a key event. It fills the \fIbuffer\fP in a way analogous to the \fBsnprintf\fP(3) or \fBstrftime\fP(3) standard library functions. This function used to be called \fBtermkey_snprint_key\fP but was renamed after version 0.6. +\fBtermkey_snprint_key\fP formats a string buffer to contain a human-readable representation of a key event. It fills the \fIbuffer\fP in a way analogous to the \fBsnprintf\fP(3) standard library function. .PP The \fIformat\fP argument specifies the format of the output, as a bitmask of the following constants: .TP @@ -34,10 +34,8 @@ .TP .B TERMKEY_FORMAT_VIM Shortcut to set \fBALTISMETA\fP and \fBWRAPBRACKET\fP, to give an output close to the format the \fIvim\fP editor uses. -.PP -When formatting a \fBTERMKEY_TYPE_UNICODE\fP key structure, this function uses the \fIutf8\fP member. If this member contains an empty string (i.e. its first character is 0) then this member will be prefilled by the function from the \fIcode.number\fP member. This can be convenient when the key structure is being constructed programatically by user code. .SH "RETURN VALUE" -\fBtermkey_strfkey\fP() returns the number of characters written to \fIbuffer\fP. +\fBtermkey_snprint_key\fP() returns the number of characters written to \fIbuffer\fP. .SH "SEE ALSO" .BR termkey_new (3), .BR termkey_getkey (3), === modified file 'termkey_waitkey.3.sh' --- termkey_waitkey.3.sh 2011-03-31 14:42:32 +0000 +++ termkey_waitkey.3.sh 2009-07-15 19:40:44 +0000 @@ -40,5 +40,5 @@ .BR termkey_getkey (3), .BR termkey_set_waittime (3), .BR termkey_get_keyname (3), -.BR termkey_strfkey (3) +.BR termkey_snprint_key (3) EOF