cismonx
/
ctlseqs
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update documentation.

This commit is contained in:
CismonX 2020-12-21 20:56:27 +08:00
parent 7f9845bb1d
commit c7730bf220
Signed by: cismonx
GPG Key ID: 3094873E29A482FB
9 changed files with 43 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
man/ctlseqs.7
View File

@ -23,10 +23,9 @@ Or perhaps, when implementing one's own terminal emulator.
.PP
Writing escape sequences is pretty straightforward, but reading and processing them could be tricky, and not trivial to implement.
.SS The ctlseqs library
The ctlseqs library tries to make your life easier when dealing with raw escape sequences.
There are three major concepts in the library, the reader, the matcher, and the helper macros.
.PP
The reader is responsible to read arbitrary data from a file descriptor, buffer it, and check whether it (or part of it) is a valid terminal control sequence.
The reader reads arbitrary data from a file descriptor, buffer it, and check whether it (or part of it) is a valid terminal control sequence.
.PP
The matcher is configured with patterns describing a terminal control sequence.
After a sequence is successfully read, it can be matched against the patterns, and according to which, values can be extracted.
@ -42,23 +41,22 @@ header.
.SH NOTES
C1 (8-bit) control characters are not supported.
.
.SH SEE ALSO
.BR terminfo (5),
.BR ncurses (3X)
.PP
.BR ctlseqs_matcher_init (3),
.BR ctlseqs_matcher_config (3),
.BR ctlseqs_matcher_free (3)
.PP
.BR ctlseqs_reader_init (3),
.BR ctlseqs_reader_config (3),
.BR ctlseqs_reader_free (3)
.PP
.BR ctlseqs_read (3)
.BR ctlseqs_purge (3)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.ad l
.nh
.BR ctlseqs_matcher_config (3),
.BR ctlseqs_matcher_init (3),
.BR ctlseqs_matcher_free (3),
.BR ctlseqs_purge (3),
.BR ctlseqs_read (3),
.BR ctlseqs_reader_config (3),
.BR ctlseqs_reader_init (3),
.BR ctlseqs_reader_free (3),
.BR ncurses (3X),
.BR terminfo (5)

6
man/ctlseqs_matcher_config.3
View File

@ -73,11 +73,11 @@ The byte following a single-shift should be a printable character.
.B SOS [chrstr] ST
Character string can be any bit combination which does not represent SOS or ST.
.
.SH SEE ALSO
.BR ctlseqs (7)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs (7)

6
man/ctlseqs_matcher_free.3
View File

@ -24,11 +24,11 @@ is NULL, this function has no effect.
.SH RETURN VALUE
This function has no return values.
.
.SH SEE ALSO
.BR ctlseqs_matcher_init (3)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs_matcher_init (3)

8
man/ctlseqs_matcher_init.3
View File

@ -24,12 +24,12 @@ holding the matcher instance.
.PP
If the function fails to allocate sufficient memory, returns NULL.
.
.SH SEE ALSO
.BR ctlseqs_matcher_config (3),
.BR ctlseqs_matcher_free (3)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs_matcher_config (3),
.BR ctlseqs_matcher_free (3)

8
man/ctlseqs_purge.3
View File

@ -29,12 +29,12 @@ The function is useful when dealing with partial sequences returned by
.BR ctlseqs_read (),
whose future completion is not desired.
.
.SH SEE ALSO
.BR ctlseqs_read (3),
.BR ctlseqs (7)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs_read (3),
.BR ctlseqs (7)

8
man/ctlseqs_read.3
View File

@ -75,12 +75,12 @@ An unexpected error occurs during a system call within the function.
.B CTLSEQS_INTR
A system call within the function is interrupted by a signal, and no data is read.
.
.SH SEE ALSO
.BR ctlseqs_matcher_config (3),
.BR ctlseqs_reader_config (3)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs_matcher_config (3),
.BR ctlseqs_reader_config (3)

6
man/ctlseqs_reader_config.3
View File

@ -146,11 +146,11 @@ Attempts to change
.I maxlen
value, but data in the internal read buffer will be lost due to truncation, if done so.
.
.SH SEE ALSO
.BR ctlseqs_read (3)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs_read (3)

6
man/ctlseqs_reader_free.3
View File

@ -24,11 +24,11 @@ is NULL, this function has no effect.
.SH RETURN VALUE
This function has no return values.
.
.SH SEE ALSO
.BR ctlseqs_reader_init (3)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs_reader_init (3)

8
man/ctlseqs_reader_init.3
View File

@ -24,12 +24,12 @@ holding the reader instance.
.PP
If the function fails to allocate sufficient memory, returns NULL.
.
.SH SEE ALSO
.BR ctlseqs_reader_config (3),
.BR ctlseqs_reader_free (3)
.
.SH COPYRIGHT
Copyright (c) 2020 CismonX <admin@cismon.net>
.PP
Copying and distribution of this file, with or without modification, are permitted in any medium without royalty, provided the copyright notice and this notice are preserved.
This file is offered as-is, without any warranty.
.
.SH SEE ALSO
.BR ctlseqs_reader_config (3),
.BR ctlseqs_reader_free (3)