-rw-r--r-- | docs/usermanual/usermanual.sgm | 3 |
1 files changed, 3 insertions, 0 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,100 +1,103 @@ | |||
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> |
8 | Opie is a GUI (Graphical User Interface) for the Linux operating system (and | 11 | Opie is a GUI (Graphical User Interface) for the Linux operating system (and |
9 | might work on other OSes as well). It was originally designed for handheld | 12 | might work on other OSes as well). It was originally designed for handheld |
10 | computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could | 13 | computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could |
11 | probably function well in other environments requiring a light GUI, such as an | 14 | probably function well in other environments requiring a light GUI, such as an |
12 | old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech, | 15 | old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech, |
13 | which is in turn a graphical environment designed for embedded applications, | 16 | which is in turn a graphical environment designed for embedded applications, |
14 | based upon the QT toolkit. | 17 | based upon the QT toolkit. |
15 | </para> | 18 | </para> |
16 | <para> | 19 | <para> |
17 | Opie has been designed for devices with small screens, and a touchscreen input | 20 | Opie has been designed for devices with small screens, and a touchscreen input |
18 | device (ie, only one mouse click, and no constant mouse position), as well as | 21 | device (ie, only one mouse click, and no constant mouse position), as well as |
19 | designed to fit in a relatively small amount of storage space (about 5 megabytes | 22 | designed to fit in a relatively small amount of storage space (about 5 megabytes |
20 | for the base libraries and the launcher). | 23 | for 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> |
26 | To install opie on an iPAQ, you will need a fresh Familiar installation (ie, | 29 | To install opie on an iPAQ, you will need a fresh Familiar installation (ie, |
27 | install Familiar, and stop before you do ipkg install task-complete or ipkg | 30 | install Familiar, and stop before you do ipkg install task-complete or ipkg |
28 | install task-x), go to http://familiar.handhelds.org to get the latest version, | 31 | install task-x), go to http://familiar.handhelds.org to get the latest version, |
29 | and to get installation instructions (again, stop after the initial boot and do | 32 | and to get installation instructions (again, stop after the initial boot and do |
30 | not install X, as it is not necessary, and will only take up space). | 33 | not 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> |
35 | If you had qpe/qtopia installed previously, | 38 | If 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 |
37 | your /etc/ipkg.conf file before attempting to install opie. | 40 | your /etc/ipkg.conf file before attempting to install opie. |
38 | </para> | 41 | </para> |
39 | </note> | 42 | </note> |
40 | <para> | 43 | <para> |
41 | Once you have Familiar installed, set up a network connection between your iPAQ | 44 | Once you have Familiar installed, set up a network connection between your iPAQ |
42 | and the ouside world (again, see the Familiar site for instructions on this), | 45 | and the ouside world (again, see the Familiar site for instructions on this), |
43 | and then run this command: | 46 | and 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> |
50 | then, run: | 53 | then, 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> |
56 | If you have a 3100 or 3800 series iPAQ, run: | 59 | If 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> |
62 | finally, start Opie with: | 65 | finally, 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> |
71 | Opie should now be running (if you should have to reboot, which is rare, Opie | 74 | Opie should now be running (if you should have to reboot, which is rare, Opie |
72 | will start automatically). From here, you can use either the "Software" | 75 | will start automatically). From here, you can use either the "Software" |
73 | application in the Settings tab, or run ipkg from the command line to install | 76 | application in the Settings tab, or run ipkg from the command line to install |
74 | other Opie apps. Check out the various task-opie-* ipkgs to install various sets | 77 | other Opie apps. Check out the various task-opie-* ipkgs to install various sets |
75 | of apps at once (you can always uninstall individual apps individually). You | 78 | of apps at once (you can always uninstall individual apps individually). You |
76 | will probably want to install opie-embeddedkonsole first, so you have access to | 79 | will probably want to install opie-embeddedkonsole first, so you have access to |
77 | the command line in Opie. | 80 | the 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> |
83 | To completely install Opie on the Zaurus, you will have to install OpenZaurus, | 86 | To completely install Opie on the Zaurus, you will have to install OpenZaurus, |
84 | which includes Opie. However, individual Opie applications will work fine on the | 87 | which includes Opie. However, individual Opie applications will work fine on the |
85 | default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM | 88 | default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM |
86 | though. | 89 | though. |
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> |
93 | Now that Opie is installed and running, it's time to start using it. When you | 96 | Now that Opie is installed and running, it's time to start using it. When you |
94 | first start Opie, you will see the "Launcher" from which you can start all of | 97 | first start Opie, you will see the "Launcher" from which you can start all of |
95 | your Applications, and the "Taskbar" along the bottom, where you can see all | 98 | your Applications, and the "Taskbar" along the bottom, where you can see all |
96 | the running applications, select an input method, and interact with the | 99 | the running applications, select an input method, and interact with the |
97 | installed "applets". | 100 | installed "applets". |
98 | </para> | 101 | </para> |
99 | 102 | ||
100 | <section><title>Getting Around</title> | 103 | <section><title>Getting Around</title> |