summaryrefslogtreecommitdiff
path: root/kit/makedist.man
blob: 0a13318351ce6c94d5f8a98ed09fae2ba5ae89e1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
.rn '' }`
''' $Id: makedist.man,v 3.0.1.2 1995/05/12 11:58:16 ram Exp ram $
'''
'''  Copyright (c) 1991-1997, 2004-2006, Raphael Manfredi
'''  
'''  You may redistribute only under the terms of the Artistic Licence,
'''  as specified in the README file that comes with the distribution.
'''  You may reuse parts of this distribution only within the terms of
'''  that same Artistic Licence; a copy of which may be found at the root
'''  of the source tree for dist 4.0.
'''
''' $Log: makedist.man,v $
''' Revision 3.0.1.2  1995/05/12  11:58:16  ram
''' patch54: updated my e-mail address
'''
''' Revision 3.0.1.1  1994/05/06  14:00:50  ram
''' patch23: now mentions kitpost and kitsend
'''
''' Revision 3.0  1993/08/18  12:04:31  ram
''' Baseline for dist 3.0 netwide release.
'''
''' 
.de Sh
.br
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp
.if t .sp .5v
.if n .sp
..
'''
'''     Set up \*(-- to give an unbreakable dash;
'''     string Tr holds user defined translation string.
'''     Bell System Logo is used as a dummy character.
'''
.ie n \{\
.tr \(*W-\*(Tr
.ds -- \(*W-
.if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.ds L" ""
.ds R" ""
.ds L' '
.ds R' '
'br\}
.el\{\
.ds -- \(em\|
.tr \*(Tr
.ds L" ``
.ds R" ''
.ds L' `
.ds R' '
'br\}
.TH MAKEDIST 1 LOCAL
.SH NAME
makedist \- a distribution kit maker
.SH SYNOPSIS
.B makedist
[ \fB\-dhqvV\fR ] [ \fB\-c\fI dir\fR ]
[ \fB\-s\fI size\fR ] [\fB\-f \fImanifest\fR ]
.SH DESCRIPTION
.I Makedist
is a rather simpleminded shar program that knows how to pack files
into multiple kits of approximately 50000 bytes each.
The shar scripts produced assume very little about the target machine;
there is correspondingly little error checking done compared to other
shar programs. Alternatively, with the \fB\-c\fR option, you can
create a directory containing the whole source tree, and then pack it
up using your own shell archiver.
.PP
If you are using the copyright expansion feature (as determined by
\fIpackinit\fR), then you have to pack your distribution using this
program to ensure the copyright is correctly set.
.PP
In order to run \fImakedist\fR you have to do two things:
.IP 1) 4
Create a .package file in the package's top-level directory by running
\fIpackinit\fR.
This program will ask you about your package and remember what you tell
it so that all the \fIdist\fR programs can be smart.
.IP 2) 4
Create a MANIFEST.new file in your top-level directory that lists all the
files in your package.
The filename should be the first field on each line.
After some whitespace you can add a comment describing your file (briefly).
.PP
After running \fImakedist\fR,
you will have a set of kits in your top-level directory.
If your package name is "foo", they will be named foo.kit1, foo.kit2, etc.
The file created PACKLIST file is automatically added to the distribution and
tells which files come with which kits.
If you used the \fB\-c\fR option, you will end-up with a single directory
instead, containing the whole distribution, ready to be sent to the end-user.
.PP
If a file is too large to be packed as-is in one archive, it will be
automatically split in smaller parts. Only the first 11 characters of the file
will be kept though, and \fImakedist\fR will abort if two distinct files are
to be split and have the same 11 first characters in their names. The split
files will automatically be reconstructed at the end of the archive extraction
by runnning a script generated in PACKNOTES.
.PP
You may then mail your kits via \fIkitsend\fR or post them with \fIkitpost\fR.
.SH OPTIONS
The following options are handled by \fImakedist\fR:
.TP 10
.B \-c \fIdir\fR
Tell \fImakedist\fR that the distribution should be copied (mirrored) in
the specified directory, instead of producing shell archives. Compatible with
the \fB\-q\fR option.
.TP
.B \-d
Turn on debug mode. Probably not useful.
.TP
\fB-f\fI file\fR
Use \fIfile\fR as manifest. By default, MANIFEST.new is used.
.TP
.B \-h
Print help message and exit.
.TP
.B \-q
Quick production of the kits: the checked-out version of the files is used,
instead of using the RCS file to actually get the latest checked-in version.
This will save some considerable time, but you have to be sure the checked-out
version is up-to-date or you might end up with an inconsistent package.
.TP
\fB\-s\fI size\fR
Set maximum kit size to \fIsize\fR bytes.
.TP
.B \-v
Verbose mode: trace kit building process or tree mirroring.
.TP
.B \-V
Print version number and exit.
.SH AUTHORS
Larry Wall <lwall@netlabs.com> (version 2.0)
.br
Raphael Manfredi <ram@hptnos02.grenoble.hp.com>
.SH FILES
Creates ./$package.kit* unless \fB\-c\fR option is used.
.br
PACKLIST and PACKNOTES are also temporarily created.
.SH "SEE ALSO"
kitsend(1), kitpost(1), metaconfig(1), patcol(1)
.rn }` ''