File: help-doc.html

package info (click to toggle)
user-mode-linux-doc 20020523-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 1,592 kB
  • ctags: 340
  • sloc: makefile: 32
file content (307 lines) | stat: -rw-r--r-- 10,916 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"
    "http://www.w3.org/TR/REC-html40/loose.dtd">
<html>
<head>
   <meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<title>Help with the documentation</title>
</head>
<body alink="#FF0000" vlink="#55188A" link="#0000EF" bgcolor="#FFFFFF" text="#000099">
<table border="0">
<tr align="left">
<td valign="top">
<table border="0">

<tr align="left"><td valign="top" >
<img width="120" height="171" src="uml-small.png">
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">
<font size="-1"><a href="index.html">Site Home Page</a></font>
<br>
              <font size="-1"><a href="uses.html">What it's good for</a></font>
<br>
              <font size="-1"><a href="case-studies.html">Case Studies</a></font>
<br>
              <font size="-1"><a href="kernel.html">Kernel Capabilities</a></font>
<br>
              <font size="-1"><a href="dl-sf.html">Downloading it</a></font>
<br>
              <font size="-1"><a href="run.html">Running it</a></font>
<br>
              <font size="-1"><a href="compile.html">Compiling</a></font>
<br>
              <font size="-1"><a href="install.html">Installation</a></font>
<br>
              <font size="-1"><a href="fs_making.html">Building filesystems</a></font>
<br>
              <font size="-1"><a href="faq.html">Troubles</a></font>
<br>
              <font size="-1"><a href="contrib.html">User Contributions</a></font>
<br>
              <font size="-1"><a href="links.html">Related Links</a></font>
<br>
              <font size="-1"><a href="todo.html">The ToDo list</a></font>
<br>
              <font size="-1"><a href="projects.html">Projects</a></font>
<br>
              <font size="-1"><a href="diary.html">Diary</a></font>
<br>
              <font size="-1"><a href="thanks.html">Thanks</a></font>
<br>
              <font size="-1"><a href="contacts.html">Contacts</a></font>
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">Tutorials<br>
<font size="-1"><a href="UserModeLinux-HOWTO.html">The HOWTO (html)</a></font>
<br>
              <font size="-1"><a href="UserModeLinux-HOWTO.txt">The HOWTO (text)</a></font>
<br>
              <font size="-1"><a href="hostfs.html">Host file access</a></font>
<br>
              <font size="-1"><a href="input.html">Device inputs</a></font>
<br>
              <font size="-1"><a href="shared_fs.html">Sharing filesystems</a></font>
<br>
              <font size="-1"><a href="fs.html">Creating filesystems</a></font>
<br>
              <font size="-1"><a href="networking.html">Virtual Networking</a></font>
<br>
              <font size="-1"><a href="mconsole.html">Management Console</a></font>
<br>
              <font size="-1"><a href="debugging.html">Kernel Debugging</a></font>
<br>
              <font size="-1"><a href="gprof.html">gprof and gcov</a></font>
<br>
              <font size="-1"><a href="xtut.html">Running X</a></font>
<br>
              <font size="-1"><a href="trouble.html">Diagnosing problems</a></font>
<br>
              <font size="-1"><a href="config.html">Configuration</a></font>
<br>
              <font size="-1"><a href="slack_readme.html">Installing Slackware</a></font>
<br>
              <font size="-1"><a href="arch-port.html">Porting UML</a></font>
<br>
              <font size="-1"><a href="iomem.html">IO memory emulation</a></font>
<br>
              <font size="-1"><a href="2G-2G.html">UML on 2G/2G hosts</a></font>
<br>
              <font size="-1"><a href="lksct/index.html">Adding a UML system call</a></font>
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">How you can help<br>
<font size="-1"><a href="help-gen.html">Overview</a></font>
<br>
              <font size="-1"><a href="help-doc.html">Documentation</a></font>
<br>
              <font size="-1"><a href="help-userspace.html">Utilities</a></font>
<br>
              <font size="-1"><a href="help-kernel-v1.html">Kernel bugs</a></font>
<br>
              <font size="-1"><a href="projects.html">Kernel projects</a></font>
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">Screenshots<br>
<font size="-1"><a href="net.html">A virtual network</a></font>
<br>
              <font size="-1"><a href="x.html">An X session</a></font>
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">Transcripts<br>
<font size="-1"><a href="login.html">A login session</a></font>
<br>
              <font size="-1"><a href="debug-session.html">A debugging session</a></font>
<br>
              <font size="-1"><a href="slackinst.html">Slackware installation</a></font>
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">Reference<br>
<font size="-1"><a href="switches.html">Kernel switches</a></font>
<br>
              <font size="-1"><a href="slack_readme.html">Slackware README</a></font>
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">Papers<br>
<font size="-1"><a href="als2000/index.html">ALS 2000 paper (html)</a></font>
<br>
              <font size="-1"><a href="als2000.tex">ALS 2000 paper (TeX)</a></font>
<br>
              <font size="-1"><a href="slides/als2000/slides.html">ALS 2000 slides</a></font>
<br>
              <font size="-1"><a href="slides/lca2001/lca.html">LCA 2001 slides</a></font>
<br>
              <font size="-1"><a href="slides/ols2001/index.html">OLS 2001 paper (html)</a></font>
