Rename mkimage to jigit-mkimage
authorSteve McIntyre <steve@einval.com>
Sun, 13 Jun 2010 23:12:54 +0000 (00:12 +0100)
committerSteve McIntyre <steve@einval.com>
Sun, 13 Jun 2010 23:12:54 +0000 (00:12 +0100)
Makefile
iso-image.pl
jigit
jigit-mkimage.1 [new file with mode: 0644]

index c9bc57f..abaa8e8 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -1,10 +1,10 @@
-BINS = jigdump mkimage jigsum rsyncsum
+BINS = jigdump jigit-mkimage jigsum rsyncsum
 CFLAGS = -g -Wall -Werror -D_FILE_OFFSET_BITS=64 -D_LARGEFILE_SOURCE -D_LARGEFILE64_SOURCE
 #CC = gcc
 
 all: $(BINS)
 
-mkimage: mkimage.o endian.o md5.o
+jigit-mkimage: mkimage.o endian.o md5.o
        $(CC) -o $@ $+ -lz -lbz2
 
 jigsum: jigsum.o md5.o
index 8250e01..c27ce08 100755 (executable)
@@ -18,7 +18,7 @@ use File::Basename;
 use Socket;
 
 # Configure these for your system
-my $mkimage = "/usr/local/bin/mkimage";
+my $mkimage = "/usr/local/bin/jigit-mkimage";
 my $logfile = "/var/log/jigdo-logs/log.$$";
 my $template_dir = "/mirror/jigdo";
 my $matches = "-q -m Debian=/mirror/debian -m Non-US=/mirror/debian-non-US";
diff --git a/jigit b/jigit
index 9ef1f1b..ca6abe6 100755 (executable)
--- a/jigit
+++ b/jigit
@@ -87,7 +87,7 @@ echo
 rm -f $TMPDIR/jigit/jigdo/missing-list
 
 # Check if we have all the pieces we need
-mkimage -f $TMPDIR/jigit/files/md5-list \
+jigit-mkimage -f $TMPDIR/jigit/files/md5-list \
     -t $TMPDIR/jigit/jigdo/$TEMPLATE \
     -j $TMPDIR/jigit/jigdo/$JIGDO \
     -M $TMPDIR/jigit/jigdo/missing-list
@@ -118,7 +118,7 @@ if [ -e $TMPDIR/jigit/jigdo/missing-list ] ; then
 
     rm -f $TMPDIR/jigit/jigdo/missing-list
        # Check (again) if we have all the pieces we need
-    mkimage -f $TMPDIR/jigit/files/md5-list \
+    jigit-mkimage -f $TMPDIR/jigit/files/md5-list \
         -t $TMPDIR/jigit/jigdo/$TEMPLATE \
         -j $TMPDIR/jigit/jigdo/$JIGDO \
         -M $TMPDIR/jigit/jigdo/missing-list
@@ -134,7 +134,7 @@ printf "\r%5d files missing; all needed files available                       "
 echo
 echo
 # We should have all the bits; build the image
-mkimage -v -f $TMPDIR/jigit/files/md5-list \
+jigit-mkimage -v -f $TMPDIR/jigit/files/md5-list \
     -t $TMPDIR/jigit/jigdo/$TEMPLATE \
     -j $TMPDIR/jigit/jigdo/$JIGDO \
     -o $TMPDIR/jigit/jigdo/$CDNAME.iso \
