xcat-core/xCAT-client/pods/man1/lskmodules.1.pod
2012-10-10 16:51:32 +00:00

109 lines
2.8 KiB
Plaintext

=head1 NAME
B<lskmodules> - list kernel driver modules in rpms or driver disk image files
=head1 SYNOPSIS
B<lskmodules> [B<-V> | B<--verbose>]
[B<-i> | B<--osimage> I<osimage_names>]
[B<-c> | B<--kitcomponent> I<kitcomp_names>]
[B<-o> | B<--osdistro> I<osdistro_names>]
[B<-u> | B<--osdistropudate> I<osdistroupdate_names>]
[B<-x> | B<--xml> | B<--XML>]
B<lskmodules> [B<-?> | B<-h> | B<--help> | B<-v> | B<--version>]
=head1 DESCRIPTION
The B<lskmodules> command finds the kernel driver module files (*.ko) in the specified input locations, runs the modinfo command against each file, and returns the driver name and description. If -x is specified, the output is returned with XML tags.
Input to the command can specify any number or combination of the input options.
=head1 OPTIONS
=over 10
=item B<-i|--osimage> I<osimage_names>
where I<osimage_names> is a comma-delimited list of xCAT database osimage object names. For each I<osimage_name>, lskmodules will use the entries in osimage.driverupdatesrc for the rpms and driver disk image files to search.
=item B<-c|--kitcomponent> I<kitcomponent_names>
where I<kitcomponent_names> is a comma-delimited list of xCAT database kitcomponent object names. For each I<kitcomponent_name>, lskmodules will use the entries in kitcomponent.driverpacks for the rpm list and the repodir of the kitcomponent.kitreponame for the location of the rpm files to search.
=item B<-o|--osdistro> I<osdistro_names>
where I<osdistro_names> is a comma-delimited list of xCAT database osdistro object names. For each I<osdistro_name>, lskmodules will search each <osdistro.dirpaths>/Packages/kernel-<kernelversion>.rpm file.
=item B<-u|--osdistroupdate> I<osdistroupdate_names>
where I<osdistroupdate_names> is a comma-delimited list of xCAT database osdistroupdate table entries. For each I<osdistroupdate_name>, lskmodules will search the <osdistroupdate.dirpath>/kernel-<kernelversion>.rpm file.
=item B<-x|--xml|--XML>
Return the output with XML tags. The data is returned as:
<module>
<name> xxx.ko </name>
<description> this is module xxx </description>
</module>
This option is intended for use by other programs. The XML will not be displayed. To view the returned XML, set the XCATSHOWXML=yes environment variable before running this command.
=item B<-V|--verbose>
Display additional progress and error messages.
=item B<-v|--version>
Command Version.
=item B<-?|-h|--help>
Display usage message.
=back
=head1 RETURN VALUE
=over 3
=item 0
The command completed successfully.
=item 1
An error has occurred.
=back
=head1 EXAMPLES
=over 3
=item 1.
To list the kernel modules included in the driverpacks shipped with kitcomponent kit1_comp1-x86_64,
enter:
lskmodules -c kit1_comp1-x86_64
=back
=head1 FILES
=head1 SEE ALSO