From 4194c22ebccdf740a968038116b48ff41308722b Mon Sep 17 00:00:00 2001 From: Volker Ruppert Date: Sat, 9 Oct 2004 15:58:47 +0000 Subject: [PATCH] - bximage: description of the command line options added - bximage, bxcommit: the link to "Bug Reports" can be found under "Feedback" - references to bxcommit added to the other manpages --- bochs/doc/man/bochs-dlx.1 | 2 +- bochs/doc/man/bochs.1 | 2 +- bochs/doc/man/bochsrc.5 | 2 +- bochs/doc/man/bxcommit.1 | 2 +- bochs/doc/man/bximage.1 | 53 +++++++++++++++++++++++++++++++++------ 5 files changed, 50 insertions(+), 11 deletions(-) diff --git a/bochs/doc/man/bochs-dlx.1 b/bochs/doc/man/bochs-dlx.1 index 7dde874e7..9915061a6 100644 --- a/bochs/doc/man/bochs-dlx.1 +++ b/bochs/doc/man/bochs-dlx.1 @@ -32,7 +32,7 @@ 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) +bochs(1), bochsrc(5), bximage(1), bxcommit(1) .PP .nf The Bochs IA-32 Emulator site on the World Wide Web: diff --git a/bochs/doc/man/bochs.1 b/bochs/doc/man/bochs.1 index cf221e528..383fc1a50 100644 --- a/bochs/doc/man/bochs.1 +++ b/bochs/doc/man/bochs.1 @@ -66,7 +66,7 @@ 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) +bochsrc(5), bochs-dlx(1), bximage(1), bxcommit(1) .PP .nf The Bochs IA-32 Emulator site on the World Wide Web: diff --git a/bochs/doc/man/bochsrc.5 b/bochs/doc/man/bochsrc.5 index c3965a02c..b64efc8a3 100644 --- a/bochs/doc/man/bochsrc.5 +++ b/bochs/doc/man/bochsrc.5 @@ -805,7 +805,7 @@ The latest version of this program can be found at: http://bochs.sourceforge.net/getcurrent.html .\"SKIP_SECTION" .SH SEE ALSO -bochs(1), bochs-dlx(1), bximage(1) +bochs(1), bochs-dlx(1), bximage(1), bxcommit(1) .PP .nf The Bochs IA-32 Emulator site on the World Wide Web: diff --git a/bochs/doc/man/bxcommit.1 b/bochs/doc/man/bxcommit.1 index a29a31052..93a351f36 100644 --- a/bochs/doc/man/bxcommit.1 +++ b/bochs/doc/man/bxcommit.1 @@ -44,7 +44,7 @@ based on Bochs bximage tool source code. .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." +"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 diff --git a/bochs/doc/man/bximage.1 b/bochs/doc/man/bximage.1 index a585db0fa..523dd0ad0 100644 --- a/bochs/doc/man/bximage.1 +++ b/bochs/doc/man/bximage.1 @@ -4,15 +4,54 @@ .SH NAME bximage \- Interactive Disk Image Creator for Bochs .\"SKIP_SECTION" -.SH USAGE +.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, so no command line arguments are -needed to use bximage. +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 @@ -26,7 +65,7 @@ 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) +bochs(1), bochsrc(5), bochs-dlx(1), bxcommit(1) .PP .nf The Bochs IA-32 Emulator site on the World Wide Web: @@ -43,7 +82,7 @@ similar tools from the bochs-developers list. .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." +"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