summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorLucas De Marchi <lucas.demarchi@profusion.mobi>2012-01-12 14:20:10 -0200
committerLucas De Marchi <lucas.demarchi@profusion.mobi>2012-01-12 14:33:05 -0200
commit9f11c43d8dcc6274f06fd0091fefaef557a86bfd (patch)
tree0a1125708e57a1510fa3f6def330b0563c3dc08c /man
parentf57497cc9a309f532fed3850719ce5c59c7b638a (diff)
downloadkmod-9f11c43d8dcc6274f06fd0091fefaef557a86bfd.tar.gz
kmod-9f11c43d8dcc6274f06fd0091fefaef557a86bfd.tar.bz2
kmod-9f11c43d8dcc6274f06fd0091fefaef557a86bfd.zip
man: build modinfo man page
Diffstat (limited to 'man')
-rw-r--r--man/Makefile.am2
-rw-r--r--man/modinfo.sgml169
-rw-r--r--man/modinfo.xml169
3 files changed, 170 insertions, 170 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index f37bb20..0fb8922 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -1,5 +1,5 @@
MAN5 = depmod.d.5 modprobe.d.5 modules.dep.5
-MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8
+MAN8 = depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8
dist_man_MANS = $(MAN5) $(MAN8) $(MAN_STUB)
diff --git a/man/modinfo.sgml b/man/modinfo.sgml
deleted file mode 100644
index 8c72eef..0000000
--- a/man/modinfo.sgml
+++ /dev/null
@@ -1,169 +0,0 @@
-<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
- <!ENTITY debian "<productname>Debian GNU/Linux</productname>">
- <!ENTITY docbook "<productname>DocBook</productname>">
- <!ENTITY sgml "<abbrev>SGML</abbrev>">
-]>
-
-<!-- Stolen from manual page for docbook-to-man, DocBook source file
- (C) 1999 W. Borgert debacle@debian.org
-
- $Id: docbook-to-man.sgml,v 1.8 2002/04/27 15:28:02 debacle Exp $ -->
-
-<refentry>
- <refentryinfo>
- <address>
- <email>jcm@jonmasters.org</email>
- </address>
- <author>
- <firstname>Jon</firstname>
- <surname>Masters</surname>
- </author>
- <date>2010-03-01</date>
- </refentryinfo>
- <refmeta>
- <refentrytitle>modinfo</refentrytitle>
- <manvolnum>8</manvolnum>
- </refmeta>
- <refnamediv>
- <refname>modinfo</refname> <refpurpose>program to show information about a Linux Kernel module</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>modinfo</command>
- <arg><option>-0</option></arg>
- <arg><option>-F <replaceable>field</replaceable></option></arg>
- <arg><option>-k <replaceable>kernel</replaceable></option></arg>
- <arg rep='repeat'>modulename|filename</arg>
- </cmdsynopsis>
- <cmdsynopsis>
- <command>modinfo -V</command>
- </cmdsynopsis>
- <cmdsynopsis>
- <command>modinfo -h</command>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>DESCRIPTION</title>
-
- <para><command>modinfo</command> extracts information from the Linux
- Kernel modules given on the command line. If the module name is
- not a filename, then the
- <filename>/lib/modules/</filename><replaceable>version</replaceable>
- directory is searched, as is also done by
- <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> when loading kernel modules.
- </para>
-
- <para><command>modinfo</command> by default lists each attribute
- of the module in form <replaceable>fieldname</replaceable> :
- <replaceable>value</replaceable>, for easy reading. The
- filename is listed the same way (although it's not really an
- attribute).
- </para>
-
- <para>This version of <command>modinfo</command> can understand
- modules of any Linux Kernel architecture.</para>
- </refsect1>
- <refsect1>
- <title>OPTIONS</title>
- <variablelist>
- <varlistentry>
- <term><option>-V</option> <option>--version</option>
- </term>
- <listitem>
- <para>
- Print the modinfo version.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-F</option> <option>--field</option>
- </term>
- <listitem>
- <para>
- Only print this field value, one per line. This is most
- useful for scripts. Field names are case-insenitive.
- Common fields (which may not be in every module) include
- <literal>author</literal>, <literal>description</literal>,
- <literal>license</literal>, <literal>parm</literal>,
- <literal>depends</literal>, and <literal>alias</literal>.
- There are often multiple <literal>parm</literal>,
- <literal>alias</literal> and <literal>depends</literal>
- fields. The special field <literal>filename</literal>
- lists the filename of the module.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-k <replaceable>kernel</replaceable></option>
- </term>
- <listitem>
- <para>
- Provide information about a kernel other than the running one. This
- is particularly useful for distributions needing to extract
- information from a newly installed (but not yet running) set of
- kernel modules. For example, you wish to find which firmware files
- are needed by various modules in a new kernel for which you must
- make an initrd/initramfs image prior to booting.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-0</option> <option>--null</option>
- </term>
- <listitem>
- <para>
- Use the ASCII zero character to separate field values,
- instead of a new line. This is useful for scripts, since
- a new line can theoretically appear inside a field.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-a</option> <option>-d</option> <option>-l</option> <option>-p</option> <option>-n</option>
- </term>
- <listitem>
- <para>
- These are shortcuts for <literal>author</literal>,
- <literal>description</literal>,
- <literal>license</literal>. <literal>parm</literal> and
- <literal>filename</literal> respectively, to ease the
- transition from the old modutils
- <command>modinfo</command>.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>COPYRIGHT</title>
- <para>
- This manual page originally Copyright 2003, Rusty Russell, IBM
- Corporation. Maintained by Jon Masters and others.
- </para>
- </refsect1>
- <refsect1>
- <title>SEE ALSO</title>
-
- <para><citerefentry>
- <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
- </citerefentry>
-</para>
- </refsect1>
-</refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:2
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-default-dtd-file:nil
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-End:
--->
diff --git a/man/modinfo.xml b/man/modinfo.xml
new file mode 100644
index 0000000..c5b5575
--- /dev/null
+++ b/man/modinfo.xml
@@ -0,0 +1,169 @@
+<?xml version='1.0'?>
+<!--*-nxml-*-->
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<refentry id="modinfo">
+ <refentryinfo>
+ <title>modinfo</title>
+ <productname>kmod</productname>
+
+ <authorgroup>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Jon</firstname>
+ <surname>Masters</surname>
+ <email>jcm@jonmasters.org</email>
+ </author>
+ <author>
+ <contrib>Developer</contrib>
+ <firstname>Lucas</firstname>
+ <surname>De Marchi</surname>
+ <email>lucas.demarchi@profusion.mobi</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>modinfo</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>modinfo</refname>
+ <refpurpose>Show information about a Linux Kernel module</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>modinfo</command>
+ <arg><option>-0</option></arg>
+ <arg><option>-F <replaceable>field</replaceable></option></arg>
+ <arg><option>-k <replaceable>kernel</replaceable></option></arg>
+ <arg rep='repeat'>modulename|filename</arg>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>modinfo -V</command>
+ </cmdsynopsis>
+ <cmdsynopsis>
+ <command>modinfo -h</command>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>DESCRIPTION</title>
+ <para>
+ <command>modinfo</command> extracts information from the Linux Kernel
+ modules given on the command line. If the module name is not a filename,
+ then the
+ <filename>/lib/modules/</filename><replaceable>version</replaceable>
+ directory is searched, as is also done by
+ <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+ when loading kernel modules.
+ </para>
+ <para>
+ <command>modinfo</command> by default lists each attribute of the module
+ in form <replaceable>fieldname</replaceable> :
+ <replaceable>value</replaceable>, for easy reading. The filename is
+ listed the same way (although it's not really an attribute).
+ </para>
+ <para>
+ This version of <command>modinfo</command> can understand modules of any
+ Linux Kernel architecture.
+ </para>
+ </refsect1>
+
+ <refsect1><title>OPTIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <option>-V</option>
+ <option>--version</option>
+ </term>
+ <listitem>
+ <para>
+ Print the modinfo version.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-F</option>
+ <option>--field</option>
+ </term>
+ <listitem>
+ <para>
+ Only print this field value, one per line. This is most useful for
+ scripts. Field names are case-insenitive. Common fields (which
+ may not be in every module) include <literal>author</literal>,
+ <literal>description</literal>, <literal>license</literal>,
+ <literal>parm</literal>, <literal>depends</literal>, and
+ <literal>alias</literal>. There are often multiple
+ <literal>parm</literal>, <literal>alias</literal> and
+ <literal>depends</literal> fields. The special field
+ <literal>filename</literal> lists the filename of the module.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-k <replaceable>kernel</replaceable></option>
+ </term>
+ <listitem>
+ <para>
+ Provide information about a kernel other than the running one. This
+ is particularly useful for distributions needing to extract
+ information from a newly installed (but not yet running) set of
+ kernel modules. For example, you wish to find which firmware files
+ are needed by various modules in a new kernel for which you must
+ make an initrd/initramfs image prior to booting.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-0</option>
+ <option>--null</option>
+ </term>
+ <listitem>
+ <para>
+ Use the ASCII zero character to separate field values, instead of a
+ new line. This is useful for scripts, since a new line can
+ theoretically appear inside a field.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <option>-a</option>
+ <option>-d</option>
+ <option>-l</option>
+ <option>-p</option>
+ <option>-n</option>
+ </term>
+ <listitem>
+ <para>
+ These are shortcuts for <literal>author</literal>,
+ <literal>description</literal>, <literal>license</literal>.
+ <literal>parm</literal> and <literal>filename</literal>
+ respectively, to ease the transition from the old modutils
+ <command>modinfo</command>.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>COPYRIGHT</title>
+ <para>
+ This manual page originally Copyright 2003, Rusty Russell, IBM
+ Corporation. Maintained by Jon Masters and others.
+ </para>
+ </refsect1>
+
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>