summaryrefslogtreecommitdiff
path: root/docs
authorharlekin <harlekin>2003-08-09 14:40:52 (UTC)
committer harlekin <harlekin>2003-08-09 14:40:52 (UTC)
commitc893a4f0a279a0a4e35d6376a21929245290605f (patch) (unidiff)
tree3f319bc5129b5fedba4ae3e7d3ca4a8f35d984c6 /docs
parentc6d96c514c58b288ac0bc8f844db35123bcaf2ad (diff)
downloadopie-c893a4f0a279a0a4e35d6376a21929245290605f.zip
opie-c893a4f0a279a0a4e35d6376a21929245290605f.tar.gz
opie-c893a4f0a279a0a4e35d6376a21929245290605f.tar.bz2
updated to usermanual by Clement Seveillac <clement@nist.gov>, changelog on http://handhelds.org/hypermail/opie/current/7412.html
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/gettingaround.sgm8
-rw-r--r--docs/usermanual/installation.sgm112
-rw-r--r--docs/usermanual/upgrading.sgm14
-rw-r--r--docs/usermanual/usermanual.sgm214
-rw-r--r--docs/usermanual/whatisopie.sgm15
5 files changed, 169 insertions, 194 deletions
diff --git a/docs/usermanual/gettingaround.sgm b/docs/usermanual/gettingaround.sgm
index 34ef403..68210de 100644
--- a/docs/usermanual/gettingaround.sgm
+++ b/docs/usermanual/gettingaround.sgm
@@ -5,37 +5,35 @@
5If everything was installed as described in the previous section, &opie; should 5If everything was installed as described in the previous section, &opie; should
6now start up and present a screen to calibrate the touchscreen. Using the stylus, 6now start up and present a screen to calibrate the touchscreen. Using the stylus,
7press firmly in the middle of the cross-hairs as they appear on the screen. This 7press firmly in the middle of the cross-hairs as they appear on the screen. This
8usually needs to be done only once, however the screen can be re-calibrated at any 8usually needs to be done only once, however the screen can be re-calibrated at any
9time, if needed, by choosing the Calibrate application on the Settings tab. 9time, if needed, by choosing the Calibrate application on the Settings tab.
10</para> 10</para>
11 11
12<para> 12<para>
13Once the screen has been calibrated, &opie; will now start up. If the opie-login 13Once the screen has been calibrated, &opie; will now start up. If the opie-login
14package is installed (which is installed with the default installation), a screen 14package is installed (which is installed with the default installation), a screen
15will appear requiring a person to log in before any applications can be accessed. 15will appear requiring a person to log in before any applications can be accessed.
16The standard &opie; installation currently requires the user to log in as the 16The standard &opie; installation currently requires the user to log in as the
17'root' user in order for all functions to work correctly. Refer to the Familiar 17'root' user in order for all functions to work correctly. Refer to the <ulink url="http://familiar.handhelds.org/#faqs">Familiar
18website (http://familiar.handhelds.org) for the default password for the version 18FAQ</ulink> for the default password for the version installed.
19installed.
20</para> 19</para>
21 20
22<para> 21<para>
23Once the correct password has been entered, &opie; should now be running. When 22Once the correct password has been entered, &opie; should now be running. When
24rebooted however, &opie; will start automatically. To install and remove 23rebooted however, &opie; will start automatically. To install and remove
25applications, the "Packages" application (located on the Settings tab) or the 24applications, the "Packages" application (located on the Settings tab) or the
26command line ipkg application can be used. There are several task-opie packages 25command line ipkg application can be used. There are several task-opie packages
27which allow the installation of whole categories (e.g. games, PIM, settings, etc.) 26which allow the installation of whole categories (e.g. games, PIM, settings, etc.)
28of software at once. It also might be helpful to install either opie-embeddedkonsole 27of software at once.
29or opie-console first to allow access a command line from within &opie;.
30</para> 28</para>
31</section> 29</section>
32 30
33<section><title>Getting Around</title> 31<section><title>Getting Around</title>
34<para> 32<para>
35Now that &opie; is installed and running, it is time to start using it. When &opie; 33Now that &opie; is installed and running, it is time to start using it. When &opie;
36is started (after logging in), the following will be visible: the "Launcher" from 34is started (after logging in), the following will be visible: the "Launcher" from
37which all of the applications can be started, and the "Taskbar" along the bottom, where 35which all of the applications can be started, and the "Taskbar" along the bottom, where
38all running applications can be accessed, select an input method, and interact with the 36all running applications can be accessed, select an input method, and interact with the
39installed applets. 37installed applets.
40</para> 38</para>
41 39
diff --git a/docs/usermanual/installation.sgm b/docs/usermanual/installation.sgm
index ce1d07b..d636c3c 100644
--- a/docs/usermanual/installation.sgm
+++ b/docs/usermanual/installation.sgm
@@ -1,80 +1,44 @@
1<chapter><title>Installation</title> 1<chapter id="installation">
2<section><title>&ipaq;</title> 2 <title id="tinstallation">Installation</title>
3<para> 3 <section>
4To install &opie; on an &ipaq;, a recent Familiar installation will be needed. Go to 4 <title>&ipaq;</title>
5the Familiar project homepage (http://familiar.handhelds.org) to download the latest 5 <para>To have &opie; 1.0 on an &ipaq;, you have to install a Familiar + &opie; <emphasis>image</emphasis> on your &ipaq;. An <emphasis>image</emphasis> is in fact a file, containing the memory image of an &ipaq; with Familiar (the linux distribution) and &opie; (the graphical platform) installed. You can download it from the Internet, then load it in your &ipaq; through a Compact Flash card, serial port or USB.</para>
6version of the "bootstrap" image (do not install the bootstrap-opie or bootstrap-gpe
7images). Follow the instructions on the Familiar website to install the image. Do not
8install the task-complete or task-x packages as they are not needed to run &opie; and
9will unnecessarily occupy space on the &ipaq;.
10</para>
11 6
12<para> 7 <itemizedlist>
13A network connection needs to be configured on the &ipaq; in order to download the 8 <listitem><para>To start with, go to the <ulink url="http://familiar.handhelds.org/familiar/releases/v0.7.1/install/download.html">Familiar download page</ulink>.</para></listitem>
14&opie; packages from the feed. The Familiar site provides instructions for connecting 9 <listitem><para>Put the model of you &ipaq; under <quote>Please select your hardware</quote>, choose <parameter>testing, v0.7.1</parameter> as the Familiar version, and <parameter>Opie</parameter> as the set of files, and press <parameter>Download</parameter>.</para></listitem>
15to the Internet in a variety of ways. 10 <listitem><para>Follow the <ulink url="http://familiar.handhelds.org/familiar/releases/v0.7/install/download.html">Familiar installation instructions</ulink> then, to know how to upload this image file on your &ipaq;.</para></listitem>
16</para> 11 </itemizedlist>
17 12
18<para> 13 <para>Configuring a network connection for the &ipaq; is then very useful, in order to install new packages, or upgrade existing ones (to get new features or bugfixes, for example). The Familiar site provides instructions for connecting the &ipaq; to the Internet in a variety of ways. See <ulink url="http://www.handhelds.org/z/wiki/How%20to%20setup%20networking%20between%20a%20desktop%20PC%20and%20an%20&ipaq;%20using%20the%20serial%20or%20USB%20cables">this &ipaq; networking tutorial</ulink> to have information on configuring PPP or USB, and masquerading (giving access to the Internet through your PC), for example. Setting up masquerading is even simpler on Windows, if you can adapt <ulink url="http://www.pocketpcpassion.com/General/LawrenceBates/connectwin2000.htm">this kind of tutorial for Windows</ulink>.</para>
19&opie; requires the libpng3 package to be installed. Prior to installing &opie;, ensure
20that this package is installed. It is available in the Familiar feed and can be installed
21by running this command:
22<informalexample>
23<literallayout>
24 ipkg install libpng3
25</literallayout>
26</informalexample>
27</para>
28 14
29<note> 15 <para>When your &ipaq; is connected to Internet, you can and should do several things, in command line, using Familiar, as noted in the <ulink url="http://familiar.handhelds.org/familiar/releases/v0.7/install/post-install.html">Familiar post-install</ulink> page, or using Opie applications.</para>
30<para> 16 <itemizedlist>
31If you had QPE/QTopia installed previously, <emphasis>completely</emphasis> remove 17 <listitem><para>For example you can synchronize the &ipaq; clock with network time servers. There is a graphical way to do that through the <parameter>Settings</parameter> / <parameter>Date/Time</parameter> Opie application, or you can also run as root the following command:
32it, and then remove the source line for that feed from your /etc/ipkg.conf file before 18 <screen>
33attempting to install &opie;. 19 <userinput>ntpdate -b time.handhelds.org</userinput>
34</para> 20 </screen>
35</note> 21 </para></listitem>
36<para> 22 <listitem><para>To teach to your &ipaq; what are the new packages or updated packages it can dowload, run the command (as root again):
37Once you have Familiar installed (including libpng3), and the network connection 23 <screen>
38between the &ipaq; and the outside world, run the following command: 24 <userinput>ipkg update</userinput>
39<informalexample> 25 </screen>
40<literallayout> 26 Or use the <parameter>Settings</parameter> / <parameter>Packages</parameter> Opie graphical application.
41 echo src opie "http://opie.handhelds.org/feed/ipaq/unstable/" \ 27 </para></listitem>
42 >> /etc/ipkg.conf 28 <listitem><para>To download and install automatically new versions, if they exist, of your installed packages,
43</literallayout> 29 <screen>
44</informalexample> 30 <userinput>ipkg upgrade</userinput>
45then, run: 31 </screen>
46<informalexample> 32 Or use the <parameter>Package</parameter> Opie application again.
47<literallayout> 33 </para></listitem>
48 ipkg update && ipkg install task-opie 34 </itemizedlist>
49</literallayout> 35 </section>
50</informalexample>
51If you have a 3100 or 3800 series &ipaq;, run:
52<informalexample>
53<literallayout>
54 ipkg install libqt2-emb-fonts
55</literallayout>
56</informalexample>
57finally, start &opie; with:
58<informalexample>
59<literallayout>
60 /etc/init.d/opie start
61</literallayout>
62</informalexample>
63</para>
64</section>
65 36
66<section><title>&zaurus;</title> 37 <section>
67<para> 38 <title>Zaurus</title>
68&opie; applications will install and run on the default &zaurus; ROM with no problems, 39 <para>&opie; applications will install and run on the default &zaurus; ROM (Linux-based distribution, as well as Familiar) with no problems,except for Launcher. It is not compatible with the default ROM, and should not be installed. You should be able to find the fine &opie; packages for you &zaurus; default ROM at this feed address: <ulink url="http://opie.handhelds.org/feed/sharprom/">http://opie.handhelds.org/feed/sharprom/</ulink>.</para>
69except for Launcher. It is not compatible with the default ROM, and should not be 40
70installed. 41 <para>Another option is to replace the default &zaurus; ROM with the OpenZaurus ROM image. OpenZaurus is a openly developed Linux distribution designed to run on the &zaurus;, and uses &opie; as its default user interface. For more information and installation instructions, please visit <ulink url="http://www.openzaurus.org/">OpenZaurus.org web site</ulink>. Notice you will access the Opie 1.0 feeds at the address <ulink url="http://opie.handhelds.org/feed/openzaurus/">http://opie.handhelds.org/feed/openzaurus/</ulink>.</para>
71</para> 42 </section>
72 43
73<para>
74Another option is to replace the default &zaurus; ROM with the OpenZaurus
75ROM image. OpenZaurus is a openly developed Linux distribution designed to run on the
76&zaurus;, and uses &opie; as its default user interface. For more information and
77installation instructions, please visit their site, http://www.openzaurus.org/.
78</para>
79</section>
80</chapter> 44</chapter>
diff --git a/docs/usermanual/upgrading.sgm b/docs/usermanual/upgrading.sgm
index 787d4dd..a0667ab 100644
--- a/docs/usermanual/upgrading.sgm
+++ b/docs/usermanual/upgrading.sgm
@@ -1,22 +1,12 @@
1<chapter><title>Upgrading</title> 1<chapter><title>Upgrading</title>
2<para> 2<para>
3First, you should shutdown &opie; from the "Shutdown" app in the Settings tab. 3First, you should shutdown &opie; from the "Shutdown" app in the Settings tab.
4Normally, simply running 4Normally, simply running
5<informalexample> 5<informalexample>
6<literallayout> 6<literallayout>
7 ipkg update && ipkg upgrade 7 ipkg update && ipkg upgrade
8</literallayout> 8</literallayout>
9</informalexample> 9</informalexample>
10will upgrade &opie;. However, if you currently have a version with the 1.5.0 10will upgrade &opie;.
11version number, you will have to upgrade it differently, because &opie; now uses a
12different version number (the 1.5.0 was Qtopia's version number, we now use our
13own). To upgrade from one of these older versions, run:
14<informalexample>
15<literallayout>
16 ipkg update
17 ipkg install opie-update
18</literallayout>
19</informalexample>
20&opie; should then be upgraded.
21</para> 11</para>
22</chapter> \ No newline at end of file 12</chapter>
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index 7c457d7..fb4669f 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,103 +1,117 @@
1<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [ 1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.2//EN"
2<!ENTITY arrow "-->"> 2[
3<!ENTITY whatis SYSTEM "whatisopie.sgm"> 3 <!ENTITY arrow "-->">
4<!ENTITY installation SYSTEM "installation.sgm"> 4 <!ENTITY whatis SYSTEM "whatisopie.sgm">
5<!ENTITY gettingaround SYSTEM "gettingaround.sgm"> 5 <!ENTITY installation SYSTEM "installation.sgm">
6<!ENTITY upgrading SYSTEM "upgrading.sgm"> 6 <!ENTITY gettingaround SYSTEM "gettingaround.sgm">
7<!ENTITY contacts SYSTEM "contacts.sgm"> 7 <!ENTITY upgrading SYSTEM "upgrading.sgm">
8<!ENTITY calendar SYSTEM "calendar.sgm"> 8 <!ENTITY contacts SYSTEM "contacts.sgm">
9<!ENTITY todo SYSTEM "todo.sgm"> 9 <!ENTITY calendar SYSTEM "calendar.sgm">
10<!ENTITY filemanager SYSTEM "filemanager.sgm"> 10 <!ENTITY todo SYSTEM "todo.sgm">
11<!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm"> 11 <!ENTITY filemanager SYSTEM "filemanager.sgm">
12<!ENTITY software SYSTEM "software.sgm"> 12 <!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm">
13<!ENTITY today SYSTEM "today.sgm"> 13 <!ENTITY software SYSTEM "software.sgm">
14<!ENTITY irda SYSTEM "irda.sgm"> 14 <!ENTITY today SYSTEM "today.sgm">
15<!ENTITY keypebble SYSTEM "keypebble.sgm"> 15 <!ENTITY irda SYSTEM "irda.sgm">
16<!ENTITY i18n SYSTEM "i18n.sgm"> 16 <!ENTITY keypebble SYSTEM "keypebble.sgm">
17<!ENTITY kjumpx SYSTEM "kjumpx.sgm"> 17 <!ENTITY i18n SYSTEM "i18n.sgm">
18<!ENTITY handwriting SYSTEM "handwriting.sgm"> 18 <!ENTITY kjumpx SYSTEM "kjumpx.sgm">
19<!ENTITY multikey SYSTEM "multikey.sgm"> 19 <!ENTITY handwriting SYSTEM "handwriting.sgm">
20<!ENTITY pickboard SYSTEM "pickboard.sgm"> 20 <!ENTITY multikey SYSTEM "multikey.sgm">
21<!ENTITY calibrate SYSTEM "calibrate.sgm"> 21 <!ENTITY pickboard SYSTEM "pickboard.sgm">
22<!ENTITY helpbrowser SYSTEM "helpbrowser.sgm"> 22 <!ENTITY calibrate SYSTEM "calibrate.sgm">
23<!ENTITY login SYSTEM "login.sgm"> 23 <!ENTITY helpbrowser SYSTEM "helpbrowser.sgm">
24<!ENTITY citytime SYSTEM "citytime.sgm"> 24 <!ENTITY login SYSTEM "login.sgm">
25<!ENTITY textedit SYSTEM "textedit.sgm"> 25 <!ENTITY citytime SYSTEM "citytime.sgm">
26<!ENTITY lightpower SYSTEM "lightpower.sgm"> 26 <!ENTITY textedit SYSTEM "textedit.sgm">
27<!ENTITY reader SYSTEM "reader.sgm"> 27 <!ENTITY lightpower SYSTEM "lightpower.sgm">
28<!ENTITY sheet SYSTEM "sheet.sgm"> 28 <!ENTITY reader SYSTEM "reader.sgm">
29<!ENTITY write SYSTEM "write.sgm"> 29 <!ENTITY sheet SYSTEM "sheet.sgm">
30<!ENTITY sysinfo SYSTEM "sysinfo.sgm"> 30 <!ENTITY write SYSTEM "write.sgm">
31<!ENTITY tableviewer SYSTEM "tableviewer.sgm"> 31 <!ENTITY sysinfo SYSTEM "sysinfo.sgm">
32<!ENTITY rotation SYSTEM "rotation.sgm"> 32 <!ENTITY tableviewer SYSTEM "tableviewer.sgm">
33<!ENTITY appearance2 SYSTEM "appearance2.sgm"> 33 <!ENTITY rotation SYSTEM "rotation.sgm">
34<!ENTITY language SYSTEM "language.sgm"> 34 <!ENTITY appearance2 SYSTEM "appearance2.sgm">
35<!ENTITY sshkeys SYSTEM "sshkeys.sgm"> 35 <!ENTITY language SYSTEM "language.sgm">
36<!ENTITY appskey SYSTEM "appskey.sgm"> 36 <!ENTITY sshkeys SYSTEM "sshkeys.sgm">
37<!ENTITY drawpad SYSTEM "drawpad.sgm"> 37 <!ENTITY appskey SYSTEM "appskey.sgm">
38<!ENTITY qpdf SYSTEM "qpdf.sgm"> 38 <!ENTITY drawpad SYSTEM "drawpad.sgm">
39<!ENTITY player2 SYSTEM "player2.sgm"> 39 <!ENTITY qpdf SYSTEM "qpdf.sgm">
40<!ENTITY showimg SYSTEM "showimg.sgm"> 40 <!ENTITY player2 SYSTEM "player2.sgm">
41 <!ENTITY showimg SYSTEM "showimg.sgm">
42 <!ENTITY preface SYSTEM "preface.sgm">
41 43
42<!--Now the real entities--> 44 <!--Now the real entities-->
43<!ENTITY opie "OPIE"> 45 <!ENTITY opie "Opie">
44<!ENTITY todayapp "Today"> 46 <!ENTITY todayapp "Today">
45<!ENTITY qt "Qt"> 47 <!ENTITY qt "Qt">
46<!ENTITY ipaq "iPAQ"> 48 <!ENTITY ipaq "iPAQ">
47<!ENTITY zaurus "Zaurus"> 49 <!ENTITY zaurus "Zaurus">
48]> 50]>
49<book><title>&opie; User Manual</title> 51<book>
50<bookinfo><authorgroup><collab> 52 <title>&opie; User Manual</title>
51<collabname>The &opie; Team</collabname> 53 <bookinfo>
52</collab></authorgroup></bookinfo> 54 <authorgroup>
53<part><title>Getting Started</title> 55 <collab>
54&whatis; 56 <collabname>The &opie; Team</collabname>
55&installation; 57 </collab>
56&gettingaround; 58 </authorgroup>
57&upgrading; 59 </bookinfo>
58</part> 60 &preface;
59<part><title>Applications</title> 61 <part>
60&contacts; 62 <title>Getting Started</title>
61&calendar; 63 &whatis;
62&todo; 64 &installation;
63&today; 65 &gettingaround;
64&filemanager; 66 &upgrading;
65&embeddedkonsole; 67 </part>
66&keypebble; 68 <part>
67&helpbrowser; 69 <title>Applications</title>
68&login; 70 &contacts;
69&citytime; 71 &calendar;
70&textedit; 72 &todo;
71&reader; 73 &today;
72&sheet; 74 &filemanager;
73&write; 75 &embeddedkonsole;
74&sysinfo; 76 &keypebble;
75&tableviewer; 77 &helpbrowser;
76&qpdf; 78 &login;
77&drawpad; 79 &citytime;
78&player2; 80 &textedit;
79&showimg; 81 &reader;
80</part> 82 &sheet;
81<part><title>Settings</title> 83 &write;
82&software; 84 &sysinfo;
83&lightpower; 85 &tableviewer;
84&calibrate; 86 &qpdf;
85&rotation; 87 &drawpad;
86&appearance2; 88 &player2;
87&language; 89 &showimg;
88&sshkeys; 90 </part>
89&appskey; 91 <part>
90</part> 92 <title>Settings</title>
91<part><title>Applets</title> 93 &software;
92&irda; 94 &lightpower;
93</part> 95 &calibrate;
94<part><title>Inputmethods</title> 96 &rotation;
95&kjumpx; 97 &appearance2;
96&handwriting; 98 &language;
97&multikey; 99 &sshkeys;
98&pickboard; 100 &appskey;
99</part> 101 </part>
100<part><title>Technical Details</title> 102 <part>
101&i18n; 103 <title>Applets</title>
102</part> 104 &irda;
105 </part>
106 <part>
107 <title>Inputmethods</title>
108 &kjumpx;
109 &handwriting;
110 &multikey;
111 &pickboard;
112 </part>
113 <part>
114 <title>Technical Details</title>
115 &i18n;
116 </part>
103</book> 117</book>
diff --git a/docs/usermanual/whatisopie.sgm b/docs/usermanual/whatisopie.sgm
index 583a9f8..ada07c0 100644
--- a/docs/usermanual/whatisopie.sgm
+++ b/docs/usermanual/whatisopie.sgm
@@ -1,17 +1,26 @@
1<chapter><title>What is &opie;?</title> 1<chapter><title>What is &opie;?</title>
2
3<figure><title>&opie; logo</title>
4<mediaobject>
5 <imageobject>
6 <imagedata fileref="logo-small.png">
7 </imageobject>
8</mediaobject>
9</figure>
10
2<para> 11<para>
3&opie; is a GUI (Graphical User Interface) for the Linux operating system (and 12<ulink url="http://opie.handhelds.org">&opie;</ulink> is a GUI (Graphical User Interface) for the Linux operating system (and
4might work on other OSes as well). It was originally designed for handheld 13might work on other OSes as well). It was originally designed for handheld
5computers (such as the Compaq/HP &ipaq; and the Sharp &zaurus;), but could 14computers (such as the Compaq/HP &ipaq; and the Sharp &zaurus;), but could
6probably function well in other environments requiring a light GUI, such as an 15function well in other environments requiring a light GUI, such as an
7old laptop, or an internet kiosk. It is based upon &qt;/Embedded from Trolltech, 16old laptop, or an internet kiosk. It is based upon <ulink url="http://www.trolltech.com/products/embedded/index.html">&qt;/Embedded from Trolltech</ulink>,
8which is in turn a graphical environment designed for embedded applications, 17which is in turn a graphical environment designed for embedded applications,
9based upon the &qt; toolkit. 18based upon the &qt; toolkit.
10</para> 19</para>
11<para> 20<para>
12&opie; has been designed for devices with small screens, and a touchscreen input 21&opie; has been designed for devices with small screens, and a touchscreen input
13device (ie, only one mouse click, and no constant mouse position), as well as 22device (ie, only one mouse click, and no constant mouse position), as well as
14designed to fit in a relatively small amount of storage space (about 5 megabytes 23designed to fit in a relatively small amount of storage space (about 5 megabytes
15for the base libraries and the launcher). 24for the base libraries and the launcher).
16</para> 25</para>
17</chapter> 26</chapter>