aboutsummaryrefslogtreecommitdiffstats
path: root/kde2
diff options
context:
space:
mode:
authorFritz Elfert <felfert@to.com>2001-04-09 02:20:26 +0000
committerFritz Elfert <felfert@to.com>2001-04-09 02:20:26 +0000
commit6be651d3cb7f55a52968fac9b0b5c7dadf40bae9 (patch)
tree34b895a5d6117d09d31f01c832fd525fc0756537 /kde2
parent67ed71600b2f53808a76f710e090b5dca770ff85 (diff)
downloadplptools-6be651d3cb7f55a52968fac9b0b5c7dadf40bae9.tar.gz
plptools-6be651d3cb7f55a52968fac9b0b5c7dadf40bae9.tar.bz2
plptools-6be651d3cb7f55a52968fac9b0b5c7dadf40bae9.zip
Starting doc.
Diffstat (limited to 'kde2')
-rw-r--r--kde2/doc/en/Makefile.am2
-rw-r--r--kde2/doc/en/firstwizard-1.pngbin0 -> 5051 bytes
-rw-r--r--kde2/doc/en/firstwizard-2.pngbin0 -> 5281 bytes
-rw-r--r--kde2/doc/en/firstwizard-3.pngbin0 -> 6596 bytes
-rw-r--r--kde2/doc/en/index.docbook.in106
-rw-r--r--kde2/doc/en/newpsionwizard-1.pngbin0 -> 3412 bytes
-rw-r--r--kde2/doc/en/newpsionwizard-2.pngbin0 -> 3652 bytes
-rw-r--r--kde2/doc/en/restore-initial.pngbin0 -> 7770 bytes
-rw-r--r--kde2/doc/en/restore-treeopen.pngbin0 -> 6820 bytes
-rw-r--r--kde2/doc/en/settings-backup.pngbin0 -> 4809 bytes
-rw-r--r--kde2/doc/en/settings-connection.pngbin0 -> 3846 bytes
-rw-r--r--kde2/doc/en/settings-machines.pngbin0 -> 4017 bytes
-rw-r--r--kde2/doc/en/toplevel.pngbin0 -> 4388 bytes
13 files changed, 106 insertions, 2 deletions
diff --git a/kde2/doc/en/Makefile.am b/kde2/doc/en/Makefile.am
index 14e83a9..912dd33 100644
--- a/kde2/doc/en/Makefile.am
+++ b/kde2/doc/en/Makefile.am
@@ -3,4 +3,4 @@ KDE_LANG = en
KDE_DOCS = kpsion
index.docbook: index.docbook.in
- cat index.docbook.in | perl -e 'while (<>) { if (/\$$Date:\s+(\S*)/) { $$d=$$1; } s/__DATE__/$$d/; s/__VERSION__/$(VERSION)/; print; }' > index.docbook
+ cat index.docbook.in | perl -e 'while (<>) { if (/\$$Date:\s+(.*)\s+\$$/) { $$d=$$1; } s/__DATE__/$$d/; s/__VERSION__/$(VERSION)/; print; }' > index.docbook
diff --git a/kde2/doc/en/firstwizard-1.png b/kde2/doc/en/firstwizard-1.png
new file mode 100644
index 0000000..8c86d9b
--- /dev/null
+++ b/kde2/doc/en/firstwizard-1.png
Binary files differ
diff --git a/kde2/doc/en/firstwizard-2.png b/kde2/doc/en/firstwizard-2.png
new file mode 100644
index 0000000..f8fc9e4
--- /dev/null
+++ b/kde2/doc/en/firstwizard-2.png
Binary files differ
diff --git a/kde2/doc/en/firstwizard-3.png b/kde2/doc/en/firstwizard-3.png
new file mode 100644
index 0000000..05ce404
--- /dev/null
+++ b/kde2/doc/en/firstwizard-3.png
Binary files differ
diff --git a/kde2/doc/en/index.docbook.in b/kde2/doc/en/index.docbook.in
index 6b4d4ce..d16a145 100644
--- a/kde2/doc/en/index.docbook.in
+++ b/kde2/doc/en/index.docbook.in
@@ -186,7 +186,92 @@ This option starts format of the specified <replaceable>DRIVE</replaceable>.
<chapter id="Configuration">
<title>Configuration</title>
-<para>TBD</para>
+<sect1 id="firsttime">
+<title>First time startup</title>
+
+<para>
+When you start &kpsion; the first time, a wizard dialog is shown which lets
+you easily configure the application for your personal use. The initial setup
+is divided into three steps:
+</para>
+
+<sect2>
+<title>Select a backup directory</title>
+<para>
+<screenshot>
+<screeninfo>Step one. Select a backup directory.</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="firstwizard-1.png" format="PNG">
+ </imageobject>
+ <textobject>
+ <phrase>Selecting the backup directory</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+The backup directory will be used by &kpsion; for storing backup archives.
+You simply can accept the default proposed by this dialog if you don't have
+to care about disk space used in your home directory. Otherwise, select a
+directory of your choice by clicking on the Browse button. &kpsion; creates
+a that directory if it does not yet exist. Of course, you need the permission
+to do so.
+</para>
+</sect2>
+
+<sect2>
+<title>Adjust the backup strategy</title>
+<para>
+<screenshot>
+<screeninfo>Step two. backup strategy.</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="firstwizard-2.png" format="PNG">
+ </imageobject>
+ <textobject>
+ <phrase>Setting the backup strategy</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+In the second step, you can adjust the backup strategy. For both, incremental
+and full backups, you can select an interval. If any of these intervals is
+enabled, &kpsion; will create a <filename>.desktop</filename> Entry in your
+KDE Autostart folder. Every time KDE is started, this will start &kpsion;
+in autobackup mode. If the interval is expired and your Psion is currently
+connected, an unattended backup will be performed.
+</para>
+<para>
+The third adjustment to be made is the number of backup generations to keep.
+A backup generation consists of a full backup plus eventually made incremental
+backups. If a backup is completed sucessfully, &kpsion; will check, if there
+are more backup generations available and delete older backup generations.
+</para>
+</sect2>
+
+<sect2>
+<title>Connection parameters</title>
+<para>
+<screenshot>
+<screeninfo>Step three. connection parameters.</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="firstwizard-3.png" format="PNG">
+ </imageobject>
+ <textobject>
+ <phrase>Setting connection parameters</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+In the third step, you can adjust the behavior of &kpsion; during initial
+connect. If you set the connection retry interval to a non-zero value, &kpsion;
+will retry a connection attempt if it had failed. Since &kpsion; needs the
+ncpd daemon running, it is also possible to start this daemon on the fly if it
+is not running. For this, you need to have permissions to use the specified
+port.
+</para>
+</sect2>
+
+</sect1>
+
</chapter>
<chapter id="Internals">
@@ -195,6 +280,25 @@ This option starts format of the specified <replaceable>DRIVE</replaceable>.
<para>TBD</para>
</chapter>
+<chapter id="faq">
+<title>Questions and Answers</title>
+&reporting.bugs;
+&updating.documentation;
+
+<qandaset id="faqlist">
+<qandaentry>
+<question>
+<para>I have a Psion Series 3 and &kpsion; doesn't work.</para>
+</question>
+<answer>
+<para>This is currently a known problem with the plptools lib. You have to
+wait until tis is fixed. Sorry.
+</para>
+</answer>
+</qandaentry>
+</qandaset>
+</chapter>
+
<chapter id="Author">
<title>Author</title>
diff --git a/kde2/doc/en/newpsionwizard-1.png b/kde2/doc/en/newpsionwizard-1.png
new file mode 100644
index 0000000..334b2a3
--- /dev/null
+++ b/kde2/doc/en/newpsionwizard-1.png
Binary files differ
diff --git a/kde2/doc/en/newpsionwizard-2.png b/kde2/doc/en/newpsionwizard-2.png
new file mode 100644
index 0000000..e98a6a1
--- /dev/null
+++ b/kde2/doc/en/newpsionwizard-2.png
Binary files differ
diff --git a/kde2/doc/en/restore-initial.png b/kde2/doc/en/restore-initial.png
new file mode 100644
index 0000000..e26193b
--- /dev/null
+++ b/kde2/doc/en/restore-initial.png
Binary files differ
diff --git a/kde2/doc/en/restore-treeopen.png b/kde2/doc/en/restore-treeopen.png
new file mode 100644
index 0000000..a5a4d0d
--- /dev/null
+++ b/kde2/doc/en/restore-treeopen.png
Binary files differ
diff --git a/kde2/doc/en/settings-backup.png b/kde2/doc/en/settings-backup.png
new file mode 100644
index 0000000..97827c4
--- /dev/null
+++ b/kde2/doc/en/settings-backup.png
Binary files differ
diff --git a/kde2/doc/en/settings-connection.png b/kde2/doc/en/settings-connection.png
new file mode 100644
index 0000000..c5852c2
--- /dev/null
+++ b/kde2/doc/en/settings-connection.png
Binary files differ
diff --git a/kde2/doc/en/settings-machines.png b/kde2/doc/en/settings-machines.png
new file mode 100644
index 0000000..1d4ded2
--- /dev/null
+++ b/kde2/doc/en/settings-machines.png
Binary files differ
diff --git a/kde2/doc/en/toplevel.png b/kde2/doc/en/toplevel.png
new file mode 100644
index 0000000..743722e
--- /dev/null
+++ b/kde2/doc/en/toplevel.png
Binary files differ