~ubuntu-branches/debian/stretch/dkms/stretch

« back to all changes in this revision

Viewing changes to debian/scripts/dh_dkms.1

  • Committer: Bazaar Package Importer
  • Author(s): Giuseppe Iuculano, David Paleino, Giuseppe Iuculano
  • Date: 2010-01-27 10:02:27 UTC
  • mfrom: (1.1.13 upstream)
  • Revision ID: james.westby@ubuntu.com-20100127100227-p8fawacw9e4e2spw
Tags: 2.1.1.1-1
[ David Paleino ]
* [19ac85e] Added DKMS debhelper script (Closes: #553665)

[ Giuseppe Iuculano ]
* [9d66264] Imported Upstream version 2.1.1.1
* [0735c11] Removed 01_upstart.patch
* [ec26539] Merge from Ubuntu: Remove the init script and Upstart job.
  There is no reason that DKMS needs to run on boot; you can build
  modules for non-running kernels just fine at installation time.
* [48ff9a4] Correct a minor shell error in dkms_autoinstaller
* [5c76a45] Fixed a minor spelling error in dh_dkms man page
* [c611461] debian/preinst: Use set -e

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.07)
 
2
.\"
 
3
.\" Standard preamble:
 
4
.\" ========================================================================
 
5
.de Sp \" Vertical space (when we can't use .PP)
 
6
.if t .sp .5v
 
7
.if n .sp
 
8
..
 
9
.de Vb \" Begin verbatim text
 
10
.ft CW
 
11
.nf
 
12
.ne \\$1
 
13
..
 
14
.de Ve \" End verbatim text
 
15
.ft R
 
16
.fi
 
17
..
 
18
.\" Set up some character translations and predefined strings.  \*(-- will
 
19
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 
20
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
 
21
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
 
22
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
 
23
.\" nothing in troff, for use with C<>.
 
