.gitignore

@@ -2,3 +2,4 @@
 /.vscode/
 /bin
 /obj
+/doc/*\.?

.gitlab-ci.yml

@@ -35,7 +35,7 @@ static-analysis:
 build::amd64:
   <<: *only-default
   before_script:
-    - apk -q add build-base linux-headers sdl2-dev sdl2_ttf-dev cryptsetup-dev
+    - apk -q add build-base linux-headers sdl2-dev sdl2_ttf-dev cryptsetup-dev scdoc
   script:
     - make -j5
   artifacts:

Makefile

 TARGET     := osk-sdl
+VERSION	   := 0.59
 
 SDL2_CFLAGS := $(shell sdl2-config --cflags)
 SDL2_LIBS  := $(shell sdl2-config --libs)
@@ -8,9 +9,12 @@ CXXFLAGS   := -std=c++14 -Wall -g $(CXXFLAGS) $(SDL2_CFLAGS)
 
 LIBS       := -lcryptsetup $(SDL2_LIBS) -lSDL2_ttf
 
+DOCB	   := scdoc
+
 SRC_DIR    := src
 BIN_DIR    := bin
 OBJ_DIR    := obj
+DOC_DIR	   := doc
 
 SOURCES    := ${wildcard $(SRC_DIR)/*.cpp}
 OBJECTS    := $(SOURCES:$(SRC_DIR)/%.cpp=$(OBJ_DIR)/%.o)
@@ -23,7 +27,7 @@ else
 	E := @echo
 endif
 
-all: directories $(BIN_DIR)/$(TARGET)
+all: directories $(BIN_DIR)/$(TARGET) $(DOC_DIR)/osk-sdl.1
 
 $(OBJ_DIR)/%.o: $(SRC_DIR)/%.cpp
 	$(E) CC $<
@@ -33,12 +37,19 @@ $(BIN_DIR)/$(TARGET): $(OBJECTS)
 	$(E) LD $<
 	$(Q)$(CXX) -o $@ $^ $(CXXFLAGS) $(CPPFLAGS) $(LDFLAGS) $(LIBS)
 
+$(DOC_DIR)/osk-sdl.1:
+	$(Q)sed -i "s:@@VERSION@@:$(VERSION):" $@.scd
+	$(E) SCDOC $<.scd
+	$(Q)$(DOCB) < $@.scd > $@
+	$(Q)sed -i "s:$(VERSION):@@VERSION@@:" $@.scd
+
 .PHONY: clean
 
 .PHONY: directories
 
 clean:
 	-rm -rfv $(OBJ_DIR) $(BIN_DIR)
+	-rm -rfv $(DOC_DIR)/osk-sdl.1
 
 directories:
 	@mkdir -p ./obj

doc/osk-sdl.1.scd

+osk-sdl(1) "osk-sdl @@VERSION@@"
+
+# NAME
+
+OSK-SDL
+
+# SYNOPSIS
+
+osk-sdl -d DISK -n NAME [OPTION]
+
+# DESCRIPTION
+
+OSK-SDL is a lightweight on screen keyboard used to unlock encrypted root partitions on mobile devices.
+
+# OPTIONS
+
+## Mandatory
+
+*-t*
+	Run in test mode, do not attempt to initialise the whole screen.
+
+*-d <path>*
+	Decrypt this disk. This argument is mandatory unless \-t is used.
+
+*-n <name>*
+	Name of the decrypted disk.
+
+
+## Optional
+
+*-h*
+	Show help options
+
+*-c <path>*
+	Locaton of the osk-sdl config file. Defaults to "/etc/osk.conf".
+
+*-v*
+	Enable verbose output
+
+*-k*
+	Enable keyscript mode. Password will be output to STDOUT for use with another program such as cryptsetup-initramfs.
+
+# EXAMPLES
+
+*Decrypt /dev/sda1 to name "root"*
+	osk-sdl -d /dev/sda1 -n root -c /etc/osk.conf
+
+# AUTHORS
+
+*Undef* <debian@undef.tools>

run_osk.sh

@@ -17,7 +17,7 @@
 export TSLIB_TSDEVICE=/dev/input/event3
 export DFBARGS=system=fbdev,no-cursor,disable-module=linux_input
 export TERM=xterm
-export osk_cmd="./osk-sdl -d a -n a -c osk.conf"
+export osk_cmd="./bin/osk-sdl -d a -n a -c osk.conf"
 
 echo "WARNING: This script is meant to assist with debugging osk-sdl and NOT"
 echo "for unlocking rootfs!"

src/main.cpp

@@ -60,7 +60,7 @@ int main(int argc, char **args)
 	}
 
 	if (!config.Read(opts.confPath)) {
-		fprintf(stderr, "No valid config file specified, use -c [path]");
+		fprintf(stderr, "No valid config file specified, use -c [path]\n");
 		exit(EXIT_FAILURE);
 	}