aboutsummaryrefslogtreecommitdiff
path: root/termkey_snprint_key.3
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-03-31 15:42:32 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2011-03-31 15:42:32 +0100
commit7c9f24fc8ed8b9acb59e2a8cf37387878fa36706 (patch)
tree5802b560f66c1a66bc3d75d4ec12b1fc69c33bcb /termkey_snprint_key.3
parent9b97244c54bb09616523d984816b89bb75de8058 (diff)
downloadtermo-7c9f24fc8ed8b9acb59e2a8cf37387878fa36706.tar.gz
termo-7c9f24fc8ed8b9acb59e2a8cf37387878fa36706.tar.xz
termo-7c9f24fc8ed8b9acb59e2a8cf37387878fa36706.zip
Updated manpages for function rename sprint_key -> strfkey
Diffstat (limited to 'termkey_snprint_key.3')
-rw-r--r--termkey_snprint_key.343
1 files changed, 0 insertions, 43 deletions
diff --git a/termkey_snprint_key.3 b/termkey_snprint_key.3
deleted file mode 100644
index 8cb41a2..0000000
--- a/termkey_snprint_key.3
+++ /dev/null
@@ -1,43 +0,0 @@
-.TH TERMKEY_SNPRINT_KEY 3
-.SH NAME
-termkey_snprint_key \- format a string representing a key event
-.SH SYNOPSIS
-.nf
-.B #include <termkey.h>
-.sp
-.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_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
-.B TERMKEY_FORMAT_LONGMOD
-Print full modifier names e.g. "Shift-" instead of abbreviating to "S-".
-.TP
-.B TERMKEY_FORMAT_CARETCTRL
-If the only modifier is \fBTERMKEY_MOD_CTRL\fP on a plain letter, render it as "^X" rather than "Ctrl-X".
-.TP
-.B TERMKEY_FORMAT_ALTISMETA
-Use the name "Meta" or the letter "M" instead of "Alt" or "A".
-.TP
-.B TERMKEY_FORMAT_WRAPBRACKET
-If the key event is a special key instead of unmodified Unicode, wrap it in "<brackets>".
-.TP
-.B TERMKEY_FORMAT_MOUSE_POS
-If the event is a mouse event, include the position rendered as "@ (col,line)".
-.PP
-The following shortcuts are provided for common combinations of format bits:
-.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.
-.SH "RETURN VALUE"
-\fBtermkey_snprint_key\fP() returns the number of characters written to \fIbuffer\fP.
-.SH "SEE ALSO"
-.BR termkey_new (3),
-.BR termkey_getkey (3),
-.BR termkey_waitkey (3),
-.BR termkey_get_keyname (3)