diff --git a/jigit-mkimage.1 b/jigit-mkimage.1
new file mode 100644 (file)
index 0000000..02400d3
--- /dev/null
@@ -0,0 +1,111 @@
+.TH MKIMAGE 1 "September 2004" "Jigit jigdo tools"
+.SH NAME
+mkimage \- Create an ISO image from jigdo files
+.SH SYNOPSIS
+.B mkimage
+\-j \f jigdo\fR \-t \f template\fR
+[\fIoptions\fR]... 
+.PP
+.B mkimage
+\-t \f template\fR \-z
+[\fIoptions\fR]... 
+.PP
+.B mkimage
+\-f \f md5\-list\fR -t \f template\fR \-M \f missing\-list\fR
+[\fIoptions\fR]... 
+.SH DESCRIPTION
+.PP
+mkimage knows how to parse a jigdo template file, commonly used when
+creating Debian CDs and DVDs. It can be used to actually convert a
+template file and associated files into an ISO image (hence the name
+mkimage), or with some command line options it will output useful
+information about the template file instead.
+.TP
+\fB\-t template file\fR
+The jigdo .template file is the most important thing that mkimage
+needs, and must be specified for all operations.
+.TP
+\fB\-j jigdo file\fR
+The jigdo .jigdo file will normally acompany the .template file. To
+rebuild the image you must specify \fBat least\fR one of the jigdo file and
+an MD5 file (\fB\-f\fR).
+.TP
+\fB\-f MD5 file\fR
+A file listing files available locally and their MD5 sums, in jigdo's
+base64-like format. Can be generated by jigdo-file or jigsum. To
+rebuild an image you must specify \fBat least\fR one of the MD5 file and
+a jigdo file (\fB\-j\fR).
+.TP
+\fB\-m item=path\fR
+Used in conjunction with a jigdo file; specify where mkimage should
+look on the local filesystem to find the files it needs to make an
+image. (e.g. "Debian=/mirror/debian").
+.TP
+\fB\-M missing file\fR
+If you're not sure if you have all the files needs to create an image,
+specify \fBboth\fR the jigdo file and an MD5 file along with the
+template file and \-M <file>. mkimage will check to see that all the
+files are available \fBinstead of\fR building the image. Any files
+that are missing will be listed in the file specified here. See jigit
+for usage examples.
+.TP
+\fB\-v\fR
+Make mkimage more verbose. Additional -v arguments will make it
+more verbose again. Default level is 0 (almost no output). 1 will
+print progress in % while the image is being created; 2 will list
+every file and data block that is appended to the image.
+.TP
+\fB\-l logfile\fR
+mkimage will normally write to stderr when it reports
+progress. Specify a logfile (or /dev/null) if you want it elsewhere.
+.TP
+\fB\-o outfile\fR
+mkimage will normally write the ISO image to stdout, ready for piping
+into cdrecord or to iso-image.pl. Specify an output filename if you
+want it written to disk instead.
+.TP
+\fB\-q\fR
+mkimage will normally check the MD5 sum of every file it reads and
+writes, and will fail if it finds any mismatches. Specify \fB-q\fR to
+tell it not to. This will normally run more quickly, but can leave you
+with a broken image so is \fBPOTENTIALLY DANGEROUS\fR. Use with care!
+.TP
+\fB\-s start offset\fR
+Rather than start at the beginning of the image, skip to the specified
+offset and start output there. Probably only useful in iso-image.pl
+when resuming a download. Specifying a non-zero offset also implies
+\fB-q\fR, as it's difficult to check MD5 sums when you're not checking
+the whole image.
+\fB\-e end offset\fR
+Rather than end at the end of the image, stop at the specified
+offset. Probably only useful in iso-image.pl when resuming a
+download. Specifying an end offset also implies \fB-q\fR, as it's
+difficult to check MD5 sums when you're not checking the whole image.
+.TP
+\fB\-z\fR
+Simply parse the template file and print the size of the image that
+would be generated, in bytes. Only needs the template file to be
+specified, any other arguments will ignored.
+.SH "EXAMPLES"
+.TP
+\fBmkimage -f MD5 -j test.jigdo -t test.template -M missing\fR
+Read in the files MD5, test.jigdo and test.template and check if all
+the needed files are available. If any are missing, list them in missing.
+.TP
+\fBmkimage -z -t test.template\fR
+Find out how big the ISO image would be from expanding test.template.
+.TP
+\fBmkimage -v -f MD5 -t test.template -o test.iso\fR
+Build the iso image in test.iso, using files listed in MD5 to fill in
+what's needed by the template file test.template. Show progress as the
+image is built.
+.SH "SEE ALSO"
+\fBjigdo-file\fP(1), \fBjigit\fP(1), \fBjigsum\fP(1) and \fBjigdump\fP(1).
+.SH "COPYRIGHT"
+Copyright 2004 Steve McIntyre (steve@einval.com)
+.PP
+mkimage may be copied under the terms and conditions of version 2
+of the GNU General Public License, as published by the Free
+Software Foundation (Cambridge, MA, USA).
+.SH "AUTHOR"
+Written by Steve McIntyre (steve@einval.com)