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

Last change on this file since 3586 was 3586, checked in by Bruno Cornec, 4 years ago

Improve man page accordingly with previour rev

File size: 5.7 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.TP
29.BR "mindi \-v"| " --version"| " \-V"| " -version"
30.TP
31.BI "mindi --findkernel"
32.TP
33.BI "mindi --makemountlist "file
34.TP
35.BI "mindi --usb "device
36.TP
37.BI "mindi --locatedeps "file
38.TP
39.BI "mindi --makemountlist "file
40.TP
41.BI "mindi --makemessage"
42.TP
43.BI "mindi --makebcf "bootloader
44.TP
45.BI "mindi --ironic "kernel " "initrd " "[BIOS|UEFI]
46[syslinux|grub|grub2] [/path/to/bootloader]
47.TP
48.BI "mindi [--max-compressed-size "max "] --custom " parameters
49.SH DESCRIPTION
50.PP
51.B mindi
52creates a bootable ISO/USB image using files from the system it runs on.
53.B mindi
54will try hard to reproduce the environment of its host system including loaded
55modules to ensure that the system can be booted properly from the created
56rescue media.
57.B mindi
58is used by
59.B monodarchive(8)
60to produce the required USB/ISO images but can also be used stand-alone.
61
62For stand-alone usage,
63.B mindi
64is called without any parameters or switches. It will then interactively ask
65the user for all information required to create a set of boot/root media.
66.LP
67The probably more frequent way of calling
68.B mindi
69is non-interactively from
70.B mondoarchive(8)
71using the
72.B --custom
73switch. All required information is then provided via command line parameters.
74The sequence of these parameters is listed below.
75.SH OPTIONS
76.TP
77.BI "\-v"| " --version"| " \-V"| " -version"
78Prints the version of mindi.
79.TP
80.BI "--findkernel"
81Finds the image of the running kernel in the file system.
82.TP
83.BI "--makemountlist "file
84Creates a mount list and writes it to file "file".
85.TP
86.BI "--usb "device
87Create a bootable USB device
88.TP
89.BI "--locatedeps "file
90Find all dependencies of a binary file
91.TP
92.BI "--makemountlist "file
93Create the mountlist of your system and write it to the file
94.TP
95.BI "--makemessage"
96Create the boot message file and display it
97.TP
98.BI "--makebcf "bootloader
99Create the boot configuration file for this bootloader and display it
100.TP
101.BI "--ironic "kernel " "initrd " "[BIOS|UEFI] " "[syslinux|grub|grub2] " "[/path/to/bootloader]
102Create 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.
103.TP
104.BI "--max-compressed-size "max
105Maximum size for disk image in KB.
106.TP
107.BI "--custom " parameters
108"Provide all required parameters to"
109.B mindi
110"for non-interactive calling. This usually means a call from"
111.BR "mondoarchive(8)".
112The following parameters are used:
113.BR
11401) directory to use for temporary files
115.BR
11602) directory to put disk images in
117.BR
11803) path to kernel image
119.BR
12004) tape device
121.BR
12205) tape size [MB]
123.BR
12406) total number of files in file list
125.BR
12607) use LZO [yes|no]
127.BR
12808) CD recovery media [yes|no]
129.BR
13009) devices to include
131.BR
13210) conservative LiLo settings [yes|no]
133.BR
13411) number of last file list
135.BR
13612) estimated total number of slices
137.BR
13813) devices to exclude
139.BR
14014) compare mode [yes|no]
141.BR
14215) use lilo [yes|no]
143.BR
14416) use star (rather than tar) [yes|no]
145.BR
14617) internal tape block size [bytes]
147.BR
14818) number of differential backup
149.BR
15019) make non-bootable [yes|no]
151.BR
15220) use gzip [yes|no]
153.BR
154(Blank parameters must be specified as "" on the command line.)
155.SH DIAGNOSTICS
156.B mindi
157writes some output to the console and extensive information to log file
158.IR /var/log/mindi.log ".
159When seeking technical support for
160.BR "mindi",
161please attach this file to your email.
162.SH FILES
163.TP
164.I /var/log/mindi.log
165Log file of mindi run. Contains important information to analyze mindi problem
166reports.
167.TP
168.I /etc/mindi/deplist.txt
169List of files to be included on boot/root disks.
170.TP
171.I /var/cache/mindi/N.tar.gz
172Number N of multiple tar balls together containing root file system for rescue
173media.
174.TP
175.I /var/cache/mindi/all.tar.gz
176Single tar ball of root file system for rescue media.
177.TP
178.I /var/cache/mindi/initrd.img
179initrd image for bootable ISO image.
180.TP
181.I /var/cache/mindi/mindi-bootroot.img
182.B mindi
183boot and root media.
184.TP
185.I /var/cache/mindi/mindi.iso
186.B mindi
187bootable ISO image.
188.SH "SEE ALSO"
189mondoarchive(8), mondorestore(8).
190.TP
191See mailing list at http://www.mondorescue.org for technical support.
192.SH AUTHORS
193Bruno Cornec (lead-development)
194.I "bruno_at_mondorescue.org"
195.BR
196Andree Leidenfrost (co-developer)
197.I "aleidenf_at_bigpond.net.au"
198.BR
199.SH ORIGINAL AUTHORS
200Hugo Rabson (original author)
201.I "hugo.rabson_at_mondorescue.org"
202.BR
203Jesse Keating (packaging)
204.I "hosting_at_j2solutions.net"
205.BR
206Stan Benoit (testing)
207.I "troff_at_nakedsoul.org"
208.BR
209Mikael Hultgren (docs)
210.I "mikael_hultgren_at_gmx.net"
211.BR
212.
Note: See TracBrowser for help on using the repository browser.