/usr/share/doc/user-mode-linux-doc/html/help-gen.html is in user-mode-linux-doc 20060501-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 | <!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>How you can help</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 src="uml-small.png" height="171" width="120"/>
</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="http://uml.harlowhill.com">The UML Wiki</a></font>
<br>
<font size="-1"><a href="http://usermodelinux.org">UML Community Site</a></font>
<br>
<font size="-1"><a href="roadmap.html">The UML roadmap</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="http://user-mode-linux.sourceforge.net/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="skas.html">Skas Mode</a></font>
<br>
<font size="-1"><a href="patches.html">Incremental Patches</a></font>
<br>
<font size="-1"><a href="tests.html">Test Suite</a></font>
<br>
<font size="-1"><a href="devanon.html">Host memory use</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.gz">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="resize.html">Resizing 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="honeypots.html">UML Honeypots</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="http://user-mode-linux.sourceforge.net/lksct/index.html">Adding a UML system call</a></font>
<br>
<font size="-1"><a href="nesting.html">Running nested UMLs</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="http://user-mode-linux.sourceforge.net/als2000/index.html">ALS 2000 paper (html)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/als2000.tex">ALS 2000 paper (TeX)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/als2000/slides.html">ALS 2000 slides</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/lca2001/lca.html">LCA 2001 slides</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/ols2001/index.html">OLS 2001 paper (html)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/ols2001.tex">OLS 2001 paper (TeX)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/als2001/index.html">ALS 2001 paper (html)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/als2001.tex">ALS 2001 paper (TeX)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/ists2002/umlsec.htm">UML security (html)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/lca2002/lca2002.htm">LCA 2002 (html)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/wvu2002/wvu2002.htm">WVU 2002 (html)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/ists_rt/ists_rt.htm">Security Roundtable (html)</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/ols2002/ols2002.html">OLS 2002 slides</a></font>
<br>
<font size="-1"><a href="http://user-mode-linux.sourceforge.net/slides/lwe2005/LWE2005.html">LWE 2005 slides</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">
No matter who you are, what you do, or what level of programming
ability you have, there are ways that you can help out with UML.
<a name="Non-programmers"/><table width="100%" bgcolor="#e0e0e0">
<tr>
<td>
<b>
<font color="black">Non-programmers</font>
</b>
</td>
</tr>
</table>
<blockquote head="Non-programmers">
If you don't program at all, there are a number of things that you can
do. The main one is to just use UML. Report any bugs, problems, or
rough spots that you encounter. If you find workarounds, tell us
about them, too. There are a large number of different kinds of
environments out there, and there may be assumptions accidentally
built in to UML that cause it not to work, or not to work well, in
some of them. The more people we have using UML, and the wider the
variety of situations it's used in, the more robust it will become.
<p>
You can check the documentation - you probably will do so in the
course of learning what you can use UML for. The main thing that you
can do is report any problems you find.
<p>
If you want to help in a more systematic way, you can
<ul>
<li>
proofread it - I try to be grammatical and spell things correctly, but
sometimes mistakes slip through.
</li>
<li>
fact-check it - in particular, make sure that the step-by-step
procedures actually work. They occasionaly get out-of-date,
describing methods of doing things that no longer work because new
ways have been introduced and the old ways removed. They may not work
in all environments. They are mostly written up after I've got them
working on my laptop. Your machines may differ, and they may differ
enough that my procedures don't work for you. Also, I may have found a
overly-complicated way of doing something. If you know a simpler way,
you should let us know about it.
</li>
<li>
style-check it - it may be that a way of doing something is correct,
but poorly worded or confusing. If you get lost trying to do
something, you should complain about it. If you persevere and figure
out how to make it work, it would be very useful for you to go back
over the documentation and see where you got lost. Then, figure out
what it could have said that would have prevented you getting lost,
and send that in.
</li>
</ul>
Documentation fixes will be accepted in any usable form, including a
general description of something that needs doing, suggested text as
just text, or fix to the XML source for the documentation.
<p>
If you want to get more involved in the documentation, it is described
<a href="help-doc.html">here</a>.
</blockquote>
<a name="User-space programmers"/><table width="100%" bgcolor="#e0e0e0">
<tr>
<td>
<b>
<font color="black">User-space programmers</font>
</b>
</td>
</tr>
</table>
<blockquote head="User-space programmers">
If you want to contribute code to UML, but you aren't a kernel hacker,
there are a number of areas that need work. There are a number of
tools that come with UML that aren't strictly part of it, but which
make using it easier in some way (such as the uml_net networking
helper) or which provide access to UML functionality (such as the
mconsole client). There are a variety of enhancements that can be
made to these.
<p>
Various applications of UML are going to require tools which don't
currently exist. For example, for UML to be most useful for virtual
hosting, there need to be tools which can configure and run a virtual
machine for a new customer. People who are doing networking of
clustering experimentation with UML need something similar, except
that it needs to be able to construct a specific network of UML
virtual machines.
<p>
The UML packaging is somewhat ad-hoc at the moment. I've learned
enough about both RPM and Debian packaging to be able to put together
defensible UML packages in both formats. However, I'm sure that
they would not be considered 100% kosher by either camp. So, there is
a need for packaging experts to have a look at the UML packaging
procedures, find the mistakes, and fix them.
<p>
Contributing code to UML itself is not completely out of the question
if you're not a kernel hacker. Since UML is a port of the Linux
kernel to Linux, the lowest levels of the code, which in other ports,
are hard-core hardware-specific code, are generally fairly
straightforward userspace code. That code does stuff like read files,
talk to pseudo-terminals, communicate over the net, etc. It's
perfectly possibly for people who don't know about kernel programming
to contribute useful stuff here.
</blockquote>
<a name="Kernel hackers"/><table width="100%" bgcolor="#e0e0e0">
<tr>
<td>
<b>
<font color="black">Kernel hackers</font>
</b>
</td>
</tr>
</table>
<blockquote head="Kernel hackers">
If you're a kernel hacker, you can find and fix bugs in UML. I've
listed the bugs (and some features) that I want to fix before UML V1.0
<a href="help-kernel-v1.html">here</a>.
<p>
There are also a number of longer-term projects described
<a href="projects.html">here</a>. These are the
post-V1 things I want to do, but I certainly have no objection to people
starting work on them now. They include things like adding SMP
support, implementing clusters of various types (first DSM-based
clusters, moving to more standard RPC-based clusters), making Linux a
better host for UML, ports of UML to more architectures and to other
operating systems, and a variety of other things.
</blockquote>
<a name="Other contributions"/><table width="100%" bgcolor="#e0e0e0">
<tr>
<td>
<b>
<font color="black">Other contributions</font>
</b>
</td>
</tr>
</table>
<blockquote head="Other contributions">
There are some things that you can do to help out UML, no matter who
you are:
<ul>
<li>
New applications - I have a number of applications of UML listed
<a href="uses.html">here</a>. I am but one
person and my imagination is limited. If you find UML useful for
something and it's not listed there, let me know.
</li>
<li>
Propaganda ... err, spreading the word - If you find UML useful for
something, chances are you know other people who are doing the same
thing who don't know about UML. Tell them about it. Recommend most
strongly that they start using it. If you know of web sites or
publications that would be interested in UML, suggest that they write
about it.
</li>
<li>
Donations - Other sorts of things will be cheerfully accepted
<ul>
<li>
Hardware - A good rule is that anything that gives me faster kernel
builds is good. SMP kit is also good, since UML has displayed races
on SMP machines that aren't seen on UP machines. Non-x86 hardware is
good, particularly if it comes with an interesting vendor OS (i.e. VMS
or OS/400). This will help out the UML porting situation.
</li>
<li>
Money - It can be exchanged for the aforementioned toys, so it's good
too.
</li>
<li>
Anything else - <a href="contacts.html">Get in
touch</a> and we can discuss it.
</li>
</ul>
</li>
</ul>
</blockquote>
</td>
</tr>
</table>
<center>
<font size="-1">Hosted at </font>
<a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=429" width="88" height="31" border="0" alt="SourceForge Logo">
</a>
</center>
</body>
</html>
|