diff --git a/Rules.make.standalone b/Rules.make.standalone index 82a0f40..44ab2c7 100644 --- a/Rules.make.standalone +++ b/Rules.make.standalone @@ -8,6 +8,7 @@ GAMESPATH=./games ICONPATH=./icon LANGPATH=./languages DOCPATH= +MANPATH= LUA_CFLAGS=$(shell pkg-config --cflags lua5.1) LUA_LFLAGS=$(shell pkg-config --libs lua5.1) diff --git a/Rules.make.system b/Rules.make.system index aaa314b..2f1f32d 100644 --- a/Rules.make.system +++ b/Rules.make.system @@ -9,6 +9,7 @@ GAMESPATH=$(STEADPATH)/games ICONPATH=$(DESTDIR)$(PREFIX)/share/pixmaps DOCPATH=$(DESTDIR)$(PREFIX)/share/doc/instead LANGPATH=$(STEADPATH)/languages +MANPATH=$(DESTDIR)$(PREFIX)/share/man/man6 LUA_CFLAGS=$(shell pkg-config --cflags lua5.1) LUA_LFLAGS=$(shell pkg-config --libs lua5.1) diff --git a/doc/Makefile b/doc/Makefile index fca2504..a135f60 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -4,3 +4,5 @@ all: install: install -d -m0755 $(DOCPATH) install -m0644 *.jpg *.html *.txt $(DOCPATH) + install -d -m0755 $(MANPATH) + install -m0644 *.6 $(MANPATH) diff --git a/doc/instead.6 b/doc/instead.6 new file mode 100644 index 0000000..f0ddde2 --- /dev/null +++ b/doc/instead.6 @@ -0,0 +1,82 @@ +.TH INSTEAD 6 "Version 0.9" Instead GAMES + +.SH NAME + +INSTEAD - Simple Text Adventure Game Engine, The Interpretor + +.SH DESCRIPTION + +The interpreter of STEAD (Simple Text Adventures) allows to play games, combining visual novels, text adventure and classic quests of 1990-s. +The STEAD games features are: +.TP + * very simple source code of the stories. (based on LUA); +.TP + * the ability to use graphic or textual (readline) game interface; +.TP + * graphic interface supports music and images; +.TP + * graphic interpreter theme support — a game may change the interface look; +.TP + * portability (originally written for Linux, depends on SDL and lua). + +.SH SYNOPSIS + +.B sdl-instead +.I [options] + +.SH OPTIONS + +.TP +.B -debug +Debug mode (for game developers). +.TP +.B -alsa +Force ALSA sound (for Linux only). +.TP +.B -nosound +Runs the game without sound. +.TP +.B -gamespath +Add path with games. +.TP +.B -themespath +Add path with themes. +.TP +.B -game +Select game in gamespath. +.TP +.B -theme +Select theme in themespath. +.TP +.B -fullscreen +Runs the game in fullscreen mode. +.TP +.B -window +Runs the game in windowed mode. +.PP +Configuration file name is 'insteadrc' and it's located in ~/.instead/. + +You can download some games from: http://instead.googlecode.com. Unzip them +in ~/.instead/games. + +.SH CONTROLS + +Please, see tutorial. + +.SH LICENCE + +This is free software; you can redistribute it and/or modify it +under the terms specified in the GNU Public Licence (GPL). + +.SH WARRANTY + +None. + + +.SH COPYRIGHT AND CREDITS + +.TP +.B Peter Kosyh +Game author +.PP +Many others for comments, bug reports and ideas.