author | spiralman <spiralman> | 2002-07-22 01:37:52 (UTC) |
---|---|---|
committer | spiralman <spiralman> | 2002-07-22 01:37:52 (UTC) |
commit | 56578578855d48629a31877c7346c5b0cf6a7d21 (patch) (unidiff) | |
tree | 8848a039aa02e64eb1f60aa4b1375a08a90e4c69 /docs/usermanual | |
parent | 94dbbe5b345ed082bf614699470b0b055ee92afc (diff) | |
download | opie-56578578855d48629a31877c7346c5b0cf6a7d21.zip opie-56578578855d48629a31877c7346c5b0cf6a7d21.tar.gz opie-56578578855d48629a31877c7346c5b0cf6a7d21.tar.bz2 |
now compiles again under latex (was broken), also some minor changes
-rw-r--r-- | docs/usermanual/usermanual.tex | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/docs/usermanual/usermanual.tex b/docs/usermanual/usermanual.tex index 6b4cb6e..d6e164c 100644 --- a/docs/usermanual/usermanual.tex +++ b/docs/usermanual/usermanual.tex | |||
@@ -1,45 +1,46 @@ | |||
1 | \documentclass[12pt,letterpaper,oneside, openany]{book} \usepackage[latin1] {inputenc} | 1 | \documentclass[12pt,letterpaper,oneside, openany]{book} \usepackage[latin1] {inputenc} |
2 | \usepackage{amsmath} \usepackage{amsfonts} \usepackage{amssymb} \usepackage[pdftex]{hyperref} | 2 | \usepackage{amsmath} \usepackage{amsfonts} \usepackage{amssymb} |
3 | \usepackage[pdflatex]{hyperref} | ||
4 | \hypersetup{bookmarks=true, bookmarksopen=false,pdftitle={Opie User Manual},pdfauthor={The Opie Team}} | ||
3 | \title{Opie User Manual} | 5 | \title{Opie User Manual} |
4 | \author{The Opie Team} | 6 | \author{The Opie Team} |
5 | \hypersetup{bookmarks=true, bookmarksopen=false,pdftitle={Opie User Manual},pdfauthor={The Opie Team}} | ||
6 | \begin{document} | 7 | \begin{document} |
7 | \maketitle | 8 | \maketitle |
8 | \tableofcontents | 9 | \tableofcontents |
9 | \part{Getting Started} | 10 | \part{Getting Started} |
10 | \chapter{What is Opie?} | 11 | \chapter{What is Opie?} |
11 | Opie is a GUI (Graphical User Interface) for the Linux operating system (and might work on other OSes as well). It was originally designed for handheld computers (such as the Compaq/HP iPaq and the Sharp Zaurus), but which could probably function well in other environments requiring a light GUI, such as an old laptop, or an internet kiosk. It is bassed upon QT/Embedded from Trolltech, which is in turn a graphical environment designed for embedded applications, based upon the QT toolkit. | 12 | Opie is a GUI (Graphical User Interface) for the Linux operating system (and might work on other OSes as well). It was originally designed for handheld computers (such as the Compaq/HP iPAQ and the Sharp Zaurus), but which could probably function well in other environments requiring a light GUI, such as an old laptop, or an internet kiosk. It is bassed upon QT/Embedded from Trolltech, which is in turn a graphical environment designed for embedded applications, based upon the QT toolkit. |
12 | 13 | ||
13 | Opie has been designed for devices with small screens, and a touchscreen input device (ie, only one mouse click, and no constant mouse position), as well as designed to fit in a relatively small amount of storage space (about 5 megabytes for the base libraries and the launcher). | 14 | Opie has been designed for devices with small screens, and a touchscreen input device (ie, only one mouse click, and no constant mouse position), as well as designed to fit in a relatively small amount of storage space (about 5 megabytes for the base libraries and the launcher). |
14 | \chapter{Installation} | 15 | \chapter{Installation} |
15 | \section{iPaq} | 16 | \section{iPAQ} |
16 | To install opie on an ipaq, you will need a fresh familiar installation (ie, install familiar, and stop before you do ipkg install task-complete or ipkg install task-x), go to http://familiar.handhelds.org to get the latest version, and to get installation instructions. | 17 | To install opie on an iPAQ, you will need a fresh familiar installation (ie, install familiar, and stop before you do ipkg install task-complete or ipkg install task-x), go to http://familiar.handhelds.org to get the latest version, and to get installation instructions. |
17 | 18 | ||
18 | Note: If you had qpe/qtopia installed previously, \emph{completely} remove it, and remove the src line for it from your /etc/ipkg.conf file before attempting to install opie. | 19 | Note: If you had qpe/qtopia installed previously, \emph{completely} remove it, and remove the src line for it from your /etc/ipkg.conf file before attempting to install opie. |
19 | 20 | ||
20 | Once you have familiar installed, set up a network connection between your ipaq and the ouside world (ppp, usbnet, or some network/modem card), and then run this command: | 21 | Once you have familiar installed, set up a network connection between your iPAQ and the ouside world (ppp, usbnet, or some network/modem card), and then run this command: |
21 | \begin{verbatim} | 22 | \begin{verbatim} |
22 | echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ | 23 | echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \ |
23 | >> /etc/ipkg.conf | 24 | >> /etc/ipkg.conf |
24 | \end{verbatim} | 25 | \end{verbatim} |
25 | then, run: | 26 | then, run: |
26 | \begin{verbatim} | 27 | \begin{verbatim} |
27 | ipkg update && ipkg install task-opie | 28 | ipkg update && ipkg install task-opie |
28 | \end{verbatim} | 29 | \end{verbatim} |
29 | If you have a 3100 or 3800 series iPaq: | 30 | If you have a 3100 or 3800 series iPAQ: |
30 | \begin{verbatim} | 31 | \begin{verbatim} |
31 | ipkg install qt-embedded-rotation | 32 | ipkg install qt-embedded-rotation |
32 | \end{verbatim} | 33 | \end{verbatim} |
33 | finally: | 34 | finally: |
34 | \begin{verbatim} | 35 | \begin{verbatim} |
35 | /etc/init.d/opie start | 36 | /etc/init.d/opie start |
36 | \end{verbatim} | 37 | \end{verbatim} |
37 | 38 | ||
38 | Opie should now be running (if you should have to reboot, which is rare, Opie will start automatically). From here, you can use either OpieOipkg (``Software'' in the settings tab of the launcher) or ipkg from the command line to install other opie apps. Check out the various task-opie-* ipkgs to install various sets of apps at once (you can always uninstall individual apps individually). You will probably want to install opie-embeddedkonsole first, so you have access to the command line in Opie. | 39 | Opie should now be running (if you should have to reboot, which is rare, Opie will start automatically). From here, you can use either OpieOipkg (``Software'' in the settings tab of the launcher) or ipkg from the command line to install other opie apps. Check out the various task-opie-* ipkgs to install various sets of apps at once (you can always uninstall individual apps individually). You will probably want to install opie-embeddedkonsole first, so you have access to the command line in Opie. |
39 | 40 | ||
40 | \section{Zaurus} | 41 | \section{Zaurus} |
41 | 42 | ||
42 | To install Opie completely on the Zaurus, you will have to install OpenZaurus, which includes Opie. However, individual Opie apps will work fine on the default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM though. | 43 | To install Opie completely on the Zaurus, you will have to install OpenZaurus, which includes Opie. However, individual Opie apps will work fine on the default Zaurus rom. Do not install Opie's launcher on a default Zaurus ROM though. |
43 | 44 | ||
44 | \chapter{Using Opie} | 45 | \chapter{Using Opie} |
45 | Now that Opie is installed and running, it's time to start using it. When you first start Opie, you will see the ``Launcher'' where you start all your applications from, and the ``Taskbar'' along the bottom, where you can see all the running applications, select an input method, and where all the ``Applets'' show up. | 46 | Now that Opie is installed and running, it's time to start using it. When you first start Opie, you will see the ``Launcher'' where you start all your applications from, and the ``Taskbar'' along the bottom, where you can see all the running applications, select an input method, and where all the ``Applets'' show up. |
@@ -99,33 +100,32 @@ To edit the contacts, select the person you want to edit, anc click the pencil i | |||
99 | 100 | ||
100 | \section{Deleting Contacts} | 101 | \section{Deleting Contacts} |
101 | 102 | ||
102 | To delete a contact, select the person from the list of contacts, and click the trash can icon, or go to Contact then Delete. A dialog will pop up asking if you want to actually delete that contact, click yes to delete them, no will cancel. | 103 | To delete a contact, select the person from the list of contacts, and click the trash can icon, or go to Contact then Delete. A dialog will pop up asking if you want to actually delete that contact, click yes to delete them, no will cancel. |
103 | 104 | ||
104 | \section{Editing Contacts} | 105 | \section{Editing Contacts} |
105 | 106 | ||
106 | To find a specific person, click the find icon (green magnifying glass), or go to Contact->Find. A dialog will pop up, and in the ``Find what'' input, enter the string you want to search for. You can also select if you want the search to be case sensative, or if you want it to search backwards from the currently selected user. The Category drop down menu lets you search only a specific category (``All'' to search all of them). When you click ``Find'', it will start search for the string in all the fields in all the contacts. When it finds a match, it will highlight the user in the main view. You can use this to search for (as an example) who a certain phone number belongs to, by entering the phone number in the ``find what'' field, and clicking ``Find''. | 107 | To find a specific person, click the find icon (green magnifying glass), or go to Contact->Find. A dialog will pop up, and in the ``Find what'' input, enter the string you want to search for. You can also select if you want the search to be case sensative, or if you want it to search backwards from the currently selected user. The Category drop down menu lets you search only a specific category (``All'' to search all of them). When you click ``Find'', it will start search for the string in all the fields in all the contacts. When it finds a match, it will highlight the user in the main view. You can use this to search for (as an example) who a certain phone number belongs to, by entering the phone number in the ``find what'' field, and clicking ``Find''. |
107 | 108 | ||
108 | 109 | ||
109 | \section{Viewing Contacts} | 110 | \section{Viewing Contacts} |
110 | 111 | ||
111 | To view only the contacts in a certain category, go to the View menu, and check the categories you want to view. | 112 | To view only the contacts in a certain category, go to the View menu, and check the categories you want to view. |
112 | 113 | ||
113 | The list of letters on the bottom of the window lets you look at only the contacts whos names begin with that letter. These work much like entering text on a mobile phone. For example, to view all the contacts whos name starts with ``B'', press the ``ABC'' group twice (since ``B'' is the second letter in that group). To go back to displaying all of the letters, click it two more times (pressing it four times brings you back to all the letters, so you pressed it 2 times to get to ``B'' and 2 more times to get back to all letters. 2+2=4). | 114 | The list of letters on the bottom of the window lets you look at only the contacts whos names begin with that letter. These work much like entering text on a mobile phone. For example, to view all the contacts whos name starts with ``B'', press the ``ABC'' group twice (since ``B'' is the second letter in that group). To go back to displaying all of the letters, click it two more times (pressing it four times brings you back to all the letters, so you pressed it 2 times to get to ``B'' and 2 more times to get back to all letters. 2+2=4). |
114 | 115 | ||
115 | |||
116 | \section{Personal Details} | 116 | \section{Personal Details} |
117 | 117 | ||
118 | Change your personal details by going to Contact then My Personal Details. This is used in today to display who the device belongs to, as well as other apps. | 118 | Change your personal details by going to Contact then My Personal Details. This is used in today to display who the device belongs to, as well as other apps. |
119 | 119 | ||
120 | \chapter{Calendar} | 120 | \chapter{Calendar} |
121 | The calendar is a way to keep track of all your appointments, birthdays, meetings, or any other even that you would put in a calendar. | 121 | The calendar is a way to keep track of all your appointments, birthdays, meetings, or any other even that you would put in a calendar. |
122 | 122 | ||
123 | \section{Navigation} | 123 | \section{Navigation} |
124 | 124 | ||
125 | Navigation in the calendar is simple. along the top are five different buttons that allow you to set the type of view, which correspond to the five items in the ``View'' menu. Each one (except for ``Today'') changes the amount of time shown on the screen. ``Day'' shows one day, ``Week'' one week, etc. Today is the same as Day, except that it automatically sets the view to the current day. | 125 | Navigation in the calendar is simple. along the top are five different buttons that allow you to set the type of view, which correspond to the five items in the ``View'' menu. Each one (except for ``Today'') changes the amount of time shown on the screen. ``Day'' shows one day, ``Week'' one week, etc. Today is the same as Day, except that it automatically sets the view to the current day. |
126 | 126 | ||
127 | \subsection{The Day view} | 127 | \subsection{The Day view} |
128 | 128 | ||
129 | The day view shows your day divided up into blocks representing each hour. At the top is the navigation bar, wher you will see a row of buttons, which represent the days of the current week, and on the left and right sides of the navigation bar are arrows, which allow you to move one day in that direction. If you are on the last day of the week, pressing the arrow will bring you into the first day of the next week (or vice-versa if you are going backwards). There is also a button that lists the current day, which you can press to select a day to view from a callendar dialog. | 129 | The day view shows your day divided up into blocks representing each hour. At the top is the navigation bar, wher you will see a row of buttons, which represent the days of the current week, and on the left and right sides of the navigation bar are arrows, which allow you to move one day in that direction. If you are on the last day of the week, pressing the arrow will bring you into the first day of the next week (or vice-versa if you are going backwards). There is also a button that lists the current day, which you can press to select a day to view from a callendar dialog. |
130 | 130 | ||
131 | In the main view, there is a collumn of buttons, each of which represents one hour. If you select one, any new appointments will automatically default to begining at that time and ending an hour later (which you can, of course, change when you create the appointment). | 131 | In the main view, there is a collumn of buttons, each of which represents one hour. If you select one, any new appointments will automatically default to begining at that time and ending an hour later (which you can, of course, change when you create the appointment). |
@@ -241,33 +241,33 @@ To view a file, press and hold on a file, and the menu that comes up will contai | |||
241 | To add a file to your ``Documents'', press and hold the file, and select ``Add to documents'' from the menu. This will add the file to the documents tab, which you can use to quickly open the file (simply click on the icon for the file in the Documents tab). Some programs also use the Documents list to aid in quickly opening files. | 241 | To add a file to your ``Documents'', press and hold the file, and select ``Add to documents'' from the menu. This will add the file to the documents tab, which you can use to quickly open the file (simply click on the icon for the file in the Documents tab). Some programs also use the Documents list to aid in quickly opening files. |
242 | 242 | ||
243 | 243 | ||
244 | \section{Sorting Files} | 244 | \section{Sorting Files} |
245 | 245 | ||
246 | To sort the files, use the ``Sort'' menu to select wich field you want to sort the files by (``by Name'', for instance, will sort the file alphabetically by name). If ``Ascending'' is checked, the files will be sorted in ascending order, if it is not, they will be sorted in descending order. | 246 | To sort the files, use the ``Sort'' menu to select wich field you want to sort the files by (``by Name'', for instance, will sort the file alphabetically by name). If ``Ascending'' is checked, the files will be sorted in ascending order, if it is not, they will be sorted in descending order. |
247 | 247 | ||
248 | \section{Viewing Options} | 248 | \section{Viewing Options} |
249 | 249 | ||
250 | The ``View'' menu lets you choose which files you view. If ``Hidden'' is checked, hidden files will be visible (in Linux, hidden files start with a ``.''). If ``Symlinks'' is checked, symbolic links (files or directories which are merely links to other files or directories) will be visible. | 250 | The ``View'' menu lets you choose which files you view. If ``Hidden'' is checked, hidden files will be visible (in Linux, hidden files start with a ``.''). If ``Symlinks'' is checked, symbolic links (files or directories which are merely links to other files or directories) will be visible. |
251 | 251 | ||
252 | \chapter{EmbeddedKonsole} | 252 | \chapter{EmbeddedKonsole} |
253 | EmbeddedKonsole is Opie's terminal emulator. From here you can do pretty much anything in (since Linux is actually a command line based OS by itself). I will not go into much detail on using the linux command line, as that is covered in many other places (http://www.tldp.org is a good place to start, or read O'Reilly's \underline{Running Linux} for a comprehensive look at Linux for the beginner). I will, however, give a quick overview of using a Linux shell. | 253 | EmbeddedKonsole is Opie's terminal emulator. From here you can do pretty much anything in (since Linux is actually a command line based OS by itself). I will not go into much detail on using the linux command line, as that is covered in many other places (http://www.tldp.org is a good place to start, or read O'Reilly's \underline{Running Linux} for a comprehensive look at Linux for the beginner). I will, however, give a quick overview of using a Linux shell. |
254 | 254 | ||
255 | \section{What is a shell} | 255 | \section{What is a shell} |
256 | 256 | ||
257 | A shell is a program that accepts input from a user, and runs commands. Each ``command'' in the shell is actually a separate program (unless you are using a shell like BusyBox, which makes some of the more common commands part of its own program in order to save space). Shells can actually be very powerful, and many of them allow you to write something called ``shell scripts'' which are just a sequence of commands, sometimes with some flow control statements. For the most part, the average user does not need to know about any of this, though. If you are running Opie on your iPaq, it is advisable to install the bash shell (ipkg install bash) because it offers things like tab completion, use of the backspace key, and a command history, as well as offering a more advanced scripting languauge than most other shells. | 257 | A shell is a program that accepts input from a user, and runs commands. Each ``command'' in the shell is actually a separate program (unless you are using a shell like BusyBox, which makes some of the more common commands part of its own program in order to save space). Shells can actually be very powerful, and many of them allow you to write something called ``shell scripts'' which are just a sequence of commands, sometimes with some flow control statements. For the most part, the average user does not need to know about any of this, though. If you are running Opie on the Familiar distribution, it is advisable to install the bash shell (ipkg install bash) because it offers things like tab completion, use of the backspace key, and a command history, as well as offering a more advanced scripting languauge than most other shells. |
258 | 258 | ||
259 | \section{Running Programs} | 259 | \section{Running Programs} |
260 | 260 | ||
261 | To run a program or a command (remember, a command is just a program), you simply type the name of the program and hit ``Return'' (in Linux, program names do not have a special suffix like they do in windows, in fact the ``.'' character has no special meaning unless it is at the begining of a filename). When you type a program name and hit ``Return'' the shell looks in a special list of directories called your ``path'', and if it cannot find it in any of those directories, it stops looking and tells you it could not find them. If you want to run a program that is not in your path, you must specify a absolute or relative path to that program. For instance, to run a program that is in the directory you are currently in, you would type \verb+./program+ (``./'' is a special directory that is explained below), or to run a program in /home/username/ you would call \verb+/home/username/program+. | 261 | To run a program or a command (remember, a command is just a program), you simply type the name of the program and hit ``Return'' (in Linux, program names do not have a special suffix like they do in windows, in fact the ``.'' character has no special meaning unless it is at the begining of a filename). When you type a program name and hit ``Return'' the shell looks in a special list of directories called your ``path'', and if it cannot find it in any of those directories, it stops looking and tells you it could not find them. If you want to run a program that is not in your path, you must specify a absolute or relative path to that program. For instance, to run a program that is in the directory you are currently in, you would type \verb+./program+ (``./'' is a special directory that is explained below), or to run a program in /home/username/ you would call \verb+/home/username/program+. |
262 | 262 | ||
263 | Most programs take ``arguments'' when run from the command line. An argument is a string that contains no spaces that changes how the program behaves (a text editor, for instance, might take a single argument, which would be the name of the file you wish to edit). Usually, you can use the arguments ``-h'' or ``--help'' to get a list of the common arguments that that program takes, along with a short usage description, and a short description of what each argument does. | 263 | Most programs take ``arguments'' when run from the command line. An argument is a string that contains no spaces that changes how the program behaves (a text editor, for instance, might take a single argument, which would be the name of the file you wish to edit). Usually, you can use the arguments ``-h'' or ``--help'' to get a list of the common arguments that that program takes, along with a short usage description, and a short description of what each argument does. |
264 | 264 | ||
265 | \section{Basic Navigation} | 265 | \section{Basic Navigation} |
266 | 266 | ||
267 | The command that you will use most often in the shell is probably the ``cd'' command, which stands for ``change directory.'' With this command, you can move around in the file system, by issuing the command like this: \verb+cd [new directory]+, where \verb+[new directory]+ is the directory you want to move to. This directory name does not have to include the entire directory structure, but can be ``relative'' which means it assumes you are talking about directories relative to the directory you are in. For example, if you are in a directory called /home/username and you want to move to the directory /home/username/other/dir you could simply type \verb+cd other/dir+ and you would end up in /home/username/other/dir. You can also specify a full, or ``absolute'' path, by specifying the entire path name starting with / ( / is a special directory called the ``root'' directory, and does not have a ``parent'', which means that it is not in any other directory). There are also two special directories called ``./'' and ``../''. The ``./'' directory is the current directory you are in, and you will probably never use this in conjunction with the cd command (why would you want to move to the directory you are already in?). The ``../'' directory represents the parent directory of the directory you are currently in, so if you are in /home/username, ../ is the same as /home. You can string several ../'s together, so if you are in /home/username/dir/ ../../ represents /home. There is one other special directory, called ``$\sim$/'' that points to your home directory (usually /home/username or /root for the root user). | 267 | The command that you will use most often in the shell is probably the ``cd'' command, which stands for ``change directory.'' With this command, you can move around in the file system, by issuing the command like this: \verb+cd [new directory]+, where \verb+[new directory]+ is the directory you want to move to. This directory name does not have to include the entire directory structure, but can be ``relative'' which means it assumes you are talking about directories relative to the directory you are in. For example, if you are in a directory called /home/username and you want to move to the directory /home/username/other/dir you could simply type \verb+cd other/dir+ and you would end up in /home/username/other/dir. You can also specify a full, or ``absolute'' path, by specifying the entire path name starting with / ( / is a special directory called the ``root'' directory, and does not have a ``parent'', which means that it is not in any other directory). There are also two special directories called ``./'' and ``../''. The ``./'' directory is the current directory you are in, and you will probably never use this in conjunction with the cd command (why would you want to move to the directory you are already in?). The ``../'' directory represents the parent directory of the directory you are currently in, so if you are in /home/username, ../ is the same as /home. You can string several ../'s together, so if you are in /home/username/dir/ ../../ represents /home. There is one other special directory, called ``$\sim$/'' that points to your home directory (usually /home/username or /root for the root user). |
268 | 268 | ||
269 | \section{Moving Files} | 269 | \section{Moving Files} |
270 | 270 | ||
271 | To move files around, you need to use the ``cp'' (copy) and ``mv'' (move) commands. Both of these are run the same way: \verb+command originalfile newfile+. The only difference is that cp creates a new file without touching the old one, while mv deletes the original file. The two path names can be either absolute or relative. If you only specify a directory for the destination, and no filename, it will use the filename for the original file. | 271 | To move files around, you need to use the ``cp'' (copy) and ``mv'' (move) commands. Both of these are run the same way: \verb+command originalfile newfile+. The only difference is that cp creates a new file without touching the old one, while mv deletes the original file. The two path names can be either absolute or relative. If you only specify a directory for the destination, and no filename, it will use the filename for the original file. |
272 | 272 | ||
273 | \section{Deleting Files} | 273 | \section{Deleting Files} |