source: branches/stable/mondo-doc/mindi.8 @ 1060

Last change on this file since 1060 was 1060, checked in by bruno, 12 years ago
  • mindi now uses completely the configuration file, including for modules description
  • DidMondoCallMe? gone for MONDO_SHARE usage rather
  • deplist.txt is now empty and replaced by a lot of files under deplist.d
  • install and package script adapted accordingly
  • delivered in hope others will test and report :-)
File size: 5.2 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 --printvar "variable
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.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 "--printvar "variable
76.RI "prints the value of the variable (useful for mondo-archive and debug)"
77.TP
78.BI "--custom " parameters
79.RI "Provide all required parameters to"
80.B mindi
81.RI "for 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
12320) use gzip [yes|no]
124.br
125(Blank parameters must be specified as "" on the command line.)
126.SH DIAGNOSTICS
127.B mindi
128writes some output to the console and extensive information to log file
129.IR /var/log/mindi.log ".
130When seeking technical support for
131.BR "mindi",
132please attach this file to your email.
133.SH FILES
134.TP
135.I /var/log/mindi.log
136Log file of mindi run. Contains important information to analyze mindi problem
137reports.
138.TP
139.I /etc/mindi/deplist.d
140Files containing the list of files to be included on boot/root disks.
141.TP
142.I /etc/mindi/deplist.txt
143List of additional 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 floppy of size F [KB].
158.TP
159.I /var/cache/mindi/mindi-root.F.img
160.B mindi
161root floppy of size F [KB].
162.TP
163.I /var/cache/mindi/mindi-data.N.img
164.B mindi
165data floppy number N for boot/root floppies.
166.TP
167.I /var/cache/mindi/mindi.iso
168.B mindi
169bootable ISO image.
170.SH CONFIGURATION FILE
171You may create a mindi configuration file under
172.B /etc/mindi
173called
174.B mindi.conf
175which overwrites default values described in
176.B mindi.conf.dist
177in the same directory.
178.br
179.SH "SEE ALSO"
180mondoarchive(8), mondorestore(8).
181.TP
182See mailing list at http://www.mondorescue.org for technical support.
183.SH AUTHORS
184Bruno Cornec (lead-development)
185.I "bcornec_at_mondorescue.org"
186.br
187Andree Leidenfrost (co-developper)
188.I "aleidenf_at_bigpond.net.au"
189.br
190.SH ORIGINAL AUTHORS
191Hugo Rabson (original author)
192.I "hugo.rabson_at_mondorescue.org"
193.br
194Jesse Keating (packaging)
195.I "hosting_at_j2solutions.net"
196.br
197Stan Benoit (testing)
198.I "troff_at_nakedsoul.org"
199.br
200Mikael Hultgren (docs)
201.I "mikael_hultgren_at_gmx.net"
202.br
203.
Note: See TracBrowser for help on using the repository browser.