source: MondoRescue/branches/2.2.5/mondo-doc/mindi.8@ 1686

Last change on this file since 1686 was 1686, checked in by Bruno Cornec, 17 years ago

Document USB support for mindi

File size: 5.0 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 "DDD" "Mondo Rescue VVV-rRRR"
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 --usb "device
36.br
37.BI "mindi [--max-compressed-size "max "] --custom " parameters
38.SH DESCRIPTION
39.PP
40.B mindi
41creates a set of boot/root floppy disk images and/or a bootable ISO/USB image using
42files from the system it runs on.
43.B mindi
44will try hard to reproduce the environment of its host system including loaded
45modules to ensure that the system can be booted properly from the created
46rescue media.
47.B mindi
48is used by
49.B monodarchive(8)
50to produce the required boot/root floppy or USB/ISO images but can also be used
51stand-alone.
52
53For stand-alone usage,
54.B mindi
55is called without any parameters or switches. It will then interactively ask
56the user for all information required to create a set of boot/root media.
57.LP
58The probably more frequent way of calling
59.B mindi
60is non-interactively from
61.B mondoarchive(8)
62using the
63.B --custom
64switch. All required information is then provided via command line parameters.
65The sequence of these parameters is listed below.
66.SH OPTIONS
67.TP
68.BI "-v"| " --version"| " -V"| " -version"
69.RI Prints the version of mindi.
70.TP
71.BI "--findkernel"
72.RI Finds the image of the running kernel in the file system.
73.TP
74.BI "--makemountlist "file
75.RI "Creates a mount list and writes it to file "file ".
76.TP
77.BI "--usb "device
78.RI Create a bootable USB device
79.TP
80.BI "--max-compressed-size "max
81Maximum size for disk image in KB.
82.TP
83.BI "--custom " parameters
84.RI "Provide all required parameters to"
85.B mindi
86.RI "for non-interactive calling. This usually means a call from"
87.BR "mondoarchive(8)".
88The following parameters are used:
89.br
9001) directory to use for temporary files
91.br
9202) directory to put disk images in
93.br
9403) path to kernel image
95.br
9604) tape device
97.br
9805) tape size [MB]
99.br
10006) total number of files in file list
101.br
10207) use LZO [yes|no]
103.br
10408) CD recovery media [yes|no]
105.br
10609) devices to include
107.br
10810) conservative LiLo settings [yes|no]
109.br
11011) number of last file list
111.br
11212) estimated total number of slices
113.br
11413) devices to exclude
115.br
11614) compare mode [yes|no]
117.br
11815) use lilo [yes|no]
119.br
12016) use star (rather than tar) [yes|no]
121.br
12217) internal tape block size [bytes]
123.br
12418) number of diffenrential backup
125.br
12619) make non-bootable [yes|no]
127.br
12820) use gzip [yes|no]
129.br
130(Blank parameters must be specified as "" on the command line.)
131.SH DIAGNOSTICS
132.B mindi
133writes some output to the console and extensive information to log file
134.IR /var/log/mindi.log ".
135When seeking technical support for
136.BR "mindi",
137please attach this file to your email.
138.SH FILES
139.TP
140.I /var/log/mindi.log
141Log file of mindi run. Contains important information to analyze mindi problem
142reports.
143.TP
144.I /etc/mindi/deplist.txt
145List of files to be included on boot/root disks.
146.TP
147.I /var/cache/mindi/N.tar.gz
148Number N of multiple tar balls together containing root file system for rescue
149media.
150.TP
151.I /var/cache/mindi/all.tar.gz
152Single tar ball of root file system for rescue media.
153.TP
154.I /var/cache/mindi/initrd.img
155initrd image for bootable ISO image.
156.TP
157.I /var/cache/mindi/mindi-boot.F.img
158.B mindi
159boot floppy of size F [KB].
160.TP
161.I /var/cache/mindi/mindi-root.F.img
162.B mindi
163root floppy of size F [KB].
164.TP
165.I /var/cache/mindi/mindi-data.N.img
166.B mindi
167data floppy number N for boot/root floppies.
168.TP
169.I /var/cache/mindi/mindi.iso
170.B mindi
171bootable ISO image.
172.SH "SEE ALSO"
173mondoarchive(8), mondorestore(8).
174.TP
175See mailing list at http://www.mondorescue.org for technical support.
176.SH AUTHORS
177Bruno Cornec (lead-development)
178.I "bruno_at_mondorescue.org"
179.br
180Andree Leidenfrost (co-developper)
181.I "aleidenf_at_bigpond.net.au"
182.br
183.SH ORIGINAL AUTHORS
184Hugo Rabson (original author)
185.I "hugo.rabson_at_mondorescue.org"
186.br
187Jesse Keating (packaging)
188.I "hosting_at_j2solutions.net"
189.br
190Stan Benoit (testing)
191.I "troff_at_nakedsoul.org"
192.br
193Mikael Hultgren (docs)
194.I "mikael_hultgren_at_gmx.net"
195.br
196.
Note: See TracBrowser for help on using the repository browser.