summaryrefslogtreecommitdiff
path: root/docs
Side-by-side diff
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/installation.sgm16
-rw-r--r--docs/usermanual/usermanual.sgm2
-rw-r--r--docs/usermanual/whatisopie.sgm2
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 @@
<chapter><title>Installation</title>
-<section><title>iPAQ</title>
+<section><title>&ipaq;</title>
<para>
-To install opie on an iPAQ, you will need a fresh Familiar installation (ie,
+To install opie on an &ipaq;, you will need a fresh Familiar installation (ie,
install Familiar, and stop before you do ipkg install task-complete or ipkg
install task-x), go to http://familiar.handhelds.org to get the latest version,
and to get installation instructions (again, stop after the initial boot and do
not install X, as it is not necessary, and will only take up space).
</para>
<note>
<para>
If you had qpe/qtopia installed previously,
<emphasis>completely</emphasis> remove it, and remove the src line for it from
your /etc/ipkg.conf file before attempting to install opie.
</para>
</note>
<para>
-Once you have Familiar installed, set up a network connection between your iPAQ
+Once you have Familiar installed, set up a network connection between your $ipaq;
and the ouside world (again, see the Familiar site for instructions on this),
and then run this command:
<informalexample>
<literallayout>
echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \
>> /etc/ipkg.conf
</literallayout>
</informalexample>
then, run:
<informalexample>
<literallayout>
ipkg update && ipkg install task-opie
</literallayout>
</informalexample>
-If you have a 3100 or 3800 series iPAQ, run:
+If you have a 3100 or 3800 series &ipaq;, run:
<informalexample>
<literallayout>
ipkg install qt-embedded-rotation
</literallayout>
</informalexample>
finally, start &opie; with:
<informalexample>
<literallayout>
/etc/init.d/opie start
</literallayout>
</informalexample>
</para>
<para>
&opie; should now be running (if you should have to reboot, which is rare, &opie;
will start automatically). From here, you can use either the "Software"
application in the Settings tab, or run ipkg from the command line to install
other &opie; apps. Check out the various task-opie-* ipkgs to install various sets
of apps at once (you can always uninstall individual apps individually). You
will probably want to install opie-embeddedkonsole first, so you have access to
the command line in &opie;.
</para>
</section>
-<section><title>Zaurus</title>
+<section><title>&zaurus;</title>
<para>
-To completely install &opie; on the Zaurus, you will have to install OpenZaurus,
+To completely install &opie; on the &zaurus;, you will have to install OpenZaurus,
which includes &opie;. However, individual &opie; applications will work fine on the
-default Zaurus rom. Do not install &opie;'s launcher on a default Zaurus ROM
+default &zaurus; rom. Do not install &opie;'s launcher on a default &zaurus; ROM
though.
</para>
</section>
-</chapter> \ No newline at end of file
+</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 @@
<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [
<!ENTITY arrow "-->">
<!ENTITY whatis SYSTEM "whatisopie.sgm">
<!ENTITY installation SYSTEM "installation.sgm">
<!ENTITY gettingaround SYSTEM "gettingaround.sgm">
<!ENTITY upgrading SYSTEM "upgrading.sgm">
<!ENTITY contacts SYSTEM "contacts.sgm">
<!ENTITY calendar SYSTEM "calendar.sgm">
<!ENTITY todo SYSTEM "todo.sgm">
<!ENTITY filemanager SYSTEM "filemanager.sgm">
<!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm">
<!ENTITY software SYSTEM "software.sgm">
<!ENTITY today SYSTEM "today.sgm">
<!ENTITY irda SYSTEM "irda.sgm">
<!ENTITY keypebble SYSTEM "keypebble.sgm">
<!ENTITY i18n SYSTEM "i18n.sgm">
<!ENTITY kjumpx SYSTEM "kjumpx.sgm">
<!ENTITY handwriting SYSTEM "handwriting.sgm">
<!ENTITY multikey SYSTEM "multikey.sgm">
<!ENTITY pickboard SYSTEM "pickboard.sgm">
<!ENTITY calibrate SYSTEM "calibrate.sgm">
<!ENTITY helpbrowser SYSTEM "helpbrowser.sgm">
<!ENTITY login SYSTEM "login.sgm">
<!ENTITY citytime SYSTEM "citytime.sgm">
<!ENTITY textedit SYSTEM "textedit.sgm">
<!ENTITY lightpower SYSTEM "lightpower.sgm">
<!ENTITY reader SYSTEM "reader.sgm">
<!ENTITY sheet SYSTEM "sheet.sgm">
<!ENTITY write SYSTEM "write.sgm">
<!ENTITY sysinfo SYSTEM "sysinfo.sgm">
<!ENTITY tableviewer SYSTEM "tableviewer.sgm">
<!ENTITY rotation SYSTEM "rotation.sgm">
<!ENTITY appearance2 SYSTEM "appearance2.sgm">
<!ENTITY language SYSTEM "language.sgm">
<!ENTITY sshkeys SYSTEM "sshkeys.sgm">
<!ENTITY appskey SYSTEM "appskey.sgm">
<!ENTITY drawpad SYSTEM "drawpad.sgm">
<!ENTITY qpdf SYSTEM "qpdf.sgm">
<!ENTITY player2 SYSTEM "player2.sgm">
<!ENTITY showimg SYSTEM "showimg.sgm">
<!--Now the real entities-->
<!ENTITY opie "OPIE">
<!ENTITY todayapp "Today">
<!ENTITY qt "Qt">
+<!ENTITY ipaq "iPAQ">
+<!ENTITY zaurus "Zaurus">
]>
<book><title>&opie; User Manual</title>
<bookinfo><authorgroup><collab>
<collabname>The &opie; Team</collabname>
</collab></authorgroup></bookinfo>
<part><title>Getting Started</title>
&whatis;
&installation;
&gettingaround;
&upgrading;
</part>
<part><title>Applications</title>
&contacts;
&calendar;
&todo;
&today;
&filemanager;
&embeddedkonsole;
&keypebble;
&helpbrowser;
&login;
&citytime;
&textedit;
&reader;
&sheet;
&write;
&sysinfo;
&tableviewer;
&qpdf;
&drawpad;
&player2;
&showimg;
</part>
<part><title>Settings</title>
&software;
&lightpower;
&calibrate;
&rotation;
&appearance2;
&language;
&sshkeys;
&appskey;
</part>
<part><title>Applets</title>
&irda;
</part>
<part><title>Inputmethods</title>
&kjumpx;
&handwriting;
&multikey;
&pickboard;
</part>
<part><title>Technical Details</title>
&i18n;
</part>
</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 @@
<chapter><title>What is &opie;?</title>
<para>
&opie; is a GUI (Graphical User Interface) for the Linux operating system (and
might work on other OSes as well). It was originally designed for handheld
-computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could
+computers (such as the Compaq/HP &ipaq; and the Sharp &zaurus;), but could
probably function well in other environments requiring a light GUI, such as an
old laptop, or an internet kiosk. It is based upon &qt;/Embedded from Trolltech,
which is in turn a graphical environment designed for embedded applications,
based upon the &qt; toolkit.
</para>
<para>
&opie; has been designed for devices with small screens, and a touchscreen input
device (ie, only one mouse click, and no constant mouse position), as well as
designed to fit in a relatively small amount of storage space (about 5 megabytes
for the base libraries and the launcher).
</para>
</chapter>