/[gxemul]/trunk/man/gxemul.1

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/man/gxemul.1

Parent Directory | Revision Log | View Patch Patch

-revision 28 by dpavlin,
Mon Oct  8 16:20:26 2007 UTC
+revision 38 by dpavlin,
Mon Oct  8 16:21:53 2007 UTC
 Line 1
- .\" $Id: gxemul.1,v 1.68 2006/07/16 13:32:24 debug Exp $
+ .\" $Id: gxemul.1,v 1.89 2007/04/10 15:37:00 debug Exp $
  .\"
- .\" Copyright (C) 2004-2006  Anders Gavare.  All rights reserved.
+ .\" Copyright (C) 2004-2007  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 29
  .\" This is a minimal man page for GXemul. Process this file with
  .\"     groff -man -Tascii gxemul.1    or    nroff -man gxemul.1
  .\"
- .Dd JULY 2006
+ .Dd APRIL 2007
  .Dt GXEMUL 1
  .Os
  .Sh NAME
 Line 54 
 hardware components are emulated well en
  systems (e.g. NetBSD) run inside the emulator as if they were running on a
  real machine.
  .Pp
- Processors (ARM, MIPS, PowerPC) are emulated using dynamic translation.
+ Processors (ARM, MIPS, PowerPC, SuperH) are emulated using dynamic translation.
  However, unlike some other dynamically translating emulators, GXemul does
- not currently generate native code, only a "runnable intermediate
+ not need to generate native code, only a "runnable intermediate
  representation", and will thus run on any host architecture, without the
  need to implement per-architecture backends.
  .Pp
 Line 89 
 from SGI. Use
  .Fl H
  to get a list of available emulation modes.
  .Pp
- There are two exceptions to the normal invocation usage mentioned above.
+ There are three exceptions to the normal invocation usage mentioned above.
- The first is for DECstation emulation: if you have a bootable
+ .Pp
- DECstation harddisk or CDROM image, then just supplying the diskimage via
+. For DECstation emulation, if you have a bootable DECstation harddisk or
- the
+ CDROM image, then just supplying the diskimage via the
  .Fl d
