source: MondoRescue/branches/3.2/mondo-doc/mindi.8@ 3586

.\" Copyright (c) 2005 Andree Leidenfrost
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, write to the Free
.\" Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
.\" USA.
.\"
.TH MINDI 8 "PBDATE" "Mondo Rescue PBVER-rPBREV"
.SH NAME
mindi \- a tool for creating boot/root disks
.SH SYNOPSIS
.B mindi
.TP
.BR "mindi \-v"| " --version"| " \-V"| " -version"
.TP
.BI "mindi --findkernel"
.TP
.BI "mindi --makemountlist "file
.TP
.BI "mindi --usb "device
.TP
.BI "mindi --locatedeps "file
.TP
.BI "mindi --makemountlist "file
.TP
.BI "mindi --makemessage"
.TP
.BI "mindi --makebcf "bootloader
.TP
.BI "mindi --ironic "kernel " "initrd " "[BIOS|UEFI] 
[syslinux|grub|grub2] [/path/to/bootloader]
.TP
.BI "mindi [--max-compressed-size "max "] --custom " parameters
.SH DESCRIPTION
.PP
.B mindi
creates a bootable ISO/USB image using files from the system it runs on.
.B mindi
will try hard to reproduce the environment of its host system including loaded
modules to ensure that the system can be booted properly from the created
rescue media.
.B mindi
is used by
.B monodarchive(8)
to produce the required USB/ISO images but can also be used stand-alone.

For stand-alone usage,
.B mindi
is called without any parameters or switches. It will then interactively ask
the user for all information required to create a set of boot/root media.
.LP
The probably more frequent way of calling
.B mindi
is non-interactively from
.B mondoarchive(8)
using the
.B --custom
switch. All required information is then provided via command line parameters.
The sequence of these parameters is listed below.
.SH OPTIONS
.TP
.BI "\-v"| " --version"| " \-V"| " -version"
Prints the version of mindi.
.TP
.BI "--findkernel"
Finds the image of the running kernel in the file system.
.TP
.BI "--makemountlist "file
Creates a mount list and writes it to file "file".
.TP
.BI "--usb "device
Create a bootable USB device 
.TP
.BI "--locatedeps "file
Find all dependencies of a binary file
.TP
.BI "--makemountlist "file
Create the mountlist of your system and write it to the file
.TP
.BI "--makemessage"
Create the boot message file and display it
.TP
.BI "--makebcf "bootloader
Create the boot configuration file for this bootloader and display it
.TP
.BI "--ironic "kernel " "initrd " "[BIOS|UEFI] " "[syslinux|grub|grub2] " "[/path/to/bootloader]
Create a bootable ISO image using the kernel and initrd passed in parameter. If given the image will be UEFI or only BIOS boot mode compliant. You can force the boot loader to use, instead of using the one of the system, and the binary file to use as this bootloader instead of the one found on your system.
.TP
.BI "--max-compressed-size "max
Maximum size for disk image in KB.
.TP
.BI "--custom " parameters
"Provide all required parameters to"
.B mindi
"for non-interactive calling. This usually means a call from"
.BR "mondoarchive(8)".
The following parameters are used:
.BR
01) directory to use for temporary files
.BR
02) directory to put disk images in
.BR
03) path to kernel image
.BR
04) tape device
.BR
05) tape size [MB]
.BR
06) total number of files in file list
.BR
07) use LZO [yes|no]
.BR
08) CD recovery media [yes|no]
.BR
09) devices to include
.BR
10) conservative LiLo settings [yes|no]
.BR
11) number of last file list
.BR
12) estimated total number of slices
.BR
13) devices to exclude
.BR
14) compare mode [yes|no]
.BR
15) use lilo [yes|no]
.BR
16) use star (rather than tar) [yes|no]
.BR
17) internal tape block size [bytes]
.BR
18) number of differential backup
.BR
19) make non-bootable [yes|no]
.BR
20) use gzip [yes|no]
.BR
(Blank parameters must be specified as "" on the command line.)
.SH DIAGNOSTICS
.B mindi
writes some output to the console and extensive information to log file
.IR /var/log/mindi.log ".
When seeking technical support for
.BR "mindi",
please attach this file to your email.
.SH FILES
.TP
.I /var/log/mindi.log
Log file of mindi run. Contains important information to analyze mindi problem
reports.
.TP
.I /etc/mindi/deplist.txt 
List of files to be included on boot/root disks.
.TP
.I /var/cache/mindi/N.tar.gz
Number N of multiple tar balls together containing root file system for rescue
media.
.TP
.I /var/cache/mindi/all.tar.gz
Single tar ball of root file system for rescue media.
.TP
.I /var/cache/mindi/initrd.img
initrd image for bootable ISO image.
.TP
.I /var/cache/mindi/mindi-bootroot.img
.B mindi
boot and root media.
.TP
.I /var/cache/mindi/mindi.iso
.B mindi
bootable ISO image.
.SH "SEE ALSO"
mondoarchive(8), mondorestore(8).
.TP
See mailing list at http://www.mondorescue.org for technical support.
.SH AUTHORS
Bruno Cornec (lead-development) 
.I "bruno_at_mondorescue.org"
.BR
Andree Leidenfrost (co-developer) 
.I "aleidenf_at_bigpond.net.au"
.BR
.SH ORIGINAL AUTHORS
Hugo Rabson (original author)
.I "hugo.rabson_at_mondorescue.org"
.BR
Jesse Keating (packaging)
.I "hosting_at_j2solutions.net"
.BR
Stan Benoit (testing)
.I "troff_at_nakedsoul.org"
.BR
Mikael Hultgren (docs)
.I "mikael_hultgren_at_gmx.net"
.BR
.