/[gxemul]/trunk/doc/configfiles.html

This is repository of my old source code which isn't updated any more. Go to git.rot13.org for current projects!

Diff of /trunk/doc/configfiles.html

Parent Directory | Revision Log | View Patch Patch

-revision 4 by dpavlin,
Mon Oct  8 16:18:00 2007 UTC
+revision 32 by dpavlin,
Mon Oct  8 16:20:58 2007 UTC
 Line 1
- <html>
+ <html><head><title>Gavare's eXperimental Emulator:&nbsp;&nbsp;&nbsp;Configuration files</title>
- <head><title>GXemul documentation: Configuration files</title>
+ <meta name="robots" content="noarchive,nofollow,noindex"></head>
- </head>
  <body bgcolor="#f8f8f8" text="#000000" link="#4040f0" vlink="#404040" alink="#ff0000">
  <table border=0 width=100% bgcolor="#d0d0d0"><tr>
  <td width=100% align=center valign=center><table border=0 width=100%><tr>
  <td align="left" valign=center bgcolor="#d0efff"><font color="#6060e0" size="6">
- <b>GXemul documentation:</b></font>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+ <b>Gavare's eXperimental Emulator:</b></font><br>
  <font color="#000000" size="6"><b>Configuration files</b>
  </font></td></tr></table></td></tr></table><p>
- <!-- The first 10 lines are cut away by the homepage updating script.  -->
  <!--
- $Id: configfiles.html,v 1.6 2005/04/16 00:29:45 debug Exp $
+ $Id: configfiles.html,v 1.27 2006/09/07 11:44:42 debug Exp $
- Copyright (C) 2003-2005  Anders Gavare.  All rights reserved.
+ Copyright (C) 2003-2006  Anders Gavare.  All rights reserved.
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:
-Line 49 
 SUCH DAMAGE.
+Line 46 
 SUCH DAMAGE.
  <p>
  <ul>
+   <li><a href="#intro">Introduction</a>
    <li><a href="#config">Configuration file syntax</a>
    <li><a href="#minimal">A minimal example</a>
  </ul>
-Line 57 
 SUCH DAMAGE.
+Line 55 
 SUCH DAMAGE.
  <p><br>
+ <a name="intro"></a>
+ <h3>Introduction:</h3>
+ GXemul can be started by entering machine settings directly on the command
+ line, or by reading a configuration file (a "configuration script").
+ <p>Configuration files in GXemul are useful/necessary for three reasons:
+ <p><ol>
+   <li>It can be difficult to remember long command lines with
+         lots of options.
+   <li>Some settings cannot be fully controlled on the command line. They can
+         only be set using configuration files.
+   <li>Complex setups of multiple machines, or complex network setups,
+         are not supported on the command line.
+ </ol>
+ <p><br>
  <a name="config"></a>
  <h3>Configuration file syntax:</h3>
-Line 67 
 through an example is good enough:
+Line 90 
 through an example is good enough:
  <p>
  <table border="0"><tr><td width="40">&nbsp;</td><td>
  <pre>
- <font color="#2020cf">!!gxemul     <-- configuration files must start like this
+ <font color="#2020cf">!  This is an example configuration file for GXemul.
- !
- !  This is an example configuration file for GXemul.
  !  Anything following an exclamation mark (and also the exclamation
  !  mark itself) is ignored.
  !