- option is sufficient. (The filename of the kernel can then be
+ option is sufficient. The filename of the kernel can then be
  skipped, as the emulator runs the bootblocks from the diskimage directly and
- doesn't need the kernel as a separate file.)
+ doesn't need the kernel as a separate file.
- The second is if you supply an ISO9660 CDROM disk image. You may then use
+ .Pp
- the
+. If you supply an ISO9660 CDROM disk image, then using the
  .Fl j
- option to indicate which file on the CDROM filesystem that should be
+ option to indicate a file on the CDROM filesystem to load is sufficient;
- loaded into emulated memory.
+ no additional kernel filename needs to be supplied on the command line.
+ .Pp
+. For Dreamcast emulation, when booting e.g. a NetBSD/dreamcast CDROM
+ image, it is enough to supply the disk image (with the correct ISO
+ partition start offset). Bootblocks will be read directly from the CDROM
+ image, and there is no need to supply the name of an external kernel on
+ the command line.
  .Pp
  Gzipped kernels are automatically unzipped, by calling the external gunzip
  program, both when specifying a gzipped file directly on the command line
-Line 158 
 Override the default geometry; use H hea
+Line 164 
 Override the default geometry; use H hea
  (The number of cylinders is calculated automatically.)
  .It i
  IDE. (This is the default for most machine types.)
+ .It oOFS;
+ Set the base offset for an ISO9660 filesystem on a disk image. The default
+ is 0. A suitable offset when booting from Dreamcast ISO9660 filesystem
+ images, which are offset by 11702 sectors, is 23965696.
  .It r
  Read-only (don't allow changes to be written to the file).
  .It s
  SCSI.
  .It t
  Tape.
+ .It V
+ Add an overlay filename to an already defined disk image.
+ (A ID number must also be specified when this flag is used. See the
+ documentation for an example of how to use overlays.)
  .It 0-7
  Force a specific ID number.
  .El
-Line 192 
 For floppies, the gH;S; prefix is ignore
+Line 206 
 For floppies, the gH;S; prefix is ignore
  heads and cylinders are assumed to be 2 and 80, respectively, and the
  number of sectors per track is calculated automatically. (This works for
 KB, 1.2MB, 1.44MB, and 2.88MB floppies.)
- .It Fl G Ar port
+ .It Fl I Ar hz
- Pause at startup, and listen to TCP port
+ Set the main CPUs frequency to
- .Ar port
+ .Ar hz
- for incoming remote GDB connections. The emulator starts up in paused
+ Hz. This option does not work for all emulated machine modes. It affects
- mode, and it is up to the remote GDB instance to start the session.
+ the way count/compare interrupts are faked to simulate emulated time =
- .It Fl I Ar x
+ real world time. If the guest operating system relies on RTC interrupts
- Emulate clock interrupts at
+ instead of count/compare interrupts, then this option has no effect.
- .Ar x
+ .Pp
- Hz. (This affects emulated clock devices only, not actual runtime speed.
+ Setting the frequency to zero disables automatic synchronization of
- This disables automatic clock adjustments, which is otherwise turned on.)
+ emulated time vs real world time, and the count/compare system runs at a
- (This option is probably only valid for DECstation emulation.)
+ fixed rate.
  .It Fl i
  Enable instruction trace, i.e. display disassembly of each instruction as
  it is being executed.
-Line 299 
 Disabled at startup.
+Line 313 
 Disabled at startup.
  Overwrite the file, instead of appending to it.
  .El
  .Pp
- .\" Statistics gathering can be enabled/disabled at runtime by using the
+ Statistics gathering can be enabled/disabled at runtime by using the
- .\" "TODO" debugger command.
+ "statistics_enabled = yes" and "statistics_enabled = no" debugger
- .\" .Pp
+ commands.
+ .Pp
  When gathering instruction statistics using the
  .Fl s
- option, instruction combinations are always disabled (i.e.
+ option, instruction combinations and native code generation
- an implicit
+ are always disabled (i.e. implicit
  .Fl J
- is added to the command line).
+ and
+ .Fl B
+ flags are added to the command line).
  .Pp
  If a value is missing (e.g. the end-of-page slot does not really have a
  known physical address), it is written out as just a dash ("-").
+ .It Fl T
+ Halt if the emulated program attempts to access non-existing memory.
  .It Fl t
  Show a trace tree of all function calls being made.
  .It Fl U
-Line 365 
 as an X11 display to use for framebuffer
+Line 384 
 as an X11 display to use for framebuffer
  .\" .Pp
  General options:
  .Bl -tag -width Ds
+ .It Fl b
+ Enable native code generation at runtime. This is not really implemented
+ yet. Don't use it unless you know what you are doing. It will most
+ likely not work.
+ .It Fl B
+ Disable native code generation at runtime. (This is the default in
+ GXemul 0.4.4; there are no implemented native code generation backends.)
  .It Fl c Ar cmd
  Add
  .Ar cmd
-Line 373 
 be achieved by using the
+Line 399 
 be achieved by using the
  .Fl V
  option, and entering the commands manually.
  .It Fl D
- Guarantee fully deterministic behavior. Normally, the emulator calls
+ Causes the emulator to skip a call to srandom(). This leads to somewhat
- srandom() with a seed based on the current time at startup. When the
+ more deterministic behaviour than running without this option.
- .Fl D
+ However, if the emulated machine has clocks or timer interrupt sources,
- option is used, the srandom() call is skipped, which should cause two
+ or if user interaction is taking place (e.g. keyboard input at irregular
- subsequent invocations of the emulator to be identical, if all other
+ intervals), then this option is meaningless.
- settings are identical and no user input is taking place. (If this option
- is used, then
- .Fl I
- must also be used.)
  .It Fl H
  Display a list of available CPU types, machine types, and userland
  emulation modes. (Most of these don't work. Please read the documentation
-Line 392 
 emulation is not included in stable rele
+Line 414 
 emulation is not included in stable rele
  yet.)
  .It Fl h
  Display a list of all available command line options.
+ .It Fl k Ar n
+ Set the size of the dyntrans cache (per emulated CPU) to
+ .Ar n
+ MB. The default size is 32 MB.
  .It Fl K
  Force the single-step debugger to be entered at the end of a simulation.
  .It Fl q
-Line 465 
 file in the
+Line 491 
 file in the
  .Nm
  source distribution, some are marked as TODO in the source code itself.
  .Pp
- Userland (syscall-only) emulation doesn't really work yet.
+ Userland (syscall-only) emulation, i.e. running a userland binary directly
- .Pp
+ without simulating an entire machine, doesn't really work yet.
- The documentation sometimes only reflects the way things worked with
- the old MIPS emulation mode (prior to 0.4.0), and it is incorrect when
- applied to current releases.
  .Pp
  .Nm
  is in general not cycle-accurate; it does not simulate individual
-Line 478 
 cache misses, so it cannot be used for a
+Line 501 
 cache misses, so it cannot be used for a
  real-world processor.
  .Pp
  .Nm
- is not timing-accurate, i.e. clocks inside the emulator are in general
+ is in general not timing-accurate. Some emulation modes
- not at all synched with clocks in the real world. There are a few
+ (DECstation, CATS, NetWinder, MobilePro (hpcmips), Malta (evbmips),
- exceptions to this rule (the mc146818 device tries to automagically
+ Cobalt, Algor, Dreamcast, PICA-61, and IQ80321) try to make the guest
- adjust emulated timer ticks to actual emulation speed).
+ operating system's clock run at the same speed as the host clock.
+ However, the number of instructions executed per clock tick can
+ obviously vary, depending on the current CPU load on the host.
  .Sh AUTHOR
- GXemul is Copyright (C) 2003-2006 Anders Gavare <anders@gavare.se>
+ GXemul is Copyright (C) 2003-2007 Anders Gavare <anders@gavare.se>
  .Pp
  See http://gavare.se/gxemul/ for more information. For other Copyright
  messages, see the corresponding parts of the source code and/or

 Legend:



Removed from v.28
 


changed lines


 
Added in v.38
 Legend:



Removed from v.28
 


changed lines


 
Added in v.38
-Removed from v.28
+Added in v.38

	ViewVC Help
Powered by ViewVC 1.1.26