File: index.html

package info (click to toggle)
module-assistant 0.9sarge1
links: PTS
area: main
in suites: sarge
size: 660 kB
ctags: 169
sloc: perl: 1,218; sh: 306; makefile: 186
file content (569 lines) | stat: -rw-r--r-- 9,382 bytes
parent folder | download | duplicates (3)
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML
><HEAD
><TITLE
>module-assistant</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><H1
><A
NAME="AEN1"
></A
>module-assistant</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN15"
></A
><H2
>Name</H2
>module-assistant&nbsp;--&nbsp;utility for kernel modules package handling</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN18"
></A
><H2
>Synopsis</H2
><P
><B
CLASS="COMMAND"
>module-assistant</B
>  [<VAR
CLASS="OPTION"
>-hv</VAR
>] [<VAR
CLASS="OPTION"
>-k <VAR
CLASS="REPLACEABLE"
>source/headers directory</VAR
></VAR
>] {update | prepare | list-available | la | list-installed | li | get | build | install | auto-install | clean | purge} [<VAR
CLASS="REPLACEABLE"
>pkg</VAR
>...]</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN41"
></A
><H2
>Description</H2
><P
>   <B
CLASS="COMMAND"
>module-assistant</B
> is the command-line tool for handling
   module-source packages that have been prepared for the Debian
   distribution. It helps users to build and install module package(s)
   easily for one or more custom kernels.
   </P
><P
><VAR
CLASS="LITERAL"
>pkg</VAR
> can be a single word (package name) or multiple
   names. The word <VAR
CLASS="LITERAL"
>all</VAR
> will be expanded to the list of all available
   packages, the word <VAR
CLASS="LITERAL"
>alli</VAR
> to the list of currently installed
   (source) packages.
   </P
><P
>   Unless the <VAR
CLASS="OPTION"
>-h</VAR
>, or <VAR
CLASS="OPTION"
>--help</VAR
> option is given, one of the
   commands below must be present.

   <P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>update</DT
><DD
><P
>     <VAR
CLASS="LITERAL"
>update</VAR
> is used to resynchronize the version index files from
     their sources. This happens with helper scripts provided by the
     packages. <B
CLASS="COMMAND"
>kernel-assistant</B
> has a default built-in list of
     the packages that it should look for but other packages can
     be registred by <B
CLASS="COMMAND"
>kernel-assistant</B
> if the maintainer adds
     the helper script.
     </P
></DD
><DT
>list | list-available | la</DT
><DD
><P
>   
     <VAR
CLASS="LITERAL"
>list-available</VAR
> (abbreviated with <VAR
CLASS="LITERAL"
>la</VAR
>) presents
     a list of details about specified packages, including
     installed version, installable versions and recently built binary
     packages. If the package names are omited, shows all known
     packages. With <VAR
CLASS="OPTION"
>-v</VAR
>, prints long package paths.
     </P
></DD
><DT
>list-installed | li</DT
><DD
><P
>   
     Synonym to <VAR
CLASS="LITERAL"
>list alli</VAR
>. Acts like <VAR
CLASS="LITERAL"
>list-available</VAR
>
     but limits the list to the installed source packages. 
     </P
></DD
><DT
>get</DT
><DD
><P
>   
     <VAR
CLASS="LITERAL"
>get</VAR
> followed by the package list installs the package
     source, downloading source packages when needed.
     </P
></DD
><DT
>build</DT
><DD
><P
>   
     <VAR
CLASS="LITERAL"
>build</VAR
> is followed by one or more source packages that
     should be built. It chooses the kernel source appropriate for the
     currently running kernel unless different directories have been
     specified.
     </P
></DD
><DT
>install</DT
><DD
><P
>   
     <VAR
CLASS="LITERAL"
>install</VAR
> is followed by one or more packages desired for 
     installation. The last built package for the current running kernel
     is choosen.
     </P
></DD
><DT
>auto-install</DT
><DD
><P
>   
     <VAR
CLASS="LITERAL"
>auto-install</VAR
> is followed by one or more packages desired for 
     installation. The build process will be executed first.
     </P
></DD
><DT
>clean</DT
><DD
><P
>   
     <VAR
CLASS="LITERAL"
>clean</VAR
> clears the build directories of the kernel
     packages.
     </P
></DD
><DT
>purge</DT
><DD
><P
>   
     <VAR
CLASS="LITERAL"
>purge</VAR
> clears the information cache of a source package
     and removes all binary packages localy built from it (that
     module-assistant knows about). USE WITH CARE!
     </P
></DD
></DL
></DIV
>
 </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN103"
></A
><H2
>Options</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><VAR
CLASS="OPTION"
>-k</VAR
>, <VAR
CLASS="OPTION"
>--kernel-dir</VAR
></DT
><DD
><P
>     A different kernel source directory to be used. You can specify
     multiple directories with multiple options or separated by commas.
     </P
></DD
><DT
><VAR
CLASS="OPTION"
>-v</VAR
>, <VAR
CLASS="OPTION"
>--verbose</VAR
></DT
><DD
><P
>     Shows a bit more information, like full paths of the binary
     packages.
     </P