<br>
              <font size="-1"><a href="ols2001.tex">OLS 2001 paper (TeX)</a></font>
<br>
              <font size="-1"><a href="als2001/index.html">ALS 2001 paper (html)</a></font>
<br>
              <font size="-1"><a href="als2001.tex">ALS 2001 paper (TeX)</a></font>
<br>
              <font size="-1"><a href="slides/ists2002/umlsec.htm">UML security (html)</a></font>
<br>
              <font size="-1"><a href="slides/lca2002/lca2002.htm">LCA 2002 (html)</a></font>
<br>
              <font size="-1"><a href="slides/wvu2002/wvu2002.htm">WVU 2002 (html)</a></font>
</td></tr>

<tr align="left"><td valign="top" bgcolor="#e0e0e0">Fun and Games<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/cgi-bin/hangman">Kernel Hangman</a></font>
<br>
              <font size="-1"><a href="sdotm.html">Disaster of the Month</a></font>
</td></tr>

</table>
</td>
<td valign="top" align="left">

<a name="How the docs are done"/><table width="100%" bgcolor="#e0e0e0">
            <tr>
              <td>
                <b>
                  <font color="black">How the docs are done</font>
                </b>
              </td>
            </tr>
          </table>
          <blockquote head="How the docs are done">
The source for all UML documentation is XML, with a set of tags
invented, ad-hoc, one-the-fly, by me.  This is processed into the UML
web site and the HOWTO with 
<a href="http://www.w3.org/TR/xsl/">XSL</a>, using 
<a href="http://www.mozilla.org/projects/xslt/">
Transformiix</a>, which is the
<a href="http://www.mozilla.org">Mozilla</a>
 XSL processor. 
<p>
The documentation source is in CVS under /doc/web.  A variety of files
are located here:
<ul>
<li>
XML files - the documentation source itself
</li>
<li>
Makefile - the Makefile knows how to build and sync the web site, and
how to build the HOWTO, as both HTML and text.
</li>
<li>
sgml.xsl and uml.xsl - the XSL scripts, sgml.xsl builds the SGML
source for the HOWTO, which is converted into HTML and text with the
sgml-tools utilities, and uml.xsl builds the web site.
</li>
<li>
md.pl - a little perl script which combines page.xml, which is the web
boilerpate, into a single XML document which each of the other XML
files.  This allows Transformiix to combine them into an HTML file.
</li>
<li>
sgml.pl - another little perl script which combines a subset of the
XML files into a single XML document along with some other bits of
information.  This combined document is then converted into the SGML
source file for the HOWTO.
</li>
</ul>
In addition, there are a large number of files which are copied
verbatim into the site.  These include
<ul>
<li>
A number of pictures
</li>
<li>
UML slides and papers from various conferences, in various forms
</li>
<li>
A few text files
</li>
<li>
All of the UML patches which have been sent to Alan, since I reference
these from my diary
</li>
</ul>
</blockquote>

<a name="What needs doing"/><table width="100%" bgcolor="#e0e0e0">
            <tr>
              <td>
                <b>
                  <font color="black">What needs doing</font>
                </b>
              </td>
            </tr>
          </table>
          <blockquote head="What needs doing">
Some things were <a href="help-gen.html">already
mentioned</a>:
<ul>
<li>
Checking the site for spelling and grammar errors
</li>
<li>
Checking it for untrue statements, particularly HOWTOs that don't work
as advertised
</li>
<li>
Looking for HOWTOs, that while technically are true, do not describe the
best, quickest, or simplest way to get the job done
</li>
</ul>
The aesthetics of this site may not be the best.  Improvements are
welcome.  Also, there are a lack of diagrams and pictures which might
help clarify things.  Contributions would also be welcome.
<p>
Improvements to the layout and organization would be good.  It might
also be nice to have some kind of automatically generated news section
on the main page which lists the latest UML happenings or the latest
site updates.
<p>
This site mostly contains HOWTO-type material.  If you would like to
see other sorts of things here, speak up, or write it up and send it in.
<p>
The utilities that ship with UML need man pages.  I'd like XML source
that can be converted into man page source, HTML, and SGML.  It's OK
if all these outputs look something like man pages.  We can add new
sections to the site and the HOWTO for them.
<p>
The XML tagset being used here is probably not the world's most sane
XML schema.  Improvements and simplifications would be welcome.  Also,
the abstract tags are not used everywhere they should be.
<p>
The site needs an advanced networking page.  This should cover things
like 
<ul>
<li>
Multiple UMLs networking via the host
</li>
<li>
Setting up a virtual network with one or more nodes acting as gateways
to the host
</li>
<li post="6441084">
Bridging - I have a  <a href="http://www.geocrawler.com/lists/3/SourceForge/597/0/6441084">walkthrough</a> 
which needs to be incorporated
</li>
<li>
Maybe setting up IPv6
</li>
<li>
Setting up a ppp link over a UML console or serial line in order to
run what amounts to a dial-up connection to the host.  Also, setting
up the serial lines of two UMLs so that one can dial up to the other.
</li>
</ul>
</blockquote>


</td>
</tr>
</table>

<center>
<font size="-1">
Hosted at </font>
<a href="http://sourceforge.net">
<IMG alt="SourceForge Logo" border="0" height="31" width="88" src="http://sourceforge.net/sflogo.php?group_id=429">
</a>
</center>
</body>
</html>