aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2021-04-09 22:35:26 +0200
committerMattias Andrée <maandree@kth.se>2021-04-09 22:35:26 +0200
commit476ff52ebcdc319f6af57d9443fd953807c8c1af (patch)
tree0f3510caa4a6b81cb3be5860cbb402e5882832ab
parentAdd libterminput_read.3 (diff)
downloadlibterminput-476ff52ebcdc319f6af57d9443fd953807c8c1af.tar.gz
libterminput-476ff52ebcdc319f6af57d9443fd953807c8c1af.tar.bz2
libterminput-476ff52ebcdc319f6af57d9443fd953807c8c1af.tar.xz
Add libterminput.7
Signed-off-by: Mattias Andrée <maandree@kth.se>
-rw-r--r--Makefile13
-rw-r--r--README11
-rw-r--r--libterminput.724
-rw-r--r--libterminput_read.32
4 files changed, 44 insertions, 6 deletions
diff --git a/Makefile b/Makefile
index 9915db6..10796c5 100644
--- a/Makefile
+++ b/Makefile
@@ -52,6 +52,7 @@ install: libterminput.a libterminput.$(LIBEXT)
mkdir -p -- "$(DESTDIR)$(PREFIX)/lib"
mkdir -p -- "$(DESTDIR)$(PREFIX)/include"
mkdir -p -- "$(DESTDIR)$(MANPREFIX)/man3"
+ mkdir -p -- "$(DESTDIR)$(MANPREFIX)/man7"
cp -- libterminput.a "$(DESTDIR)$(PREFIX)/lib/"
cp -- libterminput.h "$(DESTDIR)$(PREFIX)/include/"
cp -- libterminput.$(LIBEXT) "$(DESTDIR)$(PREFIX)/lib/libterminput.$(LIBMINOREXT)"
@@ -59,16 +60,18 @@ install: libterminput.a libterminput.$(LIBEXT)
ln -sf -- libterminput.$(LIBMAJOREXT) "$(DESTDIR)$(PREFIX)/lib/libterminput.$(LIBEXT)"
cp -- libterminput_read.3 libterminput_set_flags.3 "$(DESTDIR)$(MANPREFIX)/man3"
ln -sf -- libterminput_set_flags.3 "$(DESTDIR)$(MANPREFIX)/man3/libterminput_clear_flags.3"
+ cp -- libterminput.7 "$(DESTDIR)$(MANPREFIX)/man7"
uninstall:
-rm -f -- "$(DESTDIR)$(PREFIX)/lib/libterminput.$(LIBMAJOREXT)"
-rm -f -- "$(DESTDIR)$(PREFIX)/lib/libterminput.$(LIBMINOREXT)"
-rm -f -- "$(DESTDIR)$(PREFIX)/lib/libterminput.$(LIBEXT)"
- -rm -rf -- "$(DESTDIR)$(PREFIX)/lib/libterminput.a"
- -rm -rf -- "$(DESTDIR)$(PREFIX)/include/libterminput.h"
- -rm -rf -- "$(DESTDIR)$(MANPREFIX)/man3/libterminput_read.3"
- -rm -rf -- "$(DESTDIR)$(MANPREFIX)/man3/libterminput_set_flags.3"
- -rm -rf -- "$(DESTDIR)$(MANPREFIX)/man3/libterminput_clear_flags.3"
+ -rm -f -- "$(DESTDIR)$(PREFIX)/lib/libterminput.a"
+ -rm -f -- "$(DESTDIR)$(PREFIX)/include/libterminput.h"
+ -rm -f -- "$(DESTDIR)$(MANPREFIX)/man3/libterminput_read.3"
+ -rm -f -- "$(DESTDIR)$(MANPREFIX)/man3/libterminput_set_flags.3"
+ -rm -f -- "$(DESTDIR)$(MANPREFIX)/man3/libterminput_clear_flags.3"
+ -rm -f -- "$(DESTDIR)$(MANPREFIX)/man7/libterminput.7"
clean:
-rm -f -- *.o *.a *.lo *.so *.su *.dll *.dylib interactive-test
diff --git a/README b/README
index e6d7e61..b30d8cd 100644
--- a/README
+++ b/README
@@ -5,3 +5,14 @@ DESCRIPTION
libterminput is a small library that parses input from the
terminal. libterminput does not use terminfo, but recognises
common sequences.
+
+ libterminput provides the following functions:
+
+ libterminput_read(3)
+ Read and parse input from the terminal.
+
+ libterminput_set_flags(3)
+ Add input parsing flags.
+
+ libterminput_clear_flags(3)
+ Remove input parsing flags.
diff --git a/libterminput.7 b/libterminput.7
new file mode 100644
index 0000000..db4c751
--- /dev/null
+++ b/libterminput.7
@@ -0,0 +1,24 @@
+.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_read (3)
+Read and parse input from the terminal.
+.TP
+.BR libterminput_set_flags (3)
+Add input parsing flags.
+.TP
+.BR libterminput_clear_flags (3)
+Remove input parsing flags.
+
+.SH SEE ALSO
+.BR libterminput_read (3),
+.BR libterminput_set_flags (3)
diff --git a/libterminput_read.3 b/libterminput_read.3
index d799a1a..904342c 100644
--- a/libterminput_read.3
+++ b/libterminput_read.3
@@ -1,6 +1,6 @@
.TH LIBTERMINPUT_READ 3 LIBTERMINPUT
.SH NAME
-libterminput_read \- Read input from the terminal
+libterminput_read \- Read and parse input from the terminal
.SH SYNOPSIS
.nf