ctlseqs/INSTALL.md

39 lines
1.0 KiB
Markdown
Raw Normal View History

2020-12-14 13:12:09 +00:00
<!--
2021-01-10 17:53:38 +00:00
Copyright (C) 2020,2021 CismonX <admin@cismon.net>
2020-12-14 13:12:09 +00:00
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.
-->
2021-02-21 20:15:29 +00:00
# Installing ctlseqs
2020-12-14 13:12:09 +00:00
2021-01-25 06:17:06 +00:00
## Copy Code to Your Project
2020-12-14 13:12:09 +00:00
2021-02-21 20:15:29 +00:00
The code of ctlseqs is simple, and can be used out-of-the-box. Just copy
[ctlseqs.h](include/ctlseqs.h) and [ctlseqs.c](src/ctlseqs.c) to your project
and build it alongside with other code.
2020-12-14 13:12:09 +00:00
2021-01-25 06:17:06 +00:00
Requires an ISO C99 and POSIX.1-2001 compliant C implementation.
2020-12-14 13:12:09 +00:00
## Build and Install From Source
2021-02-21 20:15:29 +00:00
Alternatively, ctlseqs can be built into a shared/static library with
GNU Autotools (Autoconf, Automake, Libtool and Autoconf Archive).
2020-12-14 13:12:09 +00:00
```shell
autoreconf --install
2021-01-25 06:17:06 +00:00
./configure
2020-12-14 13:12:09 +00:00
make
```
2021-01-25 06:17:06 +00:00
Optionally, you can run tests (requires DejaGnu) and install the library.
2020-12-14 13:12:09 +00:00
```shell
2021-01-25 06:17:06 +00:00
make check
make install
2020-12-14 13:12:09 +00:00
```
2021-02-21 20:15:29 +00:00
Unix man pages are not automatically installed with `make install`, and should
be installed manually with `make install-man`.