added chapter on the file manager, and enabled links and bookmarks for the pdf (thanks to Patrick for the info on that)

1 files changed, 46 insertions, 1 deletions

diff --git a/docs/usermanual/usermanual.tex b/docs/usermanual/usermanual.tex
index 5ef81f6..4364e3f 100644
--- a/docs/usermanual/usermanual.tex
+++ b/docs/usermanual/usermanual.tex
@@ -1,68 +1,69 @@
 \documentclass[12pt,letterpaper,oneside, openany]{book} \usepackage[latin1] {inputenc}
-\usepackage{amsmath} \usepackage{amsfonts} \usepackage{amssymb} 
+\usepackage{amsmath} \usepackage{amsfonts} \usepackage{amssymb}  \usepackage[pdftex]{hyperref}
 \title{Opie User Manual}
 \author{The Opie Team}
+\hypersetup{bookmarks=true, bookmarksopen=false,pdftitle={Opie User Manual},pdfauthor={The Opie Team}}
 \begin{document}
 \maketitle
 \tableofcontents
 \part{Getting Started}
 \chapter{What is Opie?}
 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.
 
 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).
 \chapter{Installation}
 \section{iPaq}
 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.
 
 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.
 
 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:
 \begin{verbatim}
      echo src opie "http://131.152.105.154/feeds/ipaq/unstable/" \
           >> /etc/ipkg.conf
 \end{verbatim} 
 then, run:
 \begin{verbatim}
      ipkg update && ipkg install task-opie
 \end{verbatim}
 If you have a 3100 or 3800 series iPaq:
 \begin{verbatim}
      ipkg install qt-embedded-rotation
 \end{verbatim}
 finally:
 \begin{verbatim}
      /etc/init.d/opie start
 \end{verbatim}
 
 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. 
 
 \section{Zaurus}
 
 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. 
 
 
 \chapter{Upgrading} 
 
 First, you should probably shutdown Opie from the ``Shutdown'' app in the Settings tab. Normally, simply running 
 \begin{verbatim}
      ipkg update && ipkg upgrade
 \end{verbatim}
 will upgrade Opie. However, if you currently have a version with the 1.5.0 version number, you will have to upgrade it differently, because Opie now uses a different version number (the 1.5.0 was Qtopia's version number, now we use our own). To upgrade from one of these older versions, run: 
 \begin{verbatim}
      ipkg update
      ipkg install opie-update
 \end{verbatim}
 Opie should then be upgraded.
 
 \part{Applications}
 \chapter{Contacts}
 Contacts is a way to keep track of all the people you know, and how to contact them.  as well as other information, such as their birthday, the company they work for, etc.
 
 \section{Adding Contacts}
 
 To Add a user, go to Contact->Add, or click the add icon in the toolbar (looks like a blank piece of paper). First, you need to give the person a name. You can do this by either entering their name in the name field, or by pressing ``Full Name...'', which will open up a new dialog that lets you enter each part of their name individually. Three of the entry fields have pulldown menus instead of labels that let you set which parameter these input fields control. The File As field lets you control how their name is displayed in the main view, use the pulldown arrow to select from some common ways of ordering their first and last names. You can also select a category for the user to be filed under, and clicking the button labeled ``...'' lets you edit the available catagories (these are convinient for displaying just the contacts you want when you have a lot of them). 
 
 The address tab lets you edit their buisness and home addresses (select which one you want to change from the pulldown menu at the top). The bottom field behaves just like the three custom fields in the ``General'' tab (and if you select the same thing from the pulldown list, it will modify the same parameter). 
 
 The Details tab is used for miscelaneous things like the persons position, the name of their spouse, etc. 
 
@@ -147,65 +148,109 @@ When you are done setting up the appointment, click ``ok'' in the top right of t
 
 How you start editing an appointment varies depending on what view you are in, but they will all open the same dialog. The dialog is the same as the Add Appointment dialog, except that the fields will already be filled in with the information that the appointment contains. Clicking ``ok'' will keep your changes, ``x'' will revert them to what they were before you edited them. 
 
 
 \section{Finding Appointments}
 
 To find a specific appointment, click the find button in the toolbar (small green magnifying glass) and it will open a find dialog. Here you can enter the text you want to search for, as well as the category you want to search for, as well as the start date, and whether you want the search to be case sensitive. Click ``Find'' to find the next appointment that matches your criteria.
 
 \chapter{Todo}
 Todo is designed for storing information about things you need to do, but which arent going to happen at a specific time, like "change the oil" or "mow the lawn". You can also give todo items a deadline, if they have to be completed by a certain time. 
 
 \section{Adding Tasks}
 
 Go to Data then New Task, or click on the new task icon (blank page). The priority drop down menu lets you select the priority of the task. The lower the number, the more important it is. The Category behaves in much the same way that they do in AddressBook, you can select the category from the drop down menu, or you can click the ``...'' button to add/delete/edit categories. To give the task a due date, check the ``Due'' checkbox, and then click the button next to it (it should contain the current date). That will open a calendar from which you can select the due date. The ``Completed'' check box is the same as the checkbox next to each item in the main view. There is a large text entry area where you can enter what the task is, along with a description of what you need to do. Since only the first little bit gets shown in the main window, or in OpieToday you probably want to start out with a brief description, followed by a more in depth one. For instance: ``Document OpieTodo - add information about adding, editing and viewing tasks''. This way, if there isnt enough room to show the full description, you will at least see ``Document OpieTodo''. Click ``ok'' in the upper right to add the new task, or ``x'' to close the window without adding the new task. 
 
 
 \section{Editing Tasks}
 
 To edit a task, you can select it, and then go to Data->Edit Task, or click the edit task icon (pencil). The same dialog should apear as if you were adding a task, but the information for that task should already be filled in. You can change any of it you want to, and then click ``ok'' in the top right corner to save the changes, or ``x'' to go back to the way it was. 
 
 \section{Deleting Tasks}
 
 To delete a task, first select it, and then either select Data->Delete... or press the Delete icon (trash can). a dialog should pop up, asking if you want to delete the task, click yes to delete it, or no to cancel. 
 
 \section{Finding Tasks}
 
 To find a task, either go to Options and then Find, or click the find icon (green magnifying glass), and a dialog should pop up. Enter the text you want to search for in the description, and select the category that you want it to search through (this will speed it up, if you know what category its in). You can also select ``case sensative'' which makes the search pay attention to the case of what you type (so if you look for ``mow lawn'', it wont find a task called ``Mow lawn''). ``Search Backwards'' will search backwards from the currently selected task. Click ``Find'' to initiate the search, when it finds a task that matches the string, it will select it. If you click Find again, it will find the next one in the list (or the previous one, if ``Search backwards'' is selected) 
 
 \section{Viewing Tasks}
 
 To only view tasks filled under certain categories, go to the Category menu, and check the categories you want to view. Also, under the Options menu, you can select whether or not you want completed tasks to be visible, and whether or not you want to see the deadline (usefull for getting more space for descriptions). 
 
 \section{Completing Tasks}
 
 To mark a task as completed without deleting it, you can either check the checkbox next to it in the main view, or edit it, and check the "completed" check box in the edit dialog. If Options then Completed tasks is not checked, the task will disapear when you mark it completed. but dont worry, its not gone forever, just check Completed tasks in the options menu, and you can see it, and edit it again.
 
 \chapter{EmbeddedKonsole}
 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.
 
 \section{What is a shell}
 
 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.
 
 \section{Running Programs}
 
 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+.
 
 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.
 
 \section{Basic Navigation}
 
 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).
 
 \section{Moving Files}
 
 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.
 
 \section{Deleting Files}
 
 To delete a file, run the ``rm'' command, and to delete a directory, run the ``rmdir'' command, each of them take the file to be removed as their only argument.
 
 \section{Linking Files}
 
 In Linux, you can have a special file called a ``symbolic link'' that acts just like a copy of another file, except it takes up less space.  This is convinient if two applications are looking for the same file in two separate places, because the file can be in both places at once, without taking up any extra space, and any change to one is automatically applied to the other (really, there is no other, one of them is just a file pointing to the other one).  This is also usefull for naming applications independant of their version number.  For instance, you could have a link called ``application'' that points to ``application1.0''.  To create a link, use the following command: \verb+ln -s originalfile link+.
