diff options
Diffstat (limited to 'man')
-rw-r--r-- | man/kernel-wedge-build-all.1 | 16 | ||||
-rw-r--r-- | man/kernel-wedge-build-arch.1 | 18 | ||||
-rw-r--r-- | man/kernel-wedge-check.1 | 12 | ||||
-rw-r--r-- | man/kernel-wedge-copy-modules.1 | 13 | ||||
-rw-r--r-- | man/kernel-wedge-find-dups.1 | 13 | ||||
-rw-r--r-- | man/kernel-wedge-find-unpackaged.1 | 12 | ||||
-rw-r--r-- | man/kernel-wedge-gen-control.1 | 64 | ||||
-rw-r--r-- | man/kernel-wedge-gen-deps.1 | 12 | ||||
-rw-r--r-- | man/kernel-wedge-help.1 | 11 | ||||
-rw-r--r-- | man/kernel-wedge-install-files.1 | 9 | ||||
-rw-r--r-- | man/kernel-wedge-preprocess.1 | 28 | ||||
-rw-r--r-- | man/kernel-wedge.1 | 15 |
12 files changed, 223 insertions, 0 deletions
diff --git a/man/kernel-wedge-build-all.1 b/man/kernel-wedge-build-all.1 new file mode 100644 index 0000000..4cfb5ea --- /dev/null +++ b/man/kernel-wedge-build-all.1 @@ -0,0 +1,16 @@ +.TH KERNEL\-WEDGE\-BUILD\-ALL 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-build\-all \- build udebs for all architectures +.SH SYNOPSIS +.B kernel\-wedge build\-all +.SH DESCRIPTION +This is a wrapper script that can be used to build all architectures. + +The script builds all architectures listed in kernel\-versions. +It expects to have the unpacked kernel packages for various arches in +\a../alpha, etc. modules.dep files have to be put in there too if they are +not shipped in the .deb (varies) + +\fBdpkg\-cross\fR must be installed, but you do not need a cross compiler. +.SH AUTHOR +Joey Hess diff --git a/man/kernel-wedge-build-arch.1 b/man/kernel-wedge-build-arch.1 new file mode 100644 index 0000000..87255c8 --- /dev/null +++ b/man/kernel-wedge-build-arch.1 @@ -0,0 +1,18 @@ +.TH KERNEL\-WEDGE\-BUILD\-ARCH 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-build\-arch \- build udebs for a single architecture +.SH SYNOPSIS +.B kernel\-wedge build\-arch +.I architecture +.SH DESCRIPTION +This is a wrapper script to build a specific architecture. + +It takes the architecture to be built as parameter and that architecture +needs to be listed in kernel-versions. +It expects to have the unpacked kernel packages for the architecture in +e.g. ../alpha. modules.dep files have to be put in there too if they are +not shipped in the .deb (varies) + +\fBdpkg-cross\fR must be installed, but you do not need a cross compiler. +.SH AUTHOR +Frans Pop diff --git a/man/kernel-wedge-check.1 b/man/kernel-wedge-check.1 new file mode 100644 index 0000000..03864f2 --- /dev/null +++ b/man/kernel-wedge-check.1 @@ -0,0 +1,12 @@ +.TH KERNEL\-WEDGE\-CHECK 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-check \- check files installed in package directories +.SH SYNOPSIS +.B kernel\-wedge check +.SH DESCRIPTION +Check for various problems in the packages. + +Return 1 if any problems are found, unless $KW_CHECK_NONFATAL is +non-empty. +.SH AUTHOR +Joey Hess diff --git a/man/kernel-wedge-copy-modules.1 b/man/kernel-wedge-copy-modules.1 new file mode 100644 index 0000000..a52fa0d --- /dev/null +++ b/man/kernel-wedge-copy-modules.1 @@ -0,0 +1,13 @@ +.TH KERNEL\-WEDGE\-COPY\-MODULES 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-copy\-modules \- install modules into package directories +.SH SYNOPSIS +.B kernel\-wedge copy\-modules +.I version flavour installedname +.SH DESCRIPTION +Copy modules into the right directories in preparation for building udebs. + +Return 1 if a required module is missing, unless $KW_CHECK_NONFATAL is +non-empty. +.SH AUTHOR +Joey Hess diff --git a/man/kernel-wedge-find-dups.1 b/man/kernel-wedge-find-dups.1 new file mode 100644 index 0000000..450c69b --- /dev/null +++ b/man/kernel-wedge-find-dups.1 @@ -0,0 +1,13 @@ +.TH KERNEL\-WEDGE\-FIND\-DUPS 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-find\-dups \- find duplicate modules in package directories +.SH SYNOPSIS +.B kernel\-wedge find\-dups +.I kernel-name +.SH DESCRIPTION +Find duplicate modules. Pass the kernel name. + +Return 1 if any duplicates are found, unless $KW_CHECK_NONFATAL is +non-empty or the configuration file 'ignore\-dups' exists. +.SH AUTHOR +Joey Hess diff --git a/man/kernel-wedge-find-unpackaged.1 b/man/kernel-wedge-find-unpackaged.1 new file mode 100644 index 0000000..fd53b2a --- /dev/null +++ b/man/kernel-wedge-find-unpackaged.1 @@ -0,0 +1,12 @@ +.TH KERNEL\-WEDGE\-FIND\-UNPACKAGED 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-find\-unpackaged - list modules not packaged in a udeb +.SH SYNOPSIS +.B kernel\-wedge find\-unpackaged +.I kernel\-name +.SH DESCRIPTION +List modules that are not packaged in a udeb. Pass the kernel name. + +Always return 0. +.SH AUTHOR +Ben Hutchings <ben@decadent.org.uk> diff --git a/man/kernel-wedge-gen-control.1 b/man/kernel-wedge-gen-control.1 new file mode 100644 index 0000000..49b4707 --- /dev/null +++ b/man/kernel-wedge-gen-control.1 @@ -0,0 +1,64 @@ +.TH KERNEL\-WEDGE\-GEN\-CONTROL 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-gen\-control \- generate debian/control file +.SH SYNOPSIS +.B kernel\-wedge gen\-control +.SH DESCRIPTION +Generate a debian/control from the control stub, the kernel\-versions +files, and the package\-list files. + +For each kernel version and flavour, and for each module list defined +for that flavour, \fBgen\-control\fR will create a binary package control +paragraph. This is normally based on a template in the package\-list +in the default-configuration directory. + +Templates are processed as follows: + +.IP 1. 4 +For each standard control field \fIname\fR, copy the template control +field \fIname\fR_\fIflavour\fR, \fIname\fR_\fIarch\fR_\fIflavour\fR, +\fIname\fR_\fIarch\fR, or \fIname\fR (in descending order of priority). +.IP 2. 4 +Append the kernel version and flavour to package names in the +Package and Depends fields. +.IP 3. 4 +Stop processing the package if it has been excluded. +.IP 4. 4 +Set the Architecture, Package\-Type, Kernel\-Version, and Section +fields automatically. +.IP 5. 4 +Remove any package that is not going to be built from the Depends +field. This can be overridden by adding a "!" to the dependency +name. +.IP 6. 4 +Add the original (unsuffixed) package name to the Provides field. +.IP 7. 4 +Emit the processed control paragraph. +.RE + +The package\-list in the configuration directory may add new package +templates or override template field values. For example: + +.RS 4 +.EX +# This file is used to build up the control file. The kernel version and +# "\-di" are appended to the package names. Section can be left out. So can +# architecture, which is derived from the files in the modules directory. +# It overwrites specifications from /usr/share/kernel\-wedge/package\-list. +Package: fat\-modules +Priority: standard + +Package: nic\-modules +Depends: kernel\-image, nic\-shared\-modules, core\-modules, firewire\-core\-modules + +Package: other\-modules +Depends: kernel\-image +Description: some other modules I like to have in the installer +.EE +.RE + +The configuration directory may have an exclude\-packages file that +lists any udebs (by full package name) that would normally be built, +but should be excluded from the control file. +.SH AUTHOR +Joey Hess, Ben Hutchings <ben@decadent.org.uk> diff --git a/man/kernel-wedge-gen-deps.1 b/man/kernel-wedge-gen-deps.1 new file mode 100644 index 0000000..c9bf9d8 --- /dev/null +++ b/man/kernel-wedge-gen-deps.1 @@ -0,0 +1,12 @@ +.TH KERNEL\-WEDGE\-GEN\-DEPS 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-gen\-deps \- generate package dependency list +.SH SYNOPSIS +.B kernel\-wedge gen\-deps +.I flavour +.SH DESCRIPTION +Generates from the package\-list a dependency file for the given kernel +flavour, suitable to be fed to tsort. The file has the base package name on +the left, and the package it depends on is on the right. It is sorted. +.SH AUTHOR +Joey Hess diff --git a/man/kernel-wedge-help.1 b/man/kernel-wedge-help.1 new file mode 100644 index 0000000..3f7a246 --- /dev/null +++ b/man/kernel-wedge-help.1 @@ -0,0 +1,11 @@ +.TH KERNEL\-WEDGE\-HELP 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-help \- display online help +.SH SYNOPSIS +.B kernel\-wedge help +.I command +.SH DESCRIPTION +The \fBhelp\fR command displays the manual page for a \fBkernel-wedge\fR +command. +.SH AUTHOR +Joey Hess diff --git a/man/kernel-wedge-install-files.1 b/man/kernel-wedge-install-files.1 new file mode 100644 index 0000000..d0d5da9 --- /dev/null +++ b/man/kernel-wedge-install-files.1 @@ -0,0 +1,9 @@ +.TH KERNEL\-WEDGE\-INSTALL\-FILES 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-install\-files \- install files into package directories +.SH SYNOPSIS +.B kernel\-wedge install\-files +.SH DESCRIPTION +Create and populate the package build directories. +.SH AUTHOR +Joey Hess diff --git a/man/kernel-wedge-preprocess.1 b/man/kernel-wedge-preprocess.1 new file mode 100644 index 0000000..ea26e8b --- /dev/null +++ b/man/kernel-wedge-preprocess.1 @@ -0,0 +1,28 @@ +.TH KERNEL\-WEDGE\-PREPROCESS 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge\-preprocess \- process a module list file +.SH SYNOPSIS +.B kernel\-wedge preprocess +.I module-list module-dir +.SH DESCRIPTION +Preprocesses the \fImodule-list\fR, performing list includes and module +excludes, removing blank lines and comments, and expanding wildcards. +Emits a list of filenames to stdout. + +Return 1 if a required module or directory is missing, unless +$KW_CHECK_NONFATAL is non-empty. + +The supported wildcards are: + +.TS +nokeep; +lB l. +? Match a single character within a path component +* Match any number of characters within a path component +** Match any number of characters including multiple path components +.TE + +On Linux, '\-' and '_' also match each other since the kernel and kmod +treat them as equivalent in module names. +.SH AUTHOR +Joey Hess, Ben Hutchings <ben@decadent.org.uk> diff --git a/man/kernel-wedge.1 b/man/kernel-wedge.1 new file mode 100644 index 0000000..ba482e4 --- /dev/null +++ b/man/kernel-wedge.1 @@ -0,0 +1,15 @@ +.TH KERNEL\-WEDGE 1 "June 2019" "Kernel-wedge" +.SH NAME +kernel\-wedge \- industrial strength kernel splitter +.SH SYNOPSIS +.B kernel\-wedge +.IR "subcommand " [ options ] +.SH "DESCRIPTION" +.B kernel\-wedge +is used to generate kernel module udebs for the debian installer. +Type \fBkernel\-wedge\fR without any parameters for a list of subcommands, +and use \fBkernel\-wedge help\fR \fIsubcommand\fR for details on the usage of a +particular subcommand. +See /usr/share/doc/kernel-wedge/README.md.gz for detailed documentation. +.SH AUTHOR +Joey Hess |