summaryrefslogtreecommitdiff
path: root/docs/usermanual
Unidiff
Diffstat (limited to 'docs/usermanual') (more/less context) (show whitespace changes)
-rw-r--r--docs/usermanual/embeddedkonsole.sgm4
-rw-r--r--docs/usermanual/software.sgm67
2 files changed, 70 insertions, 1 deletions
diff --git a/docs/usermanual/embeddedkonsole.sgm b/docs/usermanual/embeddedkonsole.sgm
index 4ba0287..838e705 100644
--- a/docs/usermanual/embeddedkonsole.sgm
+++ b/docs/usermanual/embeddedkonsole.sgm
@@ -38,48 +38,50 @@ while 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
63
62of 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
63sequence of commands, sometimes with some flow control statements, saved to a 65sequence of commands, sometimes with some flow control statements, saved to a
64file 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
65does 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
66Familiar distribution, it is advisable to install the bash shell (ipkg install 68Familiar distribution, it is advisable to install the bash shell (ipkg install
67bash) 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,
68and 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
69than most other shells. 71than most other shells.
70</para> 72</para>
71</section> 73</section>
72 74
73<section><title>Running Programs</title> 75<section><title>Running Programs</title>
74<para> 76<para>
75To 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
76simply 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
77do 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 "."
78character 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
79which 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
80"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
81"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
82and 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
83in 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.
84For 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,
85you would type <literal>./program</literal> ("./" is a special directory that 87you would type <literal>./program</literal> ("./" is a special directory that
@@ -125,39 +127,39 @@ directory (usually /home/username or /root for the root user).
125</para> 127</para>
126</section> 128</section>
127 129
128<section><title>Moving Files</title> 130<section><title>Moving Files</title>
129<para> 131<para>
130To move files around, you need to use the "cp" (copy) and "mv" (move) 132To move files around, you need to use the "cp" (copy) and "mv" (move)
131commands. Both of these are run the same way: <userinput>command originalfile 133commands. Both of these are run the same way: <userinput>command originalfile
132newfile</userinput>. The only difference is that cp creates a new file without 134newfile</userinput>. The only difference is that cp creates a new file without
133touching the old one, while mv deletes the original file. The two path names 135touching the old one, while mv deletes the original file. The two path names
134can be either absolute or relative. If you only specify a directory for the 136can be either absolute or relative. If you only specify a directory for the
135destination, and no filename, it will use the filename for the original file. 137destination, and no filename, it will use the filename for the original file.
136</para> 138</para>
137</section> 139</section>
138 140
139<section><title>Deleting Files</title> 141<section><title>Deleting Files</title>
140<para> 142<para>
141To delete a file, run the "rm" command, and to delete a directory, run the 143To delete a file, run the "rm" command, and to delete a directory, run the
142"rmdir" command, each of them take the file to be removed as their only 144"rmdir" command, each of them take the file to be removed as their only
143argument. The rmdir command requires the directory to be empty, so if you want 145argument. The rmdir command requires the directory to be empty, so if you want
144to delete a directory that is not empty, along with all its contents, run 146to delete a directory that is not empty, along with all its contents, run
145<userinput>rm -r dir</userinput>. 147<userinput>rm -r dir</userinput>.
146</para> 148</para>
147</section> 149</section>
148 150
149<section><title>Linking Files</title> 151<section id=symlink><title>Linking Files</title>
150<para> 152<para>
151In Linux, you can have a special file called a "symbolic link" that acts just 153In Linux, you can have a special file called a "symbolic link" that acts just
152like a copy of another file, except it takes up less space. This is convinient 154like a copy of another file, except it takes up less space. This is convinient
153if two applications are looking for the same file in two separate places, 155if two applications are looking for the same file in two separate places,
154because the file can be in both places at once, without taking up any extra 156because the file can be in both places at once, without taking up any extra
155space, and any change to one is automatically applied to the other (really, 157space, and any change to one is automatically applied to the other (really,
156there is only one file, the link is just a file pointing to the original file). 158there is only one file, the link is just a file pointing to the original file).
157This is also useful for naming applications independant of their version number. 159This is also useful for naming applications independant of their version number.
158 For instance, you could have a link called "application" that points to 160 For instance, you could have a link called "application" that points to
159"application1.0". To create a link, use the following command: 161"application1.0". To create a link, use the following command:
160<userinput>ln -s originalfile link</userinput>. 162<userinput>ln -s originalfile link</userinput>.
161</para> 163</para>
162</section> 164</section>
163</chapter> \ No newline at end of file 165</chapter> \ No newline at end of file
diff --git a/docs/usermanual/software.sgm b/docs/usermanual/software.sgm
index 459498a..f95772c 100644
--- a/docs/usermanual/software.sgm
+++ b/docs/usermanual/software.sgm
@@ -25,25 +25,92 @@ with a blue circle, while packages that are not installed are marked with a red
25box. If you click on the icon for an uninstalled package, it will turn into an 25box. If you click on the icon for an uninstalled package, it will turn into an
26open box, with a blue circle coming out of it, indicating that you have marked 26open box, with a blue circle coming out of it, indicating that you have marked
27this package to be installed. Mark as many packages as you wish this way, and 27this package to be installed. Mark as many packages as you wish this way, and
28then press the "Apply" icon (same red box and blue dot icon) to install all 28then press the "Apply" icon (same red box and blue dot icon) to install all
29the marked packages. It will also remove any packages marked for removal (see 29the marked packages. It will also remove any packages marked for removal (see
30below). Clicking this will open a window showing all the packages marked to be 30below). Clicking this will open a window showing all the packages marked to be
31removed and installed, with some check boxes on the bottom, which represent 31removed and installed, with some check boxes on the bottom, which represent
32arguments to be sent to ipkg, which you can usually ignore. After verifying 32arguments to be sent to ipkg, which you can usually ignore. After verifying
33that all the packages to be installed are correct, press "Ok" in the upper 33that all the packages to be installed are correct, press "Ok" in the upper
34right corner (or press "x" to cancel and go back to the package selection 34right corner (or press "x" to cancel and go back to the package selection
35window). The packages should then install, and you should see their icons 35window). The packages should then install, and you should see their icons
36appear in the Launcher, if they are Opie applications. 36appear in the Launcher, if they are Opie applications.
37</para> 37</para>
38</section> 38</section>
39 39
40<section><title>Removing Software</title> 40<section><title>Removing Software</title>
41<para> 41<para>
42Removing software is the same as installing software, except you will press the 42Removing software is the same as installing software, except you will press the
43blue circle icon of an installed package, and it will have a red "X" over it. 43blue circle icon of an installed package, and it will have a red "X" over it.
44Then press the apply icon, and "Ok". You can install and remove packages at 44Then press the apply icon, and "Ok". You can install and remove packages at
45the same time by marking the ones you want to install and the ones you want to 45the same time by marking the ones you want to install and the ones you want to
46remove, and then pressing apply. 46remove, and then pressing apply.
47</para> 47</para>
48</section> 48</section>
49
50<section><title>Destinations</title>
51<para>
52Software is distributed in a format called "ipkg" which contains all the
53necessary files for the program, as well as information on where to put them.
54However, this information is only half complete, as it tells the package manager
55where in the "destination" to put the files, but the package manager must know
56where this "destination" is. The default destination is "/" (called "root") so
57if the package says to install a file in opt/QtPalmtop/ then the file will be
58installed in /opt/QtPalmtop/. However, if ask the package manger to use a
59destination at /mnt/hda/ (this is typically where a compact flash card would be)
60then the files will be installed in /mnt/hda/opt/QtPalmtop/.
61</para>
62<para>
63The problem with installing file in a destination other than root is that the
64software usually does not know where to fine the installed files, and Opie does
65not know where to find the information that tells it how to display the program
66in the Launcher. To get around this, the package manager creates links
67<footnote><para>See <xref linkend=symlink> for more information on symbolic
68links in Linux</para></footnote> from where the files would be if they were
69installed in root to where they are actually installed. This means that no more
70space is taken up where the files would normally be installed, but any programs
71can still find the files where they think they should be.
72</para>
73
74<section><title>Using Destinations</title>
75<para>
76To install a package in a destination other than root, go to
77Settings&arrow;Setups to open the settings dialog to the Setups tab. From here
78you can select the destination you would like to install the package to from the
79pulldown menu at the bottom. You will also want to check "Link to root
80destination" so that links are properly made. Once you have selected the
81destination you want to install the package to, click the dialog's "Ok" button,
82and all packages that you install will be installed to the destination you
83selected.
84</para>
85</section>
86<section><title>Adding Destinations</title>
87<para>
88To add a destination, go to Settings&arrow;Destinations to bring up the settings
89dialog at the Destinations tab, and press the "New" button to add a new
90Destination to the list. The new destination should be highlighted
91automatically, and you can then change the name and the URL with the two text
92entry fields below it. The name is only for easy display of the destination, so
93name it whatever makes the most sense to you. The URL is the location that you
94want the destination to have. So, if you want all your software to be installed
95under /usr/directory then you would set the URL to that. You can then click
96"Ok" to save, or "x" to cancel the changes.
97</para>
98</section>
99<section><title>Editing Destinations</title>
100<para>
101You can edit a destination by going to Settings&arrow;Destinations and selecting
102the destination that you would like to edit. Then you can edit the Name and URL
103fields in the same manner as when you added a destination. To save, click "Ok"
104or cancel by clicking "x".
105</para>
106</section>
107<section><title>Deleting Destinations</title>
108<para>
109Deleting a destination is very easy. Go to Settings&arrow;Destinations and
110select the Destination that you would like to delete in the dialog that appears.
111 Press the "Remove" button to delete the destination, and press "Ok" to save the
112changes, or "x" to cancel them.
113</para>
114</section>
115</section>
49</chapter> \ No newline at end of file 116</chapter> \ No newline at end of file