diff options
Diffstat (limited to 'doc/en')
| -rw-r--r-- | doc/en/Makefile.am | 11 | ||||
| -rw-r--r-- | doc/en/Makefile.in | 482 | ||||
| -rw-r--r-- | doc/en/index.docbook | 433 | ||||
| -rw-r--r-- | doc/en/index.html | 83 | ||||
| -rw-r--r-- | doc/en/kpacman-1.html | 274 | ||||
| -rw-r--r-- | doc/en/kpacman-2.html | 61 | ||||
| -rw-r--r-- | doc/en/kpacman-3.html | 564 | ||||
| -rw-r--r-- | doc/en/kpacman-4.html | 55 | ||||
| -rw-r--r-- | doc/en/kpacman.gif | bin | 0 -> 481 bytes |
9 files changed, 1963 insertions, 0 deletions
diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am new file mode 100644 index 0000000..b386973 --- /dev/null +++ b/doc/en/Makefile.am @@ -0,0 +1,11 @@ +####### kdevelop will overwrite this part!!! (begin)########## + + +EXTRA_DIST = index.docbook index.html kpacman-1.html kpacman-2.html kpacman-3.html kpacman-4.html kpacman.gif + +####### kdevelop will overwrite this part!!! (end)############ + +KDE_LANG = en +KDE_DOCS = kpacman + + diff --git a/doc/en/Makefile.in b/doc/en/Makefile.in new file mode 100644 index 0000000..fdfd488 --- /dev/null +++ b/doc/en/Makefile.in @@ -0,0 +1,482 @@ +# Makefile.in generated by automake 1.7.2 from Makefile.am. +# KDE tags expanded automatically by am_edit - $Revision: 1.349.2.2 $ +# @configure_input@ + +# Copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 +# Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +####### kdevelop will overwrite this part!!! (begin)########## + +srcdir = @srcdir@ +top_srcdir = @top_srcdir@ +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +top_builddir = ../.. + +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +INSTALL = @INSTALL@ +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +target_triplet = @target@ +ACLOCAL = @ACLOCAL@ +AMDEP_FALSE = @AMDEP_FALSE@ +AMDEP_TRUE = @AMDEP_TRUE@ +AMTAR = @AMTAR@ +ARTSCCONFIG = @ARTSCCONFIG@ +AUTOCONF = @AUTOCONF@ +AUTODIRS = @AUTODIRS@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CC = @CC@ +CCDEPMODE = @CCDEPMODE@ +CFLAGS = @CFLAGS@ +CONF_FILES = @CONF_FILES@ +CPP = @CPP@ +CPPFLAGS = @CPPFLAGS@ +CXX = @CXX@ +CXXCPP = @CXXCPP@ +CXXDEPMODE = @CXXDEPMODE@ +CXXFLAGS = @CXXFLAGS@ +CYGPATH_W = @CYGPATH_W@ +DCOPIDL = @DCOPIDL@ +DCOPIDL2CPP = @DCOPIDL2CPP@ +DCOP_DEPENDENCIES = @DCOP_DEPENDENCIES@ +DEFS = @DEFS@ +DEPDIR = @DEPDIR@ +ECHO = @ECHO@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +EGREP = @EGREP@ +EXEEXT = @EXEEXT@ +FRAMEWORK_COREAUDIO = @FRAMEWORK_COREAUDIO@ +GMSGFMT = @GMSGFMT@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +KDECONFIG = @KDECONFIG@ +KDE_EXTRA_RPATH = @KDE_EXTRA_RPATH@ +KDE_INCLUDES = @KDE_INCLUDES@ +KDE_LDFLAGS = @KDE_LDFLAGS@ +KDE_MT_LDFLAGS = @KDE_MT_LDFLAGS@ +KDE_MT_LIBS = @KDE_MT_LIBS@ +KDE_PLUGIN = @KDE_PLUGIN@ +KDE_RPATH = @KDE_RPATH@ +KDE_USE_CLOSURE_FALSE = @KDE_USE_CLOSURE_FALSE@ +KDE_USE_CLOSURE_TRUE = @KDE_USE_CLOSURE_TRUE@ +KDE_USE_FINAL_FALSE = @KDE_USE_FINAL_FALSE@ +KDE_USE_FINAL_TRUE = @KDE_USE_FINAL_TRUE@ +KDE_XSL_STYLESHEET = @KDE_XSL_STYLESHEET@ +LDFLAGS = @LDFLAGS@ +LIBCOMPAT = @LIBCOMPAT@ +LIBCRYPT = @LIBCRYPT@ +LIBDL = @LIBDL@ +LIBJPEG = @LIBJPEG@ +LIBOBJS = @LIBOBJS@ +LIBPNG = @LIBPNG@ +LIBPTHREAD = @LIBPTHREAD@ +LIBRESOLV = @LIBRESOLV@ +LIBS = @LIBS@ +LIBSM = @LIBSM@ +LIBSOCKET = @LIBSOCKET@ +LIBTOOL = @LIBTOOL@ +LIBUCB = @LIBUCB@ +LIBUTIL = @LIBUTIL@ +LIBXINERAMA = @LIBXINERAMA@ +LIBZ = @LIBZ@ +LIB_KAB = @LIB_KAB@ +LIB_KABC = @LIB_KABC@ +LIB_KDECORE = @LIB_KDECORE@ +LIB_KDEPRINT = @LIB_KDEPRINT@ +LIB_KDEUI = @LIB_KDEUI@ +LIB_KFILE = @LIB_KFILE@ +LIB_KFM = @LIB_KFM@ +LIB_KHTML = @LIB_KHTML@ +LIB_KIO = @LIB_KIO@ +LIB_KPARTS = @LIB_KPARTS@ +LIB_KSPELL = @LIB_KSPELL@ +LIB_KSYCOCA = @LIB_KSYCOCA@ +LIB_POLL = @LIB_POLL@ +LIB_QPE = @LIB_QPE@ +LIB_QT = @LIB_QT@ +LIB_SMB = @LIB_SMB@ +LIB_X11 = @LIB_X11@ +LIB_XEXT = @LIB_XEXT@ +LN_S = @LN_S@ +LTLIBOBJS = @LTLIBOBJS@ +MAKEINFO = @MAKEINFO@ +MCOPIDL = @MCOPIDL@ +MEINPROC = @MEINPROC@ +MOC = @MOC@ +MSGFMT = @MSGFMT@ +NOOPT_CFLAGS = @NOOPT_CFLAGS@ +NOOPT_CXXFLAGS = @NOOPT_CXXFLAGS@ +NOREPO = @NOREPO@ +OBJEXT = @OBJEXT@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +QTE_NORTTI = @QTE_NORTTI@ +QT_INCLUDES = @QT_INCLUDES@ +QT_LDFLAGS = @QT_LDFLAGS@ +RANLIB = @RANLIB@ +REPO = @REPO@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +TOPSUBDIRS = @TOPSUBDIRS@ +UIC = @UIC@ +UIC_TR = @UIC_TR@ +USER_INCLUDES = @USER_INCLUDES@ +USER_LDFLAGS = @USER_LDFLAGS@ +USE_EXCEPTIONS = @USE_EXCEPTIONS@ +USE_RTTI = @USE_RTTI@ +USE_THREADS = @USE_THREADS@ +VERSION = @VERSION@ +WOVERLOADED_VIRTUAL = @WOVERLOADED_VIRTUAL@ +XGETTEXT = @XGETTEXT@ +X_EXTRA_LIBS = @X_EXTRA_LIBS@ +X_INCLUDES = @X_INCLUDES@ +X_LDFLAGS = @X_LDFLAGS@ +X_PRE_LIBS = @X_PRE_LIBS@ +ac_ct_CC = @ac_ct_CC@ +ac_ct_CXX = @ac_ct_CXX@ +ac_ct_RANLIB = @ac_ct_RANLIB@ +ac_ct_STRIP = @ac_ct_STRIP@ +all_includes = @all_includes@ +all_libraries = @all_libraries@ +am__fastdepCC_FALSE = @am__fastdepCC_FALSE@ +am__fastdepCC_TRUE = @am__fastdepCC_TRUE@ +am__fastdepCXX_FALSE = @am__fastdepCXX_FALSE@ +am__fastdepCXX_TRUE = @am__fastdepCXX_TRUE@ +am__include = @am__include@ +am__quote = @am__quote@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +datadir = @datadir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +kde_appsdir = @kde_appsdir@ +kde_bindir = @kde_bindir@ +kde_confdir = @kde_confdir@ +kde_datadir = @kde_datadir@ +kde_htmldir = @kde_htmldir@ +kde_icondir = @kde_icondir@ +kde_includes = @kde_includes@ +kde_libraries = @kde_libraries@ +kde_libs_htmldir = @kde_libs_htmldir@ +kde_libs_prefix = @kde_libs_prefix@ +kde_locale = @kde_locale@ +kde_mimedir = @kde_mimedir@ +kde_moduledir = @kde_moduledir@ +kde_qtver = @kde_qtver@ +kde_servicesdir = @kde_servicesdir@ +kde_servicetypesdir = @kde_servicetypesdir@ +kde_sounddir = @kde_sounddir@ +kde_styledir = @kde_styledir@ +kde_templatesdir = @kde_templatesdir@ +kde_wallpaperdir = @kde_wallpaperdir@ +kde_widgetdir = @kde_widgetdir@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +oldincludedir = @oldincludedir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +qt_includes = @qt_includes@ +qt_libraries = @qt_libraries@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +sysconfdir = @sysconfdir@ +target = @target@ +target_alias = @target_alias@ +target_cpu = @target_cpu@ +target_os = @target_os@ +target_vendor = @target_vendor@ +x_includes = @x_includes@ +x_libraries = @x_libraries@ + +EXTRA_DIST = index.docbook index.html kpacman-1.html kpacman-2.html kpacman-3.html kpacman-4.html kpacman.gif + + +####### kdevelop will overwrite this part!!! (end)############ +KDE_LANG = en +KDE_DOCS = kpacman +subdir = doc/en +mkinstalldirs = $(SHELL) $(top_srcdir)/admin/mkinstalldirs +CONFIG_HEADER = $(top_builddir)/config.h +CONFIG_CLEAN_FILES = +DIST_SOURCES = +DIST_COMMON = Makefile.am Makefile.in +#>- all: all-am +#>+ 1 +all: docs-am all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: Makefile.am $(top_srcdir)/configure.in $(ACLOCAL_M4) +#>- cd $(top_srcdir) && \ +#>- $(AUTOMAKE) --gnu doc/en/Makefile +#>+ 3 + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/en/Makefile + cd $(top_srcdir) && perl admin/am_edit doc/en/Makefile.in +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe) + +mostlyclean-libtool: + -rm -f *.lo + +clean-libtool: + -rm -rf .libs _libs + +distclean-libtool: + -rm -f libtool +uninstall-info-am: +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) + +top_distdir = ../.. +distdir = $(top_distdir)/$(PACKAGE)-$(VERSION) + +#>- distdir: $(DISTFILES) +#>+ 1 +distdir: distdir-nls $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \ + list='$(DISTFILES)'; for file in $$list; do \ + case $$file in \ + $(srcdir)/*) file=`echo "$$file" | sed "s|^$$srcdirstrip/||"`;; \ + $(top_srcdir)/*) file=`echo "$$file" | sed "s|^$$topsrcdirstrip/|$(top_builddir)/|"`;; \ + esac; \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + dir=`echo "$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test "$$dir" != "$$file" && test "$$dir" != "."; then \ + dir="/$$dir"; \ + $(mkinstalldirs) "$(distdir)$$dir"; \ + else \ + dir=''; \ + fi; \ + if test -d $$d/$$file; then \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile + +installdirs: + +install: install-am +install-exec: install-exec-am +install-data: install-data-am +#>- uninstall: uninstall-am +#>+ 1 +uninstall: uninstall-docs uninstall-nls uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -rm -f Makefile $(CONFIG_CLEAN_FILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." +#>- clean: clean-am +#>+ 1 +clean: kde-rpo-clean clean-am + +#>- clean-am: clean-generic clean-libtool mostlyclean-am +#>+ 1 +clean-am: clean-docs clean-generic clean-libtool mostlyclean-am + +distclean: distclean-am + +distclean-am: clean-am distclean-generic distclean-libtool + +dvi: dvi-am + +dvi-am: + +info: info-am + +info-am: + +#>- install-data-am: +#>+ 1 +install-data-am: install-docs install-nls + +install-exec-am: + +install-info: install-info-am + +install-man: + +installcheck-am: + +maintainer-clean: maintainer-clean-am + +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic mostlyclean-libtool + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-info-am + +.PHONY: all all-am check check-am clean clean-generic clean-libtool \ + distclean distclean-generic distclean-libtool distdir dvi \ + dvi-am info info-am install install-am install-data \ + install-data-am install-exec install-exec-am install-info \ + install-info-am install-man install-strip installcheck \ + installcheck-am installdirs maintainer-clean \ + maintainer-clean-generic mostlyclean mostlyclean-generic \ + mostlyclean-libtool pdf pdf-am ps ps-am uninstall uninstall-am \ + uninstall-info-am + +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: + +#>+ 24 +index.cache.bz2: $(srcdir)/index.docbook $(KDE_XSL_STYLESHEET) kpacman-2.html kpacman-3.html kpacman-4.html kpacman.gif index.html index.docbook kpacman-1.html + @if test -n "$(MEINPROC)"; then echo $(MEINPROC) --check --cache index.cache.bz2 $(srcdir)/index.docbook; $(MEINPROC) --check --cache index.cache.bz2 $(srcdir)/index.docbook; fi + +docs-am: index.cache.bz2 + +install-docs: docs-am install-nls + $(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman + @if test -f index.cache.bz2; then \ + echo $(INSTALL_DATA) index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/; \ + $(INSTALL_DATA) index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/; \ + elif test -f $(srcdir)/index.cache.bz2; then \ + echo $(INSTALL_DATA) $(srcdir)/index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/; \ + $(INSTALL_DATA) $(srcdir)/index.cache.bz2 $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/; \ + fi + -rm -f $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/common + $(LN_S) $(kde_libs_htmldir)/$(KDE_LANG)/common $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/common + +uninstall-docs: + -rm -rf $(kde_htmldir)/$(KDE_LANG)/kpacman + +clean-docs: + -rm -f index.cache.bz2 + + +#>+ 13 +install-nls: + $(mkinstalldirs) $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman + @for base in kpacman-2.html kpacman-3.html kpacman-4.html kpacman.gif index.html index.docbook kpacman-1.html ; do \ + echo $(INSTALL_DATA) $$base $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/$$base ;\ + $(INSTALL_DATA) $(srcdir)/$$base $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/$$base ;\ + done + +uninstall-nls: + for base in kpacman-2.html kpacman-3.html kpacman-4.html kpacman.gif index.html index.docbook kpacman-1.html ; do \ + rm -f $(DESTDIR)$(kde_htmldir)/$(KDE_LANG)/kpacman/$$base ;\ + done + + +#>+ 5 +distdir-nls: + for file in kpacman-2.html kpacman-3.html kpacman-4.html kpacman.gif index.html index.docbook kpacman-1.html ; do \ + cp $(srcdir)/$$file $(distdir); \ + done + +#>+ 6 +force-reedit: + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu doc/en/Makefile + cd $(top_srcdir) && perl admin/am_edit doc/en/Makefile.in + + +#>+ 2 +final: + $(MAKE) all-am +#>+ 2 +final-install: + $(MAKE) install-am +#>+ 2 +no-final: + $(MAKE) all-am +#>+ 2 +no-final-install: + $(MAKE) install-am +#>+ 3 +cvs-clean: + $(MAKE) admindir=$(top_srcdir)/admin -f $(top_srcdir)/admin/Makefile.common cvs-clean + +#>+ 3 +kde-rpo-clean: + -rm -f *.rpo diff --git a/doc/en/index.docbook b/doc/en/index.docbook new file mode 100644 index 0000000..b01b1fd --- /dev/null +++ b/doc/en/index.docbook @@ -0,0 +1,433 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [ + <!ENTITY kpacman '<application>Kpacman</application>'> + <!ENTITY kapp "&kpacman;"><!-- replace kpacman here --> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"><!-- change language only here --> + + + <!-- Do not define any other entities; instead, use the entities + from kde-genent.entities and $LANG/user.entities. --> +]> +<!-- kdoctemplate v0.8 October 1 1999 + Minor update to "Credits and Licenses" section on August 24, 2000 + Removed "Revision history" section on 22 January 2001 --> + +<!-- +This template was designed by: David Rugge davidrugge@mindspring.com +with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr +and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de +of the KDE DocBook team. + +You may freely use this template for writing any sort of KDE documentation. +If you have any changes or improvements, please let us know. + +In the future, we may want to change from SGML-based DocBook to XML-based +DocBook. To make this change easier, please be careful : +- in XML, the case of the <tags> and attributes is relevant ; +- also, quote all attributes. + +Please don't forget to remove all these comments in your final documentation, +thanks ;-). +--> + +<!-- ................................................................ --> + +<!-- The language must NOT be changed here. --> + +<book lang="&language;"> + +<!-- This header contains all of the meta-information for the document such +as Authors, publish date, the abstract, and Keywords --> + +<bookinfo> +<title>The Kpacman Handbook</title> + +<authorgroup> +<author> +<firstname>George</firstname> +<othername>N.</othername> +<surname>Ugnacious</surname> +<affiliation> +<address><email>gnu@kde.org</email></address> +</affiliation> +</author> +</authorgroup> + +<!-- TRANS:ROLES_OF_TRANSLATORS --> + +<copyright> +<year>1999</year> +<year>2000</year> +<holder>George N. Ugnacious</holder> +</copyright> +<!-- Translators: put here the copyright notice of the translation --> +<!-- Put here the FDL notice. Read the explanation in fdl-notice.docbook + and in the FDL itself on how to use it. --> +<legalnotice>&FDLNotice;</legalnotice> + +<!-- Date and version information of the documentation +Don't forget to include this last date and this last revision number, we +need them for translation coordination ! +Please respect the format of the date (DD/MM/YYYY) and of the version +(V.MM.LL), it could be used by automation scripts. +Do NOT change these in the translation. --> + +<date>03/04/1999</date> +<releaseinfo>1.01.00</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para> +&kpacman; is an application specially designed to do nothing you would +ever want. +</para> +</abstract> + +<!-- This is a set of Keywords for indexing by search engines. +Please at least include KDE, the KDE package it is in, the name + of your application, and a few relevant keywords. --> + +<keywordset> +<keyword>KDE</keyword> +<keyword>kdeutils</keyword> +<keyword>Kapp</keyword> +<keyword>nothing</keyword> +<keyword>nothing else</keyword> +</keywordset> + +</bookinfo> + +<!-- The contents of the documentation begin here. Label +each chapter so with the id attribute. This is necessary for two reasons: it +allows you to easily reference the chapter from other chapters of your +document, and if there is no ID, the name of the generated HTML files will vary +from time to time making it hard to manage for maintainers and for the CVS +system. Any chapter labelled (OPTIONAL) may be left out at the author's +discretion. Other chapters should not be left out in order to maintain a +consistent documentation style across all KDE apps. --> + +<chapter id="introduction"> +<title>Introduction</title> + +<!-- The introduction chapter contains a brief introduction for the +application that explains what it does and where to report +problems. Basically a long version of the abstract. Don't include a +revision history. (see installation appendix comment) --> + +<para> +&kapp; is a program that lets you do absolutely nothing. Please report +any problems or feature requests to the KDE mailing lists. +</para> +</chapter> + +<chapter id="using-kapp"> +<title>Using Kpacman</title> + +<!-- This chapter should tell the user how to use your app. You should use as +many sections (Chapter, Sect1, Sect3, etc...) as is necessary to fully document +your application. --> + +<para> + +<!-- Note that all graphics should be in .png format. Use no gifs because of +patent issues. --> + +<screenshot> +<screeninfo>Here's a screenshot of &kapp;</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="screenshot.png" format="PNG"/> + </imageobject> + <imageobject> + <imagedata fileref="screenshot.eps" format="EPS"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> +</para> + + +<sect1 id="kapp-features"> +<title>More Kapp features</title> + +<para>It slices! It dices! and it comes with a free toaster!</para> +<para> +The Squiggle Tool <guiicon><inlinemediaobject> + <imageobject> + <imagedata fileref="squiggle.png" format="PNG"/> + </imageobject> + <imageobject> + <imagedata fileref="squiggle.eps" format="EPS"/> + </imageobject> + <textobject> + <phrase>Squiggle</phrase> + </textobject> +</inlinemediaobject></guiicon> is used to draw squiggly lines all over +the &kpacman; main window. It's not a bug, it's a feature! +</para> + +</sect1> +</chapter> + +<chapter id="commands"> +<title>Command Reference</title> + +<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the +application windows and their menubar and toolbar commands for easy reference. +Also include any keys that have a special function but have no equivalent in the +menus or toolbars. This may not be necessary for small apps or apps with no tool +or menu bars. --> + +<sect1 id="kapp-mainwindow"> +<title>The main Kpacman window</title> +<para></para> + +<sect2> +<title>The File Menu</title> +<para> +<variablelist> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>n</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>New</guimenuitem> +</menuchoice></term> +<listitem><para><action>Creates a new document</action></para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>s</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Save</guimenuitem> +</menuchoice></term> +<listitem><para><action>Saves the document</action></para></listitem> +</varlistentry> +<varlistentry> +<term><menuchoice> +<shortcut> +<keycombo><keycap>Ctrl</keycap><keycap>q</keycap></keycombo> +</shortcut> +<guimenu>File</guimenu> +<guimenuitem>Quit</guimenuitem> +</menuchoice></term> +<listitem><para><action>Quits</action> &kapp;</para></listitem> +</varlistentry> +</variablelist> +</para> + +</sect2> + +</sect1> +</chapter> + +<chapter id="developers"> +<title>Developer's Guide to Kpacman</title> + +<!-- (OPTIONAL) A Programming/Scripting reference chapter should be +used for apps that use plugins or that provide their own scripting hooks +and/or development libraries. --> + +<para> +Programming &kpacman; plugins is a joy to behold. Just read through the next +66 pages of API's to learn how! +</para> + +<!-- Use refentries to describe APIs. Refentries are fairly complicated and you +should consult the docbook reference for further details. The example below was +taken from that reference and shortened a bit for readability. --> + +</chapter> + +<chapter id="faq"> +<title>Questions and Answers</title> + +<!-- (OPTIONAL but recommended) This chapter should include all of the silly +(and not-so-silly) newbie questions that fill up your mailbox. This chapter +should be reserved for BRIEF questions and answers! If one question uses more +than a page or so then it should probably be part of the +"Using this Application" chapter instead. You should use links to +cross-reference questions to the parts of your documentation that answer them. +This is also a great place to provide pointers to other FAQ's if your users +must do some complicated configuration on other programs in order for your +application work. --> + +&reporting.bugs; +&updating.documentation; + +<qandaset id="faqlist"> +<qandaentry> +<question> +<para>My Mouse doesn't work. How do I quit &kapp;?</para> +</question> +<answer> +<para>You silly goose! Check out the <link linkend="commands">Commands +Section</link> for the answer.</para> +</answer> +</qandaentry> +<qandaentry> +<question> +<para>Why can't I twiddle my documents?</para> +</question> +<answer> +<para>You can only twiddle your documents if you have the foobar.lib +installed.</para> +</answer> +</qandaentry> +</qandaset> +</chapter> + +<chapter id="credits"> + +<!-- Include credits for the programmers, documentation writers, and +contributors here. The license for your software should then be included below +the credits with a reference to the appropriate license file included in the KDE +distribution. --> + +<title>Credits and License</title> + +<para> +&kapp; +</para> +<para> +Program copyright 1997 John Q. Hacker <email>jqh@kde.org</email> +</para> +<para> +Contributors: +<itemizedlist> +<listitem><para>Konqui the KDE Dragon <email>konqui@kde.org</email></para> +</listitem> +<listitem><para>Tux the Linux Penguin <email>tux@linux.org</email></para> +</listitem> +</itemizedlist> +</para> + +<para> +Documentation copyright 1999 George N. Ugnacious <email>gnu@kde.org</email> +</para> + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> + +&underFDL; <!-- FDL: do not remove. Commercial development should --> +<!-- replace this with their copyright and either remove it or re-set this.--> + +<!-- Determine which license your application is licensed under, + and delete all the remaining licenses below: + + (NOTE: All documentation are licensed under the FDL, + regardless of what license the application uses) --> + +&underGPL; <!-- GPL License --> +&underBSDLicense; <!-- BSD License --> +&underArtisticLicense; <!-- BSD Artistic License --> +&underX11License; <!-- X11 License --> + +</chapter> + +<appendix id="installation"> +<title>Installation</title> + +<sect1 id="getting-kpacman"> +<title>How to obtain Kpacman</title> + +<para> +&kpacman; is part of the KDE project +<ulink url="http://www.kde.org">http://www.kde.org</ulink>. +&kpacman; can be found in the kdeutils package on +<ulink url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the +main ftp site of the KDE project. </para> +</sect1> + +<sect1 id="requirements"> +<title>Requirements</title> + +<!-- +List any special requirements for your application here. This should include: +.Libraries or other software that is not included in kdesupport, +kdelibs, or kdebase. +.Hardware requirements like amount of RAM, disk space, graphics card +capabilities, screen resolution, special expansion cards, etc. +.Operating systems the app will run on. If your app is designed only for a +specific OS, (you wrote a graphical LILO configurator for example) put this +information here. +--> + +<para> +In order to successfully use &kpacman;, you need KDE 1.1. Foobar.lib is required +in order to support the advanced &kpacman; features. &kpacman; uses about 5 megs of +memory to run, but this may vary depending on your platform and +configuration. +</para> + +<para> +All required libraries as well as &kpacman; itself can be found +on <ulink url="ftp://ftp.kapp.org">The &kpacman; home page</ulink>. +</para> + +<!-- For a list of updates, you may refer to the application web site +or the ChangeLog file, or ... --> +<para> +You can find a list of changes at <ulink +url="http://apps.kde.org/kapp">http://apps.kde.org/kapp</ulink>. +</para> +</sect1> + +<sect1 id="compilation"> +<title>Compilation and Installation</title> + +<para> +In order to compile and install KApp on your system, type the following in the base +directory of the Icon Editor distribution: +<screen width="40"> +<prompt>%</prompt> <userinput>./configure</userinput> +<prompt>%</prompt> <userinput>make</userinput> +<prompt>%</prompt> <userinput>make install</userinput> +</screen> +</para> + +<para>Since KApp uses autoconf and automake you should have not trouble compiling it. +Should you run into problems please report them to the KDE mailing lists.</para> + +</sect1> + +<sect1 id="configuration"> +<title>Configuration</title> + +<para>Don't forget to tell your system to start the <filename>dtd</filename> +dicer-toaster daemon first, or KApp won't work !</para> + +</sect1> + +</appendix> + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: +--> + + + + + + + + + + + + + diff --git a/doc/en/index.html b/doc/en/index.html new file mode 100644 index 0000000..16ab587 --- /dev/null +++ b/doc/en/index.html @@ -0,0 +1,83 @@ +<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> +<head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> + <meta name="keywords" content="KPacman"> + <meta name="description" content="Documentation for KPacman"> + <title>The KPacman Handbook</title> +</head> +<body text="#000000" bgcolor="#FFFFFF" link="#8E2727" vlink="#8E2727"> + +<table BORDER=0 CELLSPACING=2 > +<tr> +<td><img SRC="kpacman.gif" ALT="KPacman" NOSAVE BORDER=0 height=32 width=32 align=TEXTTOP></td> + +<td><b><font size=+2>KPacman</font></b> +<br><font size=-1>Version 0.3.2</font></td> +</tr> +</table> + +<hr WIDTH="600" SIZE=2 ALIGN="LEFT" NOSHADE> +<table WIDTH="600" > +<tr> +<td> +<div align=right><a href="kpacman-1.html">Next</a> Previous Table of Contents</div> + +<h1> +The KPacman Handbook</h1> +<i>Jörg Thönnissen, <a href="mailto:joe@dsite.de"><joe@dsite.de></a></i> +<br><i><font size=-1>Version 0.3.2, June 30th, 2003</font></i> +<p> +<hr SIZE="1" NOSHADE>This Handbook describes KPacman Version 0.3.2 +<br> +<hr SIZE="1" NOSHADE> +<h2> +<a NAME="toc1"></a>1. <a href="kpacman-1.html">Introduction</a></h2> + +<ul> +<li> +<a href="kpacman-1.html#ss1.1">1.1 Changes</a> </li> +</ul> + +<h2> +<a NAME="toc2"></a>2. <a href="kpacman-2.html">Installation</a></h2> + +<ul> +<li> +<a href="kpacman-2.html#ss2.1">2.1 How to Obtain KPacman</a> </li> + +<li> +<a href="kpacman-2.html#ss2.2">2.2 Requirements</a> </li> + +<li> +<a href="kpacman-2.html#ss2.3">2.3 Compilation and Installation</a> </li> +</ul> + +<h2> +<a NAME="toc2"></a>3. <a href="kpacman-3.html">Configuration</a></h2> + +<ul> +<li> +<a href="kpacman-3.html#ss3.1">3.1 Timing</a> </li> + +<li> +<a href="kpacman-3.html#ss3.2">3.2 Points (Scoring)</a></li> + +<li> +<a href="kpacman-3.html#ss3.3">3.3 Graphical Schemes</a> </li> + +<li> +<a href="kpacman-3.html#ss3.4">3.4 Miscellaneous</a></li> +</ul> + +<h2> +<a NAME="toc1"></a>4. <a href="kpacman-4.html">Copyright</a> </h2> + +<div align=right><a href="kpacman-1.html">Next</a> Previous Table of Contents</div> + +<hr WIDTH="600" SIZE=3 ALIGN="LEFT" NOSHADE></td> +</tr> +</table> + +</body> +</html> diff --git a/doc/en/kpacman-1.html b/doc/en/kpacman-1.html new file mode 100644 index 0000000..702ba7e --- /dev/null +++ b/doc/en/kpacman-1.html @@ -0,0 +1,274 @@ +<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> +<head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> + <meta name="keywords" content="KPacman"> + <meta name="description" content="Documentation for KPacman"> + <title>The KPacman Handbook: Introduction</title> +</head> +<body text="#000000" bgcolor="#FFFFFF" link="#8E2727" vlink="#8E2727"> + +<table BORDER=0 CELLSPACING=2 > +<tr> +<td><img SRC="kpacman.gif" ALT="KPacman" BORDER=0 height=32 width=32 align=TEXTTOP></td> + +<td><b><font size=+2>KPacman</font></b> +<br><font size=-1>Version 0.3.2</font></td> +</tr> +</table> + +<hr WIDTH="600" SIZE=2 ALIGN="LEFT" NOSHADE> +<table CELLSPACING=0 CELLPADDING=0 WIDTH="600" > +<tr> +<td> +<div align=right><a href="kpacman-2.html">Next</a> <a href="index.html">Previous</a> +<a href="index.html#toc1">Table of Contents</a></div> + +<h3> +<a NAME="s1"></a>1. Introduction</h3> + +<h3> +<a NAME="ss1.1"></a>1.1 Changes </h3> + +<h4> +Version 0.3.2 (30. June 2003)</h4> + +<ul> +<li>Almost a real KDE3 application.</li> +</ul> + +<h4> +Version 0.3.1 (31. January 2002)</h4> + +<ul> +<li>Prerelease for KDE2 (Documentation not fully adjusted).</li> + +<li>The "highscore"-file is no longer been created by the installation, but as soon as +the hall of fame has been entered. +The path (directory/filename) could be specified in the <a href="kpacman-3.html#ss3.4">configfile</a>. +If the systemwide "highscore"-file is not writable, a private file in the +home-directory of the user is used and a corresponding message is shown.</li> +</ul> + +<h4> +Version 0.3.0 (June 2000, not released)</h4> + +<ul> +<li>Ms.Pacman mode implemented (mighty modification) !</li> + +<li>Automatic Pause/Continue in Back/Foreground, for Kevin Forge +(he has the idea for Ms.Pacman too) integrated. This options can be changed using +the menu.</li> + +<li>Portuguese translation by Sérgio Fernandes.</li> + +<li>Animation of the energizers und blinking of active player ("1UP") added.</li> + +<li>Flickering during editing the hall of fame by changing the focus +removed (FocusEvents).</li> + +<li>The mousecursor could be hidden/shown while over the playground, +thru the menubar.</li> + +<li>The boardlayout (map) could be placed in external textfiles and selected +thru the configfile (kpacmanrc) if needed.</li> + +<li>Duplicate pixmaps removed. Because all pixmapfiles could be specified +thru the configfile now, pixmaps could be placed in foreign (scheme)-directories +(EyesPixmapName=../tiny/eyes.xpm), or have different names +(e.g.: LevelPixmapName=fruit.xpm).</li> + +<li>After eating the last dot, the first pixmap of the last/current direction +is shown. The initial pixmap of the north/up-direction was displayed so far.</li> +</ul> + +<h4> +Version 0.2.6 (December 11th, 1999)</h4> + +<ul> +<li> +Swedish translation of some text (unfortunately incomplete) by Johne.</li> + +<li> +By the use of special charaters (umlauts) in the swedish version, the whole +font-handling had to be rearranged.</li> + +<li> +The fonts contains (nearly) the full ISO-Latin1 characterset (no lowercase +characters).</li> + +<li> +Alignment functions built into the display routines.</li> + +<li> +No further use of xbm-fonts, therefore pbm-files were used as fonts (they +need less space, even they contains much more characters).</li> + +<li> +All textelements added to the localisation (i18n). So strings like "GAME +OVER" or "READY!" could be translated into any language.</li> + +<li> +The documentation and programm now contains my brandnew email-address.</li> +</ul> + +<h4> +Version 0.2.5 (June 20th, 1999)</h4> + +<ul> +<li> +Displaying of the hall of fame changed, hopefully this fix some rare bugs. +Use lower/raise- instead of former used hide/show-functions to switch display.</li> + +<li> +The file used for HighScore storage, will be set to worldwriteable (chmod +666) during installation. Thru this "normal" users could store their highscores +permanently.</li> + +<li> +Levels entended upto 13 (LevelPixmaps, Score), by the higher scores, the +fonts (for displaying the scored points) had to be extended too. The scores +could be variable (in the range from 10 to 9000, only the leading digit +can be not 0. exception 1600 ) now. The pixmap for the score could be larger +than the actual figure itself.</li> + +<li> +Because there is not enough room to show 13 levelsymbols in the statusline, +the position of the symbol can be specified by the <a href="kpacman-3.html#ss3.4">LevelPosition</a> +value(s).</li> + +<li> +The default-Speed of the monsters kept constant althrough higher levels, +requested by Gerald Williams.</li> + +<li> +Update-routines (display) optimized.</li> + +<li> +The documentation and programm now contains my new email-address.</li> +</ul> + +<h4> +Version 0.2.4 (January 26th, 1999 - today linux v2.2 was released)</h4> + +<ul> +<li> +Added the hall of fame to store the highscores. For this, the structure +of the bitfonts was extented to contain furthermore characters, the special-characters +(small scores during the game) moved to the control-character-region and +the fonthandling was enhanced (FontFirstChar and FontLastChar can be stored +in the Configfile).</li> + +<li> +The size of the labels in the "Change Keys..."-dialog were set manually, +cause the autoResize-function in the qt-libs didn't work correctly in all +versions.</li> + +<li> +The menuitems are more sensitive to the actual availiable functions (disabled/enabled +and checked).</li> + +<li> +Now, also in the "MIDWAY (large)"-scheme the smoother font-smooth.xbm font +is used by default.</li> + +<li> +The files for the internationalization moved to represent the new standard +locations.</li> +</ul> + +<h4> +Version 0.2.3a (January 15th, 1999)</h4> + +<ul> +<li> +Keyboard-routines changed to be compatible with the KDE 1.1 libraries (compiles +with 1.0 and 1.1).</li> + +<li> +A small bug fixed in kpacman.cpp (CHECK_PTR( menuBar )).</li> +</ul> + +<h4> +Version 0.2.3 (September 12th, 1998)</h4> + +<ul> +<li> +Slowed down the movement of the monsters in the prison, and fixed a bug +that kept the monsters moving slowly after the "harmless"-phase of the +monsters.</li> + +<li> +Added a new font "font-smooth" and smoothed the pixmap "wall.xpm" for the +Zacman-scheme.</li> + +<li> +Enhanced configuration of all timing-parameters using the <a href="kpacman-3.html#s3">configuration +file</a>.</li> + +<li> +Changed Help-function (kapp->getHelpMenu) to reflect the KDE-Standard.</li> + +<li> +Improved the documentation (Many thanks to Andreas Pour).</li> +</ul> + +<h4> +Version 0.2.2 (August 24th, 1998)</h4> + +<ul> +<li> +Localized the sources and added a German translation of the documentation.</li> + +<li> +Fixed bug so pixmaps and bitfonts could located correctly after using the +"Change keys..."-dialog.</li> + +<li> +Changed the location of the files (sources, pixmaps, docs etc.) to reflect +the recommeded structure of kapptemplate v0.1.</li> +</ul> + +<h4> +Version 0.2.1 (August 18th, 1998)</h4> + +<ul> +<li> +Improved the timing (it's not perfect yet), and I hope Andreas Pour will +have more fun testing the next version.</li> + +<li> +Increased flexibility in handling the pixmaps.</li> +</ul> + +<h4> +Version 0.2.0 (August 13th, 1998)</h4> + +<ul> +<li> +Added (preliminary) graphic scheme support.</li> +</ul> + +<h4> +Version 0.1.1 (August 8th, 1998) </h4> + +<ul> +<li> +First public release.</li> +</ul> + +<div align=right><a href="kpacman-2.html">Next</a> <a href="index.html">Previous</a> +<a href="index.html#toc1">Table of Contents</a></div> + +<center> +<hr WIDTH="100%" SIZE=3 ALIGN=CENTER NOSHADE></center> +</td> +</tr> + +<tr> +<td></td> +</tr> +</table> + +</body> +</html> diff --git a/doc/en/kpacman-2.html b/doc/en/kpacman-2.html new file mode 100644 index 0000000..7a1f3ee --- /dev/null +++ b/doc/en/kpacman-2.html @@ -0,0 +1,61 @@ +<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> +<head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> + <meta name="keywords" content="KPacman"> + <meta name="description" content="Documentation for KPacman"> + <title>The KPacman Handbook: Installation</title> +</head> +<body text="#000000" bgcolor="#FFFFFF" link="#8E2727" vlink="#8E2727"> + +<table BORDER=0 CELLSPACING=2 > +<tr> +<td><img SRC="kpacman.gif" ALT="KPacman" BORDER=0 height=32 width=32 align=TEXTTOP></td> + +<td><b><font size=+2>KPacman</font></b> +<br><font size=-1>Version 0.3.2</font></td> +</tr> +</table> + +<hr WIDTH="600" SIZE=2 ALIGN="LEFT" NOSHADE> +<table CELLSPACING=0 CELLPADDING=0 WIDTH="600" > +<tr> +<td> +<div align=right><a href="kpacman-3.html">Next</a> <a href="kpacman-1.html">Previous</a> <a href="index.html#toc1">Table +of Contents</a></div> + +<h3> +<a NAME="s2"></a>2. Installation</h3> + +<h3> +<a NAME="ss2.1"></a>2.1 How to obtain KPacman</h3> +KPacman can be found on <a href="ftp://ftp.kde.org/pub/kde/unstable/apps/games/">ftp://ftp.kde.org/pub/kde/unstable/latest/apps/games/</a>, +the main ftp site of the KDE project. +<h3> +<a NAME="ss2.2"></a>2.2 Requirements</h3> +In order to compile KPacman successfully, you will need the version 1.0 +of the kde libraries or later and version 1.33 of the qt libraries or later. +Look for the version of the libraries appropriate for your system at <a href="ftp://ftp.kde.org/pub/kde/stable/1.0/distribution/">ftp://ftp.kde.org/pub/kde/stable/latest/distribution/</a> +and <a href="ftp://ftp.kde.org/pub/qt">ftp://ftp.kde.org/pub/qt</a>. +<h3> +<a NAME="ss2.3"></a>2.3 Compilation and installation</h3> +In order to compile and install KPacman on your system, type the following +in the base directory of the KPacman distribution: +<blockquote> +<pre><tt>% ./configure && make && make install</tt></pre> +</blockquote> +Since KPacman uses <tt>autoconf</tt> you should have no trouble compiling +it. Should you run into any problems, please report them to the the author +at <a href="mailto:joe@dsite.de">Jörg Thönnissen</a>. +<br> +<div align=right><a href="kpacman-3.html">Next</a> <a href="kpacman-1.html">Previous</a> <a href="index.html#toc1">Table +of Contents</a></div> + +<center> +<hr WIDTH="100%" SIZE=3 ALIGN=CENTER NOSHADE></center> +</td> +</tr> +</table> + +</body> +</html> diff --git a/doc/en/kpacman-3.html b/doc/en/kpacman-3.html new file mode 100644 index 0000000..aa5b6e2 --- /dev/null +++ b/doc/en/kpacman-3.html @@ -0,0 +1,564 @@ +<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> +<head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1"> + <meta name="keywords" content="KPacman"> + <meta name="description" content="Documentation for KPacman"> + <title>The KPacman Handbook: Configuration</title> +</head> +<body text="#000000" bgcolor="#FFFFFF" link="#8E2727" vlink="#8E2727"> + +<table BORDER=0 CELLSPACING=2 > +<tr> +<td><img SRC="kpacman.gif" ALT="KPacman" BORDER=0 align=TEXTTOP></td> + +<td><b><font size=+2>KPacman</font></b> +<br><font size=-1>Version 0.3.2</font></td> +</tr> +</table> + +<hr ALIGN=LEFT NOSHADE WIDTH="600"> +<table WIDTH="600" > +<tr> +<td> +<div align=right><a href="kpacman-4.html">Next</a> <a href="kpacman-2.html">Previous</a> <a href="index.html#toc1">Table of Contents</a></div> + +<h3> +<a NAME="s3"></a>3. Configuration</h3> +At this juncture all of KPacman's parameters cannot be configured graphically. +To change those parameters for an individual user you should edit the user's +KPacman configuration file (this file should be located at <tt>~/.kde/share/config/kpacmanrc</tt>). +Alternatively, you can affect the default configuration of all users by +editing the global KPacman configuration file (this file should be located +at <tt>/opt/kde/share/config/kpacmanrc</tt>). +<h3> +<a NAME="ss3.1"></a>3.1 Timings</h3> +The parameters under the standardgroup heading <tt>[KDE Setup]</tt> listed +in the table below control the timing of the game. Keys ending in +"MS" (e.g., "DyingAnimationMS") have their values expressed in milliseconds, +whereas Keys ending in "Ticks" have their values expressed in cycles. +<p>Some values below are expressed as a comma-separated list of numbers, +each of which corresponds to a different level. Keys which have a default +value of more than one number or of a number followed by a comma may be +set for each level. The first number in a list is used for the demonstration +level, and the following numbers are for the interactive game levels (the +second value is used for level 1, the third for level 2 and so on). The +maximum number of levels is defined by the value of the key "Levels". +<br> +<table BORDER WIDTH="100%" NOSAVE > +<tr> +<td>Key</td> + +<td>Description</td> + +<td>Default Value</td> +</tr> + +<tr> +<td>SpeedMS</td> + +<td>Duration of a single cycle (a "Tick"), in milliseconds. All other timings +in the game are multiples of the single cycle duration. Decreasing +the value speeds up the game and increasing the value slows down the game.</td> + +<td>20,</td> +</tr> + +<tr> +<td>PacmanTicks</td> + +<td>Number of cycles until the next move of the pacman. Increasing +the value makes the pacman move slower and decreasing the value makes the +pacman move faster.</td> + +<td>3,</td> +</tr> + +<tr> +<td>RemTicks</td> + +<td>Number of cycles for a monster to return to prison after being eaten +by the pacman (the R.E.M. -- rapid eye movement -- phase). Increasing +the value increases the time until a eaten monster returns to prison and +decreasing the value decreases the time until a monster returns to prison.</td> + +<td>1,</td> +</tr> + +<tr> +<td>DangerousTicks</td> + +<td>Number of cycles until the next move of the monsters when they are +dangerous and will eat the pacman. Increasing the value makes the +monsters move slower and decreasing the value makes the monsters move faster.</td> + +<td>3,</td> +</tr> + +<tr> +<td>HarmlessTicks</td> + +<td>Number of cycles until the next move of the monsters when they are +harmless and can be eaten by the pacman. Increasing the value makes +the monsters move slower and decreasing the value makes the monsters move +faster.</td> + +<td>7,6,,5,,4,</td> +</tr> + +<tr> +<td>HarmlessDurationTicks</td> + +<td>Number of cycles during which the monsters remain harmless and can +be eaten by the pacman after the pacman eats a switch. Increasing +this value makes the monsters stay harmless longer and decreasing this +value makes the monsters return to being dangerous sooner.</td> + +<td>375,,,300,,250,200,150,</td> +</tr> + +<tr> +<td>HarmlessWarningTicks</td> + +<td>Number of cycles in which the user is warned of the upcoming end of +the harmless-phase by the monsters blinking. This value must be less at +each level than the corresponding "HarmlessDurationTicks". Increasing +this value increases the length of the warning and decreasing this value +shortens the length of the warning.</td> + +<td>135,</td> +</tr> + +<tr> +<td>ArrestTicks</td> + +<td>Number of cycles until the next move of the monsters when they are +in prision.</td> + +<td>6,</td> +</tr> + +<tr> +<td>ArrestDurationTicks</td> + +<td>Number of cycles in which monsters remain in prison after being eaten. +This value will be multiplied by the id of the monster eaten ( 0 for first +monster eaten after the pacman eats a switch, 1 for the second, and so +on), so that the first monster will be freed immediatly and the other monsters +have to wait longer (by way of exception the second monster is also freed +immediatly during the initial stage of the game). Increasing this +value increases the prison time of the monsters, and decreasing this value +frees the monsters sooner.</td> + +<td>200,,,150,</td> +</tr> + +<tr> +<td>FruitAppearsTicks</td> + +<td>Number of cycles between the appearence of fruit. Increasing +this value causes fruit to appear less frequently and decreasing this value +causes fruit to appear more frequently.</td> + +<td>1000,,1500,2000,2500, +<br>3000,3500,4000,</td> +</tr> + +<tr> +<td>FruitDurationTicks</td> + +<td>Number of cyles for which fruit remains. Increasing this value +causes the fruit to be available for consumption longer and decreasing +this value causes the fruit to disappear sooner.</td> + +<td>500,,,400,350,300,,250, +<br>200,150,</td> +</tr> + +<tr> +<td>FruitScoreDurationTicks</td> + +<td>Number of cycles for which the score for eating a fruit is displayed +after a fruit is eaten.</td> + +<td>150,</td> +</tr> + +<tr> +<td>MonsterScoreDurationMS</td> + +<td>Number of milliseconds for which the score for eating a monster is +displayed after a monster is eaten.</td> + +<td>1000</td> +</tr> + +<tr> +<td>PlayerDurationMS</td> + +<td>Number of milliseconds for displaying "PLAYER ONE" at the start of +the game. At the moment only one player is supported.</td> + +<td>3000</td> +</tr> + +<tr> +<td>ReadyDurationMS</td> + +<td>Number of milliseconds for displaying "READY!" at the start of the +game.</td> + +<td>2000</td> +</tr> + +<tr> +<td>GameOverDurationMS</td> + +<td>Number of milliseconds for displaying "GAME OVER" at the end of the +game.</td> + +<td>3000</td> +</tr> + +<tr> +<td>AfterPauseMS</td> + +<td>Number of milliseconds until play is resumed after cancelling a "Pause".</td> + +<td>1000</td> +</tr> + +<tr> +<td>DyingPreAnimationMS</td> + +<td>Number of milliseconds for which the monsters dance after catching +the pacman.</td> + +<td>1000</td> +</tr> + +<tr> +<td>DyingAnimationMS</td> + +<td>Number of milliseconds in which the scenes (other than the first and +last scenes) of the pacman's death are displayed after he is caught by +a monster.</td> + +<td>100</td> +</tr> + +<tr> +<td>DyingPostAnimationMS</td> + +<td>Number of milliseconds in which the first and last scenes of the pacman's +death are displayed after he is caught by a monster (this permits emphasis +of these scenes).</td> + +<td>500</td> +</tr> + +<tr> +<td>IntroAnimationMS</td> + +<td>Number of milliseconds between the scenes of the introduction.</td> + +<td>800</td> +</tr> + +<tr> +<td>IntroPostAnimationMS</td> + +<td>Number of milliseconds between the introduction and the beginning of +the demonstration.</td> + +<td>1000</td> +</tr> + +<tr> +<td>LevelUpPreAnimationMS</td> + +<td>Number of milliseconds between completing a level and the beginning +of the animation for the next level.</td> + +<td>2000</td> +</tr> + +<tr> +<td>LevelUpAnimationMS</td> + +<td>Number of milliseconds for which the animation for changing levels +is displayed.</td> + +<td>2000</td> +</tr> + +<tr> +<td>MonsterIQ</td> + +<td>The intelligence of the monster (currently not fully implemented). +Increasing the value makes the monsters more clever and decreasing the +value makes them dumber.</td> + +<td>0,170,180,170,180, +<br>170,180,</td> +</tr> + +<tr> +<td>Levels</td> + +<td>Number of different levels (without the demonstration). If you +increase this value be sure all the parameters for that level are defined +above!</td> + +<td>13</td> +</tr> + +<tr> +<td>HallOfFameMS</td> + +<td>The hall of fame is displayed this amount of milliseconds.</td> + +<td>7000</td> +</tr> + +<tr> +<td>CursorBlinkMS</td> + +<td>Number of milliseconds the cursor, used for editing your name in the +hall of fame, keeps his states (on or off). The repeating of keystrokes +for scrolling (Key_Up and Key_Down) also depends of this value.</td> + +<td>250</td> +</tr> +</table> + +<p>If there are insufficient values in a list for the number of levels +(including the demonstration level), or if there is an invalid or missing +(e.g., ",,") in the list, then the previous (valid) value is used for that +position. If no valid values are listed, the value will be 0. For +example "HarmlessTicks=7,6,,5,,4" is equivalent to "HarmlessTicks=7,6,6,5,5,4,4,4 +(if Levels=7)". That means 7 cycles for the demonstration, 6 cycles for +level 1 and so on. +<h3> +<a NAME="ss3.2"></a>3.2 Points (Scoring)</h3> +Scoring during the game is controlled by the following key/value-pairs +in the standardgroup <tt>[KDE Setup]</tt> (see the section <a href="#ss3.1">Timings</a> +for information on how to interpret comma-separated values): +<br> +<table BORDER WIDTH="100%" NOSAVE > +<tr NOSAVE> +<td NOSAVE>Key</td> + +<td>Description</td> + +<td>Default</td> +</tr> + +<tr> +<td>PointScore</td> + +<td>Number of points awarded for eating a small point.</td> + +<td>10</td> +</tr> + +<tr> +<td>SwitchScore</td> + +<td>Number of points awarded for eating a switch (the large points that +convert the monsters from hunters to the hunted!)</td> + +<td>50</td> +</tr> + +<tr> +<td>FruitScore</td> + +<td>Number of points awarded for eating a fruit.</td> + +<td>100,300,500,,700,, +<br>1000,,2000,,3000,,5000,</td> +</tr> + +<tr> +<td>MonsterScore</td> + +<td>Number of points awarded for eating a monster, with each point value +in the list being awarded for each successive monster eaten after eating +a switch (the values are reset if a new switch is eaten even if the prior +switch has not expired yet). Since there are four monsters you should include +four values. Using the default values specified at right, 200 points +are awarded for eating the first monster, 400 for the second monster, and +so on.</td> + +<td>200,400,800,1600</td> +</tr> + +<tr> +<td>ExtraLifeScore</td> + +<td>Number of points needed to earn another pacman life. </td> + +<td>10000</td> +</tr> +</table> + +<h3> +<a NAME="ss3.3"></a>3.3 Graphic schemes</h3> +The graphics schemes are controlled by the following two key/value-pairs +of the standardgroup <tt>[KDE Setup]</tt>: +<br> +<table BORDER WIDTH="100%" NOSAVE > +<tr NOSAVE> +<td NOSAVE>Key</td> + +<td>Description</td> + +<td>Example</td> +</tr> + +<tr> +<td>SchemeCount</td> + +<td>Number of defined schemes. For every scheme a separate group with the +name <i>[Scheme n] </i>exists. n stands for a number between 0 and SchemeCount-1.</td> + +<td>3</td> +</tr> + +<tr> +<td>Scheme</td> + +<td>Selected scheme. Possible values are between 0 and SchemeCount-1 (this +value can also be set using the game's menu).</td> + +<td>0</td> +</tr> +</table> + +<p>Each graphic scheme is defined in a seperate scheme-group using the +group designation <tt>[Scheme N]</tt>, where <tt>N</tt> is the number of +the scheme being defined. Each scheme-group may have the following +keys: +<br> +<table BORDER WIDTH="100%" NOSAVE > +<tr> +<td>Key</td> + +<td>Description</td> + +<td>Example</td> +</tr> + +<tr> +<td>Font</td> + +<td>Filename of the xbm-font. Names without an absolute path (a leading +"/" or "~") are relative to <tt>$KDEDIR/share/apps/kpacman/fonts</tt>. +The structure of the fontfile will be explained in one of the next releases, +but you should be able to figure it out by opening one of the fontfiles +included with KPacman using a bitmap-editor.</td> + +<td>font.xbm</td> +</tr> + +<tr> +<td>FontFirstChar</td> + +<td>Defines the numeric value of the first character in the bitfont.</td> + +<td>14</td> +</tr> + +<tr> +<td>FontLastChar</td> + +<td>The last character in the bitfont, is giving here by its numeric code. +If you extent the fonts by adding the lowercase characters, this value +must be changed.</td> + +<td>95</td> +</tr> + +<tr> +<td>PixmapDirectory</td> + +<td>Directory in which the pixmap-files for the figures are located. +Direcotry names without an absolute path (a leading "/" or "~") are relative +to <tt>$KDEDIR/share/apps/kpacman/pics</tt>. The names of the individual +xpm-files are fixed in the code at the moment (this will be changed) and +are ''down.xpm" for an arrow pointing down, "fruit.xpm" for the series +of fruit for the various levels, "lifes.xpm" for the image to display at +the bottom of the screen for each pacman life remaining, "point.xpm" for +the small points which the pacman eats, "switch.xpm" for the switch points, +"dying.xpm" for the sequence of images for a dying pacman, "left.xpm" for +an arrow pointing left, "monster.xpm" for the various monsters, including +their appearance during the "switch" and "warning" cycles, "prison.xpm" +for a series of images put together to draw the prison walls, "up.xpm" +for , "eyes.xpm" for the series of eyes for the monsters when they move +up, down, right and left, respectively, "level.xpm" for the row of fruit +at the bottom of the screen indicating the current level, "pacman.xpm" +for the series of pacman images (gobbling and normal x moving up, down, +left and right), "right.xpm for a right arrow, and "wall.xpm" for a series +of images put together to draw the non-prison walls.</td> + +<td>tiny</td> +</tr> + +<tr> +<td>Description</td> + +<td>The name of the scheme, which will be displayed in the menu "Select +Graphic Scheme". Use the '&'-character in front of a character in the +name to set the accelerator-key to that character (that means pressing +that key when the Select Graphic Scheme menu is down will select that scheme). +You may add a location tag to the key (e.g., Description[de] to indicate +that the description is in German).</td> + +<td>MIDWAY MFG.CO. (&tiny)</td> +</tr> +</table> + +<h3> +<a NAME="ss3.4"></a>3.4 Miscellaneous</h3> + +<table BORDER WIDTH="100%" NOSAVE > +<tr> +<td>Key</td> + +<td>Description</td> + +<td>Example</td> +</tr> + +<tr> +<td>LevelPosition</td> + +<td>Defines the position of the levelsymbols (fruits) on the statusline. +It is possible to show to different levels on the same position to save +room. The first position (rightmost) has the value 0.</td> + +<td>0,1,2,3,,4,,5,,6,7,</td> +</tr> + +<tr> +<td>HighscoreFilePath</td> + +<td>Specifies the path (directory and filename) to the "highscore"-file. +If only a directory (".../") is given, the default-filename ("highscore") +will be used.</td> + +<td>/tmp/kpacman.highscore</td> +</tr> + +</table> + +<br> +<div align=right><a href="kpacman-4.html">Next</a> <a href="kpacman-2.html">Previous</a> <a href="index.html#toc1">Table of Contents</a> +<hr ALIGN=LEFT NOSHADE WIDTH="100%"></div> +</td> +</tr> +</table> + +</body> +</html> diff --git a/doc/en/kpacman-4.html b/doc/en/kpacman-4.html new file mode 100644 index 0000000..3803f53 --- /dev/null +++ b/doc/en/kpacman-4.html @@ -0,0 +1,55 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<HTML> +<HEAD> + <META HTTP-EQUIV="content-type" CONTENT="text/html; charset=iso-8859-1"> + <META NAME="keywords" CONTENT="KPacman"> + <META NAME="description" CONTENT="Documentation for KPacman"> + <TITLE>The KPacman Handbook: Copyright</TITLE> +</HEAD> +<BODY TEXT="#000000" BGCOLOR="#FFFFFF" LINK="#8E2727" VLINK="#8E2727"> + +<TABLE BORDER=0 CELLSPACING=2 > +<TR> +<TD><IMG SRC="kpacman.gif" ALT="KPacman" BORDER=0 HEIGHT=32 WIDTH=32 ALIGN=TEXTTOP></TD> + +<TD><B><FONT SIZE=+2>KPacman</FONT></B> +<BR><FONT SIZE=-1>Version 0.3.2</FONT></TD> +</TR> +</TABLE> + +<HR ALIGN=LEFT NOSHADE WIDTH="600"> +<TABLE WIDTH="600" > +<TR> +<TD> +<DIV ALIGN=right>Next <A HREF="kpacman-3.html">Previous</A> <A HREF="index.html#toc1">Table of Contents</A></DIV> + +<H3> +<A NAME="s1"></A>4. Copyright</H3> +KPacman Copyright (c) 1998-2003 Jörg Thönnissen, <A HREF="mailto:joe@dsite.de"><joe@dsite.de></A> +<P>This program (including this documentation) is free software; you can +redistribute it and/or modify it under the terms of the GNU General Public +License as published by the Free Software Foundation; either version 2 +of the License, or (at your option) any later version. +<P>This program is disttributed in the hope that it will be useful, but +<I>without +any warranty</I>; without even the implied warranty of <I>merchantability</I> +or <I>fitness for a particular purpose</I>. See the GNU General Public +License for more details. +<P>You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +675 Mass Ave, Cabridge, MA 02139, USA. +<BR> +<DIV ALIGN=right>Next <A HREF="kpacman-3.html">Previous</A> <A HREF="index.html#toc1">Table of Contents</A></DIV> + +<CENTER> +<HR ALIGN=LEFT NOSHADE WIDTH="100%"></CENTER> +</TD> +</TR> + +<TR> +<TD></TD> +</TR> +</TABLE> + +</BODY> +</HTML> diff --git a/doc/en/kpacman.gif b/doc/en/kpacman.gif Binary files differnew file mode 100644 index 0000000..4fa3926 --- /dev/null +++ b/doc/en/kpacman.gif |
