Skip to content
Newer
Older
100644 259 lines (249 sloc) 8.78 KB
f3b6b54 Various bugfixes for 0.59
Craig Small authored Jun 19, 2011
1 .TH DH_MAKE 8 2011-06-19 "Debian Project"
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
2 .SH NAME
e14ce3a * Removed example dirs file Closes: #540370
csmall authored Sep 6, 2009
3 dh_make \- prepare Debian packaging for an original source archive
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
4 .SH SYNOPSIS
5 .B dh_make
33c68d9 rulesformat option added
csmall authored Jun 19, 2010
6 [\-nlsmiadhr] [\-c license] [\-e address] [\-f file] [\-t directory]
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
7 [\-o directory] [\-p name] [\-\-copyright license]
8 [\-\-email address] [\-\-native] [\-\-file file]
5386616 * Standards version now 3.8.1
csmall authored Mar 14, 2009
9 [\-\-library] [\-\-single] [\-\-indep] [\-\-multi] [\-\-kmod] [\-\-kpatch]
10 [\-\-addmissing]
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
11 [\-\-templates directory] [\-\-defaultless] [\-\-overlay directory]
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 5, 2011
12 [\-\-packagename name]
33c68d9 rulesformat option added
csmall authored Jun 19, 2010
13 [\-\-rulesformat format]
bc3a8ce dh-make: Stopped shiping the kde examples (Closes: #372287)
csmall authored Jun 22, 2006
14 [\-\-help] [\-\-version]
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
15 .SH DESCRIPTION
16 .B dh_make
17 is a tool to convert a regular source code package into one formatted
18 according to the requirements of the Debian Policy.
19 .B dh_make
20 must be invoked within a directory containing the source code, which must
bc3a8ce dh-make: Stopped shiping the kde examples (Closes: #372287)
csmall authored Jun 22, 2006
21 be named <packagename>\-<version>. The <packagename> must be all lowercase,
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
22 digits and dashes. If the directory name does not conform to this scheme,
23 you must rename it before using
24 .B dh_make.
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
25 Alternatively, you may be able to use the \fB\-\-packagename\fR option to force
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
26 the package name.
27 .br
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
28 .SS PACKAGE CLASSES
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
29 .TP
30 .B Single binary (s)
31 The package will generate a single binary .deb package. It is the standard
32 case, so if you don't know what to do, choose this.
33 .TP
5386616 * Standards version now 3.8.1
csmall authored Mar 14, 2009
34 .B Arch-Independent (i)
f3b6b54 Various bugfixes for 0.59
Craig Small authored Jun 19, 2011
35 The package will generate a single package that is arch-independent.
5386616 * Standards version now 3.8.1
csmall authored Mar 14, 2009
36 .TP
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
37 .B Multiple binary (m)
38 The package will generate multiple binary .deb packages from one source
39 package. Choose this for larger packages that need to be split.
40 .TP
41 .B Library (l)
42 The package will generate at least two binaries. One library package
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
43 containing just the lib in \fI/usr/lib\fR and another *\-dev_*.deb package
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
44 containing documentation and C headers.
45 .TP
46 .B Kernel module (k)
bc3a8ce dh-make: Stopped shiping the kde examples (Closes: #372287)
csmall authored Jun 22, 2006
47 The package will generate a binary\-all kernel module \-source package for
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
48 use with the
49 .BR make\-kpkg (1)
50 command. It also generates a binary package for
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
51 additional utilities, daemons, etc. that may come with the source.
52 .TP
580e4b5 * CMake support from Sune Vuorela Closes: #490940
csmall authored Nov 3, 2008
53 .B Kernel patch
54 The package will generate a package that can be used for kernel patches.
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
55 .SS ACTIONS PERFORMED
56 Unless \fB\-\-native\fR was given,
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
57 .B dh_make
651a0dc * dh_make.1 uses correct orig file Closes: #487808
csmall authored Jun 27, 2008
58 makes sure a original source archive (<packagename>_<version>.orig.tar.gz)
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
59 exists. The archive can either end with .gz or one of the other supported
60 compression extensions such as bz2 or lzma.
61 If no such file exists, the file specified with \fB\-f\fR is copied in place.
62 If no \fB\-f\fR is supplied either but \fB\-\-createorig\fR is, the current
63 directory is created into a news archive
64 .I ../<packagename>\-<version>.orig.tar.gz
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
65 The original archive is needed for other Debian tools to generate the
66 diffs to the original sources required by the Debian packaging format.
b6b8db9 minor dh_make.1 fix and source/format fix
csmall authored Mar 8, 2010
67 Unless there are reasons against it, this file should be the pristine
997c0ca * Upgraded to standards version 3.7.2 Closes: #366697
csmall authored Jun 2, 2006
68 upstream archive.
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
69 .PP
70 Then
71 .B dh_make
72 proceeds to generate a "debian" subdirectory and the necessary control
73 files in the program source directory. Those control files are customized
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
74 with the packagename and version extracted from the directory name.
75
76 .B dh_make
77 makes several attempts to obtain the username. It first checks for the
78 environment variables \fB$DEBFULLNAME\fR, \fB$LOGNAME\fR is used to
79 find a name in the \fI/etc/passwd\fR file, and through NIS, YP
80 and LDAP.
81
ac337ed Various 0.60 fixes
Craig Small authored Feb 19, 2012
82 The e\-mail address can either be specified with the -fB\-\-email\fR option
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
83 or
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
84 .B dh_make
85 will attempt to find it. It will first check the environment variables
86 \fB$DEBEMAIL\fR and then \fB$EMAIL. If they are not set then
87 .B dh_make
88 will search an available LDAP directory using
89 .BR ldapsearch (1)
90 using \fB$LOGNAME\fR as the uid to search under. Finally it will use
91 \fB$LOGNAME\fR and \fI/etc/mailname\fR to generate an email address.
92
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
93 .B dh_make
94 will also generate example files that are also customized for the package
95 generated. You can remove all files with *.ex if you wish. You can also
96 delete the README.Debian file if you don't have anything to put in it.
97 Renaming the example files to their name without the .ex at the end (and
98 editing them if necessary) will activate that feature of debhelper.
99 .PP
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
100 If the \fB\-\-templates\fR or \fB\-o\fR (\fB\-\-overlay\fR) option is used
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
101 .B dh_make
102 will apply a customizing template to the "debian" directory. See the
103 templates described in the FILES section of this manpage for samples.
104 .SH OPTIONS
105 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
106 .BR \-c ", " \-\-copyright\ \fIlicense\fR
107 Use \fIlicense\fR type in copyright file. \fIlicense\fR can be gpl, gpl2,
108 gpl3, lgpl, lgpl2 lgpl3, artistic, apache, bsd or x11.
109 If this field is not specified the copyright file has a space to
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
110 fill in which sort of license is used. The field is case-insensitive so
5386616 * Standards version now 3.8.1
csmall authored Mar 14, 2009
111 \-c GPL works as well as \-c gpl. gpl and lgpl will give you version 3
112 of the corresponding license, apache implies Apache v2.0. If you need a
113 different version, change the
114 license file afterwards or use the gpl2 and lgpl2 options.
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
115 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
116 .BR \-e ", " \-\-email\ \fIaddress\fR
117 Use \fIaddress\fR as the e\-mail address in the Maintainer: field of
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
118 debian/control file.
119 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
120 .BR \-n ", " \-\-native
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
121 Create a native Debian packages, i.e. do not generate a .orig archive,
122 since it will be generated when building with dpkg-buildpackage.
bc3a8ce dh-make: Stopped shiping the kde examples (Closes: #372287)
csmall authored Jun 22, 2006
123 The version number will not have a Debian revision number (e.g. \-1)
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
124 appended to it.
125 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
126 .BR \-f ", " \-\-file\ \fIfile\fR
127 Use \fIfile\fR as the original source archive, and skip the copying of the
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
128 current program tree to program.orig.
129 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
130 .BR \-l ", " \-\-library
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
131 Automatically set the package class to Library, skipping the question.
132 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
133 .BR \-s ", " \-\-single
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
134 Automatically set the package class to Single binary, skipping the question.
135 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
136 .BR \-i ", " \-\-indep
5386616 * Standards version now 3.8.1
csmall authored Mar 14, 2009
137 Automatically set the package class to arch-independent binary, skipping the question.
138 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
139 .BR \-m ", " \-\-multi
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
140 Automatically set the package class to Multiple binary, skipping the question.
141 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
142 .BR \-k ", " \-\-kmod
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
143 Automatically set the package class to Kernel module, skipping the question.
144 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
145 .B \-\-kpatch
580e4b5 * CMake support from Sune Vuorela Closes: #490940
csmall authored Nov 3, 2008
146 Automatically set package class to kpatch, skipping the question.
147 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
148 .BR \-a ", " \-\-addmissing
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
149 Adds missing example and control files on an existing debian source directory.
150 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
151 .BR \-t ", " \-\-templates\ \fIdirectory\fR
152 Applies the customizing templates in \fIdirectory\fR to the debian directory.
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
153 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
154 .BR \-o ", " \-\-overlay\ \fIdirectory\fR
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
155 Applies a customization template to an existing debian directory.
156 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
157 .BR \-p ", " \-\-packagename\ \fIname\fR
158 Force the package name to be \fIname\fR, good for packages with hyphens in their
159 name or other strangeness. You can also make the parameter
160 .IR name \_ version
5386616 * Standards version now 3.8.1
csmall authored Mar 14, 2009
161 which will set both the package name and version and bypass and directory
162 checking.
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
163 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
164 .BR \-d ", " \-\-defaultless
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
165 Skips applying the default templates to the target debian directory.
166 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
167 .BR \-h ", " \-\-help
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
168 Display the name, version, available options and authors, and exit
169 successfully.
170 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
171 .BR \-r ", " \-\-rulesformat\ \fIformat\fR
172 Set the format for the debian/rules file to \fIformat\fR. The options are
33c68d9 rulesformat option added
csmall authored Jun 19, 2010
173 the default Debhelper v7 minimal rules (dh7), the old rules format (old)
174 or CDBS format (cdbs).
175 .TP
3bb4f56 standards, cleanup, license changes
Craig Small authored Jan 4, 2011
176 .BR \-v ", " \-\-version
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
177 Show the program name and version, and exit successfully.
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
178 .SH ENVIRONMENT
580bac6 typo in dh_make.1 #554392
csmall authored Nov 5, 2009
179 The following environment settings are used by \fBdh\_make\fR:
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
180 .TP
181 .B DEBEMAIL
182 Email address to use in control and changelog entries.
183 .TP
184 .B DEBFULLNAME
185 You full name, eg "John Doe" which will appear in the control and changelog
186 entries.
187 .TP
188 .B EMAIL
189 Email address to use in control and changelog entries, only used if \fBDEBEMAIL\fR is no set.
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
190 .TP
191 .B LOGNAME
192 Default username used for looking up email and full name in other directories.
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
193 .SH FILES
194 .TP
195 .I /usr/share/debhelper/dh_make
196 Directory that contains all the template files, separated in six
197 directories:
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
198 .TP
199 .I debian/
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
200 with files for all package classes,
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
201 .TP
202 .I debians/
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
203 with files specific to the Single binary class,
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
204 .TP
205 .I debianm/
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
206 with files specific to the Multiple binary class,
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
207 .TP
208 .I debianl/
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
209 with files specific to the Library class, and finally,
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
210 .TP
211 .I native/
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
212 with files specific to the native Debian packages.
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
213 .TP
214 .I licenses/
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
215 template files for the more common licenses used in Debian packages
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
216 .SH EXAMPLES
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
217 .PP
218 To get \fBdh\_make\fR to use the defaults and ask you various questions
219 about the package
220 .in +4n
221 .nf
222
223 dh_make
224
225 .fi
226 .in
227 .PP
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
228 Create your single class package using the with the GPL license:
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
229 .in +4n
230 .nf
231
232 dh_make \-s \-c gpl
233
234 .fi
235 .in
236 .PP
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
237 A more involved example where you set your name in the environment, contact \
238 email and license in the options and specify the upstream file:
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
239 .in +4n
240 .nf
241
242 DEBFULLNAME="John Doe"
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
243 .br
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
244 dh_make \-\-email contact@example.com \-\-copyright=bsd \\
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
245 .br
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
246 \ \-\-file ../foo.tar.gz
65f0518 Increased the compat version, remerge/fix differing SVN versions
csmall authored May 9, 2008
247
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
248 .fi
249 .in
315700c Fixed kdist_clean target Closes: #432816
csmall authored Feb 1, 2010
250 .SH BUGS
251 .B dh_make
252 may not detect your username and email address correctly when using sudo.
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
253 .SH SEE ALSO
ac337ed Various 0.60 fixes
Craig Small authored Feb 19, 2012
254 .BR dpkg (1), dpkg\-buildpackage (1), dh (1), make\-kpkg (1), debhelper (7)
d12c667 [svn-inject] Installing original source of dh-make
csmall authored Jun 2, 2006
255 .P
0ba4b2c lintian fixes and man pagee update
Craig Small authored Jan 5, 2011
256 You may also want to read the Debian Policy (in
257 \fI/usr/share/doc/debian\-policy \fR) and the New Maintainers' Guide (in
258 \fI/usr/share/doc/maint-guide\fR).
Something went wrong with that request. Please try again.