Merge pull request #42 from polluks/patch-2

Create manual page

install

@@ -7,5 +7,7 @@
 cp tek4010 ~/bin
 chmod +x ~/bin/tek4010
 
+cp tek4010.1 /usr/local/man/man1
+
 echo "tek4010 installed."
 echo "Reboot if this is the first time tek4010 is installed"

makefile

@@ -6,10 +6,13 @@ all: tek4010
 
 tek4010: src/help.txt src/main.c src/main.h src/tube.c src/tube.h src/tek4010.c src/ards.c
 	sed 's/\"/\\\"/g; s/$$/\\n"/; s/^/"/; 1s/^/const char *helpStr =\n/; $$a;' src/help.txt > src/help.h
-	$(CC) -o tek4010 src/main.c src/tube.c src/tek4010.c src/ards.c $(LIBS) $(CFLAGS)
+	$(CC) -o $@ src/main.c src/tube.c src/tek4010.c src/ards.c $(LIBS) $(CFLAGS)
+
+man: tek4010
+	help2man --output=$?.1 --name="Tektronix 4010 and 4014 storage tube terminal emulator" --no-info $?
 
 install: tek4010
 	./install
 
-clean: tek4010
+clean:
 	-rm -f tek4010

tek4010.1

@@ -0,0 +1,71 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
+.TH TEK4010 "1" "May 2024" "tek4010 version 1.9" "User Commands"
+.SH NAME
+tek4010 \- Tektronix 4010 and 4014 storage tube terminal emulator
+.SH SYNOPSIS
+.B tek4010
+[\fI\,options\/\fR] \fI\,COMMAND \/\fR[...]
+.SH DESCRIPTION
+tek4010 version 1.9
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Print this help and exit.
+.TP
+\fB\-noexit\fR
+do not close window after completion of "command"
+.TP
+\fB\-raw\fR
+do not execute an automatic CR (carriage return) after a
+LF (line feed)
+.TP
+\fB\-tab1\fR
+execute a blank instead of a tab to the next 8\-character column
+.TP
+\fB\-b100000\fR, \fB\-b38400\fR, \fB\-b19200\fR, \fB\-b9600\fR, \fB\-b4800\fR, \fB\-b2400\fR, \fB\-b1200\fR, \fB\-b600\fR, \fB\-b300\fR
+Emulate a baud rate. Without one of these arguments, the baud rate
+is 19200 baud. The original Tektronix 4010 had a maximal baud rate
+of 9600 baud. The 4014 could support up to 100000 baud with a special
+interface. With the small baud rates you can emulate 1970s
+style modem performance. Early modems had a baud rate of 300.
+.TP
+\fB\-full\fR
+in this mode the tek4010 emulator creates a full screen window and
+uses the full resolution of the 4014 with the enhanced graphics
+module installed, scaled down to the actual window size.
+Use ctrl\-q to close the tek4010 window.
+.TP
+\fB\-fullv\fR
+in this mode the tek4010 emulator creates a decorated window
+using the maximal vertical space available. The full resolution of
+the 4014 with the enhanced graphics module installed is used,
+scaled down to the actual window size
+.TP
+\fB\-ARDS\fR
+display ARDS data
+.TP
+\fB\-APL\fR
+emulate Tektronix 4013/4015 with alternative APL character set.
+Details see below.
+.TP
+\fB\-autoClear\fR
+erase screen if a line feed is executed at the bottom of the screen.
+This makes it sometimes easier to use tek4010 as the only terminal.
+It is not the behaviour of the original hardware.
+.TP
+\fB\-keepsize\fR
+tek4010 sets the fontsize to normal whenever the screen is erased.
+This option keeps the currently selected font size until it is
+changed with a new escape sequence. Some historic plot files will
+not reset the font size back to normal if this option is set.
+.TP
+\fB\-hidecursor\fR
+hides the cursor. Do not set while using GIN mode.
+.TP
+\fB\-wait\fR n
+Close window n seconds after completion of "command".
+It does not make sense to use \fB\-noexit\fR together with \fB\-wait\fR.
+.TP
+\fB\-fast\fR
+Use fast rendering without fading. Recommended on slower systems.
+This mode can be used to avoid a slow and choppy display.
+\fB\-fast\fR is automatically used for baud rates above 19200.