mkjigsnap: Remove mention of the dead -T option
[jigit.git] / mkjigsnap.8
1 .TH MKJIGSNAP 8 "September 2004" "Jigit jigdo tools"
2 .SH NAME
3 mkjigsnap \- Create a snapshot tree on a jigdo server
4 .SH SYNOPSIS
5 .\" The single-jigdo command line
6 .B mkjigsnap
7 [OPTIONS]
8 <\-d \f snapshot_dir\fR>
9 <\-j \f jigdo_file\fR>
10 <\-k \f keyword\fR>
11 <\-m \f mirror\fR>
12 <\-n \f CD_name\fR>
13 <\-o \f output_directory\fR>
14 <\-t \f template_file\fR>
15 .\" The multi-jigdo command line
16 .br
17 .B mkjigsnap
18 [OPTIONS]
19 <\-d \f snapshot_dir\fR>
20 <\-m \f mirror\fR>
21 <\-J \f jigdo_list\fR>
22 <\-j \f jigdo_file\fR>
23 <\-k \f keyword\fR>
24 .SH DESCRIPTION
25 .PP
26 mkjigsnap creates snapshot directories for use by other jigdo
27 tools. It can be run in two distinct modes:
28
29 .SS "Jigit / single-jigdo mode"
30
31 To build a jigit .conf file for a single jigdo file: add the "\-n"
32 option with a CD name on the command line and only specify a single
33 jigdo to work with using "\-j".
34
35 Required arguments for this mode:
36 .TP
37 \fB\-d snapshot_dir\fR
38 Specify the output directory name to be used for the snapshot tree
39 (e.g. 20041011, rc1). In single-jigdo mode this will be
40 .B relative
41 to the output directory.
42 .TP
43 \fB\-j jigdo_file\fR
44 Specify the location of the jigdo file to be used.
45 .TP
46 \fB\-m mirror\fR
47 Specify the location of the mirror containing all the files
48 needed. This
49 .B must
50 be on the same filesystem as the output directory, as hard links will
51 be used to create the snapshot efficiently.
52 .TP
53 \fB\-n CD_name\fR
54 Specify the output name of the CD for jigit (e.g. warty, sarge-i386-1).
55 .TP
56 \fB\-o output_directory\fR
57 Specify the output location for the jigdo, template, conf and
58 snapshot. This
59 .B must
60 be on the same filesystem as the mirror, as hard links will be used to
61 create the snapshot efficiently.
62 .TP
63 \fB\-t template_file\fR
64 Specify the location of the template file to be used.
65
66 .SS "Multi-jigdo mode"
67
68 To build a snapshot tree for (potentially multiple) jigdo files: do
69 not specify the "\-n" option, and list as many jigdo files as desired,
70 either on the command line using multiple "\-j <jigdo>" options or
71 (better) via a file listing them with the "\-J" option.
72
73 Required arguments for this mode:
74 .TP
75 \fB\-d snapshot_dir\fR
76 Specify the output directory name to be used for the snapshot tree
77 (e.g. 20041011, rc1). 
78 .TP
79 \fB\-J jigdo_list\fR
80 Specify the location of a file listing the jigdo files to be used. May
81 be repeated multiple times for multiple list files if desired.
82 .TP
83 \fB\-j jigdo_file\fR
84 Specify the location of the jigdo file to be used. May be repeated
85 multiple times for multiple jigdo files, but it's better to use the
86 "-J" option to point at a file containing a list of jigdo files
87 instead.
88 .TP
89 \fB\-k keyword\fR
90 Specify the "keywords" which are used in the jigdo files (e.g. Debian,
91 Non-US, Ubuntu).
92 .TP
93 \fB\-m mirror\fR
94 Specify the location of the mirror containing all the files
95 needed. This
96 .B must
97 be on the same filesystem as the snapshot directory, as hard links
98 will be used to create the snapshot efficiently.
99
100 .SS "Options"
101
102 Optional arguments for both modes:
103 .TP
104 \fB\-f fail_log\fR
105 If any files are required by the specific jigdo files but are not
106 available in the mirror, list them in the output file fail_log for
107 reference.
108 .TP
109 \fB\-i ignore_list\fR
110 If any files are required by the specific jigdo files but are not
111 available in the mirror, list them in the ignore_list file to supress
112 errors about them.
113
114 .SH EXAMPLES
115 .TP
116 mkjigsnap \-o /tmp/mjs-test \-n mjs-test \-m /tmp/mirror \-j
117 ~/jigdo/update/debian-update-3.0r2.01-i386.jigdo \-t
118 ~/jigdo/update/debian-update-3.0r2.01-i386.template \-k Debian \-k
119 Non-US \-d 20041017
120
121 This command is an example of single-jigdo mode, used for Ubuntu jigit
122 generation. It creates a single jigit conf file using the supplied
123 jigdo/template file pair, looking for jigdo references to files in the
124 "Debian" and "Non-US" areas. Output the files into /tmp/mjs-test and
125 call them "mjs-test.<ext>", creating a snapshot of the needed files in
126 /tmp/mjs-test/20041017 by linking files from /tmp/mirror as needed.
127
128 .TP
129 mkjigsnap \-m /org/ftp/debian \-J ~/jigdo.list \-k Debian
130 \-d /org/jigdo-area/snapshot/Debian \-f ~/mkjigsnap-failed.log \-i
131 ~/mkjigsnap-ignore.list
132
133 This command is an example of multi-jigdo mode, as run to keep
134 http://us.cdimage.debian.org/cdimage/snapshot/ up to date. This reads
135 in all the jigdo files listed in ~/jigdo.list, building a list of all
136 the files referenced in the "Debian" area. It will then attempt to
137 build a snapshot tree of all those files under
138 /org/jigdo-area/snapshot/Debian by linking from /org/ftp/debian. Any
139 files that are missing will be listed into the output "missing" file
140 ~/mkjigsnap-failed.log for later checking, UNLESS they are already
141 listed in the "ignore" file ~/mkjigsnap-ignore.list.
142
143 .SH "SEE ALSO"
144 \fBjigdo-file\fP(1), \fBjigit\fP(1), \fBjigdump\fP(1) and \fBmkimage\fP(1).
145 .SH "COPYRIGHT"
146 Copyright 2004 - 2011 Steve McIntyre (steve@einval.com)
147 .PP
148 mkjigsnap may be copied under the terms and conditions of version 2 of
149 the GNU General Public License, as published by the Free Software
150 Foundation (Cambridge, MA, USA).
151 .SH "AUTHOR"
152 Written by Steve McIntyre (steve@einval.com)