></DD
><DT
><VAR
CLASS="OPTION"
>-n</VAR
>, <VAR
CLASS="OPTION"
>--no-rebuild</VAR
></DT
><DD
><P
>     If a package that is to be generated does already exist in the
     target directory (maybe in on older version), <VAR
CLASS="OPTION"
>-n</VAR
> prevents
     from building the package again. 
     </P
><P
>The default behaviour is to
     skip when exactly the same file (with the same filename) is to be
     generated as the one that already exists, and the new filename
     could be detected before starting the build process (depends on the
     module package).
     </P
></DD
><DT
><VAR
CLASS="OPTION"
>-f</VAR
>, <VAR
CLASS="OPTION"
>--force</VAR
></DT
><DD
><P
>     Never look for target file (in another version) and force a build.
     For the get command, download a newer version of a package even if
     it is already installed.
     </P
></DD
><DT
><VAR
CLASS="OPTION"
>-h</VAR
>, <VAR
CLASS="OPTION"
>--help</VAR
></DT
><DD
><P
>     Prints a short help message.
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN143"
></A
><H2
>ENVIRONMENT VARIABLES</H2
><P
> You can export the following environment variables to modify the
 behaviour of the build scripts. Some packages may ignore them or
 interpret them differently.
   <P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>KPKG_DEST_DIR</DT
><DD
><P
>     <VAR
CLASS="LITERAL"
>KPKG_DEST_DIR</VAR
> specify the target directory where the
     resulting Debian package should be installed into. However, many
     packages ignore this variable and install the file into the
     directory above the kernel source directory or above the current
     directory.
     </P
></DD
><DT
>SIGNCHANGES</DT
><DD
><P
>     If <VAR
CLASS="LITERAL"
>SIGNCHANGES</VAR
> is set, .changes files will be generated
     (calling <VAR
CLASS="LITERAL"
>kdist_image</VAR
> rule instead of kdist) and debsign (or gpg or
     pgp) will be executed to sign the changes.
     </P
></DD
><DT
>KMAINT | DEBFULLNAME | DEBNAME</DT
><DD
><P
>     Specifies the realname of the person building the package,
     interesting for .changes file only. In addition, if KMAINT is set
     and <VAR
CLASS="LITERAL"
>KPKG_DEST_DIR</VAR
> is not, <VAR
CLASS="LITERAL"
>DEB_DESTDIR</VAR
> will
     become <VAR
CLASS="LITERAL"
>$(KSRC)/..</VAR
>.
     </P
></DD
><DT
>KEMAIL | DEBEMAIL</DT
><DD
><P
>     Specifies the realname of the person building the package
     (interesting for .changes file only).
     </P
></DD
><DT
>MODULE_LOC</DT
><DD
><P
>     A different location for the (already extracted) module source
     directories. Default is <TT
CLASS="FILENAME"
>/usr/src/modules</TT
>.
     </P
></DD
><DT
>MA_VARDIR</DT
><DD
><P
>     A different location for cached data, used by helper scripts from
     <B
CLASS="COMMAND"
>module-assistant</B
>. Default is <TT
CLASS="FILENAME"
>/var/cache/modass</TT
>.
     </P
></DD
></DL
></DIV
>
 </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN180"
></A
><H2
>Files</H2
><P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
><TT
CLASS="FILENAME"
>/usr/share/modass/packages/*</TT
></DT
><DD
><P
>     List of helper scripts shipped with the module-assistant package.
     </P
></DD
><DT
><TT
CLASS="FILENAME"
>/usr/share/modass/overrides/*</TT
></DT
><DD
><P
>     Helper scripts installed by other packages.
     </P
></DD
></DL
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN193"
></A
><H2
>See Also</H2
><P
>   <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>       <B
CLASS="COMMAND"
>make-kpkg</B
>
     </SPAN
>(1)</SPAN
>
   ,
   <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
>                <TT
CLASS="FILENAME"
>/usr/share/doc/module-assistant/RATIONALE</TT
>
        </SPAN
></SPAN
>
   
 </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN203"
></A
><H2
>Bugs</H2
><P
>   See the <A
HREF="http://bugs.debian.org/src:module-assistant"
TARGET="_top"
>module-assistant bug page</A
>.  
   If you wish to report a bug in module-assistant, please use 
   the <SPAN
CLASS="CITEREFENTRY"
><SPAN
CLASS="REFENTRYTITLE"
><B
CLASS="COMMAND"
>reportbug</B
>
   </SPAN
>(1)</SPAN
>
    command.
 </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN211"
></A
><H2
>Return codes</H2
><P
>   <VAR
CLASS="LITERAL"
>255</VAR
> means a fixable error after user intervention. 0 means
   success. Anything
   else means random errors during the build process.
 </P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN215"
></A
><H2
>Author</H2
><P
>   Module was written by Eduard Bloch <CODE
CLASS="EMAIL"
>&#60;<A
HREF="mailto:blade@debian.org"
>blade@debian.org</A
>&#62;</CODE
> for the
   Debian distribution.
 </P
></DIV
></BODY
></HTML
>