summaryrefslogtreecommitdiff
Unidiff
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--docs/usermanual/usermanual.sgm217
1 files changed, 216 insertions, 1 deletions
diff --git a/docs/usermanual/usermanual.sgm b/docs/usermanual/usermanual.sgm
index 1fe8c52..44cf7de 100644
--- a/docs/usermanual/usermanual.sgm
+++ b/docs/usermanual/usermanual.sgm
@@ -1,5 +1,5 @@
1<!DOCTYPE book SYSTEM "/usr/local/sgml/4.2sgml/docbook.dtd"> 1<!DOCTYPE book PUBLIC "-OASIS//DTD DocBook V4.2//EN">
2<book><title>Opie User Manual</title> 2<book><title>Opie User Manual</title>
3<part><title>Getting Started</title> 3<part><title>Getting Started</title>
4<chapter><title>What is Opie?</title> 4<chapter><title>What is Opie?</title>
5<para> 5<para>
@@ -689,5 +689,220 @@ hidden files will be visible (in Linux, hidden files start with a ``.''). If
689links to other files or directories) will be visible. 689links to other files or directories) will be visible.
690</para> 690</para>
691</section> 691</section>
692</chapter> 692</chapter>
693
694<chapter><title>Embedded Konsole</title>
695<para>
696EmbeddedKonsole is Opie's terminal emulator. From here you can do pretty much
697anything (since Linux is actually a command line based OS by itself). I will
698not go into much detail on using the linux command line, as that is covered in
699many other places (http://www.tldp.org is a good place to start, or read
700O'Reilly's \underline{Running Linux} for a comprehensive look at Linux for the
701beginner). I will, however, give a quick overview of using a Linux shell.
702</para>
703
704<section><title>Using Embedded Konsole</title>
705<para>
706Along the top of the window is a row of menus and icons. The ``Font'' menu lets
707you select the font size that you want the console to use, while the Options
708menu lets you select various options. Below this row of menus and icons is a
709pulldown list with various common commands in it.
710</para>
711
712<section><title>Options Menu</title>
713<para>
714The first submenu in the options menu is the ``Command List'' menu, which lets
715you edit or hide the command list pulldown. The ``Tabs on top'' or ``Tabs on
716bottom'' (depending on which is currently enabled) allows you to select where
717the tabs representing multiple terminal sessions are drawn. The ``Colors''
718submenu lets you select from a color scheme, or make your own, and the ``Scroll
719Bar'' submenu lets you select where or if the scroll bar is drawn.
720</para>
721</section>
722<section><title>Icons</title>
723<para>
724The row of icons to the right of the menus allows you to type common keystrokes
725without having an input method visible, as well as some other things.
726</para>
727<para>
728The icon all the way on the left will open a new terminal session in a new tab,
729while the icon all the way on the right will paste text from the clipboard into
730the terminal.
731</para>
732<para>
733The other icons are the same as typing (from left to right) enter, space, tab
734(for tab completion), up, and down (for the command history).
735</para>
736</section>
737<section><title>Command List</title>
738<para>
739The command list is a pulldown menu with a list of commonly used commands.
740Selecting one will type the command into the terminal wherever the cursor is.
741You can edit or hide this menu from <GUIMenu>Options</GUIMenu>
742<GUIMenuItem>Command List.</GUIMenuItem>
743</para>
744</section>
745</section>
746
747<section><title>What is a Shell</title>
748<para>
749A shell is a program that accepts input from a user, and runs commands. Each
750``command'' in the shell is actually a separate program (unless you are using a
751shell like BusyBox, which makes some of the more common commands part of its own
752program in order to save space). Shells can actually be very powerful, and many
753of them allow you to write something called ``shell scripts'' which are just a
754sequence of commands, sometimes with some flow control statements, saved to a
755file and run each time the script is run. For the most part, the average user
756does not need to know about any of this, though. If you are running Opie on the
757Familiar distribution, it is advisable to install the bash shell (ipkg install
758bash) because it offers things like tab completion, use of the backspace key,
759and a command history, as well as offering a more advanced scripting languauge
760than most other shells.
761</para>
762</section>
763
764<section><title>Running Programs</title>
765<para>
766To run a program or a command (remember, a command is just another program), you
767simply type the name of the program and hit ``Return'' (in Linux, program names
768do not have a special suffix like they do in windows, in fact the ``.''
769character has no special meaning unless it is at the begining of a filename, in
770which case it makes the file ``hidden''). When you type a program name and hit
771``Return'' the shell looks in a special list of directories called your
772``path'', and if it cannot find it in any of those directories, it stops looking
773and tells you it could not find them. If you want to run a program that is not
774in your path, you must specify an absolute or relative path to that program.
775For instance, to run a program that is in the directory you are currently in,
776you would type <literal>./program</literal> (``./'' is a special directory that
777is explained below), or to run a program in /home/username/ you would call
778<literal>/home/username/program</literal>.
779</para>
780<para>
781Most programs take ``arguments'' when run from the command line. An argument is
782a string that contains no spaces that changes how the program behaves (a text
783editor, for instance, might take a single argument, which would be the name of
784the file you wish to edit). Usually, you can use the arguments ``-h'' or
785``--help'' to get a list of the common arguments that that program takes, along
786with a short usage description, and a short description of what each argument
787does.
788</para>
789</section>
790
791<section><title>Basic Navigation</title>
792<para>
793The command that you will use most often in the shell is probably the ``cd''
794command, which stands for ``change directory.'' With this command, you can move
795around in the file system, by issuing the command like this: <userinput>cd
796<replaceable>[new directory]</replaceable></userinput>, where <replaceable>[new
797directory]</replaceable> is the directory you want to move to.
798This directory name does not have to include the entire directory structure, but
799can be ``relative'' which means it assumes you are talking about directories
800relative to the directory you are in. For example, if you are in a directory
801called /home/username and you want to move to the directory
802/home/username/other/dir you could simply type <userinput>cd
803other/dir</userinput> and you would end up in /home/username/other/dir. You can
804also specify a full, or "absolute" path, by specifying the entire path name
805starting with / ( / is a special directory called the "root" directory, and does
806not have a "parent" directory, which means that it is not in any other
807directory). There are also two special directories called ``./'' and ``../''.
808The ``./'' directory is the current directory you are in, and you will probably
809never use this in conjunction with the cd command (why would you want to move to
810the directory you are already in?). The ``../'' directory represents the parent
811directory of the directory you are currently in, so if you are in
812/home/username, ../ is the same as /home. You can string several ../'s
813together, so if you are in /home/username/dir/ ../../ represents /home. There
814is one other special directory, called "~/" that points to your home
815directory (usually /home/username or /root for the root user).
816</para>
817</section>
818
819<section><title>Moving Files</title>
820<para>
821To move files around, you need to use the ``cp'' (copy) and ``mv'' (move)
822commands. Both of these are run the same way: \verb+command originalfile
823newfile+. The only difference is that cp creates a new file without touching
824the old one, while mv deletes the original file. The two path names can be
825either absolute or relative. If you only specify a directory for the
826destination, and no filename, it will use the filename for the original file.
827</para>
828</section>
829
830<section><title>Deleting Files</title>
831<para>
832To delete a file, run the ``rm'' command, and to delete a directory, run the
833``rmdir'' command, each of them take the file to be removed as their only
834argument. The rmdir command requires the directory to be empty, so if you want
835to delete a directory that is not empty, along with all its contents, run
836<userinput>rm -r dir</userinput>.
837</para>
838</section>
839
840<section><title>Linking Files</title>
841<para>
842In Linux, you can have a special file called a ``symbolic link'' that acts just
843like a copy of another file, except it takes up less space. This is convinient
844if two applications are looking for the same file in two separate places,
845because the file can be in both places at once, without taking up any extra
846space, and any change to one is automatically applied to the other (really,
847there is only one file, the link is just a file pointing to the original file).
848This is also useful for naming applications independant of their version number.
849 For instance, you could have a link called ``application'' that points to
850``application1.0''. To create a link, use the following command:
851<userinput>ln -s originalfile link</userinput>.
852</para>
853</section>
854</chapter>
855</part>
856
857<part><title>Settings</title>
858<chapter><title>Software</title>
859
860<para>
861The ``Software'' application, also called oipkg, is what is used to install and
862remove software. It is actually a frontend to the command line program ``ipkg''
863so most things you can do with oipkg you can also do with ipkg. Oipkg can
864install things either remotely from a web server (called a ``feed'') or it can
865install an ipkg package file that resides on the local filesystem.
866</para>
867<important>
868<para>
869Note: There is a bug in oipkg that prevents it from installing packages
870properly. There is, however, a workaround for it. Simply run oipkg from
871Embedded Konsole to avoid the bug.
872</para>
873</important>
874
875<section><title>Installing Software</title>
876<para>
877To install software, first select ``Opie'' from the ``Section'' pulldown menu,
878the press the ``+'' icon next to ``Feeds'' in the main view. This will show all
879the available Opie packages (you can change which packages to view by selecting
880something else from the ``Section'' pulldown). Installed packages are marked
881with a blue circle, while packages that are not installed are marked with a red
882box. If you click on the icon for an uninstalled package, it will turn into an
883open box, with a blue circle coming out of it, indicating that you have marked
884this package to be installed. Mark as many packages as you wish this way, and
885then press the ``Apply'' icon (same red box and blue dot icon) to install all
886the marked packages. It will also remove any packages marked for removal (see
887below). Clicking this will open a window showing all the packages marked to be
888removed and installed, with some check boxes on the bottom, which represent
889arguments to be sent to ipkg, which you can usually ignore. After verifying
890that all the packages to be installed are correct, press ``Ok'' in the upper
891right corner (or press ``x'' to cancel and go back to the package selection
892window). The packages should then install, and you should see their icons
893appear in the Launcher, if they are Opie applications.
894</para>
895</section>
896
897<section><title>Removing Software</title>
898<para>
899Removing software is the same as installing software, except you will press the
900blue circle icon of an installed package, and it will have a red ``X'' over it.
901Then press the apply icon, and ``Ok''. You can install and remove packages at
902the same time by marking the ones you want to install and the ones you want to
903remove, and then pressing apply.
904</para>
905</section>
906</chapter>
907</part>
693</book> \ No newline at end of file 908</book> \ No newline at end of file