117 lines
2.9 KiB
Plaintext
117 lines
2.9 KiB
Plaintext
\input texinfo @c -*-texinfo-*-
|
|
|
|
@c %**start of header
|
|
@setfilename ctlseqs.info
|
|
@include version.texi
|
|
@settitle ctlseqs @value{VERSION} Manual
|
|
@c %**end of header
|
|
|
|
|
|
@copying
|
|
This manual is for ctlseqs, a helper library for control sequences.
|
|
|
|
Copyright @copyright{} 2021 CismonX <admin@@cismon.net>
|
|
|
|
@quotation
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the GNU Free Documentation License, Version 1.3 or
|
|
any later version published by the Free Software Foundation; with no
|
|
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
|
|
Texts. A copy of the license is included in the section entitled
|
|
``GNU Free Documentation License''.
|
|
@end quotation
|
|
@end copying
|
|
|
|
|
|
@titlepage
|
|
@title ctlseqs
|
|
@subtitle Helper Library for Control Sequences, version @value{VERSION}
|
|
@author CismonX
|
|
|
|
@page
|
|
@vskip 0pt plus 1filll
|
|
@insertcopying
|
|
|
|
@end titlepage
|
|
|
|
|
|
@summarycontents
|
|
@contents
|
|
|
|
@ifnottex
|
|
@node Top
|
|
@top ctlseqs
|
|
|
|
This manual is for ctlseqs, a helper library for control sequences.
|
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
under the terms of the @pxref{GNU Free Documentation License}, Version 1.3 or
|
|
any later version published by the Free Software Foundation; with no
|
|
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
|
|
Texts.
|
|
|
|
ctlseqs is free software. You can redistribute it and/or modify it under
|
|
the terms of the GNU General Public License as published by the
|
|
Free Software Foundation, either version 3 of the License, or (at your option)
|
|
any later version.
|
|
@end ifnottex
|
|
|
|
|
|
@menu
|
|
* Overview:: Brief overview of ctlseqs.
|
|
* Control Sequence Matching:: Using ctlseqs for matching control sequences.
|
|
* Control Sequence Reading:: Using ctlseqs for reading control sequences.
|
|
* Tips:: Tips & hints for using ctlseqs.
|
|
* Example Programs:: Example programs using ctlseqs.
|
|
|
|
Appendices
|
|
|
|
* API Reference:: C API reference for ctlseqs.
|
|
* GNU Free Documentation License:: Copying conditions of this manual.
|
|
|
|
@end menu
|
|
|
|
|
|
@node Overview
|
|
@chapter Overview of ctlseqs
|
|
|
|
The name ``ctlseqs'' is an abbreviation of ``control sequences'', as defined
|
|
in section 5.4 of ECMA-48.
|
|
|
|
As the name suggests, this library focuses on handling control sequences.
|
|
However, it only cares about the bit combinations, while the actual meaning
|
|
and implementation of a control sequence is up to the user.
|
|
|
|
The C API provided by ctlseqs is composed of three major parts: The
|
|
helper macros, the control sequence matcher, and the control sequence reader.
|
|
Any of them can be used separatedly or combined.
|
|
|
|
|
|
@node Control Sequence Matching
|
|
@chapter Control Sequence Matching
|
|
|
|
|
|
@node Control Sequence Reading
|
|
@chapter Control Sequence Reading
|
|
|
|
|
|
@node Tips
|
|
@chapter Tips & Hints
|
|
|
|
|
|
@node Example Programs
|
|
@chapter Example Programs
|
|
|
|
|
|
@node API Reference
|
|
@appendix API Reference
|
|
|
|
|
|
@node GNU Free Documentation License
|
|
@appendix GNU Free Documentation License
|
|
|
|
@include fdl.texi
|
|
|
|
|
|
@bye
|