--- trunk/man/gxemul.1 2007/10/08 16:18:43 13 +++ trunk/man/gxemul.1 2007/10/08 16:18:51 14 @@ -1,4 +1,4 @@ -.\" $Id: gxemul.1,v 1.29 2005/08/10 15:51:09 debug Exp $ +.\" $Id: gxemul.1,v 1.33 2005/10/07 22:45:34 debug Exp $ .\" .\" Copyright (C) 2004-2005 Anders Gavare. All rights reserved. .\" @@ -29,7 +29,7 @@ .\" This is a minimal man page for GXemul. Process this file with .\" groff -man -Tascii gxemul.1 or nroff -man gxemul.1 .\" -.Dd AUGUST 2005 +.Dd OCTOBER 2005 .Dt GXEMUL 1 .Os .Sh NAME @@ -41,33 +41,34 @@ .Op file Ar ... .Nm .Op general options -.Op Ar @configfile ... +.Ar @configfile .Nm .Op userland, other, and general options .Ar file Op Ar args ... .Sh DESCRIPTION .Nm -is an experimental instruction-level machine emulator. It can be used to -run binary code for MIPS-based machines, regardless of host -platform. Several emulation modes are available. For some modes, -processors and surrounding hardware components are emulated well enough to -let unmodified operating systems (e.g. NetBSD) run as if they were running -on a real machine. -.Pp -(Non-MIPS emulation modes are also under development, but so far none of -those modes has reached the completeness required to run unmodified -operating systems.) -.Pp -There are three ways to invoke the emulator. When emulating a -complete machine, settings can be entered directly on the command line, or -they can be read from a configuration file. When emulating a userland -environment (syscall-only emulation, not emulating complete machines), -then the program name and its argument should be given on the command -line. +is an experimental instruction-level machine emulator. Several +emulation modes are available. In some modes, processors and surrounding +hardware components are emulated well enough to let unmodified operating +systems (e.g. NetBSD) run as if they were running on a real machine. +.Pp +The processor architecture best emulated by GXemul is MIPS, but other +architectures are also partially emulated. +.Pp +There are three ways to invoke the emulator: +.Pp +1. When emulating a complete machine, configuration options can be entered +directly on the command line. +.Pp +2. Options can be read from a configuration file. +.Pp +3. When emulating a userland environment (syscall-only emulation, not +emulating complete machines), then the program name and its argument +should be given on the command line. (This mode doesn't really work yet.) .Pp The easiest way to use the emulator is to supply settings directly on the command line. The most important thing you need to supply is the -file argument. This is the name of a binary file (an ELF, a.out, ECOFF, +file argument. This is the name of a binary file (an ELF, a.out, COFF/ECOFF, SREC, or a raw binary image) which you wish to run in the emulator. This file might be an operating system kernel, or perhaps a ROM image file. .Pp @@ -163,12 +164,12 @@ Force a specific ID number. .El .Pp -Unless otherwise specified, filenames ending with ".iso" are assumed to be -CDROM images. Most others are assumed to be disks. Depending on which -machine is being emulated, the default for disks can be either SCSI or -IDE. Some disk images that are very small are assumed to be floppy disks. -(If you are not happy with the way a disk image is detected, then you need -to use explicit prefixes to force a specific type.) +Unless otherwise specified, filenames ending with ".iso" or ".cdr" are +assumed to be CDROM images. Most others are assumed to be disks. Depending +on which machine is being emulated, the default for disks can be either +SCSI or IDE. Some disk images that are very small are assumed to be floppy +disks. (If you are not happy with the way a disk image is detected, then +you need to use explicit prefixes to force a specific type.) .Pp For floppies, the gH;S; prefix is ignored. Instead, the number of heads and cylinders are assumed to be 2 and 80, respectively, and the @@ -347,8 +348,8 @@ .Pp .Nm does not simulate individual pipe-line stages or penalties caused by -branch-prediction misses or cache misses, so it cannot be used for -accurate performance measurement. +branch-prediction misses or cache misses, so it cannot be used for +accurate simulation of any actual real-world processor. .Pp .Nm is not timing-accurate.