-rw-r--r-- | docs/usermanual/installation.sgm | 16 | ||||
-rw-r--r-- | docs/usermanual/usermanual.sgm | 2 | ||||
-rw-r--r-- | docs/usermanual/whatisopie.sgm | 2 |
3 files changed, 11 insertions, 9 deletions
diff --git a/docs/usermanual/installation.sgm b/docs/usermanual/installation.sgm index 62874bb..9849965 100644 --- a/docs/usermanual/installation.sgm +++ b/docs/usermanual/installation.sgm | |||
@@ -1,67 +1,67 @@ | |||
1 | <chapter><title>Installation</title> | 1 | <chapter><title>Installation</title> |
2 | <section><title>iPAQ</title> | 2 | <section><title>&ipaq;</title> |
3 | <para> | 3 | <para> |
4 | To install opie on an iPAQ, you will need a fresh Familiar installation (ie, | 4 | To install opie on an &ipaq;, you will need a fresh Familiar installation (ie, |
5 | install Familiar, and stop before you do ipkg install task-complete or ipkg | 5 | install Familiar, and stop before you do ipkg install task-complete or ipkg |
6 | install task-x), go to http://familiar.handhelds.org to get the latest version, | 6 | install task-x), go to http://familiar.handhelds.org to get the latest version, |
7 | and to get installation instructions (again, stop after the initial boot and do | 7 | and to get installation instructions (again, stop after the initial boot and do |
8 | not install X, as it is not necessary, and will only take up space). | 8 | not install X, as it is not necessary, and will only take up space). |
9 | </para> | 9 | </para> |
10 | 10 | ||
11 | <note> | 11 | <note> |
12 | <para> | 12 | <para> |
13 | If you had qpe/qtopia installed previously, | 13 | If you had qpe/qtopia installed previously, |
14 | <emphasis>completely</emphasis> remove it, and remove the src line for it from | 14 | <emphasis>completely</emphasis> remove it, and remove the src line for it from |
15 | your /etc/ipkg.conf file before attempting to install opie. | 15 | your /etc/ipkg.conf file before attempting to install opie. |
16 | </para> | 16 | </para> |
17 | </note> | 17 | </note> |
18 | <para> | 18 | <para> |
19 | Once you have Familiar installed, set up a network connection between your iPAQ | 19 | Once you have Familiar installed, set up a network connection between your $ipaq; |
20 | and the ouside world (again, see the Familiar site for instructions on this), | 20 | and the ouside world (again, see the Familiar site for instructions on this), |
21 | and then run this command: | 21 | and then run this command: |
22 | <informalexample> | 22 | <informalexample> |
23 | <literallayout> | 23 | <literallayout> |
24 | echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ | 24 | echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ |
25 | >> /etc/ipkg.conf | 25 | >> /etc/ipkg.conf |
26 | </literallayout> | 26 | </literallayout> |
27 | </informalexample> | 27 | </informalexample> |
28 | then, run: | 28 | then, run: |
29 | <informalexample> | 29 | <informalexample> |
30 | <literallayout> | 30 | <literallayout> |
31 | ipkg update && ipkg install task-opie | 31 | ipkg update && ipkg install task-opie |
32 | </literallayout> | 32 | </literallayout> |
33 | </informalexample> | 33 | </informalexample> |
34 | If you have a 3100 or 3800 series iPAQ, run: | 34 | If you have a 3100 or 3800 series &ipaq;, run: |
35 | <informalexample> | 35 | <informalexample> |
36 | <literallayout> | 36 | <literallayout> |
37 | ipkg install qt-embedded-rotation | 37 | ipkg install qt-embedded-rotation |
38 | </literallayout> | 38 | </literallayout> |
39 | </informalexample> | 39 | </informalexample> |
40 | finally, start &opie; with: | 40 | finally, start &opie; with: |
41 | <informalexample> | 41 | <informalexample> |
42 | <literallayout> | 42 | <literallayout> |
43 | /etc/init.d/opie start | 43 | /etc/init.d/opie start |
44 | </literallayout> | 44 | </literallayout> |
45 | </informalexample> | 45 | </informalexample> |
46 | </para> | 46 | </para> |
47 | 47 | ||
48 | <para> | 48 | <para> |
49 | &opie; should now be running (if you should have to reboot, which is rare, &opie; | 49 | &opie; should now be running (if you should have to reboot, which is rare, &opie; |
50 | will start automatically). From here, you can use either the "Software" | 50 | will start automatically). From here, you can use either the "Software" |
51 | application in the Settings tab, or run ipkg from the command line to install | 51 | application in the Settings tab, or run ipkg from the command line to install |
52 | other &opie; apps. Check out the various task-opie-* ipkgs to install various sets | 52 | other &opie; apps. Check out the various task-opie-* ipkgs to install various sets |
53 | of apps at once (you can always uninstall individual apps individually). You | 53 | of apps at once (you can always uninstall individual apps individually). You |
54 | will probably want to install opie-embeddedkonsole first, so you have access to | 54 | will probably want to install opie-embeddedkonsole first, so you have access to |
55 | the command line in &opie;. | 55 | the command line in &opie;. |
56 | </para> | 56 | </para> |
57 | </section> | 57 | </section> |
58 | 58 | ||
59 | <section><title>Zaurus</title> | 59 | <section><title>&zaurus;</title> |
60 | <para> | 60 | <para> |
61 | To completely install &opie; on the Zaurus, you will have to install OpenZaurus, | 61 | To completely install &opie; on the &zaurus;, you will have to install OpenZaurus, |
62 | which includes &opie;. However, individual &opie; applications will work fine on the | 62 | which includes &opie;. However, individual &opie; applications will work fine on the |
63 | default Zaurus rom. Do not install &opie;'s launcher on a default Zaurus ROM | 63 | default &zaurus; rom. Do not install &opie;'s launcher on a default &zaurus; ROM |
64 | though. | 64 | though. |
65 | </para> | 65 | </para> |
66 | </section> | 66 | </section> |
67 | </chapter> \ No newline at end of file | 67 | </chapter> |
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm index 3acc8db..7c457d7 100644 --- a/docs/usermanual/usermanual.sgm +++ b/docs/usermanual/usermanual.sgm | |||
@@ -1,101 +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 | <!ENTITY whatis SYSTEM "whatisopie.sgm"> | 3 | <!ENTITY whatis SYSTEM "whatisopie.sgm"> |
4 | <!ENTITY installation SYSTEM "installation.sgm"> | 4 | <!ENTITY installation SYSTEM "installation.sgm"> |
5 | <!ENTITY gettingaround SYSTEM "gettingaround.sgm"> | 5 | <!ENTITY gettingaround SYSTEM "gettingaround.sgm"> |
6 | <!ENTITY upgrading SYSTEM "upgrading.sgm"> | 6 | <!ENTITY upgrading SYSTEM "upgrading.sgm"> |
7 | <!ENTITY contacts SYSTEM "contacts.sgm"> | 7 | <!ENTITY contacts SYSTEM "contacts.sgm"> |
8 | <!ENTITY calendar SYSTEM "calendar.sgm"> | 8 | <!ENTITY calendar SYSTEM "calendar.sgm"> |
9 | <!ENTITY todo SYSTEM "todo.sgm"> | 9 | <!ENTITY todo SYSTEM "todo.sgm"> |
10 | <!ENTITY filemanager SYSTEM "filemanager.sgm"> | 10 | <!ENTITY filemanager SYSTEM "filemanager.sgm"> |
11 | <!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm"> | 11 | <!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm"> |
12 | <!ENTITY software SYSTEM "software.sgm"> | 12 | <!ENTITY software SYSTEM "software.sgm"> |
13 | <!ENTITY today SYSTEM "today.sgm"> | 13 | <!ENTITY today SYSTEM "today.sgm"> |
14 | <!ENTITY irda SYSTEM "irda.sgm"> | 14 | <!ENTITY irda SYSTEM "irda.sgm"> |
15 | <!ENTITY keypebble SYSTEM "keypebble.sgm"> | 15 | <!ENTITY keypebble SYSTEM "keypebble.sgm"> |
16 | <!ENTITY i18n SYSTEM "i18n.sgm"> | 16 | <!ENTITY i18n SYSTEM "i18n.sgm"> |
17 | <!ENTITY kjumpx SYSTEM "kjumpx.sgm"> | 17 | <!ENTITY kjumpx SYSTEM "kjumpx.sgm"> |
18 | <!ENTITY handwriting SYSTEM "handwriting.sgm"> | 18 | <!ENTITY handwriting SYSTEM "handwriting.sgm"> |
19 | <!ENTITY multikey SYSTEM "multikey.sgm"> | 19 | <!ENTITY multikey SYSTEM "multikey.sgm"> |
20 | <!ENTITY pickboard SYSTEM "pickboard.sgm"> | 20 | <!ENTITY pickboard SYSTEM "pickboard.sgm"> |
21 | <!ENTITY calibrate SYSTEM "calibrate.sgm"> | 21 | <!ENTITY calibrate SYSTEM "calibrate.sgm"> |
22 | <!ENTITY helpbrowser SYSTEM "helpbrowser.sgm"> | 22 | <!ENTITY helpbrowser SYSTEM "helpbrowser.sgm"> |
23 | <!ENTITY login SYSTEM "login.sgm"> | 23 | <!ENTITY login SYSTEM "login.sgm"> |
24 | <!ENTITY citytime SYSTEM "citytime.sgm"> | 24 | <!ENTITY citytime SYSTEM "citytime.sgm"> |
25 | <!ENTITY textedit SYSTEM "textedit.sgm"> | 25 | <!ENTITY textedit SYSTEM "textedit.sgm"> |
26 | <!ENTITY lightpower SYSTEM "lightpower.sgm"> | 26 | <!ENTITY lightpower SYSTEM "lightpower.sgm"> |
27 | <!ENTITY reader SYSTEM "reader.sgm"> | 27 | <!ENTITY reader SYSTEM "reader.sgm"> |
28 | <!ENTITY sheet SYSTEM "sheet.sgm"> | 28 | <!ENTITY sheet SYSTEM "sheet.sgm"> |
29 | <!ENTITY write SYSTEM "write.sgm"> | 29 | <!ENTITY write SYSTEM "write.sgm"> |
30 | <!ENTITY sysinfo SYSTEM "sysinfo.sgm"> | 30 | <!ENTITY sysinfo SYSTEM "sysinfo.sgm"> |
31 | <!ENTITY tableviewer SYSTEM "tableviewer.sgm"> | 31 | <!ENTITY tableviewer SYSTEM "tableviewer.sgm"> |
32 | <!ENTITY rotation SYSTEM "rotation.sgm"> | 32 | <!ENTITY rotation SYSTEM "rotation.sgm"> |
33 | <!ENTITY appearance2 SYSTEM "appearance2.sgm"> | 33 | <!ENTITY appearance2 SYSTEM "appearance2.sgm"> |
34 | <!ENTITY language SYSTEM "language.sgm"> | 34 | <!ENTITY language SYSTEM "language.sgm"> |
35 | <!ENTITY sshkeys SYSTEM "sshkeys.sgm"> | 35 | <!ENTITY sshkeys SYSTEM "sshkeys.sgm"> |
36 | <!ENTITY appskey SYSTEM "appskey.sgm"> | 36 | <!ENTITY appskey SYSTEM "appskey.sgm"> |
37 | <!ENTITY drawpad SYSTEM "drawpad.sgm"> | 37 | <!ENTITY drawpad SYSTEM "drawpad.sgm"> |
38 | <!ENTITY qpdf SYSTEM "qpdf.sgm"> | 38 | <!ENTITY qpdf SYSTEM "qpdf.sgm"> |
39 | <!ENTITY player2 SYSTEM "player2.sgm"> | 39 | <!ENTITY player2 SYSTEM "player2.sgm"> |
40 | <!ENTITY showimg SYSTEM "showimg.sgm"> | 40 | <!ENTITY showimg SYSTEM "showimg.sgm"> |
41 | 41 | ||
42 | <!--Now the real entities--> | 42 | <!--Now the real entities--> |
43 | <!ENTITY opie "OPIE"> | 43 | <!ENTITY opie "OPIE"> |
44 | <!ENTITY todayapp "Today"> | 44 | <!ENTITY todayapp "Today"> |
45 | <!ENTITY qt "Qt"> | 45 | <!ENTITY qt "Qt"> |
46 | <!ENTITY ipaq "iPAQ"> | ||
47 | <!ENTITY zaurus "Zaurus"> | ||
46 | ]> | 48 | ]> |
47 | <book><title>&opie; User Manual</title> | 49 | <book><title>&opie; User Manual</title> |
48 | <bookinfo><authorgroup><collab> | 50 | <bookinfo><authorgroup><collab> |
49 | <collabname>The &opie; Team</collabname> | 51 | <collabname>The &opie; Team</collabname> |
50 | </collab></authorgroup></bookinfo> | 52 | </collab></authorgroup></bookinfo> |
51 | <part><title>Getting Started</title> | 53 | <part><title>Getting Started</title> |
52 | &whatis; | 54 | &whatis; |
53 | &installation; | 55 | &installation; |
54 | &gettingaround; | 56 | &gettingaround; |
55 | &upgrading; | 57 | &upgrading; |
56 | </part> | 58 | </part> |
57 | <part><title>Applications</title> | 59 | <part><title>Applications</title> |
58 | &contacts; | 60 | &contacts; |
59 | &calendar; | 61 | &calendar; |
60 | &todo; | 62 | &todo; |
61 | &today; | 63 | &today; |
62 | &filemanager; | 64 | &filemanager; |
63 | &embeddedkonsole; | 65 | &embeddedkonsole; |
64 | &keypebble; | 66 | &keypebble; |
65 | &helpbrowser; | 67 | &helpbrowser; |
66 | &login; | 68 | &login; |
67 | &citytime; | 69 | &citytime; |
68 | &textedit; | 70 | &textedit; |
69 | &reader; | 71 | &reader; |
70 | &sheet; | 72 | &sheet; |
71 | &write; | 73 | &write; |
72 | &sysinfo; | 74 | &sysinfo; |
73 | &tableviewer; | 75 | &tableviewer; |
74 | &qpdf; | 76 | &qpdf; |
75 | &drawpad; | 77 | &drawpad; |
76 | &player2; | 78 | &player2; |
77 | &showimg; | 79 | &showimg; |
78 | </part> | 80 | </part> |
79 | <part><title>Settings</title> | 81 | <part><title>Settings</title> |
80 | &software; | 82 | &software; |
81 | &lightpower; | 83 | &lightpower; |
82 | &calibrate; | 84 | &calibrate; |
83 | &rotation; | 85 | &rotation; |
84 | &appearance2; | 86 | &appearance2; |
85 | &language; | 87 | &language; |
86 | &sshkeys; | 88 | &sshkeys; |
87 | &appskey; | 89 | &appskey; |
88 | </part> | 90 | </part> |
89 | <part><title>Applets</title> | 91 | <part><title>Applets</title> |
90 | &irda; | 92 | &irda; |
91 | </part> | 93 | </part> |
92 | <part><title>Inputmethods</title> | 94 | <part><title>Inputmethods</title> |
93 | &kjumpx; | 95 | &kjumpx; |
94 | &handwriting; | 96 | &handwriting; |
95 | &multikey; | 97 | &multikey; |
96 | &pickboard; | 98 | &pickboard; |
97 | </part> | 99 | </part> |
98 | <part><title>Technical Details</title> | 100 | <part><title>Technical Details</title> |
99 | &i18n; | 101 | &i18n; |
100 | </part> | 102 | </part> |
101 | </book> | 103 | </book> |
diff --git a/docs/usermanual/whatisopie.sgm b/docs/usermanual/whatisopie.sgm index e60897c..583a9f8 100644 --- a/docs/usermanual/whatisopie.sgm +++ b/docs/usermanual/whatisopie.sgm | |||
@@ -1,17 +1,17 @@ | |||
1 | <chapter><title>What is &opie;?</title> | 1 | <chapter><title>What is &opie;?</title> |
2 | <para> | 2 | <para> |
3 | &opie; is a GUI (Graphical User Interface) for the Linux operating system (and | 3 | &opie; is a GUI (Graphical User Interface) for the Linux operating system (and |
4 | might work on other OSes as well). It was originally designed for handheld | 4 | might work on other OSes as well). It was originally designed for handheld |
5 | computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could | 5 | computers (such as the Compaq/HP &ipaq; and the Sharp &zaurus;), but could |
6 | probably function well in other environments requiring a light GUI, such as an | 6 | probably function well in other environments requiring a light GUI, such as an |
7 | old laptop, or an internet kiosk. It is based upon &qt;/Embedded from Trolltech, | 7 | old laptop, or an internet kiosk. It is based upon &qt;/Embedded from Trolltech, |
8 | which is in turn a graphical environment designed for embedded applications, | 8 | which is in turn a graphical environment designed for embedded applications, |
9 | based upon the &qt; toolkit. | 9 | based upon the &qt; toolkit. |
10 | </para> | 10 | </para> |
11 | <para> | 11 | <para> |
12 | &opie; has been designed for devices with small screens, and a touchscreen input | 12 | &opie; has been designed for devices with small screens, and a touchscreen input |
13 | device (ie, only one mouse click, and no constant mouse position), as well as | 13 | device (ie, only one mouse click, and no constant mouse position), as well as |
14 | designed to fit in a relatively small amount of storage space (about 5 megabytes | 14 | designed to fit in a relatively small amount of storage space (about 5 megabytes |
15 | for the base libraries and the launcher). | 15 | for the base libraries and the launcher). |
16 | </para> | 16 | </para> |
17 | </chapter> | 17 | </chapter> |