aboutsummaryrefslogblamecommitdiffstats
path: root/libterminput.7
blob: 287b71bc37ab6320a83ce871b67fec118645c903 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12











                                                       





                                           


                                       


                                     




                                





                                                                         

            
                          
                              
                                   
                          

                                    
.TH LIBTERMINPUT 7 LIBTERMINPUT
.SH NAME
libterminput \- A terminal input parsing library

.SH DESCRIPTION
.B libterminput
is a small library that parses input from the terminal.
.B libterminput
does not use terminfo, but recognises common sequences.
.PP
libterminput provides the following functions:
.TP
.BR libterminput_init (3)
Configure library for terminal quirks.
.TP
.BR libterminput_destroy (3)
Deallocate library configuration resources.
.TP
.BR libterminput_read (3)
Read and parse input from the terminal.
.TP
.BR libterminput_is_ready (3)
Check if there is read data buffered.
.TP
.BR libterminput_set_flags (3)
Add input parsing flags.
.TP
.BR libterminput_clear_flags (3)
Remove input parsing flags.
.TP
.BR libterminput_marshal_state "(3), " libterminput_marshal_input (3)
Marshal library state.
.TP
.BR libterminput_unmarshal_state "(3), " libterminput_unmarshal_input (3)
Unmarshal library state.

.SH SEE ALSO
.BR libterminput_init (3),
.BR libterminput_is_ready (3),
.BR libterminput_marshal_state (3),
.BR libterminput_read (3),
.BR libterminput_set_flags (3),
.BR libterminput_unmarshal_state (3)