summaryrefslogtreecommitdiff
Unidiff
Diffstat (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,274 +1,277 @@
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>
115<para> 118<para>
116The Launcher behaves like the "desktop" on most PC GUIs. When no applications 119The Launcher behaves like the "desktop" on most PC GUIs. When no applications
117are running or visible, you will have access to the Launcher. You can also map 120are running or visible, you will have access to the Launcher. You can also map
118a hardware key to bring the Launcher to the top without closing any of the 121a hardware key to bring the Launcher to the top without closing any of the
119running applications (this is similar to "minimising" all the applications 122running applications (this is similar to "minimising" all the applications
120that are running). 123that are running).
121</para> 124</para>
122<para> 125<para>
123Along the top of the Launcher you will see a list of tabs which function as 126Along the top of the Launcher you will see a list of tabs which function as
124categories for your applications. You can click on the tab for the category you 127categories for your applications. You can click on the tab for the category you
125want to view, and then click on the icon for the application that you wish to 128want to view, and then click on the icon for the application that you wish to
126launch. By default, there will be an Applications tab and a Settings tab (if 129launch. By default, there will be an Applications tab and a Settings tab (if
127you install any games, they will appear in the Games tab). When new 130you install any games, they will appear in the Games tab). When new
128applications are installed, they will usually appear in one of these three tabs, 131applications are installed, they will usually appear in one of these three tabs,
129or in a tab of their own. To add or delete tabs or to move applications between 132or in a tab of their own. To add or delete tabs or to move applications between
130the tabs, you can use the Tab Manager application, or you can edit them by hand, 133the tabs, you can use the Tab Manager application, or you can edit them by hand,
131by changing the directories in /opt/QtPalmtop/apps. 134by changing the directories in /opt/QtPalmtop/apps.
132</para> 135</para>
133<para> 136<para>
134There is also a tab to the far right called the "Documents" tab, which allows 137There is also a tab to the far right called the "Documents" tab, which allows
135you to quickly open your most often used documents. You can click on a document 138you to quickly open your most often used documents. You can click on a document
136to open it up in the proper application. For help on adding files to the 139to open it up in the proper application. For help on adding files to the
137Documents tab see the <xref linkend="adddoc">. 140Documents tab see the <xref linkend="adddoc">.
138</para> 141</para>
139</section> 142</section>
140 143
141<section><title>Taskbar</title> 144<section><title>Taskbar</title>
142<para> 145<para>
143Opie has a "Taskbar" that always runs along the bottom of the screen in Opie, 146Opie has a "Taskbar" that always runs along the bottom of the screen in Opie,
144except for a few "fullscreen" applications that cover it up. The Taskbar is 147except for a few "fullscreen" applications that cover it up. The Taskbar is
145what lets you select which input method you would like to use, shows what 148what lets you select which input method you would like to use, shows what
146applications are running, and is also where the "applets" draw their icons. 149applications are running, and is also where the "applets" draw their icons.
147On the left of the Taskbar is an "O" button that opens a menu which has an 150On the left of the Taskbar is an "O" button that opens a menu which has an
148entry for every tab in the Launcher, allowing you to star an applications 151entry for every tab in the Launcher, allowing you to star an applications
149without going back to the Launcher, or quiting the application that you are 152without going back to the Launcher, or quiting the application that you are
150running. On the right hand side of the Taskbar, you will probably see a clock 153running. On the right hand side of the Taskbar, you will probably see a clock
151(unless you installed task-opie-minimal), which is actually just another applet 154(unless you installed task-opie-minimal), which is actually just another applet
152that draws the time instead of an icon. 155that draws the time instead of an icon.
153</para> 156</para>
154<para> 157<para>
155When an application is run, it adds its icon to the Taskbar, starting from the 158When an application is run, it adds its icon to the Taskbar, starting from the
156right side of the input method icon, with new application's icons appearing to 159right side of the input method icon, with new application's icons appearing to
157the right. If you click on the icon for an application, it will be brought to 160the right. If you click on the icon for an application, it will be brought to
158the screen, allowing you to interact with it. 161the screen, allowing you to interact with it.
159</para> 162</para>
160<para> 163<para>
161To the right of the "O" menu you will see an icon for the currently selected 164To the right of the "O" menu you will see an icon for the currently selected
162input method. Clicking this will bring up the input method, allowing you to 165input method. Clicking this will bring up the input method, allowing you to
163type into the currently running application. To the right of the input method 166type into the currently running application. To the right of the input method
164icon is a small arrow pointing up, which will open a menu of all the currently 167icon is a small arrow pointing up, which will open a menu of all the currently
165installed input methods when clicked. When you select one of these, it will 168installed input methods when clicked. When you select one of these, it will
166become the current input method, with its icon replacing the previous one. 169become the current input method, with its icon replacing the previous one.
167</para> 170</para>
168</section> 171</section>
169 172
170<section><title>Dialogs</title> 173<section><title>Dialogs</title>
171<para> 174<para>
172In Opie, dialogs, as well as some applications, have a button labeled "Ok" on 175In Opie, dialogs, as well as some applications, have a button labeled "Ok" on
173the right side of the window title bar, in addition to the normal "x". For 176the right side of the window title bar, in addition to the normal "x". For
174dialogs, the "Ok" button will apply your changes and close the window, while 177dialogs, the "Ok" button will apply your changes and close the window, while
175the "x" will cancel them before closing the window (for people used to most 178the "x" will cancel them before closing the window (for people used to most
176desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons 179desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons
177you would normally see in the bottom right of the dialog window). 180you would normally see in the bottom right of the dialog window).
178</para> 181</para>
179<para> 182<para>
180For applications that have an "Ok" button as well as the "x" button that all 183For applications that have an "Ok" button as well as the "x" button that all
181applications have, the "Ok" button will usually save the current file and then 184applications have, the "Ok" button will usually save the current file and then
182close the application, while the "x" button will close the application without 185close the application, while the "x" button will close the application without
183saving. 186saving.
184</para> 187</para>
185</section> 188</section>
186</chapter> 189</chapter>
187 190
188<chapter><title>Upgrading</title> 191<chapter><title>Upgrading</title>
189<para> 192<para>
190First, you should shutdown Opie from the "Shutdown" app in the Settings tab. 193First, you should shutdown Opie from the "Shutdown" app in the Settings tab.
191Normally, simply running 194Normally, simply running
192<informalexample> 195<informalexample>
193<literallayout> 196<literallayout>
194 ipkg update && ipkg upgrade 197 ipkg update && ipkg upgrade
195</literallayout> 198</literallayout>
196</informalexample> 199</informalexample>
197will upgrade Opie. However, if you currently have a version with the 1.5.0 200will upgrade Opie. However, if you currently have a version with the 1.5.0
198version number, you will have to upgrade it differently, because Opie now uses a 201version number, you will have to upgrade it differently, because Opie now uses a
199different version number (the 1.5.0 was Qtopia's version number, we now use our 202different version number (the 1.5.0 was Qtopia's version number, we now use our
200own). To upgrade from one of these older versions, run: 203own). To upgrade from one of these older versions, run:
201<informalexample> 204<informalexample>
202<literallayout> 205<literallayout>
203 ipkg update 206 ipkg update
204 ipkg install opie-update 207 ipkg install opie-update
205</literallayout> 208</literallayout>
206</informalexample> 209</informalexample>
207Opie should then be upgraded. 210Opie should then be upgraded.
208</para> 211</para>
209</chapter> 212</chapter>
210</part> 213</part>
211 214
212<part><title>Applications</title> 215<part><title>Applications</title>
213<chapter><title>Contacts</title> 216<chapter><title>Contacts</title>
214<para> 217<para>
215Contacts is a way to keep track of all the people you know, and how to contact 218Contacts is a way to keep track of all the people you know, and how to contact
216them. as well as other information, such as their birthday, the company they 219them. as well as other information, such as their birthday, the company they
217work for, etc. 220work for, etc.
218<para> 221<para>
219 222
220<section><title>Adding Contacts</title> 223<section><title>Adding Contacts</title>
221<para> 224<para>
222To Add a user, go to 225To Add a user, go to
223<GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>, 226<GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>,
224or click the add icon in the toolbar (looks like a blank piece of paper). 227or click the add icon in the toolbar (looks like a blank piece of paper).
225First, you need to give the person a name. You can do this by either entering 228First, you need to give the person a name. You can do this by either entering
226their name in the name field, or by pressing "Full Name...", which will open 229their name in the name field, or by pressing "Full Name...", which will open
227up a new dialog that lets you enter each part of their name individually. Three 230up a new dialog that lets you enter each part of their name individually. Three
228of the entry fields have pulldown menus instead of labels that let you set which 231of the entry fields have pulldown menus instead of labels that let you set which
229parameter these input fields control. The File As field lets you control how 232parameter these input fields control. The File As field lets you control how
230their name is displayed in the main view, use the pulldown arrow to select from 233their name is displayed in the main view, use the pulldown arrow to select from
231some common ways of ordering their first and last names, or type in a custom 234some common ways of ordering their first and last names, or type in a custom
232one. You can also select a category for the user to be filed under, and clicking 235one. You can also select a category for the user to be filed under, and clicking
233the button labeled "..." lets you edit the available catagories (these are 236the button labeled "..." lets you edit the available catagories (these are
234convinient for displaying just the contacts you want when you have a lot of 237convinient for displaying just the contacts you want when you have a lot of
235them). 238them).
236</para> 239</para>
237<para> 240<para>
238The address tab lets you edit the contact's buisness and home addresses (select 241The address tab lets you edit the contact's buisness and home addresses (select
239which one you want to change from the pulldown menu at the top). The bottom 242which one you want to change from the pulldown menu at the top). The bottom
240field behaves just like the three custom fields in the "General" tab (and if 243field behaves just like the three custom fields in the "General" tab (and if
241you select the same thing from the pulldown list, it will modify the same 244you select the same thing from the pulldown list, it will modify the same
242parameter). 245parameter).
243</para> 246</para>
244<para> 247<para>
245The Details tab is used for miscelaneous things like the person's position, the 248The Details tab is used for miscelaneous things like the person's position, the
246name of their spouse, etc. 249name of their spouse, etc.
247</para> 250</para>
248<para> 251<para>
249When you are done, click "Ok" in the top right of the screen (you can always 252When you are done, click "Ok" in the top right of the screen (you can always
250edit their profile later), click the "x" to cancel, and not add the contact. 253edit their profile later), click the "x" to cancel, and not add the contact.
251</para> 254</para>
252</section> 255</section>
253<section><title>Editing Contacts</title> 256<section><title>Editing Contacts</title>
254<para> 257<para>
255To edit the contacts, select the person you want to edit, anc click the pencil 258To edit the contacts, select the person you want to edit, anc click the pencil
256icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>, 259icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>,
257and it will open up the same dialog used to add a user, except their information 260and it will open up the same dialog used to add a user, except their information
258that is already entered will already be filled in. To finalise the changes, 261that is already entered will already be filled in. To finalise the changes,
259click "Ok", or to cancel them, click "x". 262click "Ok", or to cancel them, click "x".
260</para> 263</para>
261</section> 264</section>
262 265
263<section><title>Deleting Contacts</title> 266<section><title>Deleting Contacts</title>
264<para> 267<para>
265To delete a contact, select the person from the list of contacts, and click the 268To delete a contact, select the person from the list of contacts, and click the
266trash can icon, or go to <GUIMenu>Contact</GUIMenu> 269trash can icon, or go to <GUIMenu>Contact</GUIMenu>
267&arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you 270&arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you
268want to actually delete that contact, click yes to delete it, no will cancel. 271want to actually delete that contact, click yes to delete it, no will cancel.
269</para> 272</para>
270</section> 273</section>
271 274
272<section><title>Editing Contacts</title> 275<section><title>Editing Contacts</title>
273<para> 276<para>
274To find a specific person, click the find icon (green magnifying glass), or go 277To find a specific person, click the find icon (green magnifying glass), or go