| -rw-r--r-- | docs/usermanual/usermanual.sgm | 5 |
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,210 +1,213 @@ <!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [ <!ENTITY arrow "-->"> ]> <book><title>Opie User Manual</title> +<bookinfo><authorgroup><collab> +<collabname>The Opie Team</collabname> +</collab></authorgroup></bookinfo> <part><title>Getting Started</title> <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 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 +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> <chapter><title>Installation</title> <section><title>iPAQ</title> <para> 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 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: <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> <para> 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 though. </para> </section> </chapter> <chapter><title>Using Opie</title> <para> Now that Opie is installed and running, it's time to start using it. When you first start Opie, you will see the "Launcher" from which you can start all of your Applications, and the "Taskbar" along the bottom, where you can see all the running applications, select an input method, and interact with the installed "applets". </para> <section><title>Getting Around</title> <para> Getting around in Opie is very easy, you simply click your stylus on whatever icon or button you want to click on. The main difference between using the stylus and using a mouse is that you cannot right click with a stylus, so things that require a right click are kept to a minimum. However, it is sometimes necessary to right click, and this is implemented with a "press and hold". Any time you want to do something that you think would require a right click on a normal pc, try pressing the stylus down and holding it still for a few seconds. This usually opens up a context sensative menu, much like a right click usually does on a desktop interface. </para> </section> <section><title>Launcher</title> <para> The Launcher behaves like the "desktop" on most PC GUIs. When no applications are running or visible, you will have access to the Launcher. You can also map a hardware key to bring the Launcher to the top without closing any of the running applications (this is similar to "minimising" all the applications that are running). </para> <para> Along the top of the Launcher you will see a list of tabs which function as categories for your applications. You can click on the tab for the category you want to view, and then click on the icon for the application that you wish to launch. By default, there will be an Applications tab and a Settings tab (if you install any games, they will appear in the Games tab). When new applications are installed, they will usually appear in one of these three tabs, or in a tab of their own. To add or delete tabs or to move applications between the tabs, you can use the Tab Manager application, or you can edit them by hand, by changing the directories in /opt/QtPalmtop/apps. </para> <para> There is also a tab to the far right called the "Documents" tab, which allows you to quickly open your most often used documents. You can click on a document to open it up in the proper application. For help on adding files to the Documents tab see the <xref linkend="adddoc">. </para> </section> <section><title>Taskbar</title> <para> Opie has a "Taskbar" that always runs along the bottom of the screen in Opie, except for a few "fullscreen" applications that cover it up. The Taskbar is what lets you select which input method you would like to use, shows what applications are running, and is also where the "applets" draw their icons. On the left of the Taskbar is an "O" button that opens a menu which has an entry for every tab in the Launcher, allowing you to star an applications without going back to the Launcher, or quiting the application that you are running. On the right hand side of the Taskbar, you will probably see a clock (unless you installed task-opie-minimal), which is actually just another applet that draws the time instead of an icon. </para> <para> When an application is run, it adds its icon to the Taskbar, starting from the right side of the input method icon, with new application's icons appearing to the right. If you click on the icon for an application, it will be brought to the screen, allowing you to interact with it. </para> <para> To the right of the "O" menu you will see an icon for the currently selected input method. Clicking this will bring up the input method, allowing you to type into the currently running application. To the right of the input method icon is a small arrow pointing up, which will open a menu of all the currently installed input methods when clicked. When you select one of these, it will become the current input method, with its icon replacing the previous one. </para> </section> <section><title>Dialogs</title> <para> In Opie, dialogs, as well as some applications, have a button labeled "Ok" on the right side of the window title bar, in addition to the normal "x". For dialogs, the "Ok" button will apply your changes and close the window, while the "x" will cancel them before closing the window (for people used to most desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons you would normally see in the bottom right of the dialog window). </para> <para> For applications that have an "Ok" button as well as the "x" button that all applications have, the "Ok" button will usually save the current file and then close the application, while the "x" button will close the application without saving. </para> </section> </chapter> <chapter><title>Upgrading</title> <para> First, you should shutdown Opie from the "Shutdown" app in the Settings tab. Normally, simply running <informalexample> <literallayout> ipkg update && ipkg upgrade </literallayout> </informalexample> will upgrade Opie. However, if you currently have a version with the 1.5.0 version number, you will have to upgrade it differently, because Opie now uses a different version number (the 1.5.0 was Qtopia's version number, we now use our own). To upgrade from one of these older versions, run: <informalexample> <literallayout> ipkg update ipkg install opie-update </literallayout> </informalexample> Opie should then be upgraded. </para> </chapter> </part> |