summaryrefslogtreecommitdiff
path: root/docs
authorspiralman <spiralman>2002-07-28 18:09:37 (UTC)
committer spiralman <spiralman>2002-07-28 18:09:37 (UTC)
commit07be2f810ca33e1ac43a4a1491da478cf32f9524 (patch) (unidiff)
treeb8900ea1b0ec015837c62cd61e209d71d3c8f482 /docs
parent6a3b966adbe2a77762fb544baeadb218aff296ff (diff)
downloadopie-07be2f810ca33e1ac43a4a1491da478cf32f9524.zip
opie-07be2f810ca33e1ac43a4a1491da478cf32f9524.tar.gz
opie-07be2f810ca33e1ac43a4a1491da478cf32f9524.tar.bz2
replaced all remaining latex markup with docbook markup. fixed display of menu entries. other minor corrections.
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/usermanual.sgm194
1 files changed, 72 insertions, 122 deletions
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index bfa09fb..0232cd3 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,2 +1,4 @@
1<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN"> 1<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN" [
2<!ENTITY arrow "-->">
3]>
2<book><title>Opie User Manual</title> 4<book><title>Opie User Manual</title>
@@ -7,5 +9,5 @@ Opie is a GUI (Graphical User Interface) for the Linux operating system (and
7might work on other OSes as well). It was originally designed for handheld 9might work on other OSes as well). It was originally designed for handheld
8computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but which could 10computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could
9probably function well in other environments requiring a light GUI, such as an 11probably function well in other environments requiring a light GUI, such as an
10old laptop, or an internet kiosk. It is bassed upon QT/Embedded from Trolltech, 12old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech,
11which is in turn a graphical environment designed for embedded applications, 13which is in turn a graphical environment designed for embedded applications,
@@ -32,5 +34,5 @@ not install X, as it is not necessary, and will only take up space).
32<para> 34<para>
33Note: If you had qpe/qtopia installed previously, \emph{completely} remove it, 35If you had qpe/qtopia installed previously,
34and remove the src line for it from your /etc/ipkg.conf file before attempting 36<emphasis>completely</emphasis> remove it, and remove the src line for it from
35to install opie. 37your /etc/ipkg.conf file before attempting to install opie.
36</para> 38</para>
@@ -72,4 +74,2 @@ application in the Settings tab, or run ipkg from the command line to install
72other Opie apps. Check out the various task-opie-* ipkgs to install various sets 74other Opie apps. Check out the various task-opie-* ipkgs to install various sets
73
74
75of apps at once (you can always uninstall individual apps individually). You 75of apps at once (you can always uninstall individual apps individually). You
@@ -84,4 +84,2 @@ To completely install Opie on the Zaurus, you will have to install OpenZaurus,
84which includes Opie. However, individual Opie applications will work fine on the 84which includes Opie. However, individual Opie applications will work fine on the
85
86
87default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM 85default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM
@@ -106,4 +104,2 @@ icon or button you want to click on. The main difference between using the
106stylus and using a mouse is that you cannot right click with a stylus, so things 104stylus and using a mouse is that you cannot right click with a stylus, so things
107
108
109that require a right click are kept to a minimum. However, it is sometimes 105that require a right click are kept to a minimum. However, it is sometimes
@@ -119,5 +115,3 @@ click usually does on a desktop interface.
119<para> 115<para>
120The Launcher behaves like the "desktop" on most PC GUIs. When no applications 116The Launcher behaves like the "desktop" on most PC GUIs. When no applications
121
122
123are running or visible, you will have access to the Launcher. You can also map 117are running or visible, you will have access to the Launcher. You can also map
@@ -130,4 +124,2 @@ Along the top of the Launcher you will see a list of tabs which function as
130categories for your applications. You can click on the tab for the category you 124categories for your applications. You can click on the tab for the category you
131
132
133want to view, and then click on the icon for the application that you wish to 125want to view, and then click on the icon for the application that you wish to
@@ -136,4 +128,2 @@ you install any games, they will appear in the Games tab). When new
136applications are installed, they will usually appear in one of these three tabs, 128applications are installed, they will usually appear in one of these three tabs,
137
138
139or in a tab of their own. To add or delete tabs or to move applications between 129or in a tab of their own. To add or delete tabs or to move applications between
@@ -145,6 +135,4 @@ There is also a tab to the far right called the "Documents" tab, which allows
145you to quickly open your most often used documents. You can click on a document 135you to quickly open your most often used documents. You can click on a document
146
147
148to open it up in the proper application. For help on adding files to the 136to open it up in the proper application. For help on adding files to the
149Documents tab see \ref{docadd} on page \pageref{docadd} 137Documents tab see the <xref linkend="adddoc">.
150</para> 138</para>
@@ -188,4 +176,2 @@ the "x" will cancel them before closing the window (for people used to most
188desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons 176desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons
189
190
191you would normally see in the bottom right of the dialog window). 177you would normally see in the bottom right of the dialog window).
@@ -212,4 +198,2 @@ will upgrade Opie. However, if you currently have a version with the 1.5.0
212version number, you will have to upgrade it differently, because Opie now uses a 198version number, you will have to upgrade it differently, because Opie now uses a
213
214
215different version number (the 1.5.0 was Qtopia's version number, we now use our 199different version number (the 1.5.0 was Qtopia's version number, we now use our
@@ -237,4 +221,5 @@ work for, etc.
237<para> 221<para>
238To Add a user, go to <GUImenu>Contact</GUImenu><GUIMenuItem>Add</GUIMenuItem>, 222To Add a user, go to
239or click the add icon in the toolbar (looks like a blank piece of paper). 223<GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>,
224or click the add icon in the toolbar (looks like a blank piece of paper).
240First, you need to give the person a name. You can do this by either entering 225First, you need to give the person a name. You can do this by either entering
@@ -270,6 +255,6 @@ edit their profile later), click the "x" to cancel, and not add the contact.
270To edit the contacts, select the person you want to edit, anc click the pencil 255To edit the contacts, select the person you want to edit, anc click the pencil
271icon, or go to <GUIMenu>Contact</GUIMenu><GUIMenuItem>Edit</GUIMenuItem>, and it 256icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>,
272will open up the same dialog used to add a user, except their information that 257and it will open up the same dialog used to add a user, except their information
273is already entered will already be filled in. To finalise the changes, click 258that is already entered will already be filled in. To finalise the changes,
274"Ok", or to cancel them, click "x". 259click "Ok", or to cancel them, click "x".
275</para> 260</para>
@@ -280,7 +265,5 @@ is already entered will already be filled in. To finalise the changes, click
280To delete a contact, select the person from the list of contacts, and click the 265To delete a contact, select the person from the list of contacts, and click the
281trash can icon, or go to Contact \begin{math}\rightarrow\end{math}Delete. A 266trash can icon, or go to <GUIMenu>Contact</GUIMenu>
282dialog will pop up asking if you want to actually delete that contact, click yes 267&arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you
283 268want to actually delete that contact, click yes to delete it, no will cancel.
284
285to delete it, no will cancel.
286</para> 269</para>
@@ -291,12 +274,12 @@ to delete it, no will cancel.
291To find a specific person, click the find icon (green magnifying glass), or go 274To find a specific person, click the find icon (green magnifying glass), or go
292to <GUIMenu>Contact</GUIMenu><GUIMenuItem>Find</GUIMenuItem>. A dialog will pop 275to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog
293up, and in the "Find what" input, enter the string you want to search for. You 276will pop up, and in the "Find what" input, enter the string you want to search
294can also select if you want the search to be case sensative, and if you want it 277for. You can also select if you want the search to be case sensative, and if you
295to search backwards from the currently selected user. The Category drop down 278want it to search backwards from the currently selected user. The Category drop
296menu lets you search only a specific category ("All" to search all of them). 279down menu lets you search only a specific category ("All" to search all of
297When you click "Find", it will start search for the string in all the fields 280them). When you click "Find", it will start search for the string in all the
298in all the contacts. When it finds a match, it will highlight the user in the 281fields in all the contacts. When it finds a match, it will highlight the user in
299main view. You can use this to search for (as an example) who a certain phone 282the main view. You can use this to search for (as an example) who a certain
300number belongs to, by entering the phone number in the "find what" field, and 283phone number belongs to, by entering the phone number in the "find what" field,
301clicking "Find". 284and clicking "Find".
302</para> 285</para>
@@ -349,4 +332,2 @@ represent the days of the current week, and on the left and right sides of the
349navigation bar are arrows, which allow you to move one day in that direction. If 332navigation bar are arrows, which allow you to move one day in that direction. If
350
351
352you are on the last day of the week, pressing the arrow will bring you into the 333you are on the last day of the week, pressing the arrow will bring you into the
@@ -360,4 +341,2 @@ hour. If you select one, any new appointments will automatically default to
360begining at that time and ending an hour later (which you can, of course, change 341begining at that time and ending an hour later (which you can, of course, change
361
362
363when you create the appointment). 342when you create the appointment).
@@ -377,4 +356,2 @@ each day of the week, and rows, representing each hour of the day. In the
377navigation bar at the top, there are two scroll boxes, the one on the left shows 356navigation bar at the top, there are two scroll boxes, the one on the left shows
378
379
380the current year, and the one to the right shows which week it is of that year. 357the current year, and the one to the right shows which week it is of that year.
@@ -388,5 +365,3 @@ see a blue square which represents an appointment, which you can press to see
388details of the appointment. If you press anywhere in the free space, you will go 365details of the appointment. If you press anywhere in the free space, you will go
389 366to the day of the column that you clicked in.
390
391to the day of the column that you clicked in.
392</para> 367</para>
@@ -400,4 +375,2 @@ between them. This is convinient if you need to see a list of all your
400appointments, but do not need to see how your time is mapped out. The navigation 375appointments, but do not need to see how your time is mapped out. The navigation
401
402
403bar has an arrow button on either side, allowing you to move to the next or 376bar has an arrow button on either side, allowing you to move to the next or
@@ -406,4 +379,2 @@ year. Pressing the week number button will bring up a calendar dialog, which
406allows you to select the week you are viewing. Selecting a day from the calendar 379allows you to select the week you are viewing. Selecting a day from the calendar
407
408
409will bring you to the week that day is in. To the right of that is a button with 380will bring you to the week that day is in. To the right of that is a button with
@@ -419,9 +390,5 @@ itself will bring you to the day view for that day. Under each day is a list of
419all the appointments for that day, as well as their start times. If you click on 390all the appointments for that day, as well as their start times. If you click on
420
421
422an appointment, you will go to an edit dialog for that appointment, which lets 391an appointment, you will go to an edit dialog for that appointment, which lets
423you view its details. Next to each day heading is a "+" sign, clicking it will 392you view its details. Next to each day heading is a "+" sign, clicking it will
424 393create a new appointment for that day.
425
426create a new appointment for that day.
427</para> 394</para>
@@ -432,8 +399,4 @@ create a new appointment for that day.
432The month view looks like a normal monthly calendar, allowing you to see on what 399The month view looks like a normal monthly calendar, allowing you to see on what
433
434
435days of the month you have appointments. In the navigation bar, there are two 400days of the month you have appointments. In the navigation bar, there are two
436pairs of arrows. The pair with an arrow and a vertical line will take you to the 401pairs of arrows. The pair with an arrow and a vertical line will take you to the
437
438
439first or last month of the currently selected year, while the normal arrow 402first or last month of the currently selected year, while the normal arrow
@@ -446,4 +409,2 @@ The main view is divided up into a grid, where the columns are the days of the
446week, and the rows are the weeks (just like an ordinary calendar). The currently 409week, and the rows are the weeks (just like an ordinary calendar). The currently
447
448
449selected day has a bold box drawn around it, and if the day has an appointment, 410selected day has a bold box drawn around it, and if the day has an appointment,
@@ -461,4 +422,2 @@ day.
461To add an appointment, click on the add appointment button in the toolbar at the 422To add an appointment, click on the add appointment button in the toolbar at the
462
463
464top of the window (an image of a blank page), and a dialog will open up, 423top of the window (an image of a blank page), and a dialog will open up,
@@ -472,4 +431,2 @@ short description of the appointment, or select a common one from the dropdown
472list. The location field allows you to do the same. The category dropdown allows 431list. The location field allows you to do the same. The category dropdown allows
473
474
475you to assign the appointment to a category, which you can use later to view 432you to assign the appointment to a category, which you can use later to view
@@ -487,4 +444,2 @@ minutes field for the start time, it will automatically set the minutes field
487for the end time to the same thing, but you can change this by selecting the end 444for the end time to the same thing, but you can change this by selecting the end
488
489
490field and giving it its own minutes field. Because of this, it is fastest to set 445field and giving it its own minutes field. Because of this, it is fastest to set
@@ -500,8 +455,4 @@ and then set the number of minutes before the appointment that you want the
500alarm to sound. If you set the dropdown list next to that to "silent" you will 455alarm to sound. If you set the dropdown list next to that to "silent" you will
501
502
503only be given a visual alarm, wheras if you set the alarm to "Loud", there 456only be given a visual alarm, wheras if you set the alarm to "Loud", there
504will be an alarm sound as well. Note: opie-alarm must be installed for alarms to 457will be an alarm sound as well. Note: opie-alarm must be installed for alarms to
505
506
507work. 458work.
@@ -515,4 +466,2 @@ interface below, to represent the available options for that type of repetition
515want it). When you are done, click "ok" in the upper right to select that type 466want it). When you are done, click "ok" in the upper right to select that type
516
517
518of repetition, or "x" to set it back to what it was (none if it is a new 467of repetition, or "x" to set it back to what it was (none if it is a new
@@ -561,16 +510,17 @@ a certain time.
561<para> 510<para>
562Go to Data \begin{math}\rightarrow\end{math}New Task, or click on the new task 511Go to <GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>New Task<GUIMenuItem>, or click
563icon (blank page). The priority drop down menu lets you select the priority of 512on the new task icon (blank page). The priority drop down menu lets you select
564the task. The lower the number, the more important it is. The categories behave 513the priority of the task. The lower the number, the more important it is. The
565in much the same way that they do in Calendar, you can select the category from 514categories behave in much the same way that they do in Calendar, you can select
566the drop down menu, or you can click the "..." button to add, delete, or edit 515the category from the drop down menu, or you can click the "..." button to add,
567categories. To give the task a due date, check the "Due" checkbox, and then 516delete, or edit categories. To give the task a due date, check the "Due"
568click the button next to it (it should contain the current date). That will open 517checkbox, and then click the button next to it (it should contain the current
569a calendar from which you can select the due date. The "Completed" check box 518date). That will open a calendar from which you can select the due date. The
570is the same as the checkbox next to each item in the main view. The "Summary" 519"Completed" check box is the same as the checkbox next to each item in the main
571field is for a short summary that will be visible in the main view, as well as 520view. The "Summary" field is for a short summary that will be visible in the
572in the Today application. The down arrow next to it will copy the text in the 521main view, as well as in the Today application. The down arrow next to it will
573"Summary" field into the large text field below it, which is used for a more 522copy the text in the "Summary" field into the large text field below it, which
574detailed description of the task. Click "ok" in the upper right to add the 523is used for a more detailed description of the task. Click "ok" in the upper
575new task, or "x" to close the window without adding the new task. 524right to add the new task, or "x" to close the window without adding the new
525task.
576</para> 526</para>
@@ -580,3 +530,3 @@ new task, or "x" to close the window without adding the new task.
580To edit a task, you can select it, and then go to 530To edit a task, you can select it, and then go to
581<GUIMenu>Data</GUIMenu><GUIMenuItem>Edit 531<GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>Edit
582Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same 532Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same
@@ -592,3 +542,3 @@ the way it was.
592To delete a task, first select it, and then either select 542To delete a task, first select it, and then either select
593<GUIMenu>Data</GUIMenu> 543<GUIMenu>Data</GUIMenu>&arrow;
594<GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of 544<GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of
@@ -601,13 +551,12 @@ click yes to delete it, or no to cancel.
601To find a task, either go to 551To find a task, either go to
602<GUIMenu>Options</GUIMenu><GUIMenuItem>Find</GUIMenuItem> 552<GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>
603, or 553, or click the find icon (an image of a green magnifying glass), and a dialog
604click the find icon (an image of a green magnifying glass), and a dialog should 554should pop up. Enter the text you want to search for in the description, and
605pop up. Enter the text you want to search for in the description, and select the 555select the category that you want it to search through (this will speed the
606category that you want it to search through (this will speed the search up, if 556search up, if you know what category it is in). You can also select "case
607you know what category it is in). You can also select "case sensative" which 557sensative" which makes the search pay attention to the case of what you type (so
608makes the search pay attention to the case of what you type (so if you look for 558if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search
609"mow lawn", it won't find a task called "Mow lawn"). "Search Backwards" 559Backwards" will search backwards from the currently selected task. Click "Find"
610will search backwards from the currently selected task. Click "Find" to 560to initiate the search, when it finds a task that matches the string, it will
611initiate the search, when it finds a task that matches the string, it will 561select it. If you click Find again, it will find the next one in the list (or
612select it. If you click Find again, it will find the next one in the list (or
613the previous one, if "Search backwards" is selected). 562the previous one, if "Search backwards" is selected).
@@ -629,3 +578,3 @@ To mark a task as completed without deleting it, you can either check the
629checkbox next to it in the main view, or edit it, and check the "completed" 578checkbox next to it in the main view, or edit it, and check the "completed"
630check box in the edit dialog. If <GUIMenu>Options</GUIMenu> 579check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow;
631<GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will 580<GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will
@@ -717,3 +666,3 @@ is actually a text file).
717 666
718<section><title>Adding to "Documents"</title> 667<section id="adddoc"><title>Adding to "Documents"</title>
719<para> 668<para>
@@ -753,4 +702,5 @@ not go into much detail on using the linux command line, as that is covered in
753many other places (http://www.tldp.org is a good place to start, or read 702many other places (http://www.tldp.org is a good place to start, or read
754O'Reilly's \underline{Running Linux} for a comprehensive look at Linux for the 703O'Reilly's <citation>Running Linux</citation> for a comprehensive look at Linux
755beginner). I will, however, give a quick overview of using a Linux shell. 704for the beginner). I will, however, give a quick overview of using a Linux
705shell.
756</para> 706</para>
@@ -794,3 +744,3 @@ The command list is a pulldown menu with a list of commonly used commands.
794Selecting one will type the command into the terminal wherever the cursor is. 744Selecting one will type the command into the terminal wherever the cursor is.
795You can edit or hide this menu from <GUIMenu>Options</GUIMenu> 745You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow;
796<GUIMenuItem>Command List.</GUIMenuItem> 746<GUIMenuItem>Command List.</GUIMenuItem>
@@ -875,6 +825,6 @@ directory (usually /home/username or /root for the root user).
875To move files around, you need to use the "cp" (copy) and "mv" (move) 825To move files around, you need to use the "cp" (copy) and "mv" (move)
876commands. Both of these are run the same way: \verb+command originalfile 826commands. Both of these are run the same way: <userinput>command originalfile
877newfile+. The only difference is that cp creates a new file without touching 827newfile</userinput>. The only difference is that cp creates a new file without
878the old one, while mv deletes the original file. The two path names can be 828touching the old one, while mv deletes the original file. The two path names
879either absolute or relative. If you only specify a directory for the 829can be either absolute or relative. If you only specify a directory for the
880destination, and no filename, it will use the filename for the original file. 830destination, and no filename, it will use the filename for the original file.
@@ -922,3 +872,3 @@ install an ipkg package file that resides on the local filesystem.
922<para> 872<para>
923Note: There is a bug in oipkg that prevents it from installing packages 873There is a bug in oipkg that prevents it from installing packages
924properly. There is, however, a workaround for it. Simply run oipkg from 874properly. There is, however, a workaround for it. Simply run oipkg from
@@ -930,3 +880,3 @@ Embedded Konsole to avoid the bug.
930<para> 880<para>
931To install software, first select "Opie" from the "Section" pulldown menu, 881To install software, first select "Opie" from the "Section" pulldown menu,
932the press the "+" icon next to "Feeds" in the main view. This will show all 882the press the "+" icon next to "Feeds" in the main view. This will show all