You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
371 lines
11 KiB
371 lines
11 KiB
<?xml version="1.0" ?> |
|
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [ |
|
<!ENTITY tdepacman '<application>TDEpacman</application>'> |
|
<!ENTITY kapp "&tdepacman;"><!-- replace tdepacman 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 TDE DocBook team. |
|
|
|
You may freely use this template for writing any sort of TDE 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 TDEpacman 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> |
|
&tdepacman; 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 TDE, the TDE package it is in, the name |
|
of your application, and a few relevant keywords. --> |
|
|
|
<keywordset> |
|
<keyword>TDE</keyword> |
|
<keyword>tdeutils</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 TDE 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 classic arcade game from the 80s in which you have |
|
to finish the tables by eating all the pac-gums (dots) to score as many points |
|
as possible. |
|
</para> |
|
<para>Eat the dots and escape the ghosts with our hero. |
|
You can eat the big spot when needed and eat the ghosts when the color changes. |
|
</para> |
|
</chapter> |
|
|
|
<chapter id="using-kapp"> |
|
<title>Using TDEpacman</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>Use the arrows from the keyboard to move &kapp;.</para> |
|
<para>Here is a screenshot of the game.</para> |
|
<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> |
|
<textobject> |
|
<phrase>Screenshot</phrase> |
|
</textobject> |
|
</mediaobject> |
|
</screenshot> |
|
</para> |
|
|
|
</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 TDEpacman 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 TDEpacman</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> |
|
Doc to make plugins has yet to be written... |
|
</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>Please Check out the <link linkend="commands">Commands |
|
Section</link> for the answer.</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 TDE |
|
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>Kontqui the TDE 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-tdepacman"> |
|
<title>How to obtain TDEpacman</title> |
|
|
|
<para> |
|
&tdepacman; is part of the TDE project |
|
<ulink url="https://mirror.git.trinitydesktop.org/gitea/TDE/tdepacman.git">https://mirror.git.trinitydesktop.org/gitea/TDE/tdepacman</ulink>. |
|
</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 tdesupport, |
|
tdelibs, or tdebase. |
|
.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 build &kapp;, the tdelibs and libtdegames libraries from the TDE project are required. |
|
</para> |
|
|
|
<para> |
|
All required libraries as well as &kapp; itself can be found |
|
on <ulink url="https://mirror.git.trinitydesktop.org/gitea/explore/repos">The TDE's home dev 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 (not currently updated) at <ulink |
|
url="https://mirror.git.trinitydesktop.org/gitea/TDE/tdepacman/src/branch/master/ChangeLog">Changelog</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 &kapp; sources: |
|
<screen width="40"> |
|
<prompt>%</prompt> <userinput>mkdir -p build</userinput> |
|
<prompt>%</prompt> <userinput>cd build</userinput> |
|
<prompt>%</prompt> <userinput>cmake ../</userinput> |
|
<prompt>%</prompt> <userinput>make V=1</userinput> |
|
<prompt>#</prompt> <userinput>make install</userinput> |
|
</screen> |
|
</para> |
|
|
|
<para>Since &kapp; uses Cmake, you should have not trouble compiling it.</para> |
|
<para> Please have a look on the 'install' file for more options.</para> |
|
|
|
</sect1> |
|
|
|
</appendix> |
|
|
|
&documentation.index; |
|
</book>
|
|
|