summaryrefslogtreecommitdiff
path: root/docs
Unidiff
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/usermanual.sgm5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index 0232cd3..f691889 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,114 +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<!ENTITY arrow "-->">
3]> 3]>
4<book><title>Opie User Manual</title> 4<book><title>Opie User Manual</title>
5<bookinfo><authorgroup><collab>
6<collabname>The Opie Team</collabname>
7</collab></authorgroup></bookinfo>
5<part><title>Getting Started</title> 8<part><title>Getting Started</title>
6<chapter><title>What is Opie?</title> 9<chapter><title>What is Opie?</title>
7<para> 10<para>
8Opie is a GUI (Graphical User Interface) for the Linux operating system (and 11Opie is a GUI (Graphical User Interface) for the Linux operating system (and
9might work on other OSes as well). It was originally designed for handheld 12might work on other OSes as well). It was originally designed for handheld
10computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could 13computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could
11probably function well in other environments requiring a light GUI, such as an 14probably function well in other environments requiring a light GUI, such as an
12old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech, 15old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech,
13which is in turn a graphical environment designed for embedded applications, 16which is in turn a graphical environment designed for embedded applications,
14based upon the QT toolkit. 17based upon the QT toolkit.
15</para> 18</para>
16<para> 19<para>
17Opie has been designed for devices with small screens, and a touchscreen input 20Opie has been designed for devices with small screens, and a touchscreen input
18device (ie, only one mouse click, and no constant mouse position), as well as 21device (ie, only one mouse click, and no constant mouse position), as well as
19designed to fit in a relatively small amount of storage space (about 5 megabytes 22designed to fit in a relatively small amount of storage space (about 5 megabytes
20for the base libraries and the launcher). 23for the base libraries and the launcher).
21</para> 24</para>
22</chapter> 25</chapter>
23<chapter><title>Installation</title> 26<chapter><title>Installation</title>
24<section><title>iPAQ</title> 27<section><title>iPAQ</title>
25<para> 28<para>
26To install opie on an iPAQ, you will need a fresh Familiar installation (ie, 29To install opie on an iPAQ, you will need a fresh Familiar installation (ie,
27install Familiar, and stop before you do ipkg install task-complete or ipkg 30install Familiar, and stop before you do ipkg install task-complete or ipkg
28install task-x), go to http://familiar.handhelds.org to get the latest version, 31install task-x), go to http://familiar.handhelds.org to get the latest version,
29and to get installation instructions (again, stop after the initial boot and do 32and to get installation instructions (again, stop after the initial boot and do
30not install X, as it is not necessary, and will only take up space). 33not install X, as it is not necessary, and will only take up space).
31</para> 34</para>
32 35
33<note> 36<note>
34<para> 37<para>
35If you had qpe/qtopia installed previously, 38If you had qpe/qtopia installed previously,
36<emphasis>completely</emphasis> remove it, and remove the src line for it from 39<emphasis>completely</emphasis> remove it, and remove the src line for it from
37your /etc/ipkg.conf file before attempting to install opie. 40your /etc/ipkg.conf file before attempting to install opie.
38</para> 41</para>
39</note> 42</note>
40<para> 43<para>
41Once you have Familiar installed, set up a network connection between your iPAQ 44Once you have Familiar installed, set up a network connection between your iPAQ
42and the ouside world (again, see the Familiar site for instructions on this), 45and the ouside world (again, see the Familiar site for instructions on this),
43and then run this command: 46and then run this command:
44<informalexample> 47<informalexample>
45<literallayout> 48<literallayout>
46 echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ 49 echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \
47 >> /etc/ipkg.conf 50 >> /etc/ipkg.conf
48</literallayout> 51</literallayout>
49</informalexample> 52</informalexample>
50then, run: 53then, run:
51<informalexample> 54<informalexample>
52<literallayout> 55<literallayout>
53 ipkg update && ipkg install task-opie 56 ipkg update && ipkg install task-opie
54</literallayout> 57</literallayout>
55</informalexample> 58</informalexample>
56If you have a 3100 or 3800 series iPAQ, run: 59If you have a 3100 or 3800 series iPAQ, run:
57<informalexample> 60<informalexample>
58<literallayout> 61<literallayout>
59 ipkg install qt-embedded-rotation 62 ipkg install qt-embedded-rotation
60</literallayout> 63</literallayout>
61</informalexample> 64</informalexample>
62finally, start Opie with: 65finally, start Opie with:
63<informalexample> 66<informalexample>
64<literallayout> 67<literallayout>
65 /etc/init.d/opie start 68 /etc/init.d/opie start
66</literallayout> 69</literallayout>
67</informalexample> 70</informalexample>
68</para> 71</para>
69 72
70<para> 73<para>
71Opie should now be running (if you should have to reboot, which is rare, Opie 74Opie should now be running (if you should have to reboot, which is rare, Opie
72will start automatically). From here, you can use either the "Software" 75will start automatically). From here, you can use either the "Software"
73application in the Settings tab, or run ipkg from the command line to install 76application in the Settings tab, or run ipkg from the command line to install
74other Opie apps. Check out the various task-opie-* ipkgs to install various sets 77other Opie apps. Check out the various task-opie-* ipkgs to install various sets
75of apps at once (you can always uninstall individual apps individually). You 78of apps at once (you can always uninstall individual apps individually). You
76will probably want to install opie-embeddedkonsole first, so you have access to 79will probably want to install opie-embeddedkonsole first, so you have access to
77the command line in Opie. 80the command line in Opie.
78</para> 81</para>
79</section> 82</section>
80 83
81<section><title>Zaurus</title> 84<section><title>Zaurus</title>
82<para> 85<para>
83To completely install Opie on the Zaurus, you will have to install OpenZaurus, 86To completely install Opie on the Zaurus, you will have to install OpenZaurus,
84which includes Opie. However, individual Opie applications will work fine on the 87which includes Opie. However, individual Opie applications will work fine on the
85default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM 88default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM
86though. 89though.
87</para> 90</para>
88</section> 91</section>
89</chapter> 92</chapter>
90 93
91<chapter><title>Using Opie</title> 94<chapter><title>Using Opie</title>
92<para> 95<para>
93Now that Opie is installed and running, it's time to start using it. When you 96Now that Opie is installed and running, it's time to start using it. When you
94first start Opie, you will see the "Launcher" from which you can start all of 97first start Opie, you will see the "Launcher" from which you can start all of
95your Applications, and the "Taskbar" along the bottom, where you can see all 98your Applications, and the "Taskbar" along the bottom, where you can see all
96the running applications, select an input method, and interact with the 99the running applications, select an input method, and interact with the
97installed "applets". 100installed "applets".
98</para> 101</para>
99 102
100<section><title>Getting Around</title> 103<section><title>Getting Around</title>
101<para> 104<para>
102Getting around in Opie is very easy, you simply click your stylus on whatever 105Getting around in Opie is very easy, you simply click your stylus on whatever
103icon or button you want to click on. The main difference between using the 106icon or button you want to click on. The main difference between using the
104stylus and using a mouse is that you cannot right click with a stylus, so things 107stylus and using a mouse is that you cannot right click with a stylus, so things
105that require a right click are kept to a minimum. However, it is sometimes 108that require a right click are kept to a minimum. However, it is sometimes
106necessary to right click, and this is implemented with a "press and hold". 109necessary to right click, and this is implemented with a "press and hold".
107Any time you want to do something that you think would require a right click on 110Any time you want to do something that you think would require a right click on
108a normal pc, try pressing the stylus down and holding it still for a few 111a normal pc, try pressing the stylus down and holding it still for a few
109seconds. This usually opens up a context sensative menu, much like a right 112seconds. This usually opens up a context sensative menu, much like a right
110click usually does on a desktop interface. 113click usually does on a desktop interface.
111</para> 114</para>
112</section> 115</section>
113 116
114<section><title>Launcher</title> 117<section><title>Launcher</title>