graphcurses

commit 9faf6eb459aa262bf7a0b4d3a53c6af4cf8874b7
parent 3b65c51be09231776fc11f7cd1c2cd3a3de56173
Author: Christos Margiolis <christos@margiolis.net>
Date:   Wed, 21 Oct 2020 14:46:46 +0300

added manpage

Diffstat:
M
Makefile
 | 
11
+++++------
A
graphcurses.1
 | 
47
+++++++++++++++++++++++++++++++++++++++++++++++

2 files changed, 52 insertions(+), 6 deletions(-)
diff --git a/Makefile b/Makefile
@@ -6,7 +6,7 @@ include config.mk
 
 BIN = graphcurses
 DIST = ${BIN}-${VERSION}
-#MAN1 = ${BIN}.1
+MAN1 = ${BIN}.1
 
 SRC = graphcurses.c
 OBJ = graphcurses.o
@@ -36,17 +36,16 @@ run:
 	./${BIN}
 
 install: all
-	#${MKDIR} ${DESTDIR}${BIN_DIR} ${DESTDIR}${MAN_DIR}
-	${MKDIR} ${DESTDIR}${BIN_DIR}
+	${MKDIR} ${DESTDIR}${BIN_DIR} ${DESTDIR}${MAN_DIR}
 	${CP} ${BIN} ${BIN_DIR}
 	${CP} ${MAN1} ${DESTDIR}${MAN_DIR}
-	#sed "s/VERSION/${VERSION}/g" < ${MAN1} > ${DESTDIR}${MAN_DIR}/${MAN1}
-	#chmod 755 ${DESTDIR}${BIN_DIR}/${BIN}
+	sed "s/VERSION/${VERSION}/g" < ${MAN1} > ${DESTDIR}${MAN_DIR}/${MAN1}
+	chmod 755 ${DESTDIR}${BIN_DIR}/${BIN}
 	chmod 644 ${DESTDIR}${MAN_DIR}/${MAN1}
 
 uninstall:
 	${RM} ${DESTDIR}${BIN_DIR}/${BIN}
-	#${RM} ${DESTDIR}${MAN_DIR}/${MAN1}
+	${RM} ${DESTDIR}${MAN_DIR}/${MAN1}
 
 clean:
 	${RM} ${BIN} ${OBJ} ${DIST}.tar.gz
diff --git a/graphcurses.1 b/graphcurses.1
@@ -0,0 +1,47 @@
+.Dd graphcurses\-VERSION
+.Dt GRAPHCURSES 1
+.Os
+.Sh NAME
+.Nm graphcurses
+.Nd ncurses 2D graph generator
+.Sh SYNOPSIS
+.Nm
+.Sh DESCRIPTION
+.Nm
+takes a function as an input and draws it using
+.Xr ncurses 3
+to draw the TUI. Functions and derivatives are evaluated by
+.Xr libmatheval 3
+and might use
+.Xr math 3
+to calculate more complicated functions.
+.Sh OPTIONS
+The following options are used during runtime in the TUI,
+not the command line.
+.Bl -tag -width 8n
+.It Sy q
+quit program.
+.It Sy UP/k
+move up on the Y axis
+.It Sy DOWN/j
+move down on the Y axis
+.It Sy LEFT/h
+move left on the X axis
+.It Sy RIGHT/l
+move right on the X axis
+.It Sy d
+calculate and show the derivative of the displayed function
+.It Sy f
+give the program a new function to calculate and plot
+.It Sy r
+reset zooming to default
+.It Sy +
+zoom in
+.It Sy -
+zoom out
+.Sh SEE ALSO
+.Xr ncurses 3 ,
+.Xr libmatheval 3 ,
+.Xr math 3
+.Sh AUTHORS
+.An Christos Margiolis Aq Mt christos@christosmarg.xyz