source: branches/2.05/mindi/mindi.8 @ 242

Last change on this file since 242 was 151, checked in by andree, 14 years ago

Added manpage for mindi.

File size: 4.9 KB
Line 
1.\" Copyright (c) 2005 Andree Leidenfrost
2.\"
3.\" This is free documentation; you can redistribute it and/or
4.\" modify it under the terms of the GNU General Public License as
5.\" published by the Free Software Foundation; either version 2 of
6.\" the License, or (at your option) any later version.
7.\"
8.\" The GNU General Public License's references to "object code"
9.\" and "executables" are to be interpreted as the output of any
10.\" document formatting or typesetting system, including
11.\" intermediate and printed output.
12.\"
13.\" This manual is distributed in the hope that it will be useful,
14.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
15.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16.\" GNU General Public License for more details.
17.\"
18.\" You should have received a copy of the GNU General Public
19.\" License along with this manual; if not, write to the Free
20.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
21.\" USA.
22.\"
23.TH MINDI 8 "November 2005" "MondoRescue"
24.SH NAME
25mindi \- a tool for creating boot/root disks
26.SH SYNOPSIS
27.B mindi
28.br
29.BR "mindi -v"| " --version"| " -V"| " -version"
30.br
31.BI "mindi --findkernel"
32.br
33.BI "mindi --makemountlist "file
34.br
35.BI "mindi [--max-compressed-size "max "] --custom " parameters
36.SH DESCRIPTION
37.PP
38.B mindi
39creates a set of boot/root floppy disk images and/or a bootable ISO image using
40files from the system it runs on.
41.B mindi
42will try hard to reproduce the environment of its host system including loaded
43modules to ensure that the system can be booted properly from the created
44rescue media.
45.B mindi
46is used by
47.B monodarchive(8)
48to produce the required boot/root floppy or CD images but can also be used
49stand-alone.
50
51For stand-alone usage,
52.B mindi
53is called without any parameters or switches. It will then interactively ask
54the user for all information required to create a set of boot/root media.
55.LP
56The probably more frequent way of calling
57.B mindi
58is non-interactively from
59.B mondoarchive(8)
60using the
61.B --custom
62switch. All required information is then provided via command line parameters.
63The sequence of these parameters is listed below.
64.SH OPTIONS
65.TP
66.BR "-v"| " --version"| " -V"| " -version"
67Prints the version of mindi.
68.TP
69.B --findkernel
70Finds the image of the running kernel in the file system.
71.TP
72.BI "--makemountlist "file
73.RI "Creates a mount list and writes it to file "file ".
74.TP
75.BI "--max-compressed-size "max
76Maximum size for disk image in KB.
77.TP
78.BI "--custom " parameters
79Provide all required parameters to
80.B mindi
81for non-interactive calling. This usually means a call from
82.BR "mondoarchive(8)".
83The following parameters are used:
84.br
8501) directory to use for temporary files
86.br
8702) directory to put disk images in
88.br
8903) path to kernel image
90.br
9104) tape device
92.br
9305) tape size [MB]
94.br
9506) total number of files in file list
96.br
9707) use LZO [yes|no]
98.br
9908) CD recovery media [yes|no]
100.br
10109) devices to include
102.br
10310) conservative LiLo settings [yes|no]
104.br
10511) number of last file list
106.br
10712) estimated total number of slices
108.br
10913) devices to exclude
110.br
11114) compare mode [yes|no]
112.br
11315) use lilo [yes|no]
114.br
11516) use star (rather than tar) [yes|no]
116.br
11717) internal tape block size [bytes]
118.br
11918) number of diffenrential backup
120.br
12119) make non-bootable [yes|no]
122.br
123(Blank parameters must be specified as "" on the command line.)
124.SH DIAGNOSTICS
125.B mindi
126writes some output to the console and extensive information to log file
127.IR /var/log/mindi.log ".
128When seeking technical support for
129.BR "mindi",
130please attach this file to your email.
131.SH FILES
132.TP
133.I /var/log/mindi.log
134Log file of mindi run. Contains important information to analyze mindi problem
135reports.
136.TP
137.I /etc/mindi/deplist.txt
138List of files to be included on boot/root disks.
139.TP
140.I /root/images/mindi/N.tar.gz
141Number N of multiple tar balls together containing root file system for rescue
142media.
143.TP
144.I /root/images/mindi/all.tar.gz
145Single tar ball of root file system for rescue media.
146.TP
147.I /root/images/mindi/initrd.img
148initrd image for bootable ISO image.
149.TP
150.I /root/images/mindi/mindi-boot.F.img
151.B mindi
152boot floppy of size F [KB].
153.TP
154.I /root/images/mindi/mindi-root.F.img
155.B mindi
156root floppy of size F [KB].
157.TP
158.I /root/images/mindi/mindi-data.N.img
159.B mindi
160data floppy number N for boot/root floppies.
161.TP
162.I /root/images/mindi/mindi.iso
163.B mindi
164bootable ISO image.
165.SH "SEE ALSO"
166mondoarchive(8), mondorestore(8).
167.TP
168See mailing list at http://www.mondorescue.org for technical support.
169.SH BUGS
170The target location for the image files created by
171.B mindi
172is hard-coded to
173.IR "/root/images/mindi".
174As a workaround, it is suggested to make
175.I /root/images
176a symbolic link to the desired location for the image files.
177.SH AUTHORS
178Hugo Rabson (coding)
179.I "hugo.rabson@mondorescue.org"
180.br
181Jesse Keating (packaging)
182.I "hosting@j2solutions.net"
183.br
184Stan Benoit (testing)
185.I "troff@nakedsoul.org"
186.br
187Mikael Hultgren (docs)
188.I "mikael_hultgren@gmx.net"
189.br
190Bruno Cornec (coding)
191.I "bruno.cornec@hp.com"
192.
Note: See TracBrowser for help on using the repository browser.