Merge pull request #39 from erentar/master

Add help message

makefile

@@ -4,7 +4,8 @@ CFLAGS = -std=c99 `pkg-config --cflags gtk+-3.0`
 
 all: tek4010
 
-tek4010: src/main.c src/main.h src/tube.c src/tube.h src/tek4010.c src/ards.c
+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)
 
 install: tek4010

src/help.txt

@@ -0,0 +1,50 @@
+Usage: ./tek4010 [options] COMMAND [...]
+
+    -h, --help      Print this help and exit.
+
+    -noexit         do not close window after completion of "command"
+
+    -raw            do not execute an automatic CR (carriage return) after a
+                    LF (line feed)
+
+    -tab1           execute a blank instead of a tab to the next 8-character column
+
+    -b100000, -b38400, -b19200, -b9600, -b4800, -b2400, -b1200, -b600, -b300
+                    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.
+
+    -full           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.
+
+    -fullv          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
+
+    -ARDS           display ARDS data
+
+    -APL            emulate Tektronix 4013/4015 with alternative APL character set.
+                    Details see below.
+
+    -autoClear      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.
+
+    -keepsize       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.
+
+    -hidecursor     hides the cursor. Do not set while using GIN mode.
+
+    -wait n         Close window n seconds after completion of "command".
+                    It does not make sense to use -noexit together with -wait.
+
+    -fast           Use fast rendering without fading. Recommended on slower systems.
+                    This mode can be used to avoid a slow and choppy display.
+                    -fast is automatically used for baud rates above 19200.

src/tube.c

@@ -55,6 +55,7 @@
 
 #include "main.h"
 #include "tube.h"
+#include "help.h"
 
 extern void gtk_main_quit();
 extern int windowWidth;
@@ -298,6 +299,11 @@ void tube_init(int argc, char* argv[])
                 exit(1);
         }
         
+        if ((strcmp(argv[firstArg],"-h") == 0) || (strcmp(argv[firstArg],"--help") == 0)){
+                printf(helpStr);
+                exit(0);
+        }
+
         // this stays here for compatibility with early versions of tek4010
         if (strcmp(argv[argc-1],"-noexit") == 0) {
                 argNoexit = 1;