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