- added instructions how to update the online documentation
[bochs-mirror.git] / doc / man / bximage.1
blob93f239658767a236f091f1ec62c4383d56803858
1 .\"Document Author:  Timothy R. Butler   -   tbutler@uninetsolutions.com"
2 .TH bximage 1 "29 Dec 2005" "bximage" "The Bochs Project"
3 .\"SKIP_SECTION"
4 .SH NAME
5 bximage \- Interactive Disk Image Creator for Bochs
6 .\"SKIP_SECTION"
7 .SH SYNOPSIS
8 .B bximage
9 .RI \|[ options \|]
10 .RI \|[ filename \|]
11 .\"SKIP_SECTION"
12 .SH DESCRIPTION
13 .LP
14 Bximage  is an easy to use console based tool for creating
15 disk  images, particularly  for  use with  Bochs.  It   is
16 completely  interactive if no command  line arguments  are
17 used.  It can be switched to a non-interactive mode if all
18 required parameters are given in the command line.
19 .\".\"DONT_SPLIT"
20 .SH OPTIONS
21 .LP
22 When you run bximage without one of the following options,
23 it will  appear  in  interactive  mode and  ask   for  all
24 required parameters to create an image.
25 .TP
26 .BI \-fd
27 Create a floppy image.
28 .TP
29 .BI \-hd
30 Create a hard disk image.
31 .TP
32 .BI \-mode=...
33 Image mode (for hard disks only - see the
34 .I bochsrc
35 sample for supported options).
36 .TP
37 .BI \-size=...
38 Image size in megabytes (e.g. 1.44 for floppy image, 10
39 for hard disk image).
40 .TP
41 .BI \-q
42 Quiet  mode (don't prompt for user input). Without this
43 option bximage uses the  command  line parameters as
44 defaults for the interactive mode. If this option is
45 given and one of the required parameters is missing,
46 bximage will fall back to interactive mode.
47 .TP
48 .BI \--help
49 Print  a  summary  of  the command line options for
50 bximage and exit.
51 .LP
52 The
53 .I filename
54 parameter specifies the name of the image to be created.
55 .\"SKIP_SECTION"
56 .SH LICENSE
57 This program  is distributed  under the terms of the  GNU
58 Lesser General Public License as published  by  the  Free
59 Software  Foundation.  See  the  COPYING file located  in
60 /usr/local/share/doc/bochs/ for details on the license and
61 the lack of warranty.
62 .\"SKIP_SECTION"
63 .SH AVAILABILITY
64 The latest version of this program can be found at:
65   http://bochs.sourceforge.net/getcurrent.html
66 .\"SKIP_SECTION"
67 .SH SEE ALSO
68 bochs(1), bochsrc(5), bochs-dlx(1), bxcommit(1)
69 .PP
70 .nf
71 The Bochs IA-32 Emulator site on the World Wide Web:
72   http://bochs.sourceforge.net
74 Online Bochs Documentation
75         http://bochs.sourceforge.net/doc/docbook
76 .fi
77 .\"SKIP_SECTION"
78 .SH AUTHORS
79 Bximage  was written  by Bryce Denney,  based on  several
80 similar tools from the bochs-developers list.
81 .\"SKIP_SECTION"
82 .SH BUGS
83 Please  report all  bugs to the bug tracker  on  our  web
84 site. Just go to http://bochs.sourceforge.net, and click
85 "Bug Reports" on the sidebar under "Feedback."
86 .PP
87 Provide a detailed description of the bug, the version of
88 the program you are running, the operating system you are
89 running the program on  and  the  operating   system  you
90 are running in the emulator.