9
9
[\-\-library] [\-\-single] [\-\-multi] [\-\-kmod] [\-\-addmissing]
10
10
[\-\-templates directory] [\-\-defaultless] [\-\-overlay directory]
11
11
[\-\-packagename name]
12
[\-\-help] [\-\-version]
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.
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
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.
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.
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,
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)
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
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:
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.
81
If the --templates or -o (--overlay) option is used
91
If the \-\-templates or \-o (\-\-overlay) option is used
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.
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.
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.
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)
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.
108
118
Automatically set the package class to Library, skipping the question.
111
121
Automatically set the package class to Single binary, skipping the question.
114
124
Automatically set the package class to Multiple binary, skipping the question.
117
127
Automatically set the package class to Kernel module, skipping the question.
130
Automatically set package class to cdbs, skipping the question.
132
.I \-a, \-\-addmissing
120
133
Adds missing example and control files on an existing debian source directory.
122
.I -t, --templates <directory>
135
.I \-t, \-\-templates <directory>
123
136
Applies the customizing templates in <directory> to the debian directory.
125
.I -o, --overlay <directory>
138
.I \-o, \-\-overlay <directory>
126
139
Applies a customization template to an existing debian directory.
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.
145
.I \-d, \-\-defaultless
133
146
Skips applying the default templates to the target debian directory.
136
149
Display the name, version, available options and authors, and exit
140
153
Show the program name and version, and exit successfully.
157
170
template files for the more common licenses used in Debian packages
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)"
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).
164
177
Christoph Lameter <clameter@debian.org> wrote the original script, in sh.