christoph/fail
1
Fork 0
Code Releases Activity

Fail* directories reorganized, Code-cleanup (-> coding-style), Typos+comments fixed.

Browse Source 
git-svn-id: https://www4.informatik.uni-erlangen.de/i4svn/danceos/trunk/devel/fail@1321 8c4709b5-6ec9-48aa-a5cd-a96041d1645a
This commit is contained in:
adrian
2012-06-08 20:09:43 +00:00
parent d474a5b952
commit 2575604b41
866 changed files with 1848 additions and 1879 deletions
Download Patch File Download Diff File Expand all files Collapse all files

104
simulators/bochs/doc/docbook/Makefile.in Normal file
View File

@ -0,0 +1,104 @@
###################################################################
# doc/docbook/Makefile
# $Id$
#
# Builds documentation in various formats from SGML source, and
# allows easy update to the Bochs web site.
#
###################################################################
prefix = @prefix@
srcdir = @srcdir@
docdir = $(prefix)/share/doc/bochs
DOCBOOK2HTML = @DOCBOOK2HTML@
WGET = @WGET@
TARGZ = bochsdoc.tar.gz
RENDERED_DOC_URL = http://bochs.sf.net/doc/docbook/$(TARGZ)
DESTDIR=
# name of the major documentation sections
SECTIONS=user documentation development
SECTION_HTML=$(SECTIONS:%=%/index.html)
# these files get installed in addition to the sections
EXTRAS=index.html images
# complete list of what to install
INSTALL_LIST=$(SECTIONS) $(EXTRAS)
# ssh to this server to install the docs
REMOTE_HOST=shell.sf.net
# path of preexisting install on the remote server. Each section
# will go into a subdirectory of $REMOTE_PATH, as in
# $REMOTE_PATH/user.
REMOTE_PATH=/home/groups/b/bo/bochs/htdocs/doc/docbook
# -x means don't try to forward X authorization, it won't work for SF
SSH=ssh -x
all: $(SECTION_HTML)
user/index.html: $(srcdir)/user/user.dbk
-mkdir -p user
$(DOCBOOK2HTML) -o user $(srcdir)/user/user.dbk
documentation/index.html: $(srcdir)/documentation/documentation.dbk
-mkdir -p documentation
$(DOCBOOK2HTML) -o documentation $(srcdir)/documentation/documentation.dbk
development/index.html: $(srcdir)/development/development.dbk
-mkdir -p development
$(DOCBOOK2HTML) -o development $(srcdir)/development/development.dbk
fixperm::
# fix permissions locally so that tar will install things right
chmod 664 `find $(INSTALL_LIST) -type f -print`
chmod 775 `find $(INSTALL_LIST) -type d -print`
copy_from_srcdir::
for i in $(EXTRAS); do if test -e $(srcdir)/$$i -a ! -e $$i; then cp -r $(srcdir)/$$i $$i; fi; done
$(TARGZ): all copy_from_srcdir fixperm
rm -f $(TARGZ)
tar cf - --exclude=CVS --exclude=.cvsignore --exclude=*.dbk $(INSTALL_LIST) | gzip > $(TARGZ)
install: all copy_from_srcdir
for i in $(DESTDIR)$(docdir); do if test ! -d $$i; then mkdir -p $$i; fi; done
#for i in $(INSTALL_LIST); do cp -r $$i $(DESTDIR)$(docdir); done
for i in $(INSTALL_LIST); do tar cf - --exclude=CVS --exclude=.cvsignore --exclude=*.dbk $$i | ( cd $(DESTDIR)$(docdir); tar xf - ); done
test_sfuser:
@if test "$$SFUSER" = ""; then SFUSER=`whoami`; export SFUSER; fi; \
echo Your Source Forge username is $${SFUSER}.
@echo 'If this is not correct, set the environment variable $$SFUSER.'
# Install the stuff on the remote server using ssh. It will assume that your
# local username is the same as your Source Forge username, unless you define
# an environment variable SFUSER.
webinst: $(TARGZ)
# copy to remote
@echo Installing documentation on $(REMOTE_PATH)
if test "$$SFUSER" = ""; then SFUSER=`whoami`; export SFUSER; fi; \
scp $(TARGZ) $${SFUSER}@$(REMOTE_HOST):$(REMOTE_PATH); \
$(SSH) $${SFUSER}@$(REMOTE_HOST) "cd $(REMOTE_PATH) && umask 002 && gunzip -c $(TARGZ) | tar xvf -"
# Download rendered docs in a TAR file from the Bochs web site using wget.
# This is useful for getting documentation onto platforms that don't have
# docbook tools.
dl_docs::
rm -f $(TARGZ)
$(WGET) $(RENDERED_DOC_URL)
gunzip -c $(TARGZ) | tar xvf -
touch */*.html
clean:
# remove generated files
for S in $(SECTIONS); do \
rm -f $$S/*.html $$S/*.htm $$S/*.ps $$S/*.pdf $$S/*.out; \
done
@RMCOMMAND@ $(TARGZ)
dist-clean: clean
rm -f Makefile

84
simulators/bochs/doc/docbook/Makefile.jade Normal file
View File

@ -0,0 +1,84 @@
###################################################################
# doc/docbook/Makefile
# $Id$
#
# Builds documentation in various formats from SGML source, and
# allows easy update to the Bochs web site.
#
###################################################################
# name of the major documentation sections
SECTIONS=user documentation development
# these files get installed in addition to the sections
EXTRAS=README index.html images include
# complete list of what to install
INSTALL_LIST=$(SECTIONS) $(EXTRAS)
# ssh to this server to install the docs
REMOTE_HOST=shell.sf.net
# path of preexisting install in, on the remote server. Each section
# will go into a subdirectory of $REMOTE_PATH, as in
# $REMOTE_PATH/user.
REMOTE_PATH=/home/groups/b/bo/bochs/htdocs/doc/docbook
# -x means don't try to forward X authorization, it won't work for SF
SSH=ssh -x
# docbook defines and stuff
DSSSL_ROOT=/usr/share/sgml/docbook/stylesheet/dsssl/modular/
HTML_STYLESHEET=$(DSSSL_ROOT)/html/docbook.dsl
JADE=jade
JADE_ARGS=-t sgml -d $(HTML_STYLESHEET) # -V nochunks
SGML_VALIDATE=nsgmls -s
all: all_html
all_html: user/book1.html documentation/book1.html development/book1.html
user/book1.html: user/user.dbk
rm -f user/*.htm*
export i=user; cd $$i; $(JADE) $(JADE_ARGS) $$i.dbk
cp user/book1.htm user/book1.html
documentation/book1.html: documentation/documentation.dbk
rm -f documentation/*.htm*
export i=documentation; cd $$i; $(JADE) $(JADE_ARGS) $$i.dbk
cp documentation/book1.htm documentation/book1.html
development/book1.html: development/development.dbk
rm -f development/*.htm*
export i=development; cd $$i; $(JADE) $(JADE_ARGS) $$i.dbk
cp development/book1.htm development/book1.html
validate::
for i in $(SECTIONS); do $(SGML_VALIDATE) $$i/$$i.dbk; done
# install the stuff on the remote server using ssh. The bryce->bdenney
# stuff is just because Bryce's local username and sourceforge
# username don't match. If your usernames match then the "whoami"
# will work ok.
webinst: #all
# fix <TITLE> tags in all html files
./fixtitles.pl `find . -name '*.htm'`
./fixtitles.pl `find . -name '*.html'`
# fix permissions locally so that tar will install things right
chmod 664 `find $(INSTALL_LIST) -type f -print`
chmod 775 `find $(INSTALL_LIST) -type d -print`
# copy to remote
@echo Installing documentation on $(REMOTE_PATH)
case "`whoami`" in \
bryce) sfuser=bdenney;; \
daemian) sfuser=vasudeva;; \
*) sfuser=`whoami`;; \
esac; \
tar cf - $(INSTALL_LIST) | \
$(SSH) $$sfuser@$(REMOTE_HOST) "cd $(REMOTE_PATH) && umask 002 && tar xvf -"
clean:
#remove generated files
for S in $(SECTIONS); do \
rm -f $$S/*.htm* $$S/*.ps $$S/*.pdf $$S/*.out $$S/*.rtf $$S/*.tex $$S/*.fot; \
done

15
simulators/bochs/doc/docbook/README Normal file
View File

@ -0,0 +1,15 @@
This is the base directory for the DocBook documents for the Bochs project.
It has been broken down into the following directories:
user - The Bochs User Guide - describes how to setup and use Bochs
development - The Bochs Development Guide - contains development information and
how to contribute to the Bochs project
documentation - The Bochs Documentation Guide - contains information on how to
contribute to the documentation of the the Bochs project
images - pictures that may be reused in any of the three books. They can
be referenced using "../images/FILENAME".
include - files to be included from other docbook files

2551
simulators/bochs/doc/docbook/development/development.dbk Normal file
View File

File diff suppressed because it is too large Load Diff

506
simulators/bochs/doc/docbook/documentation/documentation.dbk Normal file
View File

@ -0,0 +1,506 @@
<!--
================================================================
doc/docbook/documentation/documentation.dbk
$Id$
This is the top level file for the Bochs Documentation Manual.
================================================================
-->
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!-- include definitions that are common to all bochs documentation -->
<!ENTITY % bochsdefs SYSTEM "../include/defs.sgm">
%bochsdefs;
]>
<book>
<bookinfo>
<title>Bochs Documentation Manual</title>
<authorgroup>
<author><firstname>Bryce</firstname><surname>Denney</surname></author>
<author><firstname>Michael</firstname><surname>Calabrese</surname></author>
</authorgroup>
</bookinfo>
<chapter id="layout"><title>Layout of Bochs Documentation</title>
<para>
The Bochs documentation is divided into three major divisions:
<itemizedlist>
<listitem>
<para>
The User's Guide introduces the Bochs Emulator, and covers installation and use.
</para>
</listitem>
<listitem>
<para>
Developer's Guide: Describes the internals of the Bochs Emulator for developers.
</para>
</listitem>
<listitem>
<para>
Documentation Guide: Describes how the documentation is organized, and how to render it, and how to add to it. This section is in the documentation guide.
</para>
</listitem>
</itemizedlist>
</para>
<para>
In docbook terminology, each of the three divisions is a book. Inside each
book are a series of chapters. A chapter may be divided into sections, and
each section is divided into more sections. Eventually we will add fancy
things like a table of contents, index, and glossary, when we learn how.
</para>
</chapter>
<chapter id="basics"><title>Docbook Basics</title>
<para>
Some of the most commonly used docbook patterns are described here
for quick reference. For all the details (sometimes more than you
wanted), try &docbookTDG; by Norman Walsh and Leonard Muellner, which O'Reilly
&amp; Associates has generously placed on their web site. In this section,
many of the SGML tags are linked to the page of Walsh's book that describes
that tag in detail.
</para>
<section><title>Small Tutorial</title>
<para>
Docbook files are text files containing SGML. If you have ever looked
at HTML, then a docbook file will look familiar. Not the same, but familiar.
The easiest way of getting familiar with the docbook format is by looking at
examples such as the Bochs documentation itself. When you compare the source
code to the rendered documentation on the web site, it will be pretty obvious
what all the codes are doing. HTML is very forgiving about breaking the syntax
rules, such as not putting &lt;/h1&gt; at then end of an &lt;h1&gt; section.
SGML is picky; if you forget that kind of thing in SGML, it will insist that
you fix it.
</para>
<para>
Every paragraph must begin with the &lt;para&gt; tag and end with the
corresponding end tag, &lt;/para&gt;.
<programlisting>
&lt;<ulink url="http://www.docbook.org/tdg/en/html/para.html">para</ulink>&gt;
This is a paragraph.
&lt;/para&gt;
</programlisting>
</para>
<para>
A chapter looks like this:
<programlisting>
&lt;<ulink url="http://www.docbook.org/tdg/en/html/chapter.html">chapter</ulink>&gt;
&lt;title&gt;<replaceable>title of the chapter</replaceable>&lt;/title&gt;
<replaceable>text of the chapter</replaceable>
&lt;/chapter&gt;
</programlisting>
The text of the chapter must contain at least one complete &lt;para&gt; tag,
and it can include &lt;section&gt;s.
</para>
<para>
A section looks like this:
<programlisting>
&lt;<ulink url="http://www.docbook.org/tdg/en/html/section.html">section</ulink>&gt;
&lt;title&gt;<replaceable>title of the section</replaceable>&lt;/title&gt;
<replaceable>text of the section</replaceable>
&lt;/section&gt;
</programlisting>
The text of the section must contain at least one complete &lt;para&gt; tag,
and it can include other &lt;section&gt;s.
</para>
<para>
To make a link to any URL, use the syntax:
<programlisting>
&lt;<ulink url="http://www.docbook.org/tdg/en/html/ulink.html">ulink</ulink> url="<replaceable>URL</replaceable>"&gt;<replaceable>text of the hyperlink</replaceable>&lt;/ulink&gt;
</programlisting>
However, if you like to link to another target inside the same document,
for example to a section, use something like that:
<programlisting>
&lt;section id="<replaceable>unique identifier</replaceable>"&gt;
<replaceable>All stuff that is needed here...</replaceable>
&lt;/section&gt;
<replaceable>...</replaceable>
&lt;<ulink url="http://www.docbook.org/tdg/en/html/link.html">link</ulink> linkend="<replaceable>unique identifier to link to</replaceable>"&gt;<replaceable>text of hyperlink</replaceable>&lt;/link&gt;
</programlisting>
</para>
<para>
To include a picture in the text, use the &lt;graphic&gt; tag. In SGML, this
graphic tag has no closing tag.
<programlisting>
&lt;<ulink url="http://www.docbook.org/tdg/en/html/graphic.html">graphic</ulink> format="<replaceable>fmt</replaceable>" fileref="<replaceable>filename</replaceable>"&gt;
</programlisting>
The <replaceable>fmt</replaceable> can be one of many formats including GIF,
JPG, PNG, PS, and EPS. The filename should be on the local disk. If there is
a pathname, it should be relative to the source file or it won't be found on
anyone's system other than yours.
</para>
<para>
There are over 300 tags defined in the latest version of docbook, so
we won't try to list them all here. Once you get the idea, you can
either find examples in the rest of the documentation that do what you
need, or look at Walsh and Muellner's
<ulink url="http://www.docbook.org/tdg/en/html/docbook.html">DocBook: The Definitive Guide</ulink>
for more details.
</para>
</section> <!-- end of Docbook Basics:Small Tutorial section -->
<section id="references"><title>References and Other Tutorials</title>
<para>
Docbook was created more than 10 years ago, but since 1999, Docbook has been
under the guidance of the DocBook Technical Committee at OASIS. The
<ulink url="http://www.oasis-open.org/committees/docbook">OASIS website</ulink>
distributes the official DocBook DTDs, and has pages on Docbook history,
samples, tools, and runs a few docbook mailing lists.
</para>
<para>
Since the Linux Documentation Project uses docbook, they have written some
good tutorial material. In particular the <ulink url="http://www.linuxdoc.org/LDP/LDP-Author-Guide/index.html">LDP Author Guide</ulink>, by Jorge Godoy
is very good.
</para>
<para>
O'Reilly &amp; Associates publishes a book called <ulink
url="http://www.docbook.org/tdg/en/html/docbook.html">DocBook: The Definitive
Guide</ulink> by Norman Walsh and Leonard Muellner. You can buy it or read it
online. Norman Walsh knows what he's talking about, since he is the chair of
the DocBook Technical Committee. This is good for reference, since it has a
complete list of tags and their grammar.
</para>
<para>
<ulink url="http://www.ibiblio.org/godoy/sgml/docbook/howto/index.html">DocBook
HOWTO, also by Jorge Godoy</ulink>
</para>
<para>
An article on lwn.net called <ulink
url="http://lwn.net/2000/features/DocBook">Exploring SGML Docbook</ulink>
focuses mostly on installation of tools from scratch: openjade, Norman Walsh's
DSSSL stylesheets, and jade2tex. If you can get the tools from RPMs or
whatever package your OS uses, use that instead.
</para>
</section> <!-- end of Docbook Basics:References and Other Tutorials -->
</chapter>
<chapter id="conventions"><title>Conventions</title>
<para>
Put a &amp;FIXME; near things that need to be fixed up. A &amp;FIXME; causes
the under construction symbol to appear, like this &FIXME;.
</para>
<para>
A &amp;NEEDHELP; indicates, that you need someone's help in order to document
something, you don't know for sure. This is mostly the case if you need inside
information from a developer. The symbol looks like this: &NEEDHELP;.
</para>
<para>
Don't get confused because &amp;FIXME; looks the same as &amp;NEEDHELP; -
this is just for the moment. When you like to use one of them, think of what
it should mean, instead of how it looks like: Take &amp;FIXME; if you have
great ideas of what to document, but have no time or no knowledge about it, or
just noticed something wrong or outdated. &amp;NEEDHELP; instead should be used
to request help on something (see above).
</para>
<para>
This is just a first try to clearify the difference between
&amp;NEEDHELP; and &amp;FIXME;.
</para>
<para>
To maintain a consistent spelling, some "problem words" are mentioned here,
along with a hint on how to spell them.
<table>
<title>list of problem words</title>
<tgroup cols="2">
<tbody>
<row>
<entry>Bochs</entry>
<entry>Bochs is written with a leading capital letter.</entry>
</row>
<row>
<entry><filename>bochsrc</filename></entry>
<entry>
This is what the Bochs configuration file should be refered as. It is a good
compromise between what is common on Unix and what is possible on Windows
(file names starting with a dot aren't easy to create). Remember to use
&lt;<ulink url="http://www.docbook.org/tdg/en/html/filename.html">filename</ulink>&gt;bochsrc&lt;/filename&gt;.
</entry>
</row>
<row>
<entry>CD-ROM</entry>
<entry>This abbreviation is written in all capital letters, with a hyphen in between.</entry>
</row>
<row>
<entry>Unix</entry>
<entry>
Unix is written using a leading capital letter, followed by all lower-case letters.
See the <ulink url="http://en.wikipedia.org/wiki/Unix#Branding">Unix entry in Wikipedia</ulink>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<para>
&FIXME; SGML docbook...lower case elements...indentation...remarks...master document/include files
</para>
</chapter>
<chapter id="reading-writing"><title>Reading and Writing</title>
<para>
The DocBook source code -- user.dbk, for example -- is a plain text file that
can be directly edited and saved with any text editor such as emacs or vi.
</para>
<tip>
<para>
If you just want to read the documentation, you should not
need to read and understand this section, and render the docs yourself. The
&bochswebsite; has all this information in readable form already.
</para>
</tip>
<para>
To render DocBook source code into the nice readable form the end-user will
require, several tools are needed. These tools allow the .dbk file to be
rendered into such formats as HTML, PDF, and PostScript. This section
describes the tools you need and the steps you take to render the Bochs
documentation.
</para>
<tip>
<para>
The rendering process is one-way. That is, the DocBook source files will be
downloaded from CVS, edited, and uploaded to CVS as .dbk files. Along the
way, it will probably be necessary to render them into HTML, but only to
check one's work or to post them as part of a web page. (I hope I'm not the
only person to spend nine minutes trying to figure out how to 'compile' HTML
into DocBook format.)
</para>
</tip>
<sect1>
<title>Jade and DSSSL</title>
<para>
Here is what the Linux Documentation Project says about jade:
<blockquote>
<attribution>
LDP author's guide
</attribution>
<para>
Jade is the front-end processor for SGML and XML. It uses the DSSSL and
DocBook DTD to perform the verification and rendering from SGML and XML into
the target format.
</para>
</blockquote>
</para>
<para>
What does all this mean?
For purposes of Bochs documentation, jade reads the docbook source file and
writes out a HTML/PDF/PS file. Bochs documentation is in SGML format, though
apparantly jade can handle XML Docbooks as well. DSSSL stands for
<quote>Document Style Semantics and Specification Language</quote>, and it
tells jade how to translate the docbook tags into the target format. DSSSL
files are written in the Scheme programming language, which is a variant of
LISP. Learn more about DSSSL at <ulink
url="http://www.jclark.com/dsssl">Jim Clark's DSSSL page</ulink>.
The DocBook DTD is the formal description of what elements and attributes can
be used in a docbook.
</para>
<sect2>
<title>Installation</title>
<para>
The easiest way to get jade working in Linux is to install packages. The
recent RedHat, Suse, and Mandrake Linux distributions all include
openjade and SGML tools. If you can get the right packages installed,
you may save yourself a few hours of compiling and configuring from scratch.
For plex86, which also uses docbook, Kevin Lawton listed the packages that
he installed on Mandrake to get jade working:
<programlisting>
jadetex-3.5-2mdk
openjade-1.3-10mdk
docbook-dtd31-sgml-1.0-3mdk
docbook-utils-0.6-1mdk
docbook-style-dsssl-1.62-4mdk
docbook-dtd412-xml-1.0-3mdk
sgml-common-0.2-4mdk
xml-common-0.1-3mdk
</programlisting>
Under Debian, the following packages seem to be a bare minimum to install
DocBook and get it to render Bochs documentation into reader-friendly formats:
<programlisting>
jade
docbook
docbook-dsssl
</programlisting>
It's worth mentioning that, at the time of this writing, at least some of
the above-mentioned packages were in the testing or unstable branches of
Debian.
</para>
<para>
Under FreeBSD, just install the following ports:
<programlisting>
textproc/jade
textproc/dsssl-docbook-modular
textproc/docbook-410
</programlisting>
&NEEDHELP; The generated HTML output doesn't look exactly the same as the Bochs
documentation on the web, so it seems as if some kind of configuration is still
needed.
</para>
<para>
Hopefully, the required packages on other Linux distributions have
similar names. If you have jade working, please tell a documentation
writer the package names that you used so that we can include it in the docs.
&NEEDHELP;
</para>
<para>
If you cannot get jade to work using packages, you need to find and install
three things: the DocBook DTD version 4.1 from &OASIS;, the program
<ulink url="http://www.jclark.com/jade/">jade</ulink>
(or <ulink url="http://openjade.sourceforge.net/">openjade</ulink>), and the
<ulink url="http://sourceforge.net/projects/docbook/">Docbook DSSSL
stylesheets</ulink> for the formats that you want to render to. The whole
process is described in &docbookTDG; in Appendix III section A. If you want
to render to PostScript or Adobe PDF, you also need to install TeX and
and some associated tools. It is a nontrivial process.
</para>
<tip>
<para>
Just use the packages.
</para>
</tip>
<para>
For now, building the Bochs documentation also depends on some scripts called
docbook2html, docbook2pdf, and docbook2ps. These come from the docbook-tools
project at <ulink url="http://sources.redhat.com/docbook-tools">http://sources.redhat.com/docbook-tools</ulink>.
</para>
</sect2>
<sect2>
<title>Using jade with docbook2x scripts</title>
<para>
Check to see if you have the docbook2ps, docbook2pdf, and docbook2html
scripts. If so, you can probably use the Bochs Makefile. Just do
<programlisting>
cd $BOCHS/doc/docbook
make
</programlisting>
It should render three docbook books, one in user, one in development, and one
in and documentation. If there are no errors, look for the user guide
in <filename>$BOCHS/doc/docbook/user/user.pdf</filename>,
<filename>$BOCHS/doc/docbook/users/user.ps</filename>, and
<filename>$BOCHS/doc/docbook/users/book1.html</filename>. The HTML is broken
into lots of little chunks that link to each other, but book1.html is the first
one.
</para>
</sect2>
<sect2>
<title>Using jade directly</title>
<para>
If you don't have docbook2<replaceable>format</replaceable> scripts, you
can also run jade manually. The command is long, so you may want to make
your own script or edit your copy of the makefile. These commands assume that
you installed Norman Walsh's DSSSL stylesheets in <varname>$DSSSL</varname>.
To render the user's guide into HTML, type:
<programlisting>
cd $BOCHS/doc/docbook/user
jade -t sgml -d <varname>$DSSSL</varname>/html/docbook.dsl user.dbk
</programlisting>
Or, if you want to render the developer's guide into TeX format,
<programlisting>
cd $BOCHS/doc/docbook/developer
jade -t tex -d <varname>$DSSSL</varname>/print/docbook.dsl developer.dbk
</programlisting>
Or, if you want to render the documentation guide into Rich Text Format,
<programlisting>
cd $BOCHS/doc/docbook/documentation
jade -t rtf -d <varname>$DSSSL</varname>/print/docbook.dsl documentation.dbk
</programlisting>
I believe that the HTML stylesheet must have "-t sgml" but the print
stylesheet in the second example can have "-t rtf" for Rich Text Format,
"-t tex" for TeX, or "-t mif" for MIF.
</para>
<para>
Bochs has the convention of calling the docbook files
<replaceable>name</replaceable>.dbk, but any file name would work. Some
other people call them <replaceable>NAME</replaceable>.sgm for SGML.
</para>
</sect2>
</sect1>
<sect1 id="nsgmls"> <title>Nsgmls</title>
<para>
The Bochs documentation is written in SGML docbook style, so any tool which can
check SGML syntax can be used to check the docbook. The DTD (data type
description) for docbook tells exactly which elements can be used and where.
It says which attributes are required and which are optional, and how elements
should be nested. The term "validate" has a specific meaning in SGML. When
you validate a SGML document, it means that you read the DTD and then check
that the document conforms to all the rules of the DTD.
</para>
<para>
A program called nsgmls, written by James Clark <email>jjc@jclark.com</email>,
can validate an SGML document such as our docbook. Although nsgmls can do many
other things, this command will validate the docbook against the DTD which
defines the syntax:
<cmdsynopsis>
<command>nsgmls</command>
<arg choice="plain">-s</arg>
<arg choice="plain"><replaceable>filename</replaceable></arg>
</cmdsynopsis>
</para>
<para>
Nsgmls is part of SP, a "free object-oriented toolkit for SGML parsing and
entity management" by James Clark <email>jjc@jclark.com</email>. SP can be
found at
<ulink url="http://www.jclark.com/sp">http://www.jclark.com/sp</ulink>.
There is a complete man page for nsgmls
<ulink url="http://www.jclark.com/sp/nsgmls.htm">here</ulink>.
</para>
</sect1>
</chapter> <!-- end Rendering chapter -->
</book>

54
simulators/bochs/doc/docbook/fixtitles.pl Executable file
View File

@ -0,0 +1,54 @@
#!/bin/sh
exec perl -x $0 $*; echo "Could not exec perl!"; exit 1
# The line above allows perl to be anywhere, as long as it's in your
# PATH environment variable.
#!perl
#
# fix-titles.pl
# $Id$
#
# The HTML stylesheet likes to print html has the ends of tags on a different
# line, like this:
# <HTML
# ><HEAD
# ><TITLE
# >FreeBSD</TITLE
# >
#
# Glimpse, which is indexing our website, finds this very confusing and
# it cannot pick out the title from this mess. This script takes a list
# of HTML files on the command line and attempts to make the <TITLE> tag
# look more normal so that glimpse can understand it.
#
# WARNING: This is a hack. It's made to work on docbook generated html, but
# may do strange things on anything else.
use strict;
foreach my $file (@ARGV) {
print "Fixing $file\n";
rename $file, "$file.orig";
open (IN, "$file.orig") || die "open $file.orig";
open (OUT, ">$file") || die "open $file for writing";
while (<IN>) {
if (/^<HTML$/) {
print OUT "<HTML>\n";
} elsif (/^><HEAD$/) {
print OUT "<HEAD>\n";
} elsif (/^><TITLE$/) {
print OUT "<TITLE>";
} elsif (/^>(.*)<\/TITLE$/) {
print OUT "$1</TITLE>\n";
# next line has one extra >, so read it and remove it.
$_ = <IN>;
s/^>//;
print OUT;
} else {
print OUT;
}
}
close IN;
close OUT;
unlink "$file.orig";
}

BIN
simulators/bochs/doc/docbook/images/dlxlinux-in-linux.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 8.3 KiB

BIN
simulators/bochs/doc/docbook/images/headerbar.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.2 KiB

BIN
simulators/bochs/doc/docbook/images/undercon.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 383 B

31
simulators/bochs/doc/docbook/include/defs.sgm Normal file
View File

@ -0,0 +1,31 @@
<!--
================================================================
doc/docbook/include/defs.sgm
$Id$
This file is included by all Bochs docbook files, so that the
definitions can be used anywhere in the documentation.
================================================================
-->
<!--
Editing marks. FIXME is just a reminder for somebody to come back and
work on the section. NEEDHELP means that the author doesn't have enough
information to finish, and would like someone else to assist.
Presently, each one just shows an under construction icon. We might
want some editing marks that don't show anything, or only show up in
draft mode.
-->
<!ENTITY FIXME '<inlinegraphic format="PNG" fileref="../images/undercon.png">'>
<!ENTITY NEEDHELP '<inlinegraphic format="PNG" fileref="../images/undercon.png">'>
<!ENTITY bochswebsite '<ulink url="http://bochs.sourceforge.net">Bochs web site</ulink>'>
<!ENTITY bochs-sf-net '<ulink url="http://bochs.sourceforge.net">bochs.sourceforge.net</ulink>'>
<!ENTITY devlist '<link linkend="bochs-developers">bochs-developers mailing list</link>'>
<!ENTITY bochsdir '<varname>$BOCHS</varname>'>
<!ENTITY Makefile '<filename>Makefile</filename>'>
<!-- these are probably only useful for the documentation guide -->
<!ENTITY docbookTDG '<ulink url="http://www.docbook.org/tdg/en/html/docbook.html">DocBook: The Definitive Guide</ulink>'>
<!ENTITY OASIS '<ulink url="http://www.oasis-open.org/">OASIS</ulink>'>

42
simulators/bochs/doc/docbook/index.html Normal file
View File

@ -0,0 +1,42 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<TITLE>Bochs Documentation</TITLE>
<style TYPE="text/CSS">
<!--
A:link {color: blue; text-decoration: none}
A:visited {color: blue; text-decoration: none}
A:active {color: blue; text-decoration: none}
A:hover {color: blue; text-decoration: underline}
INPUT {border:thin solid black; font-size: 7pt; font-family:Verdana, Arial Helvetica}
.sidebar {font-family:Verdana, Arial, Helvetica; color: #000000}
A.sidebar:link {color: #000000; font-style: normal; text-decoration: none}
A.sidebar:visited {color: #000000; font-style: normal; text-decoration: none}
A.sidebar:active {color: #000000; font-style: normal; text-decoration: none}
A.sidebar:hover {color: blue; text-decoration: underline}
-->
</style>
</HEAD>
<BODY BGCOLOR="#FFFFFF" VLINK="#000000" ALINK="#000000" LINK="#000000">
<h1>Bochs Documentation</h1>
<P>
The documentation is divided into three parts:
<ul>
<li><a href="user/index.html">User Guide</a></li>
<li><a href="development/index.html">Development Guide</a></li>
<li><a href="documentation/index.html">Documentation Guide</a></li>
</ul>
<!--
Docbook files can be easily translated into PDF and PostScript.
However Bryce doesn't have his docbook software installed right, so
he can't produce PDF or PS at present. When he can make PDF and PS
files, we may want to revert to version 1.3 which had a link to each
book in each format.
-->

426
simulators/bochs/doc/docbook/misc.txt Normal file
View File

@ -0,0 +1,426 @@
$Id$
This is a temporary place to paste in stuff that should go into the docs one
day. When it is transferred into docbook, let's remove it from misc.txt.
--------------------------------------------------------------------------
--------------------------------------------------------------------------
--------------------------------------------------------------------------
--------------------------------------------------------------------------
Date: Thu, 15 Nov 2001 13:31:34 -0800
From: David Christy <davidc@davidc.biz>
To: bryce@tlw.com
Subject: usefull info for mounting
I didn't see this in the doc's so I thought you might like a
short description of how to mount a disk image file into
loopback filesystem for maintenance purposes.
--------------------------------------------
1) First run
fdisk -l <image_name>
... and it should print out a partition table (with a few
complaints requesting the drive geometry, and I don't know
if older versions require a block device) In fact fdisk will
even work to modify partitions in an image, but you must
specify the drive geometry that's in the bocsrc first.
2) Whatever it says the starting partition is, subtract 1
and multiply by 512
3) Type
mount -o loop,offset=<insert number here> <image_name>
/mount/dir
or if it's just a floppy image, just
mount -o loop floppy.img /mount/dir
---------------------------------------------------
I would recommend putting -o ro for read only access if
bochs is in use. For unusual filesystems you may need to
add a -t <fstype> flag to the mount command to specify the
filesystem type.
see man mount, losetup, and fdisk for more info
BOCHS Rocks!!!
-------------macintosh.txt-----------------
BBD Mon Nov 25 08:23:28 EST 2002
This file has been in our main directory for years and years, and has not
been updated since nobody has tried to compile for MacOS pre-10 in a long
time. I didn't want to leave it sitting there since it is so incredibly
obsolete. I think it would be good to put it into the documentation
with proper warnings about the fact that it hasn't been updated in 4 years
and may need significant hacking to make it work again.
------------------
Changes by Bryce Denney 4/5/2001:
I moved the contents of macutils.h into osdep.h, and macutils.c
into osdep.cc. There are functions missing on other platforms too,
so I wanted to bring them all into the same place.
The original macintosh.txt follows.
STATUS OF THE MAC PORT:
-----------------------
23 Dec 1998
Contents:
Status
How to Set up MacBochs
Problems
Other Issues
New Files
Changed Files
Status
------
This is an experimental Macintosh port of Bochs. The Mac port compiles fine
under CodeWarrior Pro R1 (CW12) and is capable of booting Win95 in command-
line mode and running DOS programs. A CodeWarrior project ("Bochs.proj") is
included (you may need to edit the type and creator information with ResEdit
in order for CodeWarrior to recognise it as a project file).
NOTE: MacBochs is very much a "work in progress", and much of the code is
incomplete. This preliminary version is being made available mainly to
interested developers who may want to contribute to the development of
MacBochs by contributing some code or testing it on their own Macs.
If anyone can test with some "clean" Windows installer disks, it would be
useful. I've been testing MacBochs with my SoftWindows HD image and disk
images derived from it, and I'm not sure if the various SoftWindows-specific
drivers are interfering.
23 Dec 98 - updated MacBochs to bochs-981222. The new version seems
noticeably faster. Finished implementing the Bochs headerbar. Added support
for ejecting floppy disks from within Bochs (click the Drive A: icon on the
headerbar or press Cmd-E).
17 Dec 98 - added real floppy disk support. Also optimized the graphics
screen drawing a bit more. Keyboard support still broken and in need of a
major overhaul. Does anyone have experience with KCHR resources and
KeyTranslate()?
How to Set up MacBochs
----------------------
This is a very brief, step-by-step guide on setting up MacBochs. More
detailed documentation will be available later.
- Step 1. Compile the version of Bochs you want to use (PPC, 68k or FAT) or
obtain a pre-compiled binary. There is a CodeWarrior project included with
the source distribution.
- Step 2. Create a hard disk image.
Bochs ALWAYS needs a hard disk image available to it, otherwise it won't
boot. To create a hard disk image on the Mac, you need to use a recent
version of DiskCopy.
First, create an untitled, empty folder anywhere on your Mac hard disk. Then,
launch DiskCopy and choose to create a folder image of that folder.
DO NOT ENTER THE DISK SIZE IN MEGABYTES. In the file "install.html" in the
"docs-html" folder you will find a table of disk sizes and geometries. Make a
note of the number of total SECTORS required for your desired hard disk size,
as well as the cylinders, heads and sectors per track (spt).
In DiskCopy, you need to choose "Custom..." from the menu of image sizes, and
choose to enter the size in "blocks" (on the Mac, a block is pretty much the
same as a sector). Then enter the number of total sectors you need.
Make sure the image is "Read/Write", not "Read Only", and make sure you have
entered the correct cyl=, heads= and spt= settings in your bochsrc file. Your
image file should now be accessible to Bochs.
You'll eventually need to use a utility like "fdisk" to make the image
readable.
- Step 3. Obtain a bootable PC floppy or floppy image.
You'll need to install an operating system in order to do anything useful
with Bochs. If you have installer floppies for a PC operating system (eg.
Windows or MS-DOS) you can use those. Otherwise you can download disk images
for FreeDOS or one of the many variants of Linux.
MacBochs now supports real PC floppy disks. To use the Mac floppy drive
instead of a disk image, use the special filename "[fd:]" in the appropriate
line of your bochsrc.
- Step 4. Set up your bochsrc file.
You set up your Bochs preferences by editing the "bochsrc" file. You'll need
to set up your bochsrc to work with your floppy and hard disk images, as well
as telling Bochs how many megs of PC RAM you want.
Problems
--------
There are some so far unresolved problems in the "macintosh.cc" GUI file:
- Keyboard support is VERY rudimentary; ie. it only supports alphanumerics
and a couple of special keys like Enter. The keyboard-related code is full of
holes and I'm going to completely rehash it.
- Mouse support hasn't been tested, but probably isn't fully working either.
Other Issues
------------
- The Mac port uses a ready-made config file (configmac.h), like the Win32
port used to. Macs are pretty homogeneous, so the settings should be
appropriate for most machines.
- The Mac port has an extra source file: "macutils.c" (with header file
"macutils.h"), which is used for Mac floppy drive support, among other
things.
- Like the Win32 port, the Mac port expects the "bochsrc" file to be in the
same directory as the Bochs application.
- Be sure to use Mac pathname conventions when editing the bochsrc file (ie
':' instead of '/' or '\').
New files
---------
The following are new, Mac-specific files:
gui/macintosh.cc
configmac.h
macutils.h
macutils.c
Bochs.proj
Changed Files
-------------
The following files from the main bochs distribution have been modified to
compile properly on the Mac:
bochs.h
main.cc
memory/memory.cc
memory/misc_mem.cc
iodev/floppy.cc
iodev/harddrv.cc
The changes are just conditional compilations which won't affect other
platforms (search for "#ifdef macintosh" and "#ifndef macintosh" if you want
to see what the changes are). These changes will need to be integrated into
the main distribution if the MacOS port is going to go ahead seriously.
-- David Batterham <drbatter@socs.uts.edu.au> or <drbatter@yahoo.com>
--------------------win32.txt----------------------
BBD Mon Nov 25 08:27:24 EST 2002
The win32 build instructions are out of date too. The --with-win32-vcpp
has been deprecated since at least March 2002. More current instructions
are already in the docs, so this info may not be of much use.
Building Bochs for Win32
------------------------
This has only been tested with MS Visual C++ 6.0.
The normal build process on a unix system is to run configure to build all the
makefiles and config.h, and then run make to compile Bochs. Configure takes a
large number of command line arguments, for example to disable floating point
or to enable sound blaster emulation. Configure works beautifully on unix
systems to help make the code portable, however it cannot run on Windows.
(Maybe, if you have cygwin.) Therefore, you need to either 1) run configure
on a unix box and copy the makefiles and config.h, or 2) download the
makefiles which are distributed in a separate ZIP file.
If you want to run configure yourself, consider using the shell script
".conf.win32-vcpp" since it has been tested. Look at it to make sure
the options make sense for you. You can always run configure by hand too,
just be sure to include the option --with-win32-vcpp so that it creates
makefiles for win32. Copy config.h, Makefile, and the Makefiles in all
subdirectories over to your windows box into the same directory as the Bochs
source.
If you download the makefiles in a ZIP, just extract them into the
same directory as the Bochs source. The config.h and top level Makefile
should end up in the same directory as Bochs.h.
Once the makefiles are installed, building Bochs is easy. Start up an MSDOS
window, run the .BAT file that sets up the environment variables
(C:\vc98\bin\vcvars32.bat on my system), and then run NMAKE in the Bochs
source directory. You will get lots of compile warnings, but hopefully no
fatal errors! At the end, you should see Bochs.exe in the source directory.
<!-- *************************************************************** -->
Wed Dec 11 13:56:20 EST 2002
this text came from build/linux/DOC-linux.html.
Originally it was an intro to Bochs for Linux users. I converted it all to
docbook. I moved most of the info from DOC-linux.html into different
sections of the user guide, and the rest I put here in misc.txt. Maybe these
paragraphs will be useful in some kind of introduction to something, or maybe
not.
<section><title>Quick Start for Linux users</title>
<!--much text removed, put into user guide -->
<para>
This file is an introduction to Bochs for Linux users. It assumes that you
have just installed a Bochs binary distribution, and now you want to see what
Bochs can do!
</para>
<section><title>How can I try out Bochs in 10 minutes or less?</title>
<para>
This RPM package includes a sample disk image containing DLX Linux, which you
can boot within Bochs. To start up DLX linux, just type "bochs-dlx" in an
xterm. The first time it runs, it creates a disk image in a directory
called <filename>$HOME/.bochsdlx</filename>. Then it creates a Bochs Display
window and prints some log messages into the xterm. The display window is the
most interesting, but if something goes wrong the log messages should give an
idea of what has happened.
</para>
<para>
Meanwhile, the Bochs display screen should look like a PC booting...and in
fact it is! Bochs begins simulating a PC from the time the power turns on.
You will see the VGA BIOS message, and it begins loading Linux from the disk
image. The disk image is just a big file that Bochs uses as if it were a
real hard drive. After a while, you see Linux boot messages and eventually a
login prompt. You are now running DLX Linux in a window!
</para>
<para>
Bochs simulates every instruction of an x86 CPU, so it is very memory- and
compute-intensive. The speed of your real CPU will make a big difference in
how fast the DLX Linux image boots. On a 1GHz Pentium, the sample Linux
image takes about 10 seconds to boot.
</para>
<para>
In this brief introduction you saw how Bochs can boot and run an x86 operating
system in a window. It doesn't have to be Linux, of course! Various people
have been able to install and run DOS, Windows 3.1, Windows 95/98/ME/NT/XP,
Linux, FreeBSD, NetBSD, OpenBSD, and probably others that we've never even
heard of. In fact Bochs is used by many operating system developers to test
out their software in a controlled environment without having to reboot their
development machine.
</para>
<para>
If you are learning about Bochs for the first time, you might want to
download a few other prebuilt disk images of other operating systems from the
Bochs website. They range from very small (1.44 meg floppy disk images) to
hundreds of megabytes. Most disk images on the web site come with a
working configuration file (often called bochsrc.txt) so they should work
without much effort. This will give you an idea of what Bochs can do,
and how it might be useful to you.
</para>
</section>
------------------------------------------
Windows 3.1 install hints
Date: Fri, 13 Dec 2002 09:56:48 -0700
From: Ben Lunt <fys@cybertrails.com>
To: bochs-devel <bochs-developers@lists.sourceforge.net>
I was playing with bochs a bit last night and successfully
got windows 3.1 installed on a c.img file and run with
almost no errors.
I first started with three original DOS 5.0 720k images,
FDISKed, FORMATed, and then install.
Then changed to seven 1_44m disks and installed Win16.
Each time either OS asked for a new disk, I simply
copied the expected image to a.img and continued.
------------------------------------------
WinNT4 guest network problems
From: Jeremy Wilkins <jeb at jeremywilkins.freeserve.co.uk>
To: bochs-developers@lists.sourceforge.net
Subject: [Bochs-developers] Odd network errors with NT4 Guest OS
I'm having trouble transferring files over the network to the guest OS
(NT4 SP1). If I'm using SMB then the it errors out early on with a
session cancelled. The file is 36Mb (SP6). I've tried with various file
sizes, 3Meg files work, 5 meg files do not.
I've also tried shuffling the files over http with similar problems,
small files are fine (can browse websites) but large files just error out.
The system is a 1Ghz Windows XP SP1 box with bochs 2.02, guest OS is
allocated 64Mb of RAM and running Windows NT4 SP1.
Any clues, anyone experiencing similar problems?
--
From: didier <dgautheron at magic.fr>
To: Jeremy Wilkins <jeb at jeremywilkins.freeserve.co.uk>
Cc: bochs-developers@lists.sourceforge.net
Subject: Re: [Bochs-developers] Odd network errors with NT4 Guest OS
Did you try with a big IPS? start the guest clock applet and try to get
a more or less accurate time, with 1 Ghz should be in the 50 000 000 range.
IIRC NT timeout and abort before it send the whole packet.
--
From: Jeremy Wilkins <jeb at jeremywilkins.freeserve.co.uk>
To: didier <dgautheron at magic.fr>, bochs-developers@lists.sourceforge.net
Subject: Re: [Bochs-developers] Odd network errors with NT4 Guest OS
Thanks, 60 000 000 seems to have done the trick (I can copy sp6 across
anyway). My original guess of 4000000 IPS was probably a bit low :)
thanks again
------------------------------------------
TAP under FreeBSD
Date: Fri, 14 Feb 2003 02:12:38 +0100
From: Ronald Klop <ronald at echteman.nl>
To: bochs-developers at lists.sourceforge.net
I've made eth_tap.cc working under FreeBSD 4.7, because the fbsd network driver
didn't work for me.
It's not a very clean patch, but the changes are minimal.
Some notes:
- I found that some of the includes aren't used at all (on FreeBSD).
- The socket which is created before /dev/tap0 is opened doesn't work, because
tap0 is created after opening the device.
- Maybe the eth_tap device can use a configure script like the eth_tuntap
device, because the device must be configured after opening.
- The padding of the ethernet frame with 2 bytes isn't needed in FreeBSD.
- I didn't do any work to check for this in configure, because I don't know how
configure works and don't have the time work it out now.
- the guest os must set (maybe this can be documented somewhere):
kldload if_tap (if tap is not compiled in the kernel)
ifconfig tap0 inet 10.0.1.1 netmask 255.255.255.0
sysctl net.inet.ip.forwarding=1
sysctl net.link.ether.inet.proxyall=1

164
simulators/bochs/doc/docbook/outline.txt Normal file
View File

@ -0,0 +1,164 @@
--- Bryce Denney <bryce@tlw.com> wrote:
> Hi Michael,
>
> I added some flesh to the skeleton. I tried to keep things in approximately
> the order that brand new user might need the information. It goes through
> the process of:
>
> 1. Is this thing worth looking at?
> 2. Ok, but will I be able to do X,Y,Z?
> 3. Fine, I'll download it. What should I download
> and how do you install?
> 4. Let's see something work soon, right now, or I'm
> going to erase the
> whole thing. (Dlxlinux)
> 5. Now how do you change the settings, try a
> different disk image, make a
> disk, etc. Who do I ask for help?
>
> If they get to #5, they are a bochs user. And
> eventually...
>
> 6. Hey, I added USB support to talk to my scanner,
> anybody want to try it?
>
>
Here's the outline that the docbooks are organized by, basically.
Title Pages
Contents
Bochs Users Guide
Introduction to Bochs
What is Bochs?
portable x86 emulator, etc.
Who uses Bochs?
run more than one operating system without rebooting
OS developers use Bochs to system software without endangering
their development machine or rebooting.
students use Bochs to learn about how PC hardware works
hardware designers use bochs to help test new hardware
Will it work for me?
platforms supported (brief list)
speed issues. if speed is top priority, maybe look elsewhere
Licensing
FAQ
Installation
How to get it
pointer to SF web site
most stable version: latest release. binaries and source available
latest version
by using CVS software
by downloading CVS snapshot
Installing a Binary
For Windows, unzip into some directory. Look for DOC-win32.html
for more instructions. Quick start: find dlxlinux/start.bat and
double click
For Unix, rpm -i bochs-<VERSION>.rpm.
Look for /usr/local/bochs/latest/DOC-linux.html, man pages for
bochs. Quick start: run bochs-dlx (in /usr/local/bin)
Compiling from source
Unix
Run configure to make the Makefiles
List of configure arguments
Option of using .conf.* scripts
What to report if configure fails: Tar up config.* and send to
bochs-testing@tlw.com
Make
What to try if make fails: turn off configure options,
look at SF bugs and patches section to see if it's a known
problem, try to fix it yourself, if using CVS version try
a release source file instead, fix it yourself
Make install, what it installs and where
/usr/local/bochs/$VERSION/*
/usr/local/bin/bochs (and bximage)
/usr/man/man1/bochs*.1 (and bximage.1)
make install_dlx option
How to build an RPM in Linux
Instructions for win32 VC++
Getting the makefiles
Download them from web site in a zip, install them on top
of the source directory
Run configure on a unix box, copy the Makefiles and config.h
to your windows machine
RUN CONFIGURE IN BOCHS! This would be awesome.
Cygwin?
Building it with NMAKE
Installation? Maybe download an existing windows binary package
and drop in your new binary. There is no make install, though
this may be added some day.
Instructions for cygwin?
I have no idea.
Setup
What does Bochs need?
bochsrc, BIOS, VGABIOS, VGA font, disk images.
table of bochsrc options and what they do
BIOS/VGABIOS, what do they do?
VGA font, how to install it
disk images
where to find one pre-made
make a blank one with bximage
grab one from a real hard disk
Using Bochs
Resources for users
bochs-developers mailing list, archive
testing status page: tells what has been tried and who got it working
SourceForge
look for bug reports
how to report problems, make feature requests
Common problems and what to do about them
What's a panic? How to report it to bug tracker, how to make
it non-fatal.
Mouse behavior, enabling and disabling
Keyboard mapping problems
[...]
Tips and Techniques
Mount disk image in loopback
Using two hard disks
[...]
Guest operating systems
Notes for different OSes
Linux
What disk images are available.
Installing from scratch.
What works
Known problems
OpenBSD
FreeBSD
FreeDOS
DOS
Windows *
[...]
Bochs Developers Guide
Resources for developers
All the resources for users
CVS
how to browse on web interface
anonymous CVS (read only)
write access CVS (must be officially a developer)
how to make a patch using CVS
SourceForge bug, feature, and patch trackers
About the code
cpu directory does this, iodev does that, gui does that
configure script, makefiles, header files
log functions: what is a panic, what is an error, etc.
objects that do all the work (cpu, mem)
timers
Debugger
compile with debugger support
get started in debugger
command reference
techniques
Coding
coding conventions
patches: how to make, where to submit, what
happens then?
life cycle of a CVS release
Documentation
Layout
Docbook Basics
Conventions
Rendering
Glossary
Index

8771
simulators/bochs/doc/docbook/user/user.dbk Normal file
View File

File diff suppressed because it is too large Load Diff

54
simulators/bochs/doc/man/bochs-dlx.1 Normal file
View File

@ -0,0 +1,54 @@
.\"Document Author: Timothy R. Butler - tbutler@uninetsolutions.com"
.TH bochs-dlx 1 "29 Dec 2005" "bochs-dlx" "The Bochs Project"
.\"SKIP_SECTION"
.SH NAME
bochs-dlx \- Runs DLX-Linux under the Bochs x86 Emulator
.\"SKIP_SECTION"
.SH USAGE
.B bochs-dlx
.LP
No command line arguments are accepted. If you require
adjustments to the normal runtime parameters, edit
/usr/local/share/bochs/dlxlinux/bochsrc.txt or run bochs(1)
directly.
.\"SKIP_SECTION"
.SH DESCRIPTION
.LP
Bochs-dlx
is a shell script that runs a sample 10Mbyte disk image
of DLX Linux inside Bochs. Bochs-dlx is simple by design
so that it is possible to try out Bochs without learning
how to configure it first.
.\"SKIP_SECTION"
.SH LICENSE
This program is distributed under the terms of the GNU
Lesser General Public License as published by the Free
Software Foundation. See the COPYING file located in
/usr/local/share/doc/bochs/ for details on the license and
the lack of warranty.
.\"SKIP_SECTION"
.SH AVAILABILITY
The latest version of this program can be found at:
http://bochs.sourceforge.net/getcurrent.html
.\"SKIP_SECTION"
.SH SEE ALSO
bochs(1), bochsrc(5), bximage(1), bxcommit(1)
.PP
.nf
The Bochs IA-32 Emulator site on the World Wide Web:
http://bochs.sourceforge.net
Online Bochs Documentation
http://bochs.sourceforge.net/doc/docbook
.fi
.\"SKIP_SECTION"
.SH BUGS
Please report all bugs to the bug tracker on our web
site. Just go to http://bochs.sourceforge.net, and click
"Bug Reports" on the sidebar under "Features."
.PP
Provide a detailed description of the bug, the version of
the program you are running, the operating system you are
running the program on and the operating system you
are running in the emulator.

96
simulators/bochs/doc/man/bochs.1 Normal file
View File

@ -0,0 +1,96 @@
.\"Document Author: Timothy R. Butler - tbutler@uninetsolutions.com"
.TH bochs 1 "29 Dec 2005" "bochs @version@" "The Bochs Project"
.\"SKIP_SECTION"
.SH NAME
bochs \- Portable x86 Emulator.
.\"SKIP_SECTION"
.SH SYNOPSIS
.B bochs
.RI \|[ bochs_options \|]
.RI \|[ bochsrc_options \|]
.\"SKIP_SECTION"
.SH DESCRIPTION
.LP
Bochs is a portable Intel Architecture 32 (x86) emulator
that runs on most popular operating systems. Inside the
emulator, it can run many operating systems including
Linux and Microsoft(R) Windows(R).
.\".\"DONT_SPLIT"
.SH OPTIONS
.LP
When you run bochs without one of the following options, it
will search for a configuration file called .bochsrc in
the current directory and your home directory and display
the start menu.
.TP
.BI \-q
With this option the start menu will be skipped after loading
the configuration file.
.TP
.BI \-f\ configfile
This option specifies the name of the configuration file.
.TP
.BI \-qf\ configfile
When you run bochs with this option, it will skip the start
menu and use the specified configuration file.
.TP
.BI \-n
With this option bochs doesn't load a configuration file.
In that case the setup for the emulation must be done with
bochsrc options on the command line or in the start menu.
.TP
.BI \-h,\ --help
Print a summary of the command line options for bochs and exit.
.LP
You can override the settings from the configuration file
with command line arguments, using the same syntax as the
bochsrc file. If you have any spaces in your command line
arguments, they should be enclosed in single quotes.
For information on Bochs command line and configuration
file arguments, see the man page
.B bochsrc(5).
Example:
bochs -q 'boot:a' 'floppya: 1_44=a.img, status=inserted'
.\"SKIP_SECTION"
.SH LICENSE
This program is distributed under the terms of the GNU
Lesser General Public License as published by the Free
Software Foundation. See the COPYING file located in
/usr/local/share/doc/bochs/ for details on the license and
the lack of warranty.
.\"SKIP_SECTION"
.SH AVAILABILITY
The latest version of this program can be found at:
http://bochs.sourceforge.net/getcurrent.html
.\"SKIP_SECTION"
.SH SEE ALSO
bochsrc(5), bochs-dlx(1), bximage(1), bxcommit(1)
.PP
.nf
The Bochs IA-32 Emulator site on the World Wide Web:
http://bochs.sourceforge.net
Online Bochs Documentation
http://bochs.sourceforge.net/doc/docbook
.fi
.\"SKIP_SECTION"
.SH AUTHORS
The Bochs emulator was created by Kevin Lawton
(kevin@mandrakesoft.com), and is currently maintained
by the members of the Bochs x86 Emulator Project. You
can see a current roster of members at:
http://bochs.sourceforge.net/getinvolved.html
.\"SKIP_SECTION"
.SH BUGS
Please report all bugs to the bug tracker on our web
site. Just go to http://bochs.sourceforge.net, and click
"Bug Reports" on the sidebar under "Feedback".
.PP
Provide a detailed description of the bug, the version of
the program you are running, the operating system you are
running the program on and the operating system you
are running in the emulator.

1032
simulators/bochs/doc/man/bochsrc.5 Normal file
View File

File diff suppressed because it is too large Load Diff

53
simulators/bochs/doc/man/bxcommit.1 Normal file
View File

@ -0,0 +1,53 @@
.\"Document Author: Christophe Bothamy - cbothamy@free.fr"
.TH bximage 1 "29 Dec 2005" "bximage" "The Bochs Project"
.\"SKIP_SECTION"
.SH NAME
bxcommit \- Interactive Tool to Commit Redologs into flat Disk Images for Bochs
.\"SKIP_SECTION"
.SH USAGE
.B bxcommit
.\"SKIP_SECTION"
.SH DESCRIPTION
.LP
Bxcommit is an easy to use console based tool for committing
redologs into flat
disk images, particularly for use with Bochs. It is
completely interactive, so no command line arguments are
needed to use bxcommit.
.\"SKIP_SECTION"
.SH LICENSE
This program is distributed under the terms of the GNU
Lesser General Public License as published by the Free
Software Foundation. See the COPYING file located in
/usr/local/share/doc/bochs/ for details on the license and
the lack of warranty.
.\"SKIP_SECTION"
.SH AVAILABILITY
The latest version of this program can be found at:
http://bochs.sourceforge.net/getcurrent.html
.\"SKIP_SECTION"
.SH SEE ALSO
bochs(1), bochsrc(5), bochs-dlx(1), bximage(1)
.PP
.nf
The Bochs IA-32 Emulator site on the World Wide Web:
http://bochs.sourceforge.net
Online Bochs Documentation
http://bochs.sourceforge.net/doc/docbook
.fi
.\"SKIP_SECTION"
.SH AUTHORS
Bximage was written by Christophe Bothamy,
based on Bochs bximage tool source code.
.\"SKIP_SECTION"
.SH BUGS
Please report all bugs to the bug tracker on our web
site. Just go to http://bochs.sourceforge.net, and click
"Bug Reports" on the sidebar under "Feedback."
.PP
Provide a detailed description of the bug, the version of
the program you are running, the operating system you are
running the program on and the operating system you
are running in the emulator.

91
simulators/bochs/doc/man/bximage.1 Normal file
View File

@ -0,0 +1,91 @@
.\"Document Author: Timothy R. Butler - tbutler@uninetsolutions.com"
.TH bximage 1 "29 Dec 2005" "bximage" "The Bochs Project"
.\"SKIP_SECTION"
.SH NAME
bximage \- Interactive Disk Image Creator for Bochs
.\"SKIP_SECTION"
.SH SYNOPSIS
.B bximage
.RI \|[ options \|]
.RI \|[ filename \|]
.\"SKIP_SECTION"
.SH DESCRIPTION
.LP
Bximage is an easy to use console based tool for creating
disk images, particularly for use with Bochs. It is
completely interactive if no command line arguments are
used. It can be switched to a non-interactive mode if all
required parameters are given in the command line.
.\".\"DONT_SPLIT"
.SH OPTIONS
.LP
When you run bximage without one of the following options,
it will appear in interactive mode and ask for all
required parameters to create an image.
.TP
.BI \-fd
Create a floppy image.
.TP
.BI \-hd
Create a hard disk image.
.TP
.BI \-mode=...
Image mode (for hard disks only - see the
.I bochsrc
sample for supported options).
.TP
.BI \-size=...
Image size in megabytes (e.g. 1.44 for floppy image, 10
for hard disk image).
.TP
.BI \-q
Quiet mode (don't prompt for user input). Without this
option bximage uses the command line parameters as
defaults for the interactive mode. If this option is
given and one of the required parameters is missing,
bximage will fall back to interactive mode.
.TP
.BI \--help
Print a summary of the command line options for
bximage and exit.
.LP
The
.I filename
parameter specifies the name of the image to be created.
.\"SKIP_SECTION"
.SH LICENSE
This program is distributed under the terms of the GNU
Lesser General Public License as published by the Free
Software Foundation. See the COPYING file located in
/usr/local/share/doc/bochs/ for details on the license and
the lack of warranty.
.\"SKIP_SECTION"
.SH AVAILABILITY
The latest version of this program can be found at:
http://bochs.sourceforge.net/getcurrent.html
.\"SKIP_SECTION"
.SH SEE ALSO
bochs(1), bochsrc(5), bochs-dlx(1), bxcommit(1)
.PP
.nf
The Bochs IA-32 Emulator site on the World Wide Web:
http://bochs.sourceforge.net
Online Bochs Documentation
http://bochs.sourceforge.net/doc/docbook
.fi
.\"SKIP_SECTION"
.SH AUTHORS
Bximage was written by Bryce Denney, based on several
similar tools from the bochs-developers list.
.\"SKIP_SECTION"
.SH BUGS
Please report all bugs to the bug tracker on our web
site. Just go to http://bochs.sourceforge.net, and click
"Bug Reports" on the sidebar under "Feedback."
.PP
Provide a detailed description of the bug, the version of
the program you are running, the operating system you are
running the program on and the operating system you
are running in the emulator.