summaryrefslogtreecommitdiff
path: root/docs
Unidiff
Diffstat (limited to 'docs') (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/calendar.sgm2
-rw-r--r--docs/usermanual/contacts.sgm2
-rw-r--r--docs/usermanual/embeddedkonsole.sgm4
-rw-r--r--docs/usermanual/gettingaround.sgm12
-rw-r--r--docs/usermanual/i18n.sgm223
-rw-r--r--docs/usermanual/installation.sgm14
-rw-r--r--docs/usermanual/irda.sgm4
-rw-r--r--docs/usermanual/keypebble.sgm2
-rw-r--r--docs/usermanual/software.sgm8
-rw-r--r--docs/usermanual/today.sgm22
-rw-r--r--docs/usermanual/todo.sgm2
-rw-r--r--docs/usermanual/upgrading.sgm8
-rw-r--r--docs/usermanual/usermanual.sgm7
-rw-r--r--docs/usermanual/whatisopie.sgm12
14 files changed, 220 insertions, 102 deletions
diff --git a/docs/usermanual/calendar.sgm b/docs/usermanual/calendar.sgm
index 99a810c..d8df4c6 100644
--- a/docs/usermanual/calendar.sgm
+++ b/docs/usermanual/calendar.sgm
@@ -131,69 +131,69 @@ numbers to more quickly enter it in. To use the fast input method, first click
131in the text entry field of the time you want to edit, then you need to select 131in the text entry field of the time you want to edit, then you need to select
132the hour. The first two rows are the hours, click whichever one you want. The 132the hour. The first two rows are the hours, click whichever one you want. The
133third row of numbers are the minutes, in units of five. When you select the 133third row of numbers are the minutes, in units of five. When you select the
134minutes field for the start time, it will automatically set the minutes field 134minutes field for the start time, it will automatically set the minutes field
135for the end time to the same thing, but you can change this by selecting the end 135for the end time to the same thing, but you can change this by selecting the end
136field and giving it its own minutes field. Because of this, it is fastest to set 136field and giving it its own minutes field. Because of this, it is fastest to set
137the start time first and then the end time. There is also an "all day" 137the start time first and then the end time. There is also an "all day"
138checkbox, which will make the appointment take up the entire day. 138checkbox, which will make the appointment take up the entire day.
139</para> 139</para>
140<para> 140<para>
141Underneath this you can set the timezone of the appointment from the dropdown 141Underneath this you can set the timezone of the appointment from the dropdown
142list. To change the available timezones, click the world icon, and it will open 142list. To change the available timezones, click the world icon, and it will open
143the City Time application. Refer to its documentation for changing the 143the City Time application. Refer to its documentation for changing the
144timezones. If you want to have an alarm go off, check the "alarm" checkbox, 144timezones. If you want to have an alarm go off, check the "alarm" checkbox,
145and then set the number of minutes before the appointment that you want the 145and then set the number of minutes before the appointment that you want the
146alarm to sound. If you set the dropdown list next to that to "silent" you will 146alarm to sound. If you set the dropdown list next to that to "silent" you will
147only be given a visual alarm, wheras if you set the alarm to "Loud", there 147only be given a visual alarm, wheras if you set the alarm to "Loud", there
148will be an alarm sound as well. Note: opie-alarm must be installed for alarms to 148will be an alarm sound as well. Note: opie-alarm must be installed for alarms to
149work. 149work.
150</para> 150</para>
151<para> 151<para>
152To set whether the appointment repeats, click the "Repeat" button and a new 152To set whether the appointment repeats, click the "Repeat" button and a new
153dialog will open up. At the top is a row of buttons, which lets you set how 153dialog will open up. At the top is a row of buttons, which lets you set how
154often the appointment repeats. Selecting one of these buttons will change the 154often the appointment repeats. Selecting one of these buttons will change the
155interface below, to represent the available options for that type of repetition 155interface 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 156(selecting "None" will turn off repetition if you turned it on and no longer
157want it). When you are done, click "ok" in the upper right to select that type 157want it). When you are done, click "ok" in the upper right to select that type
158of repetition, or "x" to set it back to what it was (none if it is a new 158of repetition, or "x" to set it back to what it was (none if it is a new
159appointment). 159appointment).
160</para> 160</para>
161<para> 161<para>
162Finally, you can add notes to the appointment by clicking the "Notes..." 162Finally, you can add notes to the appointment by clicking the "Notes..."
163button which will open a dialog with a text entry field for adding notes. Press 163button 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. 164"ok" to accept the changes to the notes, "x" to cancel.
165</para> 165</para>
166<para> 166<para>
167When you are done setting up the appointment, click "ok" in the top right of 167When you are done setting up the appointment, click "ok" in the top right of
168the window, or "x" to cancel adding the appointment. 168the window, or "x" to cancel adding the appointment.
169</para> 169</para>
170</section> 170</section>
171<section><title>Editing Appointments</title> 171<section><title>Editing Appointments</title>
172<para> 172<para>
173How you start editing an appointment varies depending on what view you are in, 173How you start editing an appointment varies depending on what view you are in,
174but they will all open the same dialog. The dialog is the same as the Add 174but they will all open the same dialog. The dialog is the same as the Add
175Appointment dialog, except that the fields will already be filled in with the 175Appointment dialog, except that the fields will already be filled in with the
176information that the appointment contains. Clicking "ok" will keep your 176information that the appointment contains. Clicking "ok" will keep your
177changes, "x" will revert them to what they were before you edited them. 177changes, "x" will revert them to what they were before you edited them.
178</para> 178</para>
179</section> 179</section>
180 180
181<section><title>Finding Appointments</title> 181<section><title>Finding Appointments</title>
182<para> 182<para>
183To find a specific appointment, click the find button in the toolbar (small 183To find a specific appointment, click the find button in the toolbar (small
184green magnifying glass) and it will open a find dialog. Here you can enter the 184green magnifying glass) and it will open a find dialog. Here you can enter the
185text you want to search for, as well as the category you want to search for, as 185text you want to search for, as well as the category you want to search for, as
186well as the start date, and whether you want the search to be case sensitive. 186well as the start date, and whether you want the search to be case sensitive.
187Click "Find" to find the next appointment that matches your criteria. 187Click "Find" to find the next appointment that matches your criteria.
188</para> 188</para>
189</section> 189</section>
190 190
191<section><title>Beaming Appointments</title> 191<section><title>Beaming Appointments</title>
192<para> 192<para>
193To beam an appointment to another device using the IrDA and OBEX protocols, you must first install the IrDA 193To beam an appointment to another device using the IrDA and OBEX protocols, you must first install the IrDA
194Applet and enable IrDA with it (see <xref linkend=irda>). Then select the appointment that you would like to 194Applet and enable IrDA with it (see <xref linkend=irda>). Then select the appointment that you would like to
195send in the Day View, and select Beam from the menu that appears. Opie will then send the appointment to any 195send in the Day View, and select Beam from the menu that appears. &opie; will then send the appointment to any
196waiting device. 196waiting device.
197</para> 197</para>
198</section> 198</section>
199</chapter> 199</chapter>
diff --git a/docs/usermanual/contacts.sgm b/docs/usermanual/contacts.sgm
index 8ba7674..b0afe73 100644
--- a/docs/usermanual/contacts.sgm
+++ b/docs/usermanual/contacts.sgm
@@ -32,77 +32,77 @@ parameter).
32<para> 32<para>
33The Details tab is used for miscelaneous things like the person's position, the 33The Details tab is used for miscelaneous things like the person's position, the
34name of their spouse, etc. 34name of their spouse, etc.
35</para> 35</para>
36<para> 36<para>
37When you are done, click "Ok" in the top right of the screen (you can always 37When you are done, click "Ok" in the top right of the screen (you can always
38edit their profile later), click the "x" to cancel, and not add the contact. 38edit their profile later), click the "x" to cancel, and not add the contact.
39</para> 39</para>
40</section> 40</section>
41<section><title>Editing Contacts</title> 41<section><title>Editing Contacts</title>
42<para> 42<para>
43To edit the contacts, select the person you want to edit, anc click the pencil 43To edit the contacts, select the person you want to edit, anc click the pencil
44icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>, 44icon, or go to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Edit</GUIMenuItem>,
45and it will open up the same dialog used to add a user, except their information 45and it will open up the same dialog used to add a user, except their information
46that is already entered will already be filled in. To finalise the changes, 46that is already entered will already be filled in. To finalise the changes,
47click "Ok", or to cancel them, click "x". 47click "Ok", or to cancel them, click "x".
48</para> 48</para>
49</section> 49</section>
50 50
51<section><title>Deleting Contacts</title> 51<section><title>Deleting Contacts</title>
52<para> 52<para>
53To delete a contact, select the person from the list of contacts, and click the 53To delete a contact, select the person from the list of contacts, and click the
54trash can icon, or go to <GUIMenu>Contact</GUIMenu> 54trash can icon, or go to <GUIMenu>Contact</GUIMenu>
55&arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you 55&arrow;<GUIMenuItem>Delete</GUIMenuItem>. A dialog will pop up asking if you
56want to actually delete that contact, click yes to delete it, no will cancel. 56want to actually delete that contact, click yes to delete it, no will cancel.
57</para> 57</para>
58</section> 58</section>
59 59
60<section><title>Editing Contacts</title> 60<section><title>Editing Contacts</title>
61<para> 61<para>
62To find a specific person, click the find icon (green magnifying glass), or go 62To find a specific person, click the find icon (green magnifying glass), or go
63to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog 63to <GUIMenu>Contact</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>. A dialog
64will pop up, and in the "Find what" input, enter the string you want to search 64will pop up, and in the "Find what" input, enter the string you want to search
65for. You can also select if you want the search to be case sensative, and if you 65for. You can also select if you want the search to be case sensative, and if you
66want it to search backwards from the currently selected user. The Category drop 66want it to search backwards from the currently selected user. The Category drop
67down menu lets you search only a specific category ("All" to search all of 67down menu lets you search only a specific category ("All" to search all of
68them). When you click "Find", it will start search for the string in all the 68them). When you click "Find", it will start search for the string in all the
69fields in all the contacts. When it finds a match, it will highlight the user in 69fields in all the contacts. When it finds a match, it will highlight the user in
70the main view. You can use this to search for (as an example) who a certain 70the main view. You can use this to search for (as an example) who a certain
71phone number belongs to, by entering the phone number in the "find what" field, 71phone number belongs to, by entering the phone number in the "find what" field,
72and clicking "Find". 72and clicking "Find".
73</para> 73</para>
74</section> 74</section>
75 75
76<section><title>Viewing Contacts</title> 76<section><title>Viewing Contacts</title>
77<para> 77<para>
78To view only the contacts in a certain category, go to the View menu, and check 78To view only the contacts in a certain category, go to the View menu, and check
79the categories you want to view. 79the categories you want to view.
80</para> 80</para>
81<para> 81<para>
82The list of letters on the bottom of the window lets you look at only the 82The list of letters on the bottom of the window lets you look at only the
83contacts who's names begin with that letter. These work much like entering text 83contacts who's names begin with that letter. These work much like entering text
84on a mobile phone. For example, to view all the contacts whos name starts with 84on 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 85"B", press the "ABC" group twice (since "B" is the second letter in that
86group). To go back to displaying all of the letters, click it two more times 86group). 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 87(pressing it four times brings you back to all the letters, so you pressed it 2
88times to get to "B" and 2 more times to get back to all letters. 2+2=4). 88times to get to "B" and 2 more times to get back to all letters. 2+2=4).
89</para> 89</para>
90</section> 90</section>
91 91
92<section><title>Beaming Contacts</title> 92<section><title>Beaming Contacts</title>
93<para> 93<para>
94To beam a contact to another device, you must first have the IrDA Applet installed, and you must enable IrDA in it. 94To beam a contact to another device, you must first have the IrDA Applet installed, and you must enable IrDA in it.
95(see <xref linkend=irda>). Once this is done, you can select the contact you would like to beam, and press the 95(see <xref linkend=irda>). Once this is done, you can select the contact you would like to beam, and press the
96beam icon in the toolbar, or select Contact&arrow;Beam Entry. Opie will then send the contact using the IrDA and 96beam icon in the toolbar, or select Contact&arrow;Beam Entry. &opie; will then send the contact using the IrDA and
97OBEX protocols to any waiting device. 97OBEX protocols to any waiting device.
98</para> 98</para>
99</section> 99</section>
100 100
101<section><title>Personal Details</title> 101<section><title>Personal Details</title>
102<para> 102<para>
103Change your personal details by going to <GUIMenu>Contact </GUIMenu> 103Change your personal details by going to <GUIMenu>Contact </GUIMenu>
104<GUIMenuItem>My Personal Details</GUIMenuItem>. This is used in today to 104<GUIMenuItem>My Personal Details</GUIMenuItem>. This is used in today to
105display who the device belongs to, as well as other apps. 105display who the device belongs to, as well as other apps.
106</para> 106</para>
107</section> 107</section>
108</chapter> 108</chapter>
diff --git a/docs/usermanual/embeddedkonsole.sgm b/docs/usermanual/embeddedkonsole.sgm
index 838e705..1564408 100644
--- a/docs/usermanual/embeddedkonsole.sgm
+++ b/docs/usermanual/embeddedkonsole.sgm
@@ -1,131 +1,131 @@
1<chapter><title>Embedded Konsole</title> 1<chapter><title>Embedded Konsole</title>
2<para> 2<para>
3EmbeddedKonsole is Opie's terminal emulator. From here you can do pretty much 3EmbeddedKonsole is &opie;'s terminal emulator. From here you can do pretty much
4anything (since Linux is actually a command line based OS by itself). I will 4anything (since Linux is actually a command line based OS by itself). I will
5not go into much detail on using the linux command line, as that is covered in 5not go into much detail on using the linux command line, as that is covered in
6many other places (http://www.tldp.org is a good place to start, or read 6many other places (http://www.tldp.org is a good place to start, or read
7O'Reilly's <citation>Running Linux</citation> for a comprehensive look at Linux 7O'Reilly's <citation>Running Linux</citation> for a comprehensive look at Linux
8for the beginner). I will, however, give a quick overview of using a Linux 8for the beginner). I will, however, give a quick overview of using a Linux
9shell. 9shell.
10</para> 10</para>
11 11
12<section><title>Using Embedded Konsole</title> 12<section><title>Using Embedded Konsole</title>
13<para> 13<para>
14Along the top of the window is a row of menus and icons. The "Font" menu lets 14Along the top of the window is a row of menus and icons. The "Font" menu lets
15you select the font size that you want the console to use, while the Options 15you select the font size that you want the console to use, while the Options
16menu lets you select various options. Below this row of menus and icons is a 16menu lets you select various options. Below this row of menus and icons is a
17pulldown list with various common commands in it. 17pulldown list with various common commands in it.
18</para> 18</para>
19 19
20<section><title>Options Menu</title> 20<section><title>Options Menu</title>
21<para> 21<para>
22The first submenu in the options menu is the "Command List" menu, which lets 22The first submenu in the options menu is the "Command List" menu, which lets
23you edit or hide the command list pulldown. The "Tabs on top" or "Tabs on 23you edit or hide the command list pulldown. The "Tabs on top" or "Tabs on
24bottom" (depending on which is currently enabled) allows you to select where 24bottom" (depending on which is currently enabled) allows you to select where
25the tabs representing multiple terminal sessions are drawn. The "Colors" 25the tabs representing multiple terminal sessions are drawn. The "Colors"
26submenu lets you select from a color scheme, or make your own, and the "Scroll 26submenu lets you select from a color scheme, or make your own, and the "Scroll
27Bar" submenu lets you select where or if the scroll bar is drawn. 27Bar" submenu lets you select where or if the scroll bar is drawn.
28</para> 28</para>
29</section> 29</section>
30<section><title>Icons</title> 30<section><title>Icons</title>
31<para> 31<para>
32The row of icons to the right of the menus allows you to type common keystrokes 32The row of icons to the right of the menus allows you to type common keystrokes
33without having an input method visible, as well as some other things. 33without having an input method visible, as well as some other things.
34</para> 34</para>
35<para> 35<para>
36The icon all the way on the left will open a new terminal session in a new tab, 36The icon all the way on the left will open a new terminal session in a new tab,
37while the icon all the way on the right will paste text from the clipboard into 37while the icon all the way on the right will paste text from the clipboard into
38the terminal. 38the terminal.
39</para> 39</para>
40<para> 40<para>
41The other icons are the same as typing (from left to right) enter, space, tab 41The 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). 42(for tab completion), up, and down (for the command history).
43</para> 43</para>
44</section> 44</section>
45<section><title>Command List</title> 45<section><title>Command List</title>
46<para> 46<para>
47The command list is a pulldown menu with a list of commonly used commands. 47The command list is a pulldown menu with a list of commonly used commands.
48Selecting one will type the command into the terminal wherever the cursor is. 48Selecting one will type the command into the terminal wherever the cursor is.
49You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow; 49You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow;
50<GUIMenuItem>Command List.</GUIMenuItem> 50<GUIMenuItem>Command List.</GUIMenuItem>
51</para> 51</para>
52</section> 52</section>
53</section> 53</section>
54 54
55<section><title>What is a Shell</title> 55<section><title>What is a Shell</title>
56<para> 56<para>
57A shell is a program that accepts input from a user, and runs commands. Each 57A 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 58"command" in the shell is actually a separate program (unless you are using a
59shell like BusyBox, which makes some of the more common commands part of its own 59shell like BusyBox, which makes some of the more common commands part of its own
60program in order to save space). Shells can actually be very powerful, and many 60program in order to save space). Shells can actually be very powerful, and many
61 61
62 62
63 63
64of them allow you to write something called "shell scripts" which are just a 64of them allow you to write something called "shell scripts" which are just a
65sequence of commands, sometimes with some flow control statements, saved to a 65sequence of commands, sometimes with some flow control statements, saved to a
66file and run each time the script is run. For the most part, the average user 66file and run each time the script is run. For the most part, the average user
67does not need to know about any of this, though. If you are running Opie on the 67does not need to know about any of this, though. If you are running &opie; on the
68Familiar distribution, it is advisable to install the bash shell (ipkg install 68Familiar distribution, it is advisable to install the bash shell (ipkg install
69bash) because it offers things like tab completion, use of the backspace key, 69bash) because it offers things like tab completion, use of the backspace key,
70and a command history, as well as offering a more advanced scripting languauge 70and a command history, as well as offering a more advanced scripting languauge
71than most other shells. 71than most other shells.
72</para> 72</para>
73</section> 73</section>
74 74
75<section><title>Running Programs</title> 75<section><title>Running Programs</title>
76<para> 76<para>
77To run a program or a command (remember, a command is just another program), you 77To run a program or a command (remember, a command is just another program), you
78simply type the name of the program and hit "Return" (in Linux, program names 78simply type the name of the program and hit "Return" (in Linux, program names
79do not have a special suffix like they do in windows, in fact the "." 79do not have a special suffix like they do in windows, in fact the "."
80character has no special meaning unless it is at the begining of a filename, in 80character has no special meaning unless it is at the begining of a filename, in
81which case it makes the file "hidden"). When you type a program name and hit 81which case it makes the file "hidden"). When you type a program name and hit
82"Return" the shell looks in a special list of directories called your 82"Return" the shell looks in a special list of directories called your
83"path", and if it cannot find it in any of those directories, it stops looking 83"path", and if it cannot find it in any of those directories, it stops looking
84and tells you it could not find them. If you want to run a program that is not 84and tells you it could not find them. If you want to run a program that is not
85in your path, you must specify an absolute or relative path to that program. 85in your path, you must specify an absolute or relative path to that program.
86For instance, to run a program that is in the directory you are currently in, 86For instance, to run a program that is in the directory you are currently in,
87you would type <literal>./program</literal> ("./" is a special directory that 87you would type <literal>./program</literal> ("./" is a special directory that
88is explained below), or to run a program in /home/username/ you would call 88is explained below), or to run a program in /home/username/ you would call
89<literal>/home/username/program</literal>. 89<literal>/home/username/program</literal>.
90</para> 90</para>
91<para> 91<para>
92Most programs take "arguments" when run from the command line. An argument is 92Most programs take "arguments" when run from the command line. An argument is
93a string that contains no spaces that changes how the program behaves (a text 93a string that contains no spaces that changes how the program behaves (a text
94editor, for instance, might take a single argument, which would be the name of 94editor, for instance, might take a single argument, which would be the name of
95the file you wish to edit). Usually, you can use the arguments "-h" or 95the file you wish to edit). Usually, you can use the arguments "-h" or
96"--help" to get a list of the common arguments that that program takes, along 96"--help" to get a list of the common arguments that that program takes, along
97with a short usage description, and a short description of what each argument 97with a short usage description, and a short description of what each argument
98does. 98does.
99</para> 99</para>
100</section> 100</section>
101 101
102<section><title>Basic Navigation</title> 102<section><title>Basic Navigation</title>
103<para> 103<para>
104The command that you will use most often in the shell is probably the "cd" 104The command that you will use most often in the shell is probably the "cd"
105command, which stands for "change directory." With this command, you can move 105command, which stands for "change directory." With this command, you can move
106around in the file system, by issuing the command like this: <userinput>cd 106around in the file system, by issuing the command like this: <userinput>cd
107<replaceable>[new directory]</replaceable></userinput>, where <replaceable>[new 107<replaceable>[new directory]</replaceable></userinput>, where <replaceable>[new
108directory]</replaceable> is the directory you want to move to. 108directory]</replaceable> is the directory you want to move to.
109This directory name does not have to include the entire directory structure, but 109This directory name does not have to include the entire directory structure, but
110can be "relative" which means it assumes you are talking about directories 110can be "relative" which means it assumes you are talking about directories
111relative to the directory you are in. For example, if you are in a directory 111relative to the directory you are in. For example, if you are in a directory
112called /home/username and you want to move to the directory 112called /home/username and you want to move to the directory
113/home/username/other/dir you could simply type <userinput>cd 113/home/username/other/dir you could simply type <userinput>cd
114other/dir</userinput> and you would end up in /home/username/other/dir. You can 114other/dir</userinput> and you would end up in /home/username/other/dir. You can
115also specify a full, or "absolute" path, by specifying the entire path name 115also specify a full, or "absolute" path, by specifying the entire path name
116starting with / ( / is a special directory called the "root" directory, and does 116starting with / ( / is a special directory called the "root" directory, and does
117not have a "parent" directory, which means that it is not in any other 117not have a "parent" directory, which means that it is not in any other
118directory). There are also two special directories called "./" and "../". 118directory). There are also two special directories called "./" and "../".
119The "./" directory is the current directory you are in, and you will probably 119The "./" directory is the current directory you are in, and you will probably
120never use this in conjunction with the cd command (why would you want to move to 120never use this in conjunction with the cd command (why would you want to move to
121the directory you are already in?). The "../" directory represents the parent 121the directory you are already in?). The "../" directory represents the parent
122directory of the directory you are currently in, so if you are in 122directory of the directory you are currently in, so if you are in
123/home/username, ../ is the same as /home. You can string several ../'s 123/home/username, ../ is the same as /home. You can string several ../'s
124together, so if you are in /home/username/dir/ ../../ represents /home. There 124together, so if you are in /home/username/dir/ ../../ represents /home. There
125is one other special directory, called "~/" that points to your home 125is one other special directory, called "~/" that points to your home
126directory (usually /home/username or /root for the root user). 126directory (usually /home/username or /root for the root user).
127</para> 127</para>
128</section> 128</section>
129 129
130<section><title>Moving Files</title> 130<section><title>Moving Files</title>
131<para> 131<para>
diff --git a/docs/usermanual/gettingaround.sgm b/docs/usermanual/gettingaround.sgm
index 88103bb..90aa3cf 100644
--- a/docs/usermanual/gettingaround.sgm
+++ b/docs/usermanual/gettingaround.sgm
@@ -1,96 +1,96 @@
1<chapter><title>Using Opie</title> 1<chapter><title>Using &opie;</title>
2<para> 2<para>
3Now that Opie is installed and running, it's time to start using it. When you 3Now that &opie; is installed and running, it's time to start using it. When you
4first start Opie, you will see the "Launcher" from which you can start all of 4first start &opie;, you will see the "Launcher" from which you can start all of
5your Applications, and the "Taskbar" along the bottom, where you can see all 5your Applications, and the "Taskbar" along the bottom, where you can see all
6the running applications, select an input method, and interact with the 6the running applications, select an input method, and interact with the
7installed "applets". 7installed "applets".
8</para> 8</para>
9 9
10<section><title>Getting Around</title> 10<section><title>Getting Around</title>
11<para> 11<para>
12Getting around in Opie is very easy, you simply click your stylus on whatever 12Getting around in &opie; is very easy, you simply click your stylus on whatever
13icon or button you want to click on. The main difference between using the 13icon or button you want to click on. The main difference between using the
14stylus and using a mouse is that you cannot right click with a stylus, so things 14stylus and using a mouse is that you cannot right click with a stylus, so things
15that require a right click are kept to a minimum. However, it is sometimes 15that require a right click are kept to a minimum. However, it is sometimes
16necessary to right click, and this is implemented with a "press and hold". 16necessary to right click, and this is implemented with a "press and hold".
17Any time you want to do something that you think would require a right click on 17Any time you want to do something that you think would require a right click on
18a normal pc, try pressing the stylus down and holding it still for a few 18a normal pc, try pressing the stylus down and holding it still for a few
19seconds. This usually opens up a context sensative menu, much like a right 19seconds. This usually opens up a context sensative menu, much like a right
20click usually does on a desktop interface. 20click usually does on a desktop interface.
21</para> 21</para>
22</section> 22</section>
23 23
24<section><title>Launcher</title> 24<section><title>Launcher</title>
25<para> 25<para>
26The Launcher behaves like the "desktop" on most PC GUIs. When no applications 26The Launcher behaves like the "desktop" on most PC GUIs. When no applications
27are running or visible, you will have access to the Launcher. You can also map 27are running or visible, you will have access to the Launcher. You can also map
28a hardware key to bring the Launcher to the top without closing any of the 28a hardware key to bring the Launcher to the top without closing any of the
29running applications (this is similar to "minimising" all the applications 29running applications (this is similar to "minimising" all the applications
30that are running). 30that are running).
31</para> 31</para>
32<para> 32<para>
33Along the top of the Launcher you will see a list of tabs which function as 33Along the top of the Launcher you will see a list of tabs which function as
34categories for your applications. You can click on the tab for the category you 34categories for your applications. You can click on the tab for the category you
35want to view, and then click on the icon for the application that you wish to 35want to view, and then click on the icon for the application that you wish to
36launch. By default, there will be an Applications tab and a Settings tab (if 36launch. By default, there will be an Applications tab and a Settings tab (if
37you install any games, they will appear in the Games tab). When new 37you install any games, they will appear in the Games tab). When new
38applications are installed, they will usually appear in one of these three tabs, 38applications are installed, they will usually appear in one of these three tabs,
39or in a tab of their own. To add or delete tabs or to move applications between 39or in a tab of their own. To add or delete tabs or to move applications between
40the tabs, you can use the Tab Manager application, or you can edit them by hand, 40the tabs, you can use the Tab Manager application, or you can edit them by hand,
41by changing the directories in /opt/QtPalmtop/apps. 41by changing the directories in /opt/QtPalmtop/apps.
42</para> 42</para>
43<para> 43<para>
44There is also a tab to the far right called the "Documents" tab, which allows 44There is also a tab to the far right called the "Documents" tab, which allows
45you to quickly open your most often used documents. You can click on a document 45you to quickly open your most often used documents. You can click on a document
46to open it up in the proper application. For help on adding files to the 46to open it up in the proper application. For help on adding files to the
47Documents tab see the <xref linkend="adddoc">. 47Documents tab see the <xref linkend="adddoc">.
48</para> 48</para>
49</section> 49</section>
50 50
51<section><title>Taskbar</title> 51<section><title>Taskbar</title>
52<para> 52<para>
53Opie has a "Taskbar" that always runs along the bottom of the screen in Opie, 53&opie; has a "Taskbar" that always runs along the bottom of the screen in &opie;,
54except for a few "fullscreen" applications that cover it up. The Taskbar is 54except for a few "fullscreen" applications that cover it up. The Taskbar is
55what lets you select which input method you would like to use, shows what 55what lets you select which input method you would like to use, shows what
56applications are running, and is also where the "applets" draw their icons. 56applications are running, and is also where the "applets" draw their icons.
57On the left of the Taskbar is an "O" button that opens a menu which has an 57On the left of the Taskbar is an "O" button that opens a menu which has an
58entry for every tab in the Launcher, allowing you to star an applications 58entry for every tab in the Launcher, allowing you to star an applications
59without going back to the Launcher, or quiting the application that you are 59without going back to the Launcher, or quiting the application that you are
60running. On the right hand side of the Taskbar, you will probably see a clock 60running. 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 61(unless you installed task-opie-minimal), which is actually just another applet
62that draws the time instead of an icon. 62that draws the time instead of an icon.
63</para> 63</para>
64<para> 64<para>
65When an application is run, it adds its icon to the Taskbar, starting from the 65When an application is run, it adds its icon to the Taskbar, starting from the
66right side of the input method icon, with new application's icons appearing to 66right side of the input method icon, with new application's icons appearing to
67the right. If you click on the icon for an application, it will be brought to 67the right. If you click on the icon for an application, it will be brought to
68the screen, allowing you to interact with it. 68the screen, allowing you to interact with it.
69</para> 69</para>
70<para> 70<para>
71To the right of the "O" menu you will see an icon for the currently selected 71To the right of the "O" menu you will see an icon for the currently selected
72input method. Clicking this will bring up the input method, allowing you to 72input method. Clicking this will bring up the input method, allowing you to
73type into the currently running application. To the right of the input method 73type into the currently running application. To the right of the input method
74icon is a small arrow pointing up, which will open a menu of all the currently 74icon is a small arrow pointing up, which will open a menu of all the currently
75installed input methods when clicked. When you select one of these, it will 75installed input methods when clicked. When you select one of these, it will
76become the current input method, with its icon replacing the previous one. 76become the current input method, with its icon replacing the previous one.
77</para> 77</para>
78</section> 78</section>
79 79
80<section><title>Dialogs</title> 80<section><title>Dialogs</title>
81<para> 81<para>
82In Opie, dialogs, as well as some applications, have a button labeled "Ok" on 82In &opie;, dialogs, as well as some applications, have a button labeled "Ok" on
83the right side of the window title bar, in addition to the normal "x". For 83the right side of the window title bar, in addition to the normal "x". For
84dialogs, the "Ok" button will apply your changes and close the window, while 84dialogs, the "Ok" button will apply your changes and close the window, while
85the "x" will cancel them before closing the window (for people used to most 85the "x" will cancel them before closing the window (for people used to most
86desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons 86desktop GUI's the "Ok" and "x" behave like the "Ok" and "Cancel" buttons
87you would normally see in the bottom right of the dialog window). 87you would normally see in the bottom right of the dialog window).
88</para> 88</para>
89<para> 89<para>
90For applications that have an "Ok" button as well as the "x" button that all 90For applications that have an "Ok" button as well as the "x" button that all
91applications have, the "Ok" button will usually save the current file and then 91applications have, the "Ok" button will usually save the current file and then
92close the application, while the "x" button will close the application without 92close the application, while the "x" button will close the application without
93saving. 93saving.
94</para> 94</para>
95</section> 95</section>
96</chapter> \ No newline at end of file 96</chapter> \ No newline at end of file
diff --git a/docs/usermanual/i18n.sgm b/docs/usermanual/i18n.sgm
index 1964f50..b1ac33a 100644
--- a/docs/usermanual/i18n.sgm
+++ b/docs/usermanual/i18n.sgm
@@ -1,77 +1,192 @@
1<chapter id=i18n><title>Translations</title> 1<chapter id=i18n>
2<section>
3 <title>Translations</title>
4
2 <para> 5 <para>
3 The OPIE-Project tries to offer the support for as many languages as possible. 6 The &opie;-Project tries to offer the support for as many languages
4 In this chapter the process of translating OPIE and its documentation is explained. 7 as possible. In this chapter the process of translating &opie; and its
8 documentation is explained.
5 </para> 9 </para>
6<section>
7 <title>Introduction</title>
8 <para> 10 <para>
9 To ensure that OPIE can be used by as many people as possible the OPIE-project 11 To ensure that &opie; can be used by as many people as possible the
10 aims to be translated in as many languages as possible. Of course, as there are so many 12 &opie;-project aims to be translated in as many languages as possible. Of
11 different languages, there is always a lot work to do. Furthermore, OPIE evolves and thus 13 course, as there are so many different languages, there is always a lot
12 most likely there are translations for applications which should be updated. In this tutorial 14 work to do. Furthermore, &opie; evolves and thus most likely there are
13 you will learn how to help OPIE to be availeble in as many languages as possible and see how 15 translations for applications which should be updated. In this tutorial
14 easy it is to give something very much respected to the open-source community. 16 you will learn how to help &opie; to be available in as many languages as
17 possible and see how easy it is to give something very much respected to
18 the open-source community.
15 </para> 19 </para>
16</section> 20</section>
21
17<section> 22<section>
18 <title>Preferences</title> 23 <title>Preferences</title>
24
19 <para> 25 <para>
20 In order to translate for OPIE you need an editor to edit the translationfile 26 In order to translate for &opie; you need an editor to edit the
21 and preferably access to cvs. The preferred editor is Linguist. That is an application which 27 translationfile and preferably access to cvs. The preferred editor
22 comes with Qt. It has a intuitive GUI and is very easy to use. A tutorial can be found here: 28 is Linguist. That is an application which comes with &qt;. It has a
23 <link>http://doc.trolltech.com/3.1/linguist-manual-3.html</link>. 29 intuitive GUI and is very easy to use. A tutorial can be found <ulink
24 </para> 30 url="http://doc.trolltech.com/3.1/linguist-manual-3.html">here</ulink>.
31 </para>
32 <para>
33 However, you can use every editor which works with UTF8, for example VIM or
34 EMACS. The advantage of Linguist is that its GUI is optimized for &opie;s
35 translationfiles and can help you by proposing a translation and notice
36 you if there is an error within the translation.
37 </para>
25 <para> 38 <para>
26 However, you can use every editor which works with UTF8, for example VIM or EMACS. The advantage 39 CVS is a tool which the developers and most translators use to get the source
27 of Linguist is that its GUI is optimized for OPIEs translationfiles and can help you be 40 of &opie;. If you already have an anonymous account for the &opie;-cvs you
28 proposing a translation and notice you if there is an error within the translation. 41 should go to <filename class='directory'>OPIEDIR/i18n</filename> and do
42 <programlisting>cvs up</programlisting>. If there is already a translation for the language you would like to
43 translate you will see the language code in that directory. For example,
44 for german this is <programlisting>de</programlisting> and for danish it is
45 <programlisting>da</programlisting>. If not, you should contact the coordinator
46 <personname><firstname>Carsten</firstname><surname>Niehaus</surname></personname>
47 so that everything will be set up for your language.
29 </para> 48 </para>
49</section>
50
51<section>
52 <title>Styleguide</title>
30 <para> 53 <para>
31 CVS is a tool which the developers and most translators use to get the source of OPIE. If you 54 To ensure a high quality of the translations the translatiors have to keep certain things
32 already have an anonymous account for the OPIE-cvs you should go to $OPIEDIR/i18n and do <code>cvs up</code>. 55 in mind.
33 If there is already a translation for the language you would like to translate you will see
34 the language code in that directory. For example, for german this is <code>de</code> and for danish
35 it is <code>da</code>. If not you should contact the coordinator Carsten Niehaus so that
36 everything will be set up for your language.
37 </para> 56 </para>
57 <itemizedlist mark='opencircle'>
58 <listitem>
59 <para>
60 The applications do not speak to the user. This means that for example it should not
61 be <errortext>I didn't find the file!</errortext> but <errortext>File not found!</errortext>.
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Try not to use exclamationmarks. If the users sees them to often the ! looses it function
67 as a amplifier of a warning.
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Don't put a space in front of a punctuation mark. So write eg "this is a demonstation!" insteadt
73 of "this is a demonstation !".
74 </para>
75 </listitem>
76 </itemizedlist>
38</section> 77</section>
78
39<section> 79<section>
40 <title>Examplecode</title> 80 <title>Examplecode</title>
81
41 <para> 82 <para>
42 In the next paragraph you see an example of how the XML looks like. 83 In the next paragraph you see an example of how the XML looks like.
43 </para>
44 <!--
45 <message>
46 <source>New</source>
47 <translation>Neu</translation>
48 </message>
49 <message>
50 <source>Today</source>
51 <translation>Heute</translation>
52 </message>
53 <message>
54 <source>Day</source>
55 <translation type="unfinished"></translation>
56 </message>
57 -->
58 </para> 84 </para>
85
86 <programlisting>
87 <message>
88 <source>New</source>
89 <translation>Neu</translation>
90 </message>
91 <message>
92 <source>Today</source>
93 <translation>Heute</translation>
94 </message>
95 <message>
96 <source>Day</source>
97 <translation type="unfinished"></translation>
98 </message>
99 </programlisting>
100
101 </para>
102 <para>
103 As you can see the markup is very simple. The part between two source-tags is
104 the english text which appears if there is no translation yet. In the first
105 case this is <quote>New</quote>. The next row is where the translated string
106 would be. The first two messages are already translated, the third is
107 not. This is marked by the <programlisting>type="unfinished"</programlisting>.
108 </para>
59 <para> 109 <para>
60 As you can see the markup is very simple. The part between two source-tags is the english 110 If you choose to use an editor like VIM instead of the prefered tool
61 text which appears if there is no translation yet. In the first case this is <quote>New</quote>. 111 -Linguist- you have to remove that mark and add the translated string
62 In the next rowis where the translation would be. The first two messages are already translated, 112 between the two <programlisting>translation</programlisting>-tags.
63 the third is not. This is marked by the <code>type="unfinished"</code>.
64 </para> 113 </para>
65 <para> 114 <para>
66 If you choose to use an editor like vim instead of the prefered tool -Linguist- you have to remove 115 It might happen that you see <programlisting>type="obsolete"</programlisting> in a
67 that mark and add the translated string between the two <code>translation</code>-tags. 116 .ts-file. You should not translate these stings as they do no longer appear in the
117 application. The translationcoordinator removes those strings from time to time. In
118 Linguist those strings are grey and not translatable.
68 </para> 119 </para>
69</section> 120</section>
121
70<section> 122<section>
71 <title>Do's and don'ts</title> 123 <title>Filetypes</title>
72 <para> 124 <para>
73 There are certain things that should only be done be the translationcoordinator or one of the 125 As a translator one need to know three different filetypes.
74 core developers. 126
127 <filename class='extension'>ts</filename>
128 .ts-files are the most important files for translators. In these files are all strings which
129 need to be translated and the translations themselfs. All .ts-files are located in
130 <filename class='directory'>OPIEDIR/i18n/xx</filename> while xx is a languagecode (eg. de or de).
131 In theory .ts-files are the only ones a translator needs to know.
132
133 <filename class='extension'>pro</filename>
134 Every application has a .pro-file from which the Makefiles are generated. As a translator
135 you need to check if in every .pro-file is a line for the language you would to
136 translate for. A line like this should look this way:
137
138 <programlisting>
139 ../../../i18n/de/today.ts \
140 </programlisting>
141
142 Usually the translationcoordinator takes care of these entries so you should not
143 need to edit them.
144
145 <filename class='extension'>qm</filename>
146 These are binary files used by &opie; to display the translated strings. They are
147 automatically generated by calling the command <command>make lrelease</command>. Of course,
148 you need to have the binary of <application>lrelease</application> which comes with &qt;.
75 </para> 149 </para>
76</section> 150</section>
151
152<section>
153 <title>Do's and don'ts</title>
154 There are certain things that should only be done be the
155 translationcoordinator or one of the core developers.
156 <itemizedlist mark='opencircle'>
157 <listitem>
158 <para>
159 The translationfiles should never be updated by the translators. Only the
160 translationcoordinator updates the repository. This is to avoid merging conflicts.
161 </para>
162 </listitem>
163 <listitem>
164 <para>
165 The binary .qm-files are created by either the translationcoordinator or by the feed-manager.
166 Of course, the translators can created them as described above for testingpurposes but
167 the official files will be provided.
168 </para>
169 </listitem>
170 <listitem>
171 <para>
172 Whenever you find a typo or an incorrect message contact the author of the application
173 and/or use our bugtrackingsystem (Mantis) to make sure this string will be fixed.
174 </para>
175 </listitem>
176 <listitem>
177 <para>
178 If you find a string like "Form1" contact the translationcoordinator. These strings
179 should not be in the translationfiles. You don't need to translate them.
180 </para>
181 </listitem>
182 <listitem>
183 <para>
184 If you check you translation and see a not translated string even though you translationfile
185 is 100% translated use the bugtrackingsystem and/or contact the author of that application
186 directly so that this bug is fixed.
187 </para>
188 </listitem>
189 </itemizedlist>
190</section>
191
77</chapter> 192</chapter>
diff --git a/docs/usermanual/installation.sgm b/docs/usermanual/installation.sgm
index 82834a6..62874bb 100644
--- a/docs/usermanual/installation.sgm
+++ b/docs/usermanual/installation.sgm
@@ -1,67 +1,67 @@
1<chapter><title>Installation</title> 1<chapter><title>Installation</title>
2<section><title>iPAQ</title> 2<section><title>iPAQ</title>
3<para> 3<para>
4To install opie on an iPAQ, you will need a fresh Familiar installation (ie, 4To install opie on an iPAQ, you will need a fresh Familiar installation (ie,
5install Familiar, and stop before you do ipkg install task-complete or ipkg 5install Familiar, and stop before you do ipkg install task-complete or ipkg
6install task-x), go to http://familiar.handhelds.org to get the latest version, 6install task-x), go to http://familiar.handhelds.org to get the latest version,
7and to get installation instructions (again, stop after the initial boot and do 7and to get installation instructions (again, stop after the initial boot and do
8not install X, as it is not necessary, and will only take up space). 8not install X, as it is not necessary, and will only take up space).
9</para> 9</para>
10 10
11<note> 11<note>
12<para> 12<para>
13If you had qpe/qtopia installed previously, 13If you had qpe/qtopia installed previously,
14<emphasis>completely</emphasis> remove it, and remove the src line for it from 14<emphasis>completely</emphasis> remove it, and remove the src line for it from
15your /etc/ipkg.conf file before attempting to install opie. 15your /etc/ipkg.conf file before attempting to install opie.
16</para> 16</para>
17</note> 17</note>
18<para> 18<para>
19Once you have Familiar installed, set up a network connection between your iPAQ 19Once you have Familiar installed, set up a network connection between your iPAQ
20and the ouside world (again, see the Familiar site for instructions on this), 20and the ouside world (again, see the Familiar site for instructions on this),
21and then run this command: 21and then run this command:
22<informalexample> 22<informalexample>
23<literallayout> 23<literallayout>
24 echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ 24 echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \
25 >> /etc/ipkg.conf 25 >> /etc/ipkg.conf
26</literallayout> 26</literallayout>
27</informalexample> 27</informalexample>
28then, run: 28then, run:
29<informalexample> 29<informalexample>
30<literallayout> 30<literallayout>
31 ipkg update && ipkg install task-opie 31 ipkg update && ipkg install task-opie
32</literallayout> 32</literallayout>
33</informalexample> 33</informalexample>
34If you have a 3100 or 3800 series iPAQ, run: 34If you have a 3100 or 3800 series iPAQ, run:
35<informalexample> 35<informalexample>
36<literallayout> 36<literallayout>
37 ipkg install qt-embedded-rotation 37 ipkg install qt-embedded-rotation
38</literallayout> 38</literallayout>
39</informalexample> 39</informalexample>
40finally, start Opie with: 40finally, start &opie; with:
41<informalexample> 41<informalexample>
42<literallayout> 42<literallayout>
43 /etc/init.d/opie start 43 /etc/init.d/opie start
44</literallayout> 44</literallayout>
45</informalexample> 45</informalexample>
46</para> 46</para>
47 47
48<para> 48<para>
49Opie should now be running (if you should have to reboot, which is rare, Opie 49&opie; should now be running (if you should have to reboot, which is rare, &opie;
50will start automatically). From here, you can use either the "Software" 50will start automatically). From here, you can use either the "Software"
51application in the Settings tab, or run ipkg from the command line to install 51application in the Settings tab, or run ipkg from the command line to install
52other Opie apps. Check out the various task-opie-* ipkgs to install various sets 52other &opie; apps. Check out the various task-opie-* ipkgs to install various sets
53of apps at once (you can always uninstall individual apps individually). You 53of apps at once (you can always uninstall individual apps individually). You
54will probably want to install opie-embeddedkonsole first, so you have access to 54will probably want to install opie-embeddedkonsole first, so you have access to
55the command line in Opie. 55the command line in &opie;.
56</para> 56</para>
57</section> 57</section>
58 58
59<section><title>Zaurus</title> 59<section><title>Zaurus</title>
60<para> 60<para>
61To completely install Opie on the Zaurus, you will have to install OpenZaurus, 61To completely install &opie; on the Zaurus, you will have to install OpenZaurus,
62which includes Opie. However, individual Opie applications will work fine on the 62which includes &opie;. However, individual &opie; applications will work fine on the
63default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM 63default Zaurus rom. Do not install &opie;'s launcher on a default Zaurus ROM
64though. 64though.
65</para> 65</para>
66</section> 66</section>
67</chapter> \ No newline at end of file 67</chapter> \ No newline at end of file
diff --git a/docs/usermanual/irda.sgm b/docs/usermanual/irda.sgm
index a2f084c..9e58e2d 100644
--- a/docs/usermanual/irda.sgm
+++ b/docs/usermanual/irda.sgm
@@ -1,45 +1,45 @@
1<chapter id=irda><title>IrDA Applet</title> 1<chapter id=irda><title>IrDA Applet</title>
2<para> 2<para>
3The IrDA Applet provides a GUI for easilly controlling communication between your device and others using the IrDA 3The IrDA Applet provides a GUI for easilly controlling communication between your device and others using the IrDA
4protocol. You can use it to communicate with PalmOS based devices, cell phones, and almost anything else that 4protocol. You can use it to communicate with PalmOS based devices, cell phones, and almost anything else that
5can use infra red to communicate. 5can use infra red to communicate.
6</para> 6</para>
7<section><title>Starting IrDA</title> 7<section><title>Starting IrDA</title>
8<para> 8<para>
9To start IrDA, click the IrDA Applet icon in the taskbar, and select "Enable IrDA". The icon should then turn red, and 9To start IrDA, click the IrDA Applet icon in the taskbar, and select "Enable IrDA". The icon should then turn red, and
10clicking the icon should then bring up a larger menu. If this does not happen, you do not have the IrDA modules installed 10clicking the icon should then bring up a larger menu. If this does not happen, you do not have the IrDA modules installed
11properly on you device. Make sure you install the IrDA driver package for the device and distribution that you are using. 11properly on you device. Make sure you install the IrDA driver package for the device and distribution that you are using.
12</para> 12</para>
13</section> 13</section>
14<section><title>Recieving Files</title> 14<section><title>Recieving Files</title>
15<para> 15<para>
16If you want to recieve files like images or contact information from another device, you need to tell your device to 16If you want to recieve files like images or contact information from another device, you need to tell your device to
17start looking for other devices. Do this by clicking on the IrDA Applet icon and selectiong "Enable Discovery". A 17start looking for other devices. Do this by clicking on the IrDA Applet icon and selectiong "Enable Discovery". A
18green dot should appear in the upper right hand corner of the IrDA Applet icon. Then select "Enable Recieve" from 18green dot should appear in the upper right hand corner of the IrDA Applet icon. Then select "Enable Recieve" from
19the applet's menu, and a white box should appear in the bottom left corner of the IrDA Applet's icon. You can then 19the applet's menu, and a white box should appear in the bottom left corner of the IrDA Applet's icon. You can then
20have the other device send the file, and Opie should recieve it and open the file in whatever application is 20have the other device send the file, and &opie; should recieve it and open the file in whatever application is
21appropriate. 21appropriate.
22</para> 22</para>
23<para> 23<para>
24When you are done recieving files, you will want to select "Disable Recieve" and "Disable Discovery" from the 24When you are done recieving files, you will want to select "Disable Recieve" and "Disable Discovery" from the
25IrDA Applet's menu so that you are not wasting system resources. 25IrDA Applet's menu so that you are not wasting system resources.
26</para> 26</para>
27</section> 27</section>
28<section><title>Beaming Files</title> 28<section><title>Beaming Files</title>
29<para> 29<para>
30Several applications support beaming files in a format specific to that application (specifically, Contacts, Calendar, 30Several applications support beaming files in a format specific to that application (specifically, Contacts, Calendar,
31and Todo). However, sometimes you may need to simply send a file to another device via IrDA, regardless of the 31and Todo). However, sometimes you may need to simply send a file to another device via IrDA, regardless of the
32file type. To do this, you can use either AdvancedFM (yet to be documented), or you can do this from the 32file type. To do this, you can use either AdvancedFM (yet to be documented), or you can do this from the
33Documents tab. To beam a file from the Documents tab, you must first add that file to the Documents tab if you 33Documents tab. To beam a file from the Documents tab, you must first add that file to the Documents tab if you
34havent already (see <xref linkend="adddoc">). Then, go to the Documents tab and press and hold on the icon for 34havent already (see <xref linkend="adddoc">). Then, go to the Documents tab and press and hold on the icon for
35the file you want to send. A dialog should appear, with a button in the bottom right labeled "Beam". Press this 35the file you want to send. A dialog should appear, with a button in the bottom right labeled "Beam". Press this
36button, and Opie will beam the file to any waiting devices. 36button, and &opie; will beam the file to any waiting devices.
37</para> 37</para>
38</section> 38</section>
39<section><title>Stoping IrDA</title> 39<section><title>Stoping IrDA</title>
40<para> 40<para>
41Sometimes it is necessary to stop IrDA, usually so that you can use the IR port for another application. To do this, 41Sometimes it is necessary to stop IrDA, usually so that you can use the IR port for another application. To do this,
42select "Disable IrDA" from the IrDA applet's menu. 42select "Disable IrDA" from the IrDA applet's menu.
43</para> 43</para>
44</section> 44</section>
45</chapter> \ No newline at end of file 45</chapter> \ No newline at end of file
diff --git a/docs/usermanual/keypebble.sgm b/docs/usermanual/keypebble.sgm
index a4ebfdf..92b3628 100644
--- a/docs/usermanual/keypebble.sgm
+++ b/docs/usermanual/keypebble.sgm
@@ -1,63 +1,63 @@
1<chapter><title>VNC Viewer</title> 1<chapter><title>VNC Viewer</title>
2<para> 2<para>
3The OPIE VNC Viewer allows you to connect to servers that are compatible with 3The &opie; VNC Viewer allows you to connect to servers that are compatible with
4the Remote Frame Buffer (RFB) protocol, most commonly used by the VNC remote 4the Remote Frame Buffer (RFB) protocol, most commonly used by the VNC remote
5access software. 5access software.
6</para> 6</para>
7 7
8<section><title>Adding a bookmark</title> 8<section><title>Adding a bookmark</title>
9<para> 9<para>
10To add a new bookmark to your bookmark list, lick the New icon on the 10To add a new bookmark to your bookmark list, lick the New icon on the
11window's toolbar. The "VNC Viewer Connection" dialog will appear. Enter the 11window's toolbar. The "VNC Viewer Connection" dialog will appear. Enter the
12hostname or IP address of the computer you would like to connect to in the 12hostname or IP address of the computer you would like to connect to in the
13"Host Name" field. In the "Display Number" field, enter the number of the 13"Host Name" field. In the "Display Number" field, enter the number of the
14display you would like to connect to. If you are connecting to a Windows or 14display you would like to connect to. If you are connecting to a Windows or
15Mac OS server, you typically select display 0. Unix servers typically use 15Mac OS server, you typically select display 0. Unix servers typically use
16display 1 or higher. You must also enter the password for the server you 16display 1 or higher. You must also enter the password for the server you
17would like to connect to if it requires one. If you are having difficulties 17would like to connect to if it requires one. If you are having difficulties
18entering the password, you can select "Show Password" to show the password 18entering the password, you can select "Show Password" to show the password
19you are entering. You must also add a descriptive name for the bookmark if 19you are entering. You must also add a descriptive name for the bookmark if
20you would like it to be saved. You can then either select the OK button to 20you would like it to be saved. You can then either select the OK button to
21save the bookmark and connect to the server, or the cancel button to return 21save the bookmark and connect to the server, or the cancel button to return
22to the bookmark list. 22to the bookmark list.
23</para> 23</para>
24</section> 24</section>
25<section><title>Connecting to a bookmarked server</title> 25<section><title>Connecting to a bookmarked server</title>
26<para> 26<para>
27To connect to a server that has already been bookmarked, select the bookmark 27To connect to a server that has already been bookmarked, select the bookmark
28from the list and press the "Open" icon on the toolbar. The "VNC Viewer 28from the list and press the "Open" icon on the toolbar. The "VNC Viewer
29Connection" dialog will appear, and you will have the chance to modify the 29Connection" dialog will appear, and you will have the chance to modify the
30bookmark before actually connecting. Pressing the OK button will connect to 30bookmark before actually connecting. Pressing the OK button will connect to
31the server, and pressing the cancel button will return to the bookmark list. 31the server, and pressing the cancel button will return to the bookmark list.
32</para> 32</para>
33</section> 33</section>
34<section><title>Deleting a bookmark</title> 34<section><title>Deleting a bookmark</title>
35<para> 35<para>
36To delete a bookmark, choose the bookmark that you would like to delete, and 36To delete a bookmark, choose the bookmark that you would like to delete, and
37select the delete item from the toolbar. 37select the delete item from the toolbar.
38</para> 38</para>
39</section> 39</section>
40<section><title>Advanced Connection Options</title> 40<section><title>Advanced Connection Options</title>
41<para> 41<para>
42In addition to the display number, hostname, and password, you can choose many 42In addition to the display number, hostname, and password, you can choose many
43advanced options from the "VNC Viewer Connection" dialog box that will affect 43advanced options from the "VNC Viewer Connection" dialog box that will affect
44the performance of the connection. 44the performance of the connection.
45</para> 45</para>
46<para> 46<para>
47On the options tab you can set the delay in between requesting updates to the 47On the options tab you can set the delay in between requesting updates to the
48screen, a higher value will result in a more up to date screen, but you will 48screen, a higher value will result in a more up to date screen, but you will
49use more bandwidth. You can also choose to restrict your connection to 8 bit 49use more bandwidth. You can also choose to restrict your connection to 8 bit
50color, which is much faster than using the color depth of the remote server 50color, which is much faster than using the color depth of the remote server
51at the cost of image quality. Requesting a shared session tells the RFB server 51at the cost of image quality. Requesting a shared session tells the RFB server
52that you are willing to let other users connect at the same time. You can use 52that you are willing to let other users connect at the same time. You can use
53the scaling factor on fit more of the remote screen into the space available on 53the scaling factor on fit more of the remote screen into the space available on
54your PDA, if you are willing to accept the performance hit involved in the 54your PDA, if you are willing to accept the performance hit involved in the
55scaling. 55scaling.
56</para> 56</para>
57<para> 57<para>
58The Encodings tab allows you to select which of the supported encodings you would 58The Encodings tab allows you to select which of the supported encodings you would
59would like the VNC Viewer to use to communicate with the remote server. In most 59would like the VNC Viewer to use to communicate with the remote server. In most
60cases you don't need to modify anything on this tab. 60cases you don't need to modify anything on this tab.
61</para> 61</para>
62</chapter> 62</chapter>
63 63
diff --git a/docs/usermanual/software.sgm b/docs/usermanual/software.sgm
index 8b82118..a0a8264 100644
--- a/docs/usermanual/software.sgm
+++ b/docs/usermanual/software.sgm
@@ -1,199 +1,199 @@
1<chapter><title>Software</title> 1<chapter><title>Software</title>
2 2
3<para> 3<para>
4The "Software" application, also called oipkg, is what is used to install and 4The "Software" application, also called oipkg, is what is used to install and
5remove software. It is actually a frontend to the command line program "ipkg" 5remove software. It is actually a frontend to the command line program "ipkg"
6so most things you can do with oipkg you can also do with ipkg. Oipkg can 6so most things you can do with oipkg you can also do with ipkg. Oipkg can
7install things either remotely from a web server (called a "feed") or it can 7install things either remotely from a web server (called a "feed") or it can
8install an ipkg package file that resides on the local filesystem. 8install an ipkg package file that resides on the local filesystem.
9</para> 9</para>
10<important> 10<important>
11<para> 11<para>
12If you are using a version of ipkg lower than 0.99.20 there is a bug that prevents 12If you are using a version of ipkg lower than 0.99.20 there is a bug that prevents
13oipkg from working properly. If you see errors in the installation log about not being 13oipkg from working properly. If you see errors in the installation log about not being
14able to kill the old gunzip process, you can get around this by starting oipkg from 14able to kill the old gunzip process, you can get around this by starting oipkg from
15Embedded Konsole. 15Embedded Konsole.
16</para> 16</para>
17</important> 17</important>
18 18
19<section><title>Installing Software</title> 19<section><title>Installing Software</title>
20<para> 20<para>
21There are several way to install a software package, depending on how you are 21There are several way to install a software package, depending on how you are
22accessing the package. 22accessing the package.
23</para> 23</para>
24<para> 24<para>
25To install software from a feed (see <xref linkend=feed>), first select "Opie" from the 25To install software from a feed (see <xref linkend=feed>), first select "&opie;" from the
26"Section" pulldown menu, the press the "+" icon next to "Feeds" in the main view. 26"Section" pulldown menu, the press the "+" icon next to "Feeds" in the main view.
27This will show all the available Opie packages (you can change which packages 27This will show all the available &opie; packages (you can change which packages
28to view by selecting something else from the "Section" pulldown). Installed 28to view by selecting something else from the "Section" pulldown). Installed
29packages are marked with a blue circle, while packages that are not installed are marked with a red 29packages are marked with a blue circle, while packages that are not installed are marked with a red
30box. If you click on the icon for an uninstalled package, it will turn into an 30box. If you click on the icon for an uninstalled package, it will turn into an
31open box, with a blue circle coming out of it, indicating that you have marked 31open box, with a blue circle coming out of it, indicating that you have marked
32this package to be installed. Mark as many packages as you wish this way, and 32this package to be installed. Mark as many packages as you wish this way, and
33then press the "Apply" icon (same red box and blue dot icon) to install all 33then press the "Apply" icon (same red box and blue dot icon) to install all
34the marked packages. It will also remove any packages marked for removal (see 34the marked packages. It will also remove any packages marked for removal (see
35below). Clicking this will open a window showing all the packages marked to be 35below). Clicking this will open a window showing all the packages marked to be
36removed and installed, with some check boxes on the bottom, which represent 36removed and installed, with some check boxes on the bottom, which represent
37arguments to be sent to ipkg, which you can usually ignore. After verifying 37arguments to be sent to ipkg, which you can usually ignore. After verifying
38that all the packages to be installed are correct, press "Ok" in the upper 38that all the packages to be installed are correct, press "Ok" in the upper
39right corner (or press "x" to cancel and go back to the package selection 39right corner (or press "x" to cancel and go back to the package selection
40window). The packages should then install, and you should see their icons 40window). The packages should then install, and you should see their icons
41appear in the Launcher, if they are Opie applications. 41appear in the Launcher, if they are &opie; applications.
42</para> 42</para>
43<para> 43<para>
44If you would like to install software that is not avaialable in a feed, you can 44If you would like to install software that is not avaialable in a feed, you can
45download it to your device, and open Filemanger to the directory that it is in. You 45download it to your device, and open Filemanger to the directory that it is in. You
46can then press and hold on the file name, and select "Open in Software", and oipkg 46can then press and hold on the file name, and select "Open in Software", and oipkg
47will be started, with the package already marked to install. Confirm that it is the 47will be started, with the package already marked to install. Confirm that it is the
48correct package, and check any options that you may need and press "Ok" to install 48correct package, and check any options that you may need and press "Ok" to install
49the package. 49the package.
50</para> 50</para>
51<para> 51<para>
52If you would like to install a package but are not sure where to find it, and it is not in 52If you would like to install a package but are not sure where to find it, and it is not in
53any of the feeds that you are using, you can try to have oipkg search for it. You can 53any of the feeds that you are using, you can try to have oipkg search for it. You can
54enter a query in the "Search" field in the toolbars, and then press the magnifying 54enter a query in the "Search" field in the toolbars, and then press the magnifying
55glass icon. Oipkg will then search a list of feeds as well as some software websites, 55glass icon. Oipkg will then search a list of feeds as well as some software websites,
56and show you all the packages that it thinks might be what you are looking for, and 56and show you all the packages that it thinks might be what you are looking for, and
57displays them under the "ipkgfind&amp;killefiz" section in the Package view. You can 57displays them under the "ipkgfind&amp;killefiz" section in the Package view. You can
58then select the packages that you would like to install from that list and install them 58then select the packages that you would like to install from that list and install them
59as you normally would install packages from a feed. 59as you normally would install packages from a feed.
60</para> 60</para>
61</section> 61</section>
62 62
63<section><title>Removing Software</title> 63<section><title>Removing Software</title>
64<para> 64<para>
65Removing software is the same as installing software, except you will press the 65Removing software is the same as installing software, except you will press the
66blue circle icon of an installed package, and it will have a red "X" over it. 66blue circle icon of an installed package, and it will have a red "X" over it.
67Then press the apply icon, and "Ok". You can install and remove packages at 67Then press the apply icon, and "Ok". You can install and remove packages at
68the same time by marking the ones you want to install and the ones you want to 68the same time by marking the ones you want to install and the ones you want to
69remove, and then pressing apply. 69remove, and then pressing apply.
70</para> 70</para>
71</section> 71</section>
72 72
73<section id=feed><title>Servers</title> 73<section id=feed><title>Servers</title>
74<para> 74<para>
75When you install software normally, ipkg downloadins the packages automatically 75When you install software normally, ipkg downloadins the packages automatically
76from ipkg servers (also called "Feeds") and installing them. The list of 76from ipkg servers (also called "Feeds") and installing them. The list of
77servers and where they are is stored in a file called ipkg.conf in /etc/. Oipkg 77servers and where they are is stored in a file called ipkg.conf in /etc/. Oipkg
78is capable of maintaining this list, as well as adding or deleting feeds from 78is capable of maintaining this list, as well as adding or deleting feeds from
79it. 79it.
80</para> 80</para>
81<section><title>Selecting Servers</title> 81<section><title>Selecting Servers</title>
82<para> 82<para>
83To select which feeds you want to be able to see and install packages from, go 83To select which feeds you want to be able to see and install packages from, go
84to Settings&arrow;Setups. There will be a box with a list of servers in it 84to Settings&arrow;Setups. There will be a box with a list of servers in it
85called "Used Servers". Servers that are highlighted will be used to install 85called "Used Servers". Servers that are highlighted will be used to install
86software from, while servers that are not highlighted will be ignored. You can 86software from, while servers that are not highlighted will be ignored. You can
87click on a server to toggle its status. When a server is disabled, the 87click on a server to toggle its status. When a server is disabled, the
88information about that server such as its name and location is kept, so that 88information about that server such as its name and location is kept, so that
89you can resume using it without having to reenter this data. "Ok" will save the 89you can resume using it without having to reenter this data. "Ok" will save the
90changes, and "x" will cancel them. 90changes, and "x" will cancel them.
91</para> 91</para>
92</section> 92</section>
93<section><title>Adding Servers</title> 93<section><title>Adding Servers</title>
94<para> 94<para>
95You can add a server to your list of available servers by going to 95You can add a server to your list of available servers by going to
96Settings&arrow;Servers. Click on the button labeled "New" and enter the name 96Settings&arrow;Servers. Click on the button labeled "New" and enter the name
97and URL into the appropriate fields at the bottom of the window. The name is 97and URL into the appropriate fields at the bottom of the window. The name is
98only for your convinience, so name it whatever makes sense to you. The URL is 98only for your convinience, so name it whatever makes sense to you. The URL is
99the URL of the feed, so the URL for the opie feed would be 99the URL of the feed, so the URL for the opie feed would be
100"http://131.152.105.154/feeds/ipaq/unstable". When you are done, click "Ok" to 100"http://131.152.105.154/feeds/ipaq/unstable". When you are done, click "Ok" to
101save the new server, or "x" to cancel adding it. 101save the new server, or "x" to cancel adding it.
102</para> 102</para>
103</section> 103</section>
104<section><title>Editing Servers</title> 104<section><title>Editing Servers</title>
105<para> 105<para>
106To change the URL or name of a server, go to Settings&arrow;Servers, and select 106To change the URL or name of a server, go to Settings&arrow;Servers, and select
107the server that you want to edit. The current Name and URL should appear in the 107the server that you want to edit. The current Name and URL should appear in the
108appropriate fields, and you can change them to the new values. Once you are 108appropriate fields, and you can change them to the new values. Once you are
109done, click "Ok" to save, or "x" to cancel. 109done, click "Ok" to save, or "x" to cancel.
110</para> 110</para>
111</section> 111</section>
112<section><title>Deleting Servers</title> 112<section><title>Deleting Servers</title>
113<para> 113<para>
114If you no longer need to use a server, this can be done by going to 114If you no longer need to use a server, this can be done by going to
115Settings&arrow;Servers. You can then select the server you wish to delete and 115Settings&arrow;Servers. You can then select the server you wish to delete and
116press the "Remove" button. "Ok" will save the deletion, and "x" will cancel it. 116press the "Remove" button. "Ok" will save the deletion, and "x" will cancel it.
117</para> 117</para>
118</section> 118</section>
119</section> 119</section>
120 120
121<section><title>Destinations</title> 121<section><title>Destinations</title>
122<para> 122<para>
123Software is distributed in a format called "ipkg" which contains all the 123Software is distributed in a format called "ipkg" which contains all the
124necessary files for the program, as well as information on where to put them. 124necessary files for the program, as well as information on where to put them.
125However, this information is only half complete, as it tells the package manager 125However, this information is only half complete, as it tells the package manager
126where in the "destination" to put the files, but the package manager must know 126where in the "destination" to put the files, but the package manager must know
127where this "destination" is. The default destination is "/" (called "root") so 127where this "destination" is. The default destination is "/" (called "root") so
128if the package says to install a file in opt/QtPalmtop/ then the file will be 128if the package says to install a file in opt/QtPalmtop/ then the file will be
129installed in /opt/QtPalmtop/. However, if ask the package manger to use a 129installed in /opt/QtPalmtop/. However, if ask the package manger to use a
130destination at /mnt/hda/ (this is typically where a compact flash card would be) 130destination at /mnt/hda/ (this is typically where a compact flash card would be)
131then the files will be installed in /mnt/hda/opt/QtPalmtop/. 131then the files will be installed in /mnt/hda/opt/QtPalmtop/.
132</para> 132</para>
133<para> 133<para>
134The problem with installing file in a destination other than root is that the 134The problem with installing file in a destination other than root is that the
135software usually does not know where to fine the installed files, and Opie does 135software usually does not know where to fine the installed files, and &opie; does
136not know where to find the information that tells it how to display the program 136not know where to find the information that tells it how to display the program
137in the Launcher. To get around this, the package manager creates links 137in the Launcher. To get around this, the package manager creates links
138<footnote><para>See <xref linkend=symlink> for more information on symbolic 138<footnote><para>See <xref linkend=symlink> for more information on symbolic
139links in Linux</para></footnote> from where the files would be if they were 139links in Linux</para></footnote> from where the files would be if they were
140installed in root to where they are actually installed. This means that no more 140installed in root to where they are actually installed. This means that no more
141space is taken up where the files would normally be installed, but any programs 141space is taken up where the files would normally be installed, but any programs
142can still find the files where they think they should be. 142can still find the files where they think they should be.
143</para> 143</para>
144 144
145<section><title>Using Destinations</title> 145<section><title>Using Destinations</title>
146<para> 146<para>
147To mark a single package to be installed to a destination other than the default, you 147To mark a single package to be installed to a destination other than the default, you
148can press and hold on it, and select the destination you would like to use from the 148can press and hold on it, and select the destination you would like to use from the
149"Install to" menu. That package will then be installed in that destination. 149"Install to" menu. That package will then be installed in that destination.
150</para> 150</para>
151<para> 151<para>
152To install a group of packages in a destination other than root, go to 152To install a group of packages in a destination other than root, go to
153Settings&arrow;Setups to open the settings dialog to the Setups tab. From here 153Settings&arrow;Setups to open the settings dialog to the Setups tab. From here
154you can select the destination you would like to install the package to from the 154you can select the destination you would like to install the package to from the
155pulldown menu at the bottom. You will also want to check "Link to root 155pulldown menu at the bottom. You will also want to check "Link to root
156destination" so that links are properly made. Once you have selected the 156destination" so that links are properly made. Once you have selected the
157destination you want to install the package to, click the dialog's "Ok" button, 157destination you want to install the package to, click the dialog's "Ok" button,
158and all packages that you mark for install will be installed in the selected feed 158and all packages that you mark for install will be installed in the selected feed
159(The destination will not be changed for the packages already marked for 159(The destination will not be changed for the packages already marked for
160installation). 160installation).
161</para> 161</para>
162<para> 162<para>
163You can also change the default destination by checking View&arrow;Destinations 163You can also change the default destination by checking View&arrow;Destinations
164to add the Destination toolbar to your toolbars. You can then select the default 164to add the Destination toolbar to your toolbars. You can then select the default
165destination from the pulldown menu, as well as use the checkbox to select whether 165destination from the pulldown menu, as well as use the checkbox to select whether
166the packages should be linked to the root destination or not. 166the packages should be linked to the root destination or not.
167</para> 167</para>
168</section> 168</section>
169<section><title>Adding Destinations</title> 169<section><title>Adding Destinations</title>
170<para> 170<para>
171To add a destination, go to Settings&arrow;Destinations to bring up the settings 171To add a destination, go to Settings&arrow;Destinations to bring up the settings
172dialog at the Destinations tab, and press the "New" button to add a new 172dialog at the Destinations tab, and press the "New" button to add a new
173Destination to the list. The new destination should be highlighted 173Destination to the list. The new destination should be highlighted
174automatically, and you can then change the name and the URL with the two text 174automatically, and you can then change the name and the URL with the two text
175entry fields below it. The name is only for easy display of the destination, so 175entry fields below it. The name is only for easy display of the destination, so
176name it whatever makes the most sense to you. The URL is the location that you 176name it whatever makes the most sense to you. The URL is the location that you
177want the destination to have. So, if you want all your software to be installed 177want the destination to have. So, if you want all your software to be installed
178under /usr/directory then you would set the URL to that. You can then click 178under /usr/directory then you would set the URL to that. You can then click
179"Ok" to save, or "x" to cancel the changes. 179"Ok" to save, or "x" to cancel the changes.
180</para> 180</para>
181</section> 181</section>
182<section><title>Editing Destinations</title> 182<section><title>Editing Destinations</title>
183<para> 183<para>
184You can edit a destination by going to Settings&arrow;Destinations and selecting 184You can edit a destination by going to Settings&arrow;Destinations and selecting
185the destination that you would like to edit. Then you can edit the Name and URL 185the destination that you would like to edit. Then you can edit the Name and URL
186fields in the same manner as when you added a destination. To save, click "Ok" 186fields in the same manner as when you added a destination. To save, click "Ok"
187or cancel by clicking "x". 187or cancel by clicking "x".
188</para> 188</para>
189</section> 189</section>
190<section><title>Deleting Destinations</title> 190<section><title>Deleting Destinations</title>
191<para> 191<para>
192Deleting a destination is very easy. Go to Settings&arrow;Destinations and 192Deleting a destination is very easy. Go to Settings&arrow;Destinations and
193select the Destination that you would like to delete in the dialog that appears. 193select the Destination that you would like to delete in the dialog that appears.
194 Press the "Remove" button to delete the destination, and press "Ok" to save the 194 Press the "Remove" button to delete the destination, and press "Ok" to save the
195changes, or "x" to cancel them. 195changes, or "x" to cancel them.
196</para> 196</para>
197</section> 197</section>
198</section> 198</section>
199</chapter> 199</chapter>
diff --git a/docs/usermanual/today.sgm b/docs/usermanual/today.sgm
index d77921c..4c96af0 100644
--- a/docs/usermanual/today.sgm
+++ b/docs/usermanual/today.sgm
@@ -1,53 +1,53 @@
1<chapter><title>Today</title> 1<chapter><title>&today;</title>
2<para> 2<para>
3The Today application is a convenient way to view both the appointments from the Calendar and the tasks from the 3The &today; application is a convenient way to view both the appointments from the Calendar and the tasks from the
4Todo application for the current day, as well as seeing what e-mail is available. It provides no interface for editing your 4Todo application for the current day, as well as seeing what e-mail is available. It provides no interface for editing your
5appointments, or your tasks, but if you click the icon of the application, it will be launched. For those familiar with 5appointments, or your tasks, but if you click the icon of the application, it will be launched. For those familiar with
6PocketPC, this is similar to the Today application included with that. 6PocketPC, this is similar to the &today; application included with that.
7</para> 7</para>
8<section><title>Configuration</title> 8<section><title>Configuration</title>
9<para> 9<para>
10You can configure the Today application by pressing the wrench icon in the bottom left corner of the window. This will 10You can configure the &today; application by pressing the wrench icon in the bottom left corner of the window. This will
11open the configuration dialog, from which you can change various settings related to display, amongst other things. 11open the configuration dialog, from which you can change various settings related to display, amongst other things.
12</para> 12</para>
13<section><title>Calendar</title> 13<section><title>Calendar</title>
14<para> 14<para>
15The Calendar tab in the configuration dialog lets you change the settings for how your appointments should be displayed. 15The Calendar tab in the configuration dialog lets you change the settings for how your appointments should be displayed.
16</para> 16</para>
17<para> 17<para>
18The first field allows you to select the number of appointments to be shown in the Calendar section of the application. 18The first field allows you to select the number of appointments to be shown in the Calendar section of the application.
19If you add more appointments, you will be taking away screen space from the other sections. 19If you add more appointments, you will be taking away screen space from the other sections.
20The "Should location be shown?" is for determining exactly that. If checked, the location field of the appointment 20The "Should location be shown?" is for determining exactly that. If checked, the location field of the appointment
21will be shown in the Today main view. 21will be shown in the &today; main view.
22"Show only later appoinmtnets" will only show appointments that begin after the current time. 22"Show only later appoinmtnets" will only show appointments that begin after the current time.
23Finally, if the "Should the notes be shown" checkbox is checked, then the notes for each appointment will be visible 23Finally, if the "Should the notes be shown" checkbox is checked, then the notes for each appointment will be visible
24in the main view. 24in the main view.
25</para> 25</para>
26</section> 26</section>
27<section><title>Tasks</title> 27<section><title>Tasks</title>
28<para> 28<para>
29The Tasks tab lets you change how tasks are displayed in the Today main view. 29The Tasks tab lets you change how tasks are displayed in the &today; main view.
30</para> 30</para>
31<para> 31<para>
32The first field lets you chose how many tasks to display in the main view. The more that are shown, the more space 32The first field lets you chose how many tasks to display in the main view. The more that are shown, the more space
33is taken from the other categories. 33is taken from the other categories.
34</para> 34</para>
35</section> 35</section>
36<section><title>Miscellaneous</title> 36<section><title>Miscellaneous</title>
37<para> 37<para>
38The Misc. tab allows you to set global settings that affect the entire application. 38The Misc. tab allows you to set global settings that affect the entire application.
39</para> 39</para>
40<para> 40<para>
41The "Clip after how many letters" field lets you change the number of characters from each appointment or task that 41The "Clip after how many letters" field lets you change the number of characters from each appointment or task that
42are displayed in the main view. The "Should today be autostarted on resume" checkbox lets you set whether or not 42are displayed in the main view. The "Should today be autostarted on resume" checkbox lets you set whether or not
43the Today application should be started each time you resume from a suspend or not.<note><para>This only works 43the &today; application should be started each time you resume from a suspend or not.<note><para>This only works
44if you have a full installation of Opie. If you are running Today on some other environment (Qtopia, for example) 44if you have a full installation of &opie;. If you are running &today; on some other environment (Qtopia, for example)
45this feature will not work.</para></note>The final field, "Activate autostart after how many minutes", lets you set 45this feature will not work.</para></note>The final field, "Activate autostart after how many minutes", lets you set
46the number of minutes that the device must be suspended before the Today application will start automatically on 46the number of minutes that the device must be suspended before the &today; application will start automatically on
47resume. For instance, if this is set to 5, and you suspend the device for 3 minutes, when you resume the device, the 47resume. For instance, if this is set to 5, and you suspend the device for 3 minutes, when you resume the device, the
48Today application will not start automatically. However, if it is set to 5 and you leave the device in the suspend state 48&today; application will not start automatically. However, if it is set to 5 and you leave the device in the suspend state
49for 6 minutes, then Today will be started automatically upon resume. 49for 6 minutes, then &today; will be started automatically upon resume.
50</para> 50</para>
51</section> 51</section>
52</section> 52</section>
53</chapter> 53</chapter>
diff --git a/docs/usermanual/todo.sgm b/docs/usermanual/todo.sgm
index 18138d9..223de7b 100644
--- a/docs/usermanual/todo.sgm
+++ b/docs/usermanual/todo.sgm
@@ -27,69 +27,69 @@ task.
27</section> 27</section>
28<section><title>Editing Tasks</title> 28<section><title>Editing Tasks</title>
29<para> 29<para>
30To edit a task, you can select it, and then go to 30To edit a task, you can select it, and then go to
31<GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>Edit 31<GUIMenu>Data</GUIMenu>&arrow;<GUIMenuItem>Edit
32Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same 32Task</GUIMenuItem>, or click the edit task icon (an image of a pencil). The same
33dialog should apear as if you were adding a task, but the information for that 33dialog should apear as if you were adding a task, but the information for that
34task should already be filled in. You can change any of it you want to, and then 34task should already be filled in. You can change any of it you want to, and then
35click "ok" in the top right corner to save the changes, or "x" to go back to 35click "ok" in the top right corner to save the changes, or "x" to go back to
36the way it was. 36the way it was.
37</para> 37</para>
38</section> 38</section>
39 39
40<section><title>Deleting Tasks</title> 40<section><title>Deleting Tasks</title>
41<para> 41<para>
42To delete a task, first select it, and then either select 42To delete a task, first select it, and then either select
43<GUIMenu>Data</GUIMenu>&arrow; 43<GUIMenu>Data</GUIMenu>&arrow;
44<GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of 44<GUIMenuItem>Delete...</GUIMenuItem> or press the Delete icon (an image of
45a trash can). A dialog should pop up, asking if you want to delete the task, 45a trash can). A dialog should pop up, asking if you want to delete the task,
46click yes to delete it, or no to cancel. 46click yes to delete it, or no to cancel.
47</para> 47</para>
48</section> 48</section>
49<section><title>Finding Tasks</title> 49<section><title>Finding Tasks</title>
50<para> 50<para>
51To find a task, either go to 51To find a task, either go to
52<GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem> 52<GUIMenu>Options</GUIMenu>&arrow;<GUIMenuItem>Find</GUIMenuItem>
53, or click the find icon (an image of a green magnifying glass), and a dialog 53, or click the find icon (an image of a green magnifying glass), and a dialog
54should pop up. Enter the text you want to search for in the description, and 54should pop up. Enter the text you want to search for in the description, and
55select the category that you want it to search through (this will speed the 55select the category that you want it to search through (this will speed the
56search up, if you know what category it is in). You can also select "case 56search up, if you know what category it is in). You can also select "case
57sensative" which makes the search pay attention to the case of what you type (so 57sensative" which makes the search pay attention to the case of what you type (so
58if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search 58if you look for "mow lawn", it won't find a task called "Mow lawn"). "Search
59Backwards" will search backwards from the currently selected task. Click "Find" 59Backwards" will search backwards from the currently selected task. Click "Find"
60to initiate the search, when it finds a task that matches the string, it will 60to initiate the search, when it finds a task that matches the string, it will
61select it. If you click Find again, it will find the next one in the list (or 61select it. If you click Find again, it will find the next one in the list (or
62the previous one, if "Search backwards" is selected). 62the previous one, if "Search backwards" is selected).
63</para> 63</para>
64</section> 64</section>
65 65
66<section><title>Viewing Tasks</title> 66<section><title>Viewing Tasks</title>
67<para> 67<para>
68To only view tasks filled under certain categories, go to the Category menu, and 68To only view tasks filled under certain categories, go to the Category menu, and
69check the categories you want to view. Also, under the Options menu, you can 69check the categories you want to view. Also, under the Options menu, you can
70select whether or not you want completed tasks to be visible, and whether or not 70select whether or not you want completed tasks to be visible, and whether or not
71you want to see the deadline. 71you want to see the deadline.
72</para> 72</para>
73</section> 73</section>
74 74
75<section><title>Completing Tasks</title> 75<section><title>Completing Tasks</title>
76<para> 76<para>
77To mark a task as completed without deleting it, you can either check the 77To mark a task as completed without deleting it, you can either check the
78checkbox next to it in the main view, or edit it, and check the "completed" 78checkbox next to it in the main view, or edit it, and check the "completed"
79check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow; 79check box in the edit dialog. If <GUIMenu>Options</GUIMenu>&arrow;
80<GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will 80<GUIMenuItem>Completed<GUIMenuItem> tasks is not checked, the task will
81disapear when you mark it completed. but do not worry, it is not gone forever, 81disapear when you mark it completed. but do not worry, it is not gone forever,
82just check Completed tasks in the options menu, and you can see and edit it 82just check Completed tasks in the options menu, and you can see and edit it
83again. 83again.
84</para> 84</para>
85</section> 85</section>
86 86
87<section><title>Beaming Tasks</title> 87<section><title>Beaming Tasks</title>
88<para> 88<para>
89To beam a task to another device using the IrDA and OBEX protocols, you must first install the IrDA 89To beam a task to another device using the IrDA and OBEX protocols, you must first install the IrDA
90Applet and enable IrDA with it (see <xref linkend=irda>). Then select the task that you would like to and select 90Applet and enable IrDA with it (see <xref linkend=irda>). Then select the task that you would like to and select
91press the Beam icon in the toolbar, or select Data&arrow;Beam. Opie will then send the task to any waiting 91press the Beam icon in the toolbar, or select Data&arrow;Beam. &opie; will then send the task to any waiting
92device. 92device.
93</para> 93</para>
94</section> 94</section>
95</chapter> 95</chapter>
diff --git a/docs/usermanual/upgrading.sgm b/docs/usermanual/upgrading.sgm
index 310b99b..787d4dd 100644
--- a/docs/usermanual/upgrading.sgm
+++ b/docs/usermanual/upgrading.sgm
@@ -1,22 +1,22 @@
1<chapter><title>Upgrading</title> 1<chapter><title>Upgrading</title>
2<para> 2<para>
3First, you should shutdown Opie from the "Shutdown" app in the Settings tab. 3First, you should shutdown &opie; from the "Shutdown" app in the Settings tab.
4Normally, simply running 4Normally, simply running
5<informalexample> 5<informalexample>
6<literallayout> 6<literallayout>
7 ipkg update && ipkg upgrade 7 ipkg update && ipkg upgrade
8</literallayout> 8</literallayout>
9</informalexample> 9</informalexample>
10will upgrade Opie. However, if you currently have a version with the 1.5.0 10will upgrade &opie;. However, if you currently have a version with the 1.5.0
11version number, you will have to upgrade it differently, because Opie now uses a 11version number, you will have to upgrade it differently, because &opie; now uses a
12different version number (the 1.5.0 was Qtopia's version number, we now use our 12different version number (the 1.5.0 was Qtopia's version number, we now use our
13own). To upgrade from one of these older versions, run: 13own). To upgrade from one of these older versions, run:
14<informalexample> 14<informalexample>
15<literallayout> 15<literallayout>
16 ipkg update 16 ipkg update
17 ipkg install opie-update 17 ipkg install opie-update
18</literallayout> 18</literallayout>
19</informalexample> 19</informalexample>
20Opie should then be upgraded. 20&opie; should then be upgraded.
21</para> 21</para>
22</chapter> \ No newline at end of file 22</chapter> \ No newline at end of file
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index 6adc963..5a7e6c0 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,46 +1,49 @@
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"> 3<!ENTITY whatis SYSTEM "whatisopie.sgm">
4<!ENTITY installation SYSTEM "installation.sgm"> 4<!ENTITY installation SYSTEM "installation.sgm">
5<!ENTITY gettingaround SYSTEM "gettingaround.sgm"> 5<!ENTITY gettingaround SYSTEM "gettingaround.sgm">
6<!ENTITY upgrading SYSTEM "upgrading.sgm"> 6<!ENTITY upgrading SYSTEM "upgrading.sgm">
7<!ENTITY contacts SYSTEM "contacts.sgm"> 7<!ENTITY contacts SYSTEM "contacts.sgm">
8<!ENTITY calendar SYSTEM "calendar.sgm"> 8<!ENTITY calendar SYSTEM "calendar.sgm">
9<!ENTITY todo SYSTEM "todo.sgm"> 9<!ENTITY todo SYSTEM "todo.sgm">
10<!ENTITY filemanager SYSTEM "filemanager.sgm"> 10<!ENTITY filemanager SYSTEM "filemanager.sgm">
11<!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm"> 11<!ENTITY embeddedkonsole SYSTEM "embeddedkonsole.sgm">
12<!ENTITY software SYSTEM "software.sgm"> 12<!ENTITY software SYSTEM "software.sgm">
13<!ENTITY today SYSTEM "today.sgm"> 13<!ENTITY today SYSTEM "today.sgm">
14<!ENTITY irda SYSTEM "irda.sgm"> 14<!ENTITY irda SYSTEM "irda.sgm">
15<!ENTITY keypebble SYSTEM "keypebble.sgm"> 15<!ENTITY keypebble SYSTEM "keypebble.sgm">
16<!ENTITY i18n SYSTEM "i18n.sgm"> 16<!ENTITY i18n SYSTEM "i18n.sgm">
17<!ENTITY opie "OPIE">
18<!ENTITY todayapp "Today">
19<!ENTITY qt "Qt">
17]> 20]>
18<book><title>Opie User Manual</title> 21<book><title>&opie; User Manual</title>
19<bookinfo><authorgroup><collab> 22<bookinfo><authorgroup><collab>
20<collabname>The Opie Team</collabname> 23<collabname>The &opie; Team</collabname>
21</collab></authorgroup></bookinfo> 24</collab></authorgroup></bookinfo>
22<part><title>Getting Started</title> 25<part><title>Getting Started</title>
23&whatis; 26&whatis;
24&installation; 27&installation;
25&gettingaround; 28&gettingaround;
26&upgrading; 29&upgrading;
27</part> 30</part>
28<part><title>Applications</title> 31<part><title>Applications</title>
29&contacts; 32&contacts;
30&calendar; 33&calendar;
31&todo; 34&todo;
32&today; 35&today;
33&filemanager; 36&filemanager;
34&embeddedkonsole; 37&embeddedkonsole;
35&keypebble; 38&keypebble;
36</part> 39</part>
37<part><title>Settings</title> 40<part><title>Settings</title>
38&software; 41&software;
39</part> 42</part>
40<part><title>Applets</title> 43<part><title>Applets</title>
41&irda; 44&irda;
42</part> 45</part>
43<part><title>Technical Details</title> 46<part><title>Technical Details</title>
44&i18n; 47&i18n;
45</part> 48</part>
46</book> 49</book>
diff --git a/docs/usermanual/whatisopie.sgm b/docs/usermanual/whatisopie.sgm
index 2a51429..e60897c 100644
--- a/docs/usermanual/whatisopie.sgm
+++ b/docs/usermanual/whatisopie.sgm
@@ -1,17 +1,17 @@
1<chapter><title>What is Opie?</title> 1<chapter><title>What is &opie;?</title>
2<para> 2<para>
3Opie is a GUI (Graphical User Interface) for the Linux operating system (and 3&opie; is a GUI (Graphical User Interface) for the Linux operating system (and
4might work on other OSes as well). It was originally designed for handheld 4might work on other OSes as well). It was originally designed for handheld
5computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could 5computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but could
6probably function well in other environments requiring a light GUI, such as an 6probably function well in other environments requiring a light GUI, such as an
7old laptop, or an internet kiosk. It is based upon QT/Embedded from Trolltech, 7old laptop, or an internet kiosk. It is based upon &qt;/Embedded from Trolltech,
8which is in turn a graphical environment designed for embedded applications, 8which is in turn a graphical environment designed for embedded applications,
9based upon the QT toolkit. 9based upon the &qt; toolkit.
10</para> 10</para>
11<para> 11<para>
12Opie has been designed for devices with small screens, and a touchscreen input 12&opie; has been designed for devices with small screens, and a touchscreen input
13device (ie, only one mouse click, and no constant mouse position), as well as 13device (ie, only one mouse click, and no constant mouse position), as well as
14designed to fit in a relatively small amount of storage space (about 5 megabytes 14designed to fit in a relatively small amount of storage space (about 5 megabytes
15for the base libraries and the launcher). 15for the base libraries and the launcher).
16</para> 16</para>
17</chapter> \ No newline at end of file 17</chapter>