+
+\chapter{File Manager}
+The file manager allows easy access to your file system, letting you browse, copy, move, delete and link files.  You can also use it to open the file in an application based upon the file type, or add the file to your ``Documents'' tab, as well as several other filesystem related things.
+
+\section{Navigating }
+
+To enter a directory, simply press its icon or name in the main view. There are also two buttons in the toolbar which help with navigation. The back arrow will take you back to the directory you were previously looking at, while the up arrow will take you up one level in the directory structure (so, if you are in /usr/bin, it will take you to /usr, regardless of where you were before). The ``Dir'' menu shows the current path, with each directory as a menu item. So, if you are in /opt/QtPalmtop/bin there will be four entries: /, opt, QtPalmtop, and bin. Selecting one of these will take you immediately to that directory. 
+
+\section{Selecting Files}
+
+When you click on a file, its selection status is toggled. So the first time you click on it, it will be selected, and the second time it will be deselected. To select multiple files, simply click on each one you want to select. 
+
+\section{Moving Files}
+
+To copy a file from one directory to another, press and hold on the filenam, and select ``Copy'' from the menu that pops up. Then, change into the directory thatyou want to copy it into, and press the "paste" icon (an image of a clipboard and a piece of paper). To move a file, do the same thing, except select ``Cut'' from the first menu, instead of ``Copy''. You can also move or copy multiple file by selecting all of them and using the cut or copy buttons in the toolbar. 
+
+\section{Deleting Files}
+
+To delete a file, press and hold it to bring up its menu, then select ``Delete'', and click ``Yes'' (or ``No'' to cancel). Delete will delete all the currently selected files, which may be more than the one that you pressed and held on. 
+
+\section{Renaming Files}
+
+To change a file's name, first bring up the input method you want to use (unless you are going to use the hardware keyboard), then press and hold on the filename, and select ``rename''. A new file will appear with a ``Name'' field that is editable, enter the new name in, and click another file to keep the new name. 
+
+\section{Creating Directories}
+
+To create a directory, first bring up the input method you want to use (if you are using one), and then click the new directory button (an image of a file folder with a ``+'' sign). A new folder will be created with the name ``New Folder'', and the folder name will be editable. Enter the name you want and then click another file to create the folder. 
+
+\section{Viewing Files}
+
+To view a file, press and hold on a file, and the menu that comes up will contain two entries for vieing the file, the first depends on the filetype, but usually lets you open the file in a specific program. The second is ``view as text'' which will open the file up in TextEdit (regardless of whether or not it is actually a text file). 
+
+\section{Adding to ``Documents''}
+
+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. 
+
+
+\section{Sorting Files}
+
+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. 
+
+\section{Viewing Options}
+
+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.
 \end{document}
\ No newline at end of file