source: MondoRescue/branches/2.2.9/mondo-doc/mindi.8@ 2336

Last change on this file since 2336 was 2294, checked in by Bruno Cornec, 15 years ago

Man pages patch from Joe Ross (joe.ross_at_gmail.com)
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 "PBDATE" "Mondo Rescue PBVER-rPBREV"
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 bootable ISO/USB image using files from the system it runs on.
42.B mindi
43will try hard to reproduce the environment of its host system including loaded
44modules to ensure that the system can be booted properly from the created
45rescue media.
46.B mindi
47is used by
48.B monodarchive(8)
49to produce the required USB/ISO images but can also be used stand-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.BI "-v"| " --version"| " -V"| " -version"
67.RI Prints the version of mindi.
68.TP
69.BI "--findkernel"
70.RI Finds 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 "--usb "device
76.RI Create a bootable USB device
77.TP
78.BI "--max-compressed-size "max
79Maximum size for disk image in KB.
80.TP
81.BI "--custom " parameters
82.RI "Provide all required parameters to"
83.B mindi
84.RI "for non-interactive calling. This usually means a call from"
85.BR "mondoarchive(8)".
86The following parameters are used:
87.br
8801) directory to use for temporary files
89.br
9002) directory to put disk images in
91.br
9203) path to kernel image
93.br
9404) tape device
95.br
9605) tape size [MB]
97.br
9806) total number of files in file list
99.br
10007) use LZO [yes|no]
101.br
10208) CD recovery media [yes|no]
103.br
10409) devices to include
105.br
10610) conservative LiLo settings [yes|no]
107.br
10811) number of last file list
109.br
11012) estimated total number of slices
111.br
11213) devices to exclude
113.br
11414) compare mode [yes|no]
115.br
11615) use lilo [yes|no]
117.br
11816) use star (rather than tar) [yes|no]
119.br
12017) internal tape block size [bytes]
121.br
12218) number of differential backup
123.br
12419) make non-bootable [yes|no]
125.br
12620) use gzip [yes|no]
127.br
128(Blank parameters must be specified as "" on the command line.)
129.SH DIAGNOSTICS
130.B mindi
131writes some output to the console and extensive information to log file
132.IR /var/log/mindi.log ".
133When seeking technical support for
134.BR "mindi",
135please attach this file to your email.
136.SH FILES
137.TP
138.I /var/log/mindi.log
139Log file of mindi run. Contains important information to analyze mindi problem
140reports.
141.TP
142.I /etc/mindi/deplist.txt
143List of files to be included on boot/root disks.
144.TP
145.I /var/cache/mindi/N.tar.gz
146Number N of multiple tar balls together containing root file system for rescue
147media.
148.TP
149.I /var/cache/mindi/all.tar.gz
150Single tar ball of root file system for rescue media.
151.TP
152.I /var/cache/mindi/initrd.img
153initrd image for bootable ISO image.
154.TP
155.I /var/cache/mindi/mindi-boot.F.img
156.B mindi
157boot media of size F [KB].
158.TP
159.I /var/cache/mindi/mindi-root.F.img
160.B mindi
161root media of size F [KB].
162.TP
163.I /var/cache/mindi/mindi-data.N.img
164.B mindi
165data media number N for boot/root media.
166.TP
167.I /var/cache/mindi/mindi.iso
168.B mindi
169bootable ISO image.
170.SH "SEE ALSO"
171mondoarchive(8), mondorestore(8).
172.TP
173See mailing list at http://www.mondorescue.org for technical support.
174.SH AUTHORS
175Bruno Cornec (lead-development)
176.I "bruno_at_mondorescue.org"
177.br
178Andree Leidenfrost (co-developer)
179.I "aleidenf_at_bigpond.net.au"
180.br
181.SH ORIGINAL AUTHORS
182Hugo Rabson (original author)
183.I "hugo.rabson_at_mondorescue.org"
184.br
185Jesse Keating (packaging)
186.I "hosting_at_j2solutions.net"
187.br
188Stan Benoit (testing)
189.I "troff_at_nakedsoul.org"
190.br
191Mikael Hultgren (docs)
192.I "mikael_hultgren_at_gmx.net"
193.br
194.
Note: See TracBrowser for help on using the repository browser.