diff --git a/man/ctlseqs.7 b/man/ctlseqs.7 index 23ae912..43e9974 100644 --- a/man/ctlseqs.7 +++ b/man/ctlseqs.7 @@ -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 .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) diff --git a/man/ctlseqs_matcher_config.3 b/man/ctlseqs_matcher_config.3 index e0f9769..3d64795 100644 --- a/man/ctlseqs_matcher_config.3 +++ b/man/ctlseqs_matcher_config.3 @@ -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 .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) diff --git a/man/ctlseqs_matcher_free.3 b/man/ctlseqs_matcher_free.3 index de806ba..5136fca 100644 --- a/man/ctlseqs_matcher_free.3 +++ b/man/ctlseqs_matcher_free.3 @@ -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 .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) diff --git a/man/ctlseqs_matcher_init.3 b/man/ctlseqs_matcher_init.3 index f329549..bdf82d4 100644 --- a/man/ctlseqs_matcher_init.3 +++ b/man/ctlseqs_matcher_init.3 @@ -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 .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) diff --git a/man/ctlseqs_purge.3 b/man/ctlseqs_purge.3 index ac0d8d8..6cf3b03 100644 --- a/man/ctlseqs_purge.3 +++ b/man/ctlseqs_purge.3 @@ -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 .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) diff --git a/man/ctlseqs_read.3 b/man/ctlseqs_read.3 index 45d3573..10b6baa 100644 --- a/man/ctlseqs_read.3 +++ b/man/ctlseqs_read.3 @@ -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 .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) diff --git a/man/ctlseqs_reader_config.3 b/man/ctlseqs_reader_config.3 index fdab338..395c167 100644 --- a/man/ctlseqs_reader_config.3 +++ b/man/ctlseqs_reader_config.3 @@ -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 .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) diff --git a/man/ctlseqs_reader_free.3 b/man/ctlseqs_reader_free.3 index b9c3b60..1c9cc77 100644 --- a/man/ctlseqs_reader_free.3 +++ b/man/ctlseqs_reader_free.3 @@ -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 .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) diff --git a/man/ctlseqs_reader_init.3 b/man/ctlseqs_reader_init.3 index b89515b..14a5eff 100644 --- a/man/ctlseqs_reader_init.3 +++ b/man/ctlseqs_reader_init.3 @@ -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 .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)