-rw-r--r-- | docs/usermanual/embeddedkonsole.sgm | 6 | ||||
-rw-r--r-- | docs/usermanual/software.sgm | 69 |
2 files changed, 72 insertions, 3 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 | |||
38 | the terminal. | 38 | the terminal. |
39 | </para> | 39 | </para> |
40 | <para> | 40 | <para> |
41 | The other icons are the same as typing (from left to right) enter, space, tab | 41 | The 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> |
47 | The command list is a pulldown menu with a list of commonly used commands. | 47 | The command list is a pulldown menu with a list of commonly used commands. |
48 | Selecting one will type the command into the terminal wherever the cursor is. | 48 | Selecting one will type the command into the terminal wherever the cursor is. |
49 | You can edit or hide this menu from <GUIMenu>Options</GUIMenu>&arrow; | 49 | You 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> |
57 | A shell is a program that accepts input from a user, and runs commands. Each | 57 | A 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 |
59 | shell like BusyBox, which makes some of the more common commands part of its own | 59 | shell like BusyBox, which makes some of the more common commands part of its own |
60 | program in order to save space). Shells can actually be very powerful, and many | 60 | program in order to save space). Shells can actually be very powerful, and many |
61 | 61 | ||
62 | |||
63 | |||
62 | of them allow you to write something called "shell scripts" which are just a | 64 | of them allow you to write something called "shell scripts" which are just a |
63 | sequence of commands, sometimes with some flow control statements, saved to a | 65 | sequence of commands, sometimes with some flow control statements, saved to a |
64 | file and run each time the script is run. For the most part, the average user | 66 | file and run each time the script is run. For the most part, the average user |
65 | does not need to know about any of this, though. If you are running Opie on the | 67 | does not need to know about any of this, though. If you are running Opie on the |
66 | Familiar distribution, it is advisable to install the bash shell (ipkg install | 68 | Familiar distribution, it is advisable to install the bash shell (ipkg install |
67 | bash) because it offers things like tab completion, use of the backspace key, | 69 | bash) because it offers things like tab completion, use of the backspace key, |
68 | and a command history, as well as offering a more advanced scripting languauge | 70 | and a command history, as well as offering a more advanced scripting languauge |
69 | than most other shells. | 71 | than 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> |
75 | To run a program or a command (remember, a command is just another program), you | 77 | To run a program or a command (remember, a command is just another program), you |
76 | simply type the name of the program and hit "Return" (in Linux, program names | 78 | simply type the name of the program and hit "Return" (in Linux, program names |
77 | do not have a special suffix like they do in windows, in fact the "." | 79 | do not have a special suffix like they do in windows, in fact the "." |
78 | character has no special meaning unless it is at the begining of a filename, in | 80 | character has no special meaning unless it is at the begining of a filename, in |
79 | which case it makes the file "hidden"). When you type a program name and hit | 81 | which 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 |
82 | and tells you it could not find them. If you want to run a program that is not | 84 | and tells you it could not find them. If you want to run a program that is not |
83 | in your path, you must specify an absolute or relative path to that program. | 85 | in your path, you must specify an absolute or relative path to that program. |
84 | For instance, to run a program that is in the directory you are currently in, | 86 | For instance, to run a program that is in the directory you are currently in, |
85 | you would type <literal>./program</literal> ("./" is a special directory that | 87 | you 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> |
130 | To move files around, you need to use the "cp" (copy) and "mv" (move) | 132 | To move files around, you need to use the "cp" (copy) and "mv" (move) |
131 | commands. Both of these are run the same way: <userinput>command originalfile | 133 | commands. Both of these are run the same way: <userinput>command originalfile |
132 | newfile</userinput>. The only difference is that cp creates a new file without | 134 | newfile</userinput>. The only difference is that cp creates a new file without |
133 | touching the old one, while mv deletes the original file. The two path names | 135 | touching the old one, while mv deletes the original file. The two path names |
134 | can be either absolute or relative. If you only specify a directory for the | 136 | can be either absolute or relative. If you only specify a directory for the |
135 | destination, and no filename, it will use the filename for the original file. | 137 | destination, 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> |
141 | To delete a file, run the "rm" command, and to delete a directory, run the | 143 | To 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 |
143 | argument. The rmdir command requires the directory to be empty, so if you want | 145 | argument. The rmdir command requires the directory to be empty, so if you want |
144 | to delete a directory that is not empty, along with all its contents, run | 146 | to 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> |
151 | In Linux, you can have a special file called a "symbolic link" that acts just | 153 | In Linux, you can have a special file called a "symbolic link" that acts just |
152 | like a copy of another file, except it takes up less space. This is convinient | 154 | like a copy of another file, except it takes up less space. This is convinient |
153 | if two applications are looking for the same file in two separate places, | 155 | if two applications are looking for the same file in two separate places, |
154 | because the file can be in both places at once, without taking up any extra | 156 | because the file can be in both places at once, without taking up any extra |
155 | space, and any change to one is automatically applied to the other (really, | 157 | space, and any change to one is automatically applied to the other (really, |
156 | there is only one file, the link is just a file pointing to the original file). | 158 | there is only one file, the link is just a file pointing to the original file). |
157 | This is also useful for naming applications independant of their version number. | 159 | This 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> |
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 | |||
25 | box. If you click on the icon for an uninstalled package, it will turn into an | 25 | box. If you click on the icon for an uninstalled package, it will turn into an |
26 | open box, with a blue circle coming out of it, indicating that you have marked | 26 | open box, with a blue circle coming out of it, indicating that you have marked |
27 | this package to be installed. Mark as many packages as you wish this way, and | 27 | this package to be installed. Mark as many packages as you wish this way, and |
28 | then press the "Apply" icon (same red box and blue dot icon) to install all | 28 | then press the "Apply" icon (same red box and blue dot icon) to install all |
29 | the marked packages. It will also remove any packages marked for removal (see | 29 | the marked packages. It will also remove any packages marked for removal (see |
30 | below). Clicking this will open a window showing all the packages marked to be | 30 | below). Clicking this will open a window showing all the packages marked to be |
31 | removed and installed, with some check boxes on the bottom, which represent | 31 | removed and installed, with some check boxes on the bottom, which represent |
32 | arguments to be sent to ipkg, which you can usually ignore. After verifying | 32 | arguments to be sent to ipkg, which you can usually ignore. After verifying |
33 | that all the packages to be installed are correct, press "Ok" in the upper | 33 | that all the packages to be installed are correct, press "Ok" in the upper |
34 | right corner (or press "x" to cancel and go back to the package selection | 34 | right corner (or press "x" to cancel and go back to the package selection |
35 | window). The packages should then install, and you should see their icons | 35 | window). The packages should then install, and you should see their icons |
36 | appear in the Launcher, if they are Opie applications. | 36 | appear 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> |
42 | Removing software is the same as installing software, except you will press the | 42 | Removing software is the same as installing software, except you will press the |
43 | blue circle icon of an installed package, and it will have a red "X" over it. | 43 | blue circle icon of an installed package, and it will have a red "X" over it. |
44 | Then press the apply icon, and "Ok". You can install and remove packages at | 44 | Then press the apply icon, and "Ok". You can install and remove packages at |
45 | the same time by marking the ones you want to install and the ones you want to | 45 | the same time by marking the ones you want to install and the ones you want to |
46 | remove, and then pressing apply. | 46 | remove, and then pressing apply. |
47 | </para> | 47 | </para> |
48 | </section> | 48 | </section> |
49 | </chapter> \ No newline at end of file | 49 | |
50 | <section><title>Destinations</title> | ||
51 | <para> | ||
52 | Software is distributed in a format called "ipkg" which contains all the | ||
53 | necessary files for the program, as well as information on where to put them. | ||
54 | However, this information is only half complete, as it tells the package manager | ||
55 | where in the "destination" to put the files, but the package manager must know | ||
56 | where this "destination" is. The default destination is "/" (called "root") so | ||
57 | if the package says to install a file in opt/QtPalmtop/ then the file will be | ||
58 | installed in /opt/QtPalmtop/. However, if ask the package manger to use a | ||
59 | destination at /mnt/hda/ (this is typically where a compact flash card would be) | ||
60 | then the files will be installed in /mnt/hda/opt/QtPalmtop/. | ||
61 | </para> | ||
62 | <para> | ||
63 | The problem with installing file in a destination other than root is that the | ||
64 | software usually does not know where to fine the installed files, and Opie does | ||
65 | not know where to find the information that tells it how to display the program | ||
66 | in the Launcher. To get around this, the package manager creates links | ||
67 | <footnote><para>See <xref linkend=symlink> for more information on symbolic | ||
68 | links in Linux</para></footnote> from where the files would be if they were | ||
69 | installed in root to where they are actually installed. This means that no more | ||
70 | space is taken up where the files would normally be installed, but any programs | ||
71 | can still find the files where they think they should be. | ||
72 | </para> | ||
73 | |||
74 | <section><title>Using Destinations</title> | ||
75 | <para> | ||
76 | To install a package in a destination other than root, go to | ||
77 | Settings&arrow;Setups to open the settings dialog to the Setups tab. From here | ||
78 | you can select the destination you would like to install the package to from the | ||
79 | pulldown menu at the bottom. You will also want to check "Link to root | ||
80 | destination" so that links are properly made. Once you have selected the | ||
81 | destination you want to install the package to, click the dialog's "Ok" button, | ||
82 | and all packages that you install will be installed to the destination you | ||
83 | selected. | ||
84 | </para> | ||
85 | </section> | ||
86 | <section><title>Adding Destinations</title> | ||
87 | <para> | ||
88 | To add a destination, go to Settings&arrow;Destinations to bring up the settings | ||
89 | dialog at the Destinations tab, and press the "New" button to add a new | ||
90 | Destination to the list. The new destination should be highlighted | ||
91 | automatically, and you can then change the name and the URL with the two text | ||
92 | entry fields below it. The name is only for easy display of the destination, so | ||
93 | name it whatever makes the most sense to you. The URL is the location that you | ||
94 | want the destination to have. So, if you want all your software to be installed | ||
95 | under /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> | ||
101 | You can edit a destination by going to Settings&arrow;Destinations and selecting | ||
102 | the destination that you would like to edit. Then you can edit the Name and URL | ||
103 | fields in the same manner as when you added a destination. To save, click "Ok" | ||
104 | or cancel by clicking "x". | ||
105 | </para> | ||
106 | </section> | ||
107 | <section><title>Deleting Destinations</title> | ||
108 | <para> | ||
109 | Deleting a destination is very easy. Go to Settings&arrow;Destinations and | ||
110 | select 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 | ||
112 | changes, or "x" to cancel them. | ||
113 | </para> | ||
114 | </section> | ||
115 | </section> | ||
116 | </chapter> | ||