Fixed up base64_dump() users and interfaces to fix memory leaks
[jigit.git] / mkimage.1
1 .TH MKIMAGE 1 "September 2004" "Jigit jigdo tools"
2 .SH NAME
3 mkimage \- Create an ISO image from jigdo files
4 .SH SYNOPSIS
5 .B mkimage
6 \-j \f jigdo\fR \-t \f template\fR
7 [\fIoptions\fR]... 
8 .PP
9 .B mkimage
10 \-t \f template\fR \-z
11 [\fIoptions\fR]... 
12 .PP
13 .B mkimage
14 \-f \f md5\-list\fR -t \f template\fR \-M \f missing\-list\fR
15 [\fIoptions\fR]... 
16 .SH DESCRIPTION
17 .PP
18 mkimage knows how to parse a jigdo template file, commonly used when
19 creating Debian CDs and DVDs. It can be used to actually convert a
20 template file and associated files into an ISO image (hence the name
21 mkimage), or with some command line options it will output useful
22 information about the template file instead.
23 .TP
24 \fB\-t template file\fR
25 The jigdo .template file is the most important thing that mkimage
26 needs, and must be specified for all operations.
27 .TP
28 \fB\-j jigdo file\fR
29 The jigdo .jigdo file will normally acompany the .template file. To
30 rebuild the image you must specify \fBat least\fR one of the jigdo file and
31 an MD5 file (\fB\-f\fR).
32 .TP
33 \fB\-f MD5 file\fR
34 A file listing files available locally and their MD5 sums, in jigdo's
35 base64-like format. Can be generated by jigdo-file or jigsum. To
36 rebuild an image you must specify \fBat least\fR one of the MD5 file and
37 a jigdo file (\fB\-j\fR).
38 .TP
39 \fB\-m item=path\fR
40 Used in conjunction with a jigdo file; specify where mkimage should
41 look on the local filesystem to find the files it needs to make an
42 image. (e.g. "Debian=/mirror/debian").
43 .TP
44 \fB\-M missing file\fR
45 If you're not sure if you have all the files needs to create an image,
46 specify \fBboth\fR the jigdo file and an MD5 file along with the
47 template file and \-M <file>. mkimage will check to see that all the
48 files are available \fBinstead of\fR building the image. Any files
49 that are missing will be listed in the file specified here. See jigit
50 for usage examples.
51 .TP
52 \fB\-v\fR
53 Make mkimage more verbose. Additional -v arguments will make it
54 more verbose again. Default level is 0 (almost no output). 1 will
55 print progress in % while the image is being created; 2 will list
56 every file and data block that is appended to the image.
57 .TP
58 \fB\-l logfile\fR
59 mkimage will normally write to stderr when it reports
60 progress. Specify a logfile (or /dev/null) if you want it elsewhere.
61 .TP
62 \fB\-o outfile\fR
63 mkimage will normally write the ISO image to stdout, ready for piping
64 into cdrecord or to iso-image.pl. Specify an output filename if you
65 want it written to disk instead.
66 .TP
67 \fB\-q\fR
68 mkimage will normally check the MD5 sum of every file it reads and
69 writes, and will fail if it finds any mismatches. Specify \fB-q\fR to
70 tell it not to. This will normally run more quickly, but can leave you
71 with a broken image so is \fBPOTENTIALLY DANGEROUS\fR. Use with care!
72 .TP
73 \fB\-s start offset\fR
74 Rather than start at the beginning of the image, skip to the specified
75 offset and start output there. Probably only useful in iso-image.pl
76 when resuming a download. Specifying a non-zero offset also implies
77 \fB-q\fR, as it's difficult to check MD5 sums when you're not checking
78 the whole image.
79 \fB\-e end offset\fR
80 Rather than end at the end of the image, stop at the specified
81 offset. Probably only useful in iso-image.pl when resuming a
82 download. Specifying an end offset also implies \fB-q\fR, as it's
83 difficult to check MD5 sums when you're not checking the whole image.
84 .TP
85 \fB\-z\fR
86 Simply parse the template file and print the size of the image that
87 would be generated, in bytes. Only needs the template file to be
88 specified, any other arguments will ignored.
89 .SH "EXAMPLES"
90 .TP
91 \fBmkimage -f MD5 -j test.jigdo -t test.template -M missing\fR
92 Read in the files MD5, test.jigdo and test.template and check if all
93 the needed files are available. If any are missing, list them in missing.
94 .TP
95 \fBmkimage -z -t test.template\fR
96 Find out how big the ISO image would be from expanding test.template.
97 .TP
98 \fBmkimage -v -f MD5 -t test.template -o test.iso\fR
99 Build the iso image in test.iso, using files listed in MD5 to fill in
100 what's needed by the template file test.template. Show progress as the
101 image is built.
102 .SH "SEE ALSO"
103 \fBjigdo-file\fP(1), \fBjigit\fP(1), \fBjigsum\fP(1) and \fBjigdump\fP(1).
104 .SH "COPYRIGHT"
105 Copyright 2004 Steve McIntyre (steve@einval.com)
106 .PP
107 mkimage may be copied under the terms and conditions of version 2
108 of the GNU General Public License, as published by the Free
109 Software Foundation (Cambridge, MA, USA).
110 .SH "AUTHOR"
111 Written by Steve McIntyre (steve@einval.com)