24
.tr \(*W-
 
25
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 
26
.ie n \{\
 
27
.    ds -- \(*W-
 
28
.    ds PI pi
 
29
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
 
30
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
 
31
.    ds L" ""
 
32
.    ds R" ""
 
33
.    ds C` ""
 
34
.    ds C' ""
 
35
'br\}
 
36
.el\{\
 
37
.    ds -- \|\(em\|
 
38
.    ds PI \(*p
 
39
.    ds L" ``
 
40
.    ds R" ''
 
41
'br\}
 
42
.\"
 
43
.\" Escape single quotes in literal strings from groff's Unicode transform.
 
44
.ie \n(.g .ds Aq \(aq
 
45
.el       .ds Aq '
 
46
.\"
 
47
.\" If the F register is turned on, we'll generate index entries on stderr for
 
48
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 
49
.\" entries marked with X<> in POD.  Of course, you'll have to process the
 
50
.\" output yourself in some meaningful fashion.
 
51
.ie \nF \{\
 
52
.    de IX
 
53
.    tm Index:\\$1\t\\n%\t"\\$2"
 
54
..
 
55
.    nr % 0
 
56
.    rr F
 
57
.\}
 
58
.el \{\
 
59
.    de IX
 
60
..
 
61
.\}
 
62
.\"
 
63
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
64
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
65
.    \" fudge factors for nroff and troff
 
66
.if n \{\
 
67
.    ds #H 0
 
68
.    ds #V .8m
 
69
.    ds #F .3m
 
70
.    ds #[ \f1
 
71
.    ds #] \fP
 
72
.\}
 
73
.if t \{\
 
74
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
75
.    ds #V .6m
 
76
.    ds #F 0
 
77
.    ds #[ \&
 
78
.    ds #] \&
 
79
.\}
 
80
.    \" simple accents for nroff and troff
 
81
.if n \{\
 
82
.    ds ' \&
 
83
.    ds ` \&
 
84
.    ds ^ \&
 
85
.    ds , \&
 
86
.    ds ~ ~
 
87
.    ds /
 
88
.\}
 
89
.if t \{\
 
90
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
91
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
92
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
93
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
94
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
95
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
96
.\}
 
97
.    \" troff and (daisy-wheel) nroff accents
 
98
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
99
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
100
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
101
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
102
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
103
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
104
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
105
.ds ae a\h'-(\w'a'u*4/10)'e
 
106
.ds Ae A\h'-(\w'A'u*4/10)'E
 
107
.    \" corrections for vroff
 
108
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
109
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
110
.    \" for low resolution devices (crt and lpr)
 
111
.if \n(.H>23 .if \n(.V>19 \
 
112
\{\
 
113
.    ds : e
 
114
.    ds 8 ss
 
115
.    ds o a
 
116
.    ds d- d\h'-1'\(ga
 
117
.    ds D- D\h'-1'\(hy
 
118
.    ds th \o'bp'
 
119
.    ds Th \o'LP'
 
120
.    ds ae ae
 
121
.    ds Ae AE
 
122
.\}
 
123
.rm #[ #] #H #V #F C
 
124
.\" ========================================================================
 
125
.\"
 
126
.IX Title "DH_DKMS 1"
 
127
.TH DH_DKMS 1 "2010-01-16" "2.1.1.0" "DKMS Debhelper"
 
128
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 
129
.\" way too many mistakes in technical documents.
 
130
.if n .ad l
 
131
.nh
 
132
.SH "NAME"
 
133
dh_dkms \- correctly handle DKMS usage by a kernel module package
 
134
.SH "SYNOPSIS"
 
135
.IX Header "SYNOPSIS"
 
136
\&\fBdh_dkms\fR [\fIdebhelper\ options\fR] [\fB\-l\fR] [\fB\-\-\fR\ \fIfile\fR]
 
137
.SH "DESCRIPTION"
 
138
.IX Header "DESCRIPTION"
 
139
dh_dkms is a debhelper program that is responsible for correctly setting
 
140
postinst, postrm and dependencies in kernel module packages using \s-1DKMS\s0.
 
141
.PP
 
142
If a file named debian/package.dkms exists, then different actions are
 
143
performed, depending on its contents.
 
144
.SH "FILES"
 
145
.IX Header "FILES"
 
146
.IP "debian/\fIpackage\fR.dkms" 4
 
147
.IX Item "debian/package.dkms"
 
148
.PD 0
 
149
.IP "debian/dkms" 4
 
150
.IX Item "debian/dkms"
 
151
.PD
 
152
It can be a proper configuration file, and in this case it would be installed
 
153
in the proper directory as dkms.conf.
 
154
.Sp
 
155
It can also point to another file (this should be used when the configuration
 
156
is provided by upstream), and in this case that file will be installed as dkms.conf
 
157
in the proper directory.
 
158
.Sp
 
159
This file can only miss if a filename is provided when calling dh_dkms.
 
160
.SH "OPTIONS"
 
161
.IX Header "OPTIONS"
 
162
.IP "\fB\-l\fR, \fB\-\-legacy\fR" 4
 
163
.IX Item "-l, --legacy"
 
164
Add code to also support \s-1DKMS\s0 versions < 2.1.0.0.
 
165
.IP "\fB\-\-\fR \fIfile\fR" 4
 
166
.IX Item "-- file"
 
167
Don't look for debian/\fIpackage\fR.dkms or debian/dkms, but install \fIfile\fR as dkms.conf.
 
168
.SH "NOTES"
 
169
.IX Header "NOTES"
 
170
Note that this command is not idempotent. \fIdh_prep\fR\|(1) should be called
 
171
between invocations of this command. Otherwise, it may cause multiple
 
172
instances of the same text to be added to maintainer scripts.
 
173
.SH "SEE ALSO"
 
174
.IX Header "SEE ALSO"
 
175
\&\fIdebhelper\fR\|(1)
 
176
.PP
 
177
This program is part of the Debian \s-1DKMS\s0 package.
 
178
.PP
 
179
\&\fIdkms\fR\|(8)
 
180
.SH "AUTHOR"
 
181
.IX Header "AUTHOR"
 
182
David Paleino <dapal@debian.org>