summaryrefslogtreecommitdiff
path: root/docs/usermanual/usermanual.sgm
Unidiff
Diffstat (limited to 'docs/usermanual/usermanual.sgm') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/usermanual.sgm921
1 files changed, 20 insertions, 901 deletions
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index f691889..8ad298e 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,915 +1,34 @@
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">
4<!ENTITY installation SYSTEM "installation.sgm">
5<!ENTITY gettingaround SYSTEM "gettingaround.sgm">
6<!ENTITY upgrading SYSTEM "upgrading.sgm">
7<!ENTITY contacts SYSTEM "contacts.sgm">
8<!ENTITY calendar SYSTEM "calendar.sgm">
9<!ENTITY todo SYSTEM "todo.sgm">
10<!ENTITY filemanager SYSTEM "filemanager.sgm">
11<!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm">
12<!ENTITY software SYSTEM "software.sgm">
3]> 13]>
4<book><title>Opie User Manual</title> 14<book><title>Opie User Manual</title>
5<bookinfo><authorgroup><collab> 15<bookinfo><authorgroup><collab>
6<collabname>The Opie Team</collabname> 16<collabname>The Opie Team</collabname>
7</collab></authorgroup></bookinfo> 17</collab></authorgroup></bookinfo>
8<part><title>Getting Started</title> 18<part><title>Getting Started</title>
9<chapter><title>What is Opie?</title> 19&whatis;
10<para> 20&installation;
11Opie is a GUI (Graphical User Interface) for the Linux operating system (and 21&gettingaround;
12might work on other OSes as well). It was originally designed for handheld 22&upgrading;
13computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could
14probably function well in other environments requiring a light GUI, such as an
15old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech,
16which is in turn a graphical environment designed for embedded applications,
17based upon the QT toolkit.
18</para>
19<para>
20Opie has been designed for devices with small screens, and a touchscreen input
21device (ie, only one mouse click, and no constant mouse position), as well as
22designed to fit in a relatively small amount of storage space (about 5 megabytes
23for the base libraries and the launcher).
24</para>
25</chapter>
26<chapter><title>Installation</title>
27<section><title>iPAQ</title>
28<para>
29To install opie on an iPAQ, you will need a fresh Familiar installation (ie,
30install Familiar, and stop before you do ipkg install task-complete or ipkg
31install task-x), go to http://familiar.handhelds.org to get the latest version,
32and to get installation instructions (again, stop after the initial boot and do
33not install X, as it is not necessary, and will only take up space).
34</para>
35
36<note>
37<para>
38If you had qpe/qtopia installed previously,
39<emphasis>completely</emphasis> remove it, and remove the src line for it from
40your /etc/ipkg.conf file before attempting to install opie.
41</para>
42</note>
43<para>
44Once you have Familiar installed, set up a network connection between your iPAQ
45and the ouside world (again, see the Familiar site for instructions on this),
46and then run this command:
47<informalexample>
48<literallayout>
49 echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \
50 >> /etc/ipkg.conf
51</literallayout>
52</informalexample>
53then, run:
54<informalexample>
55<literallayout>
56 ipkg update && ipkg install task-opie
57</literallayout>
58</informalexample>
59If you have a 3100 or 3800 series iPAQ, run:
60<informalexample>
61<literallayout>
62 ipkg install qt-embedded-rotation
63</literallayout>
64</informalexample>
65finally, start Opie with:
66<informalexample>
67<literallayout>
68 /etc/init.d/opie start
69</literallayout>
70</informalexample>
71</para>
72
73<para>
74Opie should now be running (if you should have to reboot, which is rare, Opie
75will start automatically). From here, you can use either the "Software"
76application in the Settings tab, or run ipkg from the command line to install
77other Opie apps. Check out the various task-opie-* ipkgs to install various sets
78of apps at once (you can always uninstall individual apps individually). You
79will probably want to install opie-embeddedkonsole first, so you have access to
80the command line in Opie.
81</para>
82</section>
83
84<section><title>Zaurus</title>
85<para>
86To completely install Opie on the Zaurus, you will have to install OpenZaurus,
87which includes Opie. However, individual Opie applications will work fine on the
88default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM
89though.
90</para>
91</section>
92</chapter>
93
94<chapter><title>Using Opie</title>
95<para>
96Now that Opie is installed and running, it's time to start using it. When you
97first start Opie, you will see the "Launcher" from which you can start all of
98your Applications, and the "Taskbar" along the bottom, where you can see all
99the running applications, select an input method, and interact with the
100installed "applets".
101</para>
102
103<section><title>Getting Around</title>
104<para>
105Getting around in Opie is very easy, you simply click your stylus on whatever
106icon or button you want to click on. The main difference between using the
107stylus and using a mouse is that you cannot right click with a stylus, so things
108that require a right click are kept to a minimum. However, it is sometimes
109necessary to right click, and this is implemented with a "press and hold".
110Any time you want to do something that you think would require a right click on
111a normal pc, try pressing the stylus down and holding it still for a few
112seconds. This usually opens up a context sensative menu, much like a right
113click usually does on a desktop interface.
114</para>
115</section>
116
117<section><title>Launcher</title>
118<para>
119The Launcher behaves like the "desktop" on most PC GUIs. When no applications
120are running or visible, you will have access to the Launcher. You can also map
121a hardware key to bring the Launcher to the top without closing any of the
122running applications (this is similar to "minimising" all the applications
123that are running).
124</para>
125<para>
126Along the top of the Launcher you will see a list of tabs which function as
127categories for your applications. You can click on the tab for the category you
128want to view, and then click on the icon for the application that you wish to
129launch. By default, there will be an Applications tab and a Settings tab (if
130you install any games, they will appear in the Games tab). When new
131applications are installed, they will usually appear in one of these three tabs,
132or in a tab of their own. To add or delete tabs or to move applications between
133the tabs, you can use the Tab Manager application, or you can edit them by hand,
134by changing the directories in /opt/QtPalmtop/apps.
135</para>
136<para>
137There is also a tab to the far right called the "Documents" tab, which allows
138you to quickly open your most often used documents. You can click on a document
139to open it up in the proper application. For help on adding files to the
140Documents tab see the <xref linkend="adddoc">.
141</para>
142</section>
143
144<section><title>Taskbar</title>
145<para>
146Opie has a "Taskbar" that always runs along the bottom of the screen in Opie,
147except for a few "fullscreen" applications that cover it up. The Taskbar is
148what lets you select which input method you would like to use, shows what
149applications are running, and is also where the "applets" draw their icons.
150On the left of the Taskbar is an "O" button that opens a menu which has an
151entry for every tab in the Launcher, allowing you to star an applications
152without going back to the Launcher, or quiting the application that you are
153running. On the right hand side of the Taskbar, you will probably see a clock
154(unless you installed task-opie-minimal), which is actually just another applet
155that draws the time instead of an icon.
156</para>
157<para>
158When an application is run, it adds its icon to the Taskbar, starting from the
159right side of the input method icon, with new application's icons appearing to
160the right. If you click on the icon for an application, it will be brought to
161the screen, allowing you to interact with it.
162</para>
163<para>
164To the right of the "O" menu you will see an icon for the currently selected
165input method. Clicking this will bring up the input method, allowing you to
166type into the currently running application. To the right of the input method
167icon is a small arrow pointing up, which will open a menu of all the currently
168installed input methods when clicked. When you select one of these, it will
169become the current input method, with its icon replacing the previous one.
170</para>
171</section>
172
173<section><title>Dialogs</title>
174<para>
175In Opie, dialogs, as well as some applications, have a button labeled "Ok" on
176the right side of the window title bar, in addition to the normal "x". For
177dialogs, the "Ok" button will apply your changes and close the window, while
178the "x" will cancel them before closing the window (for people used to most
179desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons
180you would normally see in the bottom right of the dialog window).
181</para>
182<para>
183For applications that have an "Ok" button as well as the "x" button that all
184applications have, the "Ok" button will usually save the current file and then
185close the application, while the "x" button will close the application without
186saving.
187</para>
188</section>
189</chapter>
190
191<chapter><title>Upgrading</title>
192<para>
193First, you should shutdown Opie from the "Shutdown" app in the Settings tab.
194Normally, simply running
195<informalexample>
196<literallayout>
197 ipkg update && ipkg upgrade
198</literallayout>
199</informalexample>
200will upgrade Opie. However, if you currently have a version with the 1.5.0
201version number, you will have to upgrade it differently, because Opie now uses a
202different version number (the 1.5.0 was Qtopia's version number, we now use our
203own). To upgrade from one of these older versions, run:
204<informalexample>
205<literallayout>
206 ipkg update
207 ipkg install opie-update
208</literallayout>
209</informalexample>
210Opie should then be upgraded.
211</para>
212</chapter>
213</part> 23</part>
214
215<part><title>Applications</title> 24<part><title>Applications</title>
216<chapter><title>Contacts</title> 25&contacts;
217<para> 26&calendar;
218Contacts is a way to keep track of all the people you know, and how to contact 27&todo;
219them. as well as other information, such as their birthday, the company they 28&filemanager;
220work for, etc. 29&embeddedkonsole;
221<para>
222
223<section><title>Adding Contacts</title>
224<para>
225To Add a user, go to
226<GUImenu>Contact</GUImenu>&arrow;<GUIMenuItem>Add</GUIMenuItem>,
227or click the add icon in the toolbar (looks like a blank piece of paper).
228First, you need to give the person a name. You can do this by either entering
229their name in the name field, or by pressing "Full Name...", which will open
230up a new dialog that lets you enter each part of their name individually. Three
231of the entry fields have pulldown menus instead of labels that let you set which
232parameter these input fields control. The File As field lets you control how
233their name is displayed in the main view, use the pulldown arrow to select from
234some common ways of ordering their first and last names, or type in a custom
235one. You can also select a category for the user to be filed under, and clicking
236the button labeled "..." lets you edit the available catagories (these are
237convinient for displaying just the contacts you want when you have a lot of
238them).
239</para>
240<para>
241The address tab lets you edit the contact's buisness and home addresses (select
242which one you want to change from the pulldown menu at the top). The bottom
243field behaves just like the three custom fields in the "General" tab (and if
244you select the same thing from the pulldown list, it will modify the same
245parameter).
246</para>
247<para>
248The Details tab is used for miscelaneous things like the person's position, the
249name of their spouse, etc.
250</para>
251<para>
252When you are done, click "Ok" in the top right of the screen (you can always
253edit their profile later), click the "x" to cancel, and not add the contact.
254</para>
255</section>
256<section><title>Editing Contacts</title>
257<para>
258To edit the contacts, select the person you want to edit, anc click the pencil
259icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>,
260and it will open up the same dialog used to add a user, except their information
261that is already entered will already be filled in. To finalise the changes,
262click "Ok", or to cancel them, click "x".
263</para>
264</section>
265
266<section><title>Deleting Contacts</title>
267<para>
268To delete a contact, select the person from the list of contacts, and click the
269trash can icon, or go to <GUIMenu>Contact</GUIMenu>
270&arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you
271want to actually delete that contact, click yes to delete it, no will cancel.
272</para>
273</section>
274
275<section><title>Editing Contacts</title>
276<para>
277To find a specific person, click the find icon (green magnifying glass), or go
278to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog
279will pop up, and in the "Find what" input, enter the string you want to search
280for. You can also select if you want the search to be case sensative, and if you
281want it to search backwards from the currently selected user. The Category drop
282down menu lets you search only a specific category ("All" to search all of
283them). When you click "Find", it will start search for the string in all the
284fields in all the contacts. When it finds a match, it will highlight the user in
285the main view. You can use this to search for (as an example) who a certain
286phone number belongs to, by entering the phone number in the "find what" field,
287and clicking "Find".
288</para>
289</section>
290
291<section><title>Viewing Contacts</title>
292<para>
293To view only the contacts in a certain category, go to the View menu, and check
294the categories you want to view.
295</para>
296<para>
297The list of letters on the bottom of the window lets you look at only the
298contacts who's names begin with that letter. These work much like entering text
299on a mobile phone. For example, to view all the contacts whos name starts with
300"B", press the "ABC" group twice (since "B" is the second letter in that
301group). To go back to displaying all of the letters, click it two more times
302(pressing it four times brings you back to all the letters, so you pressed it 2
303times to get to "B" and 2 more times to get back to all letters. 2+2=4).
304</para>
305</section>
306
307<section><title>Personal Details</title>
308<para>
309Change your personal details by going to <GUIMenu>Contact </GUIMenu>
310<GUIMenuItem>My Personal Details</GUIMenuItem>. This is used in today to
311display who the device belongs to, as well as other apps.
312</para>
313</section>
314</chapter>
315
316<chapter><title>Calendar</title>
317<para>
318The Calendar is a way to keep track of all your appointments, birthdays,
319meetings, or any other event that you would put in a calendar.
320</para>
321
322<section><title>Navigation</title>
323<para>
324Navigation in the Calendar is simple. Along the top are five different buttons
325that allow you to set the type of view, which correspond to the five items in
326the "View" menu. Each one (except for "Today") changes the amount of time
327shown on the screen. "Day" shows one day, "Week" one week, etc. Today is the
328same as Day, except that it automatically sets the view to the current day.
329</para>
330<section><title>The Day view</title>
331<para>
332The day view shows your day divided up into blocks representing each hour. At
333the top is the navigation bar, wher you will see a row of buttons, which
334represent the days of the current week, and on the left and right sides of the
335navigation bar are arrows, which allow you to move one day in that direction. If
336you are on the last day of the week, pressing the arrow will bring you into the
337first day of the next week (or vice-versa if you are going backwards). There is
338also a button that lists the current day, which you can press to select a day to
339view from a calendar dialog.
340</para>
341<para>
342In the main view, there is a collumn of buttons, each of which represents one
343hour. If you select one, any new appointments will automatically default to
344begining at that time and ending an hour later (which you can, of course, change
345when you create the appointment).
346</para>
347<para>
348Clicking on an appointment will open a menu that lets you edit, delete or beam
349the appointment. Beam will beam the appointment to any device supporting the
350Obex protocol (PalmOS based devices, cellphones, etc). libopieobex must be
351installed to use this feature.
352</para>
353</section>
354
355<section><title>The Week View</title>
356<para>
357The week view allows you to see your week divided up into columns, representing
358each day of the week, and rows, representing each hour of the day. In the
359navigation bar at the top, there are two scroll boxes, the one on the left shows
360the current year, and the one to the right shows which week it is of that year.
361To the right of both of those is a label which shows the date range for the
362currently selected week.
363</para>
364<para>
365In the main view, you see the week divided up into rows and collumns
366representing the days of the week, and hours of the day. In each cell, you will
367see a blue square which represents an appointment, which you can press to see
368details of the appointment. If you press anywhere in the free space, you will go
369to the day of the column that you clicked in.
370</para>
371</section>
372
373<section><title>The Week List View</title>
374<para>
375The week list view shows you all the appointments that you have that week
376without graphically representing how long they are or showing the free time
377between them. This is convinient if you need to see a list of all your
378appointments, but do not need to see how your time is mapped out. The navigation
379bar has an arrow button on either side, allowing you to move to the next or
380previous week, as well as a button which gives the current week number for that
381year. Pressing the week number button will bring up a calendar dialog, which
382allows you to select the week you are viewing. Selecting a day from the calendar
383will bring you to the week that day is in. To the right of that is a button with
384a "2" in it. When this is depressed, the main view will show two weeks at a
385time, instead of one. The last item is a label which shows the range of dates
386for the currently selected week.
387</para>
388<para>
389The main view is comprised of several rows, each of which represents a day of
390the week. If you have an appointment on that day, the date will be red,
391otherwise it will be black (the current day is blue). Clicking on the date
392itself will bring you to the day view for that day. Under each day is a list of
393all the appointments for that day, as well as their start times. If you click on
394an appointment, you will go to an edit dialog for that appointment, which lets
395you view its details. Next to each day heading is a "+" sign, clicking it will
396create a new appointment for that day.
397</para>
398</section>
399
400<section><title>The Month View</title>
401<para>
402The month view looks like a normal monthly calendar, allowing you to see on what
403days of the month you have appointments. In the navigation bar, there are two
404pairs of arrows. The pair with an arrow and a vertical line will take you to the
405first or last month of the currently selected year, while the normal arrow
406buttons will take you to the next or previous month. There is a dropdown menu
407which allows you to select the month, and a entry field which allows you to
408select the year (press the up or down arrows, or enter in your own year).
409</para>
410<para>
411The main view is divided up into a grid, where the columns are the days of the
412week, and the rows are the weeks (just like an ordinary calendar). The currently
413selected day has a bold box drawn around it, and if the day has an appointment,
414there will be a small blue square in the bottom right corner of it (that square
415will have a smaller white square if it is a recurring appointment). If the
416appointment is an all day event, it will be drawn as a green dot instead. When
417you click on the sqaure of a day, you will be taken to the day view for that
418day.
419</para>
420</section>
421</section>
422
423<section><title>Adding Appointments</title>
424<para>
425To add an appointment, click on the add appointment button in the toolbar at the
426top of the window (an image of a blank page), and a dialog will open up,
427allowing you to enter information about the appointment (depending on the
428current view, and what you may have selected, there may be certain default
429settings).
430</para>
431<para>
432At the top of the window is the description field, where you can enter in a
433short description of the appointment, or select a common one from the dropdown
434list. The location field allows you to do the same. The category dropdown allows
435you to assign the appointment to a category, which you can use later to view
436only some of your appointments. The button labeled "..." to the right of that
437will open up a dialog where you can add, delete, or edit certain categories.
438</para>
439<para>
440To enter a start and end time, select the date for each from the dropdown menu,
441and then you can either manually enter a time, or you can use the three rows of
442numbers to more quickly enter it in. To use the fast input method, first click
443in the text entry field of the time you want to edit, then you need to select
444the hour. The first two rows are the hours, click whichever one you want. The
445third row of numbers are the minutes, in units of five. When you select the
446minutes field for the start time, it will automatically set the minutes field
447for the end time to the same thing, but you can change this by selecting the end
448field and giving it its own minutes field. Because of this, it is fastest to set
449the start time first and then the end time. There is also an "all day"
450checkbox, which will make the appointment take up the entire day.
451</para>
452<para>
453Underneath this you can set the timezone of the appointment from the dropdown
454list. To change the available timezones, click the world icon, and it will open
455the City Time application. Refer to its documentation for changing the
456timezones. If you want to have an alarm go off, check the "alarm" checkbox,
457and then set the number of minutes before the appointment that you want the
458alarm to sound. If you set the dropdown list next to that to "silent" you will
459only be given a visual alarm, wheras if you set the alarm to "Loud", there
460will be an alarm sound as well. Note: opie-alarm must be installed for alarms to
461work.
462</para>
463<para>
464To set whether the appointment repeats, click the "Repeat" button and a new
465dialog will open up. At the top is a row of buttons, which lets you set how
466often the appointment repeats. Selecting one of these buttons will change the
467interface below, to represent the available options for that type of repetition
468(selecting "None" will turn off repetition if you turned it on and no longer
469want it). When you are done, click "ok" in the upper right to select that type
470of repetition, or "x" to set it back to what it was (none if it is a new
471appointment).
472</para>
473<para>
474Finally, you can add notes to the appointment by clicking the "Notes..."
475button which will open a dialog with a text entry field for adding notes. Press
476"ok" to accept the changes to the notes, "x" to cancel.
477</para>
478<para>
479When you are done setting up the appointment, click "ok" in the top right of
480the window, or "x" to cancel adding the appointment.
481</para>
482</section>
483<section><title>Editing Appointments</title>
484<para>
485How you start editing an appointment varies depending on what view you are in,
486but they will all open the same dialog. The dialog is the same as the Add
487Appointment dialog, except that the fields will already be filled in with the
488information that the appointment contains. Clicking "ok" will keep your
489changes, "x" will revert them to what they were before you edited them.
490</para>
491</section>
492
493<section><title>Finding Appointments</title>
494<para>
495To find a specific appointment, click the find button in the toolbar (small
496green magnifying glass) and it will open a find dialog. Here you can enter the
497text you want to search for, as well as the category you want to search for, as
498well as the start date, and whether you want the search to be case sensitive.
499Click "Find" to find the next appointment that matches your criteria.
500</para>
501</section>
502</chapter>
503
504<chapter><title>Todo</title>
505<para>
506Todo is designed for storing information about things you need to do, but which
507arent going to happen at a specific time, like "change the oil" or "mow the
508lawn". You can also give todo items a deadline, if they have to be completed by
509a certain time.
510</para>
511
512<section><title>Adding Tasks</title>
513<para>
514Go to <GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>New Task<GUIMenuItem>, or click
515on the new task icon (blank page). The priority drop down menu lets you select
516the priority of the task. The lower the number, the more important it is. The
517categories behave in much the same way that they do in Calendar, you can select
518the category from the drop down menu, or you can click the "..." button to add,
519delete, or edit categories. To give the task a due date, check the "Due"
520checkbox, and then click the button next to it (it should contain the current
521date). That will open a calendar from which you can select the due date. The
522"Completed" check box is the same as the checkbox next to each item in the main
523view. The "Summary" field is for a short summary that will be visible in the
524main view, as well as in the Today application. The down arrow next to it will
525copy the text in the "Summary" field into the large text field below it, which
526is used for a more detailed description of the task. Click "ok" in the upper
527right to add the new task, or "x" to close the window without adding the new
528task.
529</para>
530</section>
531<section><title>Editing Tasks</title>
532<para>
533To edit a task, you can select it, and then go to
534<GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>Edit
535Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same
536dialog should apear as if you were adding a task, but the information for that
537task should already be filled in. You can change any of it you want to, and then
538click "ok" in the top right corner to save the changes, or "x" to go back to
539the way it was.
540</para>
541</section>
542
543<section><title>Deleting Tasks</title>
544<para>
545To delete a task, first select it, and then either select
546<GUIMenu>Data</GUIMenu>&arrow;
547<GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of
548a trash can). A dialog should pop up, asking if you want to delete the task,
549click yes to delete it, or no to cancel.
550</para>
551</section>
552<section><title>Finding Tasks</title>
553<para>
554To find a task, either go to
555<GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>
556, or click the find icon (an image of a green magnifying glass), and a dialog
557should pop up. Enter the text you want to search for in the description, and
558select the category that you want it to search through (this will speed the
559search up, if you know what category it is in). You can also select "case
560sensative" which makes the search pay attention to the case of what you type (so
561if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search
562Backwards" will search backwards from the currently selected task. Click "Find"
563to initiate the search, when it finds a task that matches the string, it will
564select it. If you click Find again, it will find the next one in the list (or
565the previous one, if "Search backwards" is selected).
566</para>
567</section>
568
569<section><title>Viewing Tasks</title>
570<para>
571To only view tasks filled under certain categories, go to the Category menu, and
572check the categories you want to view. Also, under the Options menu, you can
573select whether or not you want completed tasks to be visible, and whether or not
574you want to see the deadline.
575</para>
576</section>
577
578<section><title>Completing Tasks</title>
579<para>
580To mark a task as completed without deleting it, you can either check the
581checkbox next to it in the main view, or edit it, and check the "completed"
582check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow;
583<GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will
584disapear when you mark it completed. but do not worry, it is not gone forever,
585just check Completed tasks in the options menu, and you can see and edit it
586again.
587</para>
588</section>
589</chapter>
590
591<chapter><title>File Manager</title>
592<para>
593The file manager allows easy access to your file system, letting you browse,
594copy, move, delete and link files. You can also use it to open the file in an
595application based upon the file type, or add the file to your "Documents" tab,
596as well as several other filesystem related things.
597<para>
598
599<section><title>Navigating</title>
600<para>
601To enter a directory, simply press its icon or name in the main view. There are
602also two buttons in the toolbar which help with navigation. The back arrow will
603take you back to the directory you were previously looking at, while the up
604arrow will take you up one level in the directory structure (so, if you are in
605/usr/bin, it will take you to /usr, regardless of where you were before). The
606"Dir" menu shows the current path, with each directory as a menu item. So, if
607you are in /opt/QtPalmtop/bin there will be four entries: /, opt, QtPalmtop, and
608bin. Selecting one of these will take you immediately to that directory.
609</para>
610</section>
611
612<section><title>Selecting Files</title>
613<para>
614When you click on a file, its selection status is toggled. So the first time you
615click on it, it will be selected, and the second time it will be deselected. To
616select multiple files, simply click on each one you want to select.
617</para>
618</section>
619<section><title>Moving Files</title>
620<para>
621To copy a file from one directory to another, press and hold on the filename,
622and select "Copy" from the menu that pops up. Then, change into the directory
623that you want to copy it into, and press the "paste" icon (an image of a
624clipboard and a piece of paper). To move a file, do the same thing, except
625select "Cut" from the first menu, instead of "Copy". You can also move or
626copy multiple files by selecting all of them and using the cut or copy buttons
627in the toolbar.
628</para>
629</section>
630
631<section><title>Deleting Files</title>
632<para>
633To delete a file, press and hold it to bring up its menu, then select
634"Delete", and click "Yes" (or "No" to cancel). Delete will delete all the
635currently selected files, which may be more than the one that you pressed and
636held on.
637</para>
638</section>
639
640<section><title>Renaming Files</title>
641<para>
642To change a file's name, first bring up the input method you want to use (unless
643you are going to use the hardware keyboard), then press and hold on the
644filename, and select "rename". A new file will appear with a "Name" field
645that is editable, enter the new name, and click another file to keep the new
646name.
647</para>
648</section>
649
650<section><title>Creating Directories</title>
651<para>
652To create a directory, first bring up the input method you want to use (if you
653are using one), and then click the new directory button (an image of a file
654folder with a "+" sign). A new folder will be created with the name "New
655Folder", and the folder name will be editable. Enter the name you want and then
656click another file to create the folder.
657</para>
658</section>
659
660<section><title>Viewing Files</title>
661<para>
662To view a file, press and hold on a file, and the menu that comes up will
663contain two entries for vieing the file, the first depends on the filetype, but
664usually lets you open the file in a specific program. The second is "view as
665text" which will open the file up in TextEdit (regardless of whether or not it
666is actually a text file).
667</para>
668</section>
669
670<section id="adddoc"><title>Adding to "Documents"</title>
671<para>
672To add a file to your "Documents", press and hold the file, and select "Add
673to documents" from the menu. This will add the file to the documents tab, which
674you can use to quickly open the file (simply click on the icon for the file in
675the Documents tab). Some programs also use the Documents list to aid in quickly
676opening files.
677</para>
678</section>
679
680<section><title>Sorting Files</title>
681<para>
682To sort the files, use the "Sort" menu to select wich field you want to sort
683the files by ("by Name", for instance, will sort the file alphabetically by
684name). If "Ascending" is checked, the files will be sorted in ascending order,
685if it is not, they will be sorted in descending order. You can also press the
686name of the column in the main view to sort by that field.
687</para>
688</section>
689
690<section><title>Viewing Options</title>
691<para>
692The "View" menu lets you choose which files to view. If "Hidden" is checked,
693hidden files will be visible (in Linux, hidden files start with a "."). If
694"Symlinks" is checked, symbolic links (files or directories which are merely
695links to other files or directories) will be visible.
696</para>
697</section>
698</chapter>
699
700<chapter><title>Embedded Konsole</title>
701<para>
702EmbeddedKonsole is Opie's terminal emulator. From here you can do pretty much
703anything (since Linux is actually a command line based OS by itself). I will
704not go into much detail on using the linux command line, as that is covered in
705many other places (http://www.tldp.org is a good place to start, or read
706O'Reilly's <citation>Running Linux</citation> for a comprehensive look at Linux
707for the beginner). I will, however, give a quick overview of using a Linux
708shell.
709</para>
710
711<section><title>Using Embedded Konsole</title>
712<para>
713Along the top of the window is a row of menus and icons. The "Font" menu lets
714you select the font size that you want the console to use, while the Options
715menu lets you select various options. Below this row of menus and icons is a
716pulldown list with various common commands in it.
717</para>
718
719<section><title>Options Menu</title>
720<para>
721The first submenu in the options menu is the "Command List" menu, which lets
722you edit or hide the command list pulldown. The "Tabs on top" or "Tabs on
723bottom" (depending on which is currently enabled) allows you to select where
724the tabs representing multiple terminal sessions are drawn. The "Colors"
725submenu lets you select from a color scheme, or make your own, and the "Scroll
726Bar" submenu lets you select where or if the scroll bar is drawn.
727</para>
728</section>
729<section><title>Icons</title>
730<para>
731The row of icons to the right of the menus allows you to type common keystrokes
732without having an input method visible, as well as some other things.
733</para>
734<para>
735The icon all the way on the left will open a new terminal session in a new tab,
736while the icon all the way on the right will paste text from the clipboard into
737the terminal.
738</para>
739<para>
740The other icons are the same as typing (from left to right) enter, space, tab
741(for tab completion), up, and down (for the command history).
742</para>
743</section>
744<section><title>Command List</title>
745<para>
746The command list is a pulldown menu with a list of commonly used commands.
747Selecting one will type the command into the terminal wherever the cursor is.
748You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow;
749<GUIMenuItem>Command List.</GUIMenuItem>
750</para>
751</section>
752</section>
753
754<section><title>What is a Shell</title>
755<para>
756A shell is a program that accepts input from a user, and runs commands. Each
757"command" in the shell is actually a separate program (unless you are using a
758shell like BusyBox, which makes some of the more common commands part of its own
759program in order to save space). Shells can actually be very powerful, and many
760of them allow you to write something called "shell scripts" which are just a
761sequence of commands, sometimes with some flow control statements, saved to a
762file and run each time the script is run. For the most part, the average user
763does not need to know about any of this, though. If you are running Opie on the
764Familiar distribution, it is advisable to install the bash shell (ipkg install
765bash) because it offers things like tab completion, use of the backspace key,
766and a command history, as well as offering a more advanced scripting languauge
767than most other shells.
768</para>
769</section>
770
771<section><title>Running Programs</title>
772<para>
773To run a program or a command (remember, a command is just another program), you
774simply type the name of the program and hit "Return" (in Linux, program names
775do not have a special suffix like they do in windows, in fact the "."
776character has no special meaning unless it is at the begining of a filename, in
777which case it makes the file "hidden"). When you type a program name and hit
778"Return" the shell looks in a special list of directories called your
779"path", and if it cannot find it in any of those directories, it stops looking
780and tells you it could not find them. If you want to run a program that is not
781in your path, you must specify an absolute or relative path to that program.
782For instance, to run a program that is in the directory you are currently in,
783you would type <literal>./program</literal> ("./" is a special directory that
784is explained below), or to run a program in /home/username/ you would call
785<literal>/home/username/program</literal>.
786</para>
787<para>
788Most programs take "arguments" when run from the command line. An argument is
789a string that contains no spaces that changes how the program behaves (a text
790editor, for instance, might take a single argument, which would be the name of
791the file you wish to edit). Usually, you can use the arguments "-h" or
792"--help" to get a list of the common arguments that that program takes, along
793with a short usage description, and a short description of what each argument
794does.
795</para>
796</section>
797
798<section><title>Basic Navigation</title>
799<para>
800The command that you will use most often in the shell is probably the "cd"
801command, which stands for "change directory." With this command, you can move
802around in the file system, by issuing the command like this: <userinput>cd
803<replaceable>[new directory]</replaceable></userinput>, where <replaceable>[new
804directory]</replaceable> is the directory you want to move to.
805This directory name does not have to include the entire directory structure, but
806can be "relative" which means it assumes you are talking about directories
807relative to the directory you are in. For example, if you are in a directory
808called /home/username and you want to move to the directory
809/home/username/other/dir you could simply type <userinput>cd
810other/dir</userinput> and you would end up in /home/username/other/dir. You can
811also specify a full, or "absolute" path, by specifying the entire path name
812starting with / ( / is a special directory called the "root" directory, and does
813not have a "parent" directory, which means that it is not in any other
814directory). There are also two special directories called "./" and "../".
815The "./" directory is the current directory you are in, and you will probably
816never use this in conjunction with the cd command (why would you want to move to
817the directory you are already in?). The "../" directory represents the parent
818directory of the directory you are currently in, so if you are in
819/home/username, ../ is the same as /home. You can string several ../'s
820together, so if you are in /home/username/dir/ ../../ represents /home. There
821is one other special directory, called "~/" that points to your home
822directory (usually /home/username or /root for the root user).
823</para>
824</section>
825
826<section><title>Moving Files</title>
827<para>
828To move files around, you need to use the "cp" (copy) and "mv" (move)
829commands. Both of these are run the same way: <userinput>command originalfile
830newfile</userinput>. The only difference is that cp creates a new file without
831touching the old one, while mv deletes the original file. The two path names
832can be either absolute or relative. If you only specify a directory for the
833destination, and no filename, it will use the filename for the original file.
834</para>
835</section>
836
837<section><title>Deleting Files</title>
838<para>
839To delete a file, run the "rm" command, and to delete a directory, run the
840"rmdir" command, each of them take the file to be removed as their only
841argument. The rmdir command requires the directory to be empty, so if you want
842to delete a directory that is not empty, along with all its contents, run
843<userinput>rm -r dir</userinput>.
844</para>
845</section>
846
847<section><title>Linking Files</title>
848<para>
849In Linux, you can have a special file called a "symbolic link" that acts just
850like a copy of another file, except it takes up less space. This is convinient
851if two applications are looking for the same file in two separate places,
852because the file can be in both places at once, without taking up any extra
853space, and any change to one is automatically applied to the other (really,
854there is only one file, the link is just a file pointing to the original file).
855This is also useful for naming applications independant of their version number.
856 For instance, you could have a link called "application" that points to
857"application1.0". To create a link, use the following command:
858<userinput>ln -s originalfile link</userinput>.
859</para>
860</section>
861</chapter>
862</part> 30</part>
863
864<part><title>Settings</title> 31<part><title>Settings</title>
865<chapter><title>Software</title> 32&software;
866
867<para>
868The "Software" application, also called oipkg, is what is used to install and
869remove software. It is actually a frontend to the command line program "ipkg"
870so most things you can do with oipkg you can also do with ipkg. Oipkg can
871install things either remotely from a web server (called a "feed") or it can
872install an ipkg package file that resides on the local filesystem.
873</para>
874<important>
875<para>
876There is a bug in oipkg that prevents it from installing packages
877properly. There is, however, a workaround for it. Simply run oipkg from
878Embedded Konsole to avoid the bug.
879</para>
880</important>
881
882<section><title>Installing Software</title>
883<para>
884To install software, first select "Opie" from the "Section" pulldown menu,
885the press the "+" icon next to "Feeds" in the main view. This will show all
886the available Opie packages (you can change which packages to view by selecting
887something else from the "Section" pulldown). Installed packages are marked
888with a blue circle, while packages that are not installed are marked with a red
889box. If you click on the icon for an uninstalled package, it will turn into an
890open box, with a blue circle coming out of it, indicating that you have marked
891this package to be installed. Mark as many packages as you wish this way, and
892then press the "Apply" icon (same red box and blue dot icon) to install all
893the marked packages. It will also remove any packages marked for removal (see
894below). Clicking this will open a window showing all the packages marked to be
895removed and installed, with some check boxes on the bottom, which represent
896arguments to be sent to ipkg, which you can usually ignore. After verifying
897that all the packages to be installed are correct, press "Ok" in the upper
898right corner (or press "x" to cancel and go back to the package selection
899window). The packages should then install, and you should see their icons
900appear in the Launcher, if they are Opie applications.
901</para>
902</section>
903
904<section><title>Removing Software</title>
905<para>
906Removing software is the same as installing software, except you will press the
907blue circle icon of an installed package, and it will have a red "X" over it.
908Then press the apply icon, and "Ok". You can install and remove packages at
909the same time by marking the ones you want to install and the ones you want to
910remove, and then pressing apply.
911</para>
912</section>
913</chapter>
914</part> 33</part>
915</book> 34</book>