- !  Each configuration file should contain one emul entry. Almost
+ !  Almost all settings are optional.</font>
- !  everything else is optional.</font>
- <b>emul(</b>
+ <b>name(<font color="#ff003f">"my test emul"</font>)</b>         <font color="#2020cf">!  Optional name of this emulation</font>
-     <b>name(<font color="#ff003f">"my test emul"</font>)</b>     <font color="#2020cf">!  Optional name of this emulation</font>
-     <font color="#2020cf">!  This creates a network (ethernet):</font>
+ <font color="#2020cf">!  This creates an ethernet network:</font>
-     <b>net(</b>
+ <b>net(</b>
          <b>ipv4net(<font color="#ff003f">"10.2.0.0"</font>)</b>  <font color="#2020cf">!  The default is 10.0.0.0/8, but</font>
          <b>ipv4len(16)</b>          <font color="#2020cf">!  it can be overridden like this.</font>
-     <b>)</b>
+         <font color="#2020cf">!  local_port(12345)</font>
+         <font color="#2020cf">!  add_remote("localhost:12346")</font>
+ <b>)</b>
-     <font color="#2020cf">!  This creates a machine:</font>
+ <font color="#2020cf">!  This creates a machine:</font>
-     <b>machine(</b>
+ <b>machine(</b>
          <b>name(<font color="#ff003f">"My test machine"</font>)</b>
          <font color="#2020cf">! serial_nr(123)    ! Useful when emulating multiple machines</font>
-Line 96 
 through an example is good enough:
+Line 117 
 through an example is good enough:
          <b>type(<font color="#ff003f">"dec"</font>)</b>         <font color="#2020cf">!  This is actually not optional</font>
          <b>subtype(<font color="#ff003f">"5000/200"</font>)</b>
-         <b>cpu(R3000)</b>      <font color="#2020cf">!  Normally set implicitly to a reasonable</font>
+         <b>cpu(<font color="#ff003f">"R3000"</font>)</b>    <font color="#2020cf">!  Normally set implicitly to a reasonable</font>
                          <font color="#2020cf">!  value, depending on <i>type</i> and <i>subtype</i></font>
          <font color="#2020cf">! ncpus(4)</font>
-Line 119 
 through an example is good enough:
+Line 140 
 through an example is good enough:
          <b>bootarg(<font color="#ff003f">"-a"</font>)</b>
          <font color="#2020cf">! n_gfx_cards(2)         !  for DECstation dual/tripple-head</font>
-         <font color="#2020cf">! emulated_hz(10000000)  !  for fixing the emulated clock speed</font>
+         <font color="#2020cf">! emulated_hz(10000000)  !  for setting the emulated clock speed (mostly fake)</font>
          <font color="#2020cf">! add_x11_display("otherbox:0")  !  for dual/tripple-head etc</font>
          <font color="#2020cf">! add_x11_display("thisbox:0")</font>
-Line 142 
 through an example is good enough:
+Line 163 
 through an example is good enough:
          <b>use_x11(yes)</b>
          <b>x11_scaledown(2)</b>
-         <font color="#2020cf">! bintrans(disable)</font>
-         <font color="#2020cf">! old_bintrans(enable)</font>
-         <font color="#2020cf">! bintrans_size(24)</font>
          <font color="#2020cf">! slow_serial_interrupts_hack_for_linux(yes)</font>
-         <font color="#2020cf">! debugger_on_badaddr(yes)</font>
          <font color="#2020cf">{
              Long comments spanning multiple lines should be surrounded
              with tuborg parentheses.
-Line 164 
 through an example is good enough:
+Line 179 
 through an example is good enough:
            -p pc     add a breakpoint (remember to use the '0x' prefix for hex!)
            -r        register dumps before every instruction
            -t        show function trace tree
-           -y x      set max_random_cycles_per_chunk to x (experimental)
          </i></b>-->
          }</font>
-     <b>)</b>
+ <b>)</b>
-     <font color="#2020cf">!  Multiple machine are allowed.</font>
+ <font color="#2020cf">!  Multiple machine definitions are allowed.</font>
-     <b>machine(</b>
+ <b>machine(</b>
          <b>name(<font color="#ff003f">"another machine"</font>)</b>
          <b>type(<font color="#ff003f">"hpcmips"</font>)</b>
          <b>subtype(<font color="#ff003f">"be300"</font>)</b>
          <i>...</i>
-     <b>)</b>
  <b>)</b>
  </pre>
  </td></tr></table>
-Line 186 
 through an example is good enough:
+Line 199 
 through an example is good enough:
  Starting the emulator with a configuration file is as simple as
  <pre>
-         $ <b>./gxemul @myconfig</b>
+         $ <b>gxemul @myconfig</b>
  </pre>
  if <b>myconfig</b> is the name of the configuration file.
-Line 196 
 if <b>myconfig</b> is the name of the co
+Line 209 
 if <b>myconfig</b> is the name of the co
  <p><br>
  <a name="minimal"></a>
  <h3>A minimal example:</h3>
  Here is an example of what a minimal configuration file might look like:
- <p>
+ <p><table border="0"><tr><td width="40">&nbsp;</td><td><pre>
- <table border="0"><tr><td width="40">&nbsp;</td><td>
+ <b>machine(</b>
- <pre>
+     <b>subtype(<font color="#ff003f">"3max"</font>)</b>
- <font color="#2020cf">!!gxemul</font>
+     <b>load(<font color="#ff003f">"netbsd-pmax-INSTALL-2.0"</font>)</b>
- <b>emul(</b>
-     <b>machine(</b>
-         <b>type(<font color="#ff003f">"dec"</font>)</b>
-         <b>subtype(<font color="#ff003f">"3max"</font>)</b>
-         <b>load(<font color="#ff003f">"netbsd-pmax-INSTALL-2.0"</font>)</b>
-     <b>)</b>
  <b>)</b>
  </pre>
  </td></tr></table>
- <p>
+ <p>For most machine types, <tt>type</tt> is needed. If only
- For some machine types, specifying the <b>subtype</b> might not even be
+ <tt>subtype</tt> is specified, and the name is unique (i.e. there is only
- necessary. Also, adding a <b>net</b> is quite useful, especially for
+ one major type which has such a subtype), then the <tt>type</tt> can be
+ omitted. Also, adding a <tt>net</tt> is quite useful, especially for
  netbooting kernels.
  </p>

 Legend:



Removed from v.4
 


changed lines


 
Added in v.32
 Legend:



Removed from v.4
 


changed lines


 
Added in v.32
-Removed from v.4
+Added in v.32

	ViewVC Help
Powered by ViewVC 1.1.26