summaryrefslogtreecommitdiff
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/usermanual.tex18
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,37 +1,38 @@
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?}
11Opie 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. 12Opie 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
13Opie 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). 14Opie 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}
16To 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. 17To 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
18Note: 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. 19Note: 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
20Once 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: 21Once 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}
25then, run: 26then, 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}
29If you have a 3100 or 3800 series iPaq: 30If 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}
33finally: 34finally:
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
@@ -107,17 +108,16 @@ To find a specific person, click the find icon (green magnifying glass), or go t
107 108
108 109
109\section{Viewing Contacts} 110\section{Viewing Contacts}
110 111
111To view only the contacts in a certain category, go to the View menu, and check the categories you want to view. 112To view only the contacts in a certain category, go to the View menu, and check the categories you want to view.
112 113
113The 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). 114The 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
118Change 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. 118Change 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}
121The calendar is a way to keep track of all your appointments, birthdays, meetings, or any other even that you would put in a calendar. 121The 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}
@@ -249,17 +249,17 @@ To sort the files, use the ``Sort'' menu to select wich field you want to sort t
249 249
250The ``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. 250The ``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}
253EmbeddedKonsole 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. 253EmbeddedKonsole 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
257A 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. 257A 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
261To 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+. 261To 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
263Most 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. 263Most 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}