~ubuntu-branches/ubuntu/quantal/dh-make/quantal

« back to all changes in this revision

Viewing changes to dh_make.1

  • Committer: Bazaar Package Importer
  • Author(s): Craig Small
  • Date: 2006-11-01 08:30:21 UTC
  • mfrom: (1.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061101083021-mkdu8suq5t891dh7
* Stopped shiiping the kde examples (Closes: #372287)
* debiank/rules is executable (Closes: #372768)
* de-hypened man page (Closes: #372777)
* templates changed to use compat level 5 (Closes: #370468)
* Default priority extra in templates (Closes: #373603)
* MAKE install var=xx => MAKE var=xx install (Closes: #374175)
* Consitent formatting of maintainer script (Closes: #370488)
* Kernel module name consistent (Closes: #384085)
* bzip2 path was changed (Closes: #377523)
* fixes for cdbs template (Closes: #382042)
* Now supports ~ in upstream version number (Closes: #387465)
* fixed force-reload behaviour of init.d template to follow LSB
  (Closes: #377292)
* README.Debian the same author line as in changelog (Closes: #379773)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH DH_MAKE 8 "October 2001" "Debian Project" \" -*- nroff -*-
 
1
.TH DH_MAKE 8 "7 March 2006" "Debian Project" \" -*- nroff -*-
2
2
.SH NAME
3
3
dh_make \- Debianize a regular source archive
4
4
.SH SYNOPSIS
9
9
[\-\-library] [\-\-single] [\-\-multi] [\-\-kmod] [\-\-addmissing]
10
10
[\-\-templates directory] [\-\-defaultless] [\-\-overlay directory]
11
11
[\-\-packagename name]
12
 
[--help] [--version]
 
12
[\-\-help] [\-\-version]
13
13
.SH DESCRIPTION
14
14
.B dh_make
15
15
is a tool to convert a regular source code package into one formatted
16
16
according to the requirements of the Debian Policy.
17
17
.B dh_make
18
18
must be invoked within a directory containing the source code, which must
19
 
be named <packagename>-<version>. The <packagename> must be all lowercase,
 
19
be named <packagename>\-<version>. The <packagename> must be all lowercase,
20
20
digits and dashes. If the directory name does not conform to this scheme,
21
21
you must rename it before using 
22
22
.B dh_make.
35
35
.TP
36
36
.B Library (l)
37
37
The package will generate at least two binaries. One library package
38
 
containing just the lib in /usr/lib and another *-dev_*.deb package
 
38
containing just the lib in /usr/lib and another *\-dev_*.deb package
39
39
containing documentation and C headers.
40
40
.TP
41
41
.B Kernel module (k)
42
 
The package will generate a binary-all kernel module -source package for
43
 
use with the make-kpkg command. It also generates a binary package for
 
42
The package will generate a binary\-all kernel module \-source package for
 
43
use with the make\-kpkg command. It also generates a binary package for
44
44
additional utilities, daemons, etc. that may come with the source.
 
45
.TP
 
46
.B cdbs (b)
 
47
The package will be build using the Common Debian Build System.
 
48
CDBS provides a sane set of default rules upon which packages can build.
45
49
.SH ACTIONS PERFORMED
 
50
Unless \-\-native was given, 
46
51
.B dh_make
47
 
copies the archive on the higher directory level into
48
 
<packagename>-<version>.orig if that directory does not exist. If the -f
49
 
option is supplied, the specified file name is taken as the source archive.
 
52
makes sure a original source archive (<packagename>\-<version>.orig.tar.gz)
 
53
exists.
 
54
If no such file exists, the file specified with \-f is copied in place.
 
55
If no \-f is supplied either but \-\-createorig is, the current directory
 
56
it copied into <packagename>\-<version>.orig which will be made to this
 
57
archive by dpkg\-source later automatically.
50
58
The original archive is needed for other Debian tools to generate the
51
59
diffs to the original sources required by the Debian packaging format.
 
60
Unless there are reasons against it this file should be the pristine
 
61
upstream archive.
52
62
.PP
53
63
Then
54
64
.B dh_make
65
75
.B $EMAIL
66
76
or
67
77
.B $DEBEMAIL
68
 
is set, or the -e (--email) option is supplied, then that e-mail address
69
 
is used for the e-mail address of the maintainer (instead of looking it
 
78
is set, or the \-e (\-\-email) option is supplied, then that e\-mail address
 
79
is used for the e\-mail address of the maintainer (instead of looking it
70
80
up in the environment. An example, for bash:
71
81
.PP
72
82
export DEBEMAIL="jsmith@debian.org"
78
88
Renaming the example files to their name without the .ex at the end (and
79
89
editing them if necessary) will activate that feature of debhelper.
80
90
.PP
81
 
If the --templates or -o (--overlay) option is used
 
91
If the \-\-templates or \-o (\-\-overlay) option is used
82
92
.B dh_make
83
93
will apply a customizing template to the "debian" directory. See the
84
94
templates described in the FILES section of this manpage for samples.
85
95
.SH OPTIONS
86
96
.TP
87
 
.I -c, --copyright <license>
 
97
.I \-c, \-\-copyright <license>
88
98
Use <license> type in copyright file.  <license> can be gpl, lgpl, artistic
89
99
or bsd.  If this field is not specified the copyright file has a space to
90
100
fill in which sort of license is used. The field is case-insensitive so
91
 
-c GPL works as well as -c gpl.
 
101
\-c GPL works as well as \-c gpl.
92
102
.TP
93
 
.I -e, --email <address>
94
 
Use <address> as the e-mail address in the Maintainer: field of
 
103
.I \-e, \-\-email <address>
 
104
Use <address> as the e\-mail address in the Maintainer: field of
95
105
debian/control file.
96
106
.TP
97
 
.I -n, --native
 
107
.I \-n, \-\-native
98
108
Create a native Debian packages, i.e. do not generate a .orig archive, 
99
109
since it will be generated when building with dpkg-buildpackage.
100
 
The version number will not have a Debian revision number (e.g. -1)
 
110
The version number will not have a Debian revision number (e.g. \-1)
101
111
appended to it.
102
112
.TP
103
 
.I -f, --file <file>
 
113
.I \-f, \-\-file <file>
104
114
Use <file> as the original source archive, and skip the copying of the
105
115
current program tree to program.orig.
106
116
.TP
107
 
.I -l, --library
 
117
.I \-l, \-\-library
108
118
Automatically set the package class to Library, skipping the question.
109
119
.TP
110
 
.I -s, --single
 
120
.I \-s, \-\-single
111
121
Automatically set the package class to Single binary, skipping the question.
112
122
.TP
113
 
.I -m, --multi
 
123
.I \-m, \-\-multi
114
124
Automatically set the package class to Multiple binary, skipping the question.
115
125
.TP
116
 
.I -k, --kmod
 
126
.I \-k, \-\-kmod
117
127
Automatically set the package class to Kernel module, skipping the question.
118
128
.TP
119
 
.I -a, --addmissing
 
129
.I \-b, \-\-cdbs
 
130
Automatically set package class to cdbs, skipping the question.
 
131
.TP
 
132
.I \-a, \-\-addmissing
120
133
Adds missing example and control files on an existing debian source directory.
121
134
.TP
122
 
.I -t, --templates <directory>
 
135
.I \-t, \-\-templates <directory>
123
136
Applies the customizing templates in <directory> to the debian directory.
124
137
.TP
125
 
.I -o, --overlay <directory>
 
138
.I \-o, \-\-overlay <directory>
126
139
Applies a customization template to an existing debian directory.
127
140
.TP
128
 
.I -p, --packagename <name>
 
141
.I \-p, \-\-packagename <name>
129
142
Force the package name to be <name>, good for packages with hyphens in their
130
143
name or other strangeness.
131
144
.TP
132
 
.I -d, --defaultless
 
145
.I \-d, \-\-defaultless
133
146
Skips applying the default templates to the target debian directory.
134
147
.TP
135
 
.I -h, --help
 
148
.I \-h, \-\-help
136
149
Display the name, version, available options and authors, and exit
137
150
successfully.
138
151
.TP
139
 
.I -v, --version
 
152
.I \-v, \-\-version
140
153
Show the program name and version, and exit successfully.
141
154
.SH FILES
142
155
.TP
156
169
.B licenses/
157
170
template files for the more common licenses used in Debian packages
158
171
.SH SEE ALSO
159
 
.BR "dpkg(1), dpkg-buildpackage(1), debhelper(1), make-kpkg(1), /usr/share/doc/debhelper/README"
 
172
.BR "dpkg(1), dpkg\-buildpackage(1), debhelper(1), make\-kpkg(1), debhelper(7)"
160
173
.P
161
 
You may also want to read the Debian Policy (in /usr/share/doc/debian-policy)
 
174
You may also want to read the Debian Policy (in /usr/share/doc/debian\-policy)
162
175
and the New Maintainers' Guide (in /usr/share/doc/maint-guide).
163
176
.SH AUTHORS
164
177
Christoph Lameter <clameter@debian.org> wrote the original script, in sh.