summaryrefslogtreecommitdiff
path: root/bin/packinit.man
blob: 002b25ea0c7c81e0482dd877127e5a2604e74040 (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
148
''' $Id: packinit.man,v 3.0.1.4 1995/07/25 13:31:38 ram Exp $
'''
'''  Copyright (c) 1991-1993, 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 3.0.
'''
''' $Log: packinit.man,v $
''' Revision 3.0.1.4  1995/07/25  13:31:38  ram
''' patch56: fixed a typo
'''
''' Revision 3.0.1.3  1995/05/12  11:57:38  ram
''' patch54: updated my e-mail address
'''
''' Revision 3.0.1.2  1994/10/29  15:45:17  ram
''' patch36: added new variables cext, shext, changelog and changercs
'''
''' Revision 3.0.1.1  1994/01/24  13:54:31  ram
''' patch16: now documents variables set in .package by packinit
'''
''' Revision 3.0  1993/08/18  12:04:06  ram
''' Baseline for dist 3.0 netwide release.
'''
''' 
.TH PACKINIT 1 ram
.SH NAME
packinit \- initialize or update your .package file
.SH SYNOPSIS
.B packinit
.SH DESCRIPTION
.B Packinit
will create (or update) a \fI.package\fR file, so that all the
.B dist
tools can be smart and know some basic things about your package,
such as its revision number, or the e-mail address of its maintainer.
.PP
.I Packinit
should be run from the top level directory of your package, before
using any other \fIdist\fR tool. Later on, you may rerun it to
update some of its values.
.I Packinit
will create a single file and leave the remaining of
your directory undisturbed.
.SH VARIABLES
.I Packinit
defines the following variables in your \fI.package\fR file:
.TP 15
.PD 0
baserev
The baseline revision number.
.TP
cext
The list (space separated) of file extensions identifying potential holders of
C symbols. This is added to the default .[chyl] extension lookup.
Shell-style patterns may be used.
.TP
changelog
The name of the \fIChangeLog\fR file managed by \fIpatlog\fR.
.TP
changercs
Boolean stating whether RCS logs are to be made part of \fIChangeLog\fR.
.TP
copyright
Name of the file used for Copyright expansion.
.TP
ftpdir
Directory where patches are located on the FTP site.
.TP
ftpsite
Name of the FTP site where patches may be retrieved from.
.TP
list_addr
Address of the package mailing list where users may post messages to.
.TP
list_manager
Type of list manager attached to the list administrative request address.
.TP
list_name
Name of the package users mailing list.
.TP
list_request
Address where subscribe and unsubscribe requests for the package mailing
list should be sent to.
.TP
list_sub
Format of the subscribe requests.
.TP
list_unsub
Format of the unsubscribe requests.
.TP
list_users
A boolean string set to 'true' when there is a mailing list set up for
discussion about the package.
.TP
mailagent
A boolean string set to 'true' when people are allowed to retrieve
patches via mailagent \fI@SH mailpatch\fR commands.
.TP
maintloc
E-mail address of the package maintainer, preferably in Internet format.
.TP
maintname
Full name of the package maintainer.
.TP
mydiff
Name of the \fIdiff\fR program to be used when computing a patch.
.TP
newsgroups
Newsgroup list where new patches should be posted to, empty for no
postings.
.TP
orgname
Full name of the organization where the package maitainer resides, or
path to a file containing that name.
.TP
package
Name of the package.
.TP
packver
Version of the \fIpackinit\fR program that built the \fI.package\fR file.
.TP
patchbranch
Name of the RCS branch used to store subsequent updates of a file after
a baseline has been released.
.TP
recipients
People who should be sent newly issued patches.
.TP
shext
The list (space separated) of file extensions identifying potential holders of
shell symbols. This is added to the default .SH extension lookup.
Shell-style patterns may be used. Note that only .SH extensions are looked
up by Configure for automatic shell extraction with variable substitutions,
no matter what this variable is set to.
.PD
.SH FILE
.TP 15
\&.package
File holding all the package-related values
.SH AUTHORS
Larry Wall <lwall@netlabs.com> (version 2.0)
.br
Raphael Manfredi <ram@hptnos02.grenoble.hp.com>
.SH "SEE ALSO"
dist(1).