man added :)

This commit is contained in:
p.kosyh 2009-09-15 10:06:58 +00:00
parent ab9cf45a43
commit 992e5ac166
4 changed files with 86 additions and 0 deletions

View file

@ -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)

View file

@ -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)

View file

@ -4,3 +4,5 @@ all:
install:
install -d -m0755 $(DOCPATH)
install -m0644 *.jpg *.html *.txt $(DOCPATH)
install -d -m0755 $(MANPATH)
install -m0644 *.6 $(MANPATH)

82
doc/instead.6 Normal file
View file

@ -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 <path>
Add path with games.
.TP
.B -themespath <path>
Add path with themes.
.TP
.B -game <basename>
Select game in gamespath.
.TP
.B -theme <basename>
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.