From: md@Linux.IT (Marco d'Itri)
To: linux-modules@vger.kernel.org
Subject: [patch 2/2] Add the man page for kmod(8)
Date: Wed, 17 Sep 2014 05:12:27 +0200 [thread overview]
Message-ID: <20140917031328.089606663@bongo.bofh.it> (raw)
In-Reply-To: 20140917031225.559902121@bongo.bofh.it
--- /dev/null
+++ b/man/kmod.xml
@@ -0,0 +1,126 @@
+<?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="kmod">
+ <refentryinfo>
+ <title>kmod</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.de.marchi@gmail.com</email>
+ </author>
+ </authorgroup>
+ </refentryinfo>
+
+ <refmeta>
+ <refentrytitle>kmod</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </refmeta>
+
+ <refnamediv>
+ <refname>kmod</refname>
+ <refpurpose>Program to manage Linux Kernel modules</refpurpose>
+ </refnamediv>
+
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>kmod</command>
+ <arg rep='repeat'><option>OPTIONS</option></arg>
+ <arg><replaceable>COMMAND</replaceable></arg>
+ <arg rep='repeat'><option>COMMAND_OPTIONS</option></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1><title>DESCRIPTION</title>
+ <para>
+ <command>kmod</command> is a multi-call binary which implements the
+ programs used to control Linux Kernel modules. Most users will only
+ run it using its other names.
+ </para>
+ </refsect1>
+
+ <refsect1><title>OPTIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>-V</option> <option>--version</option>
+ </term>
+ <listitem>
+ <para>Show the program version and exit.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-h</option> <option>--help</option>
+ </term>
+ <listitem>
+ <para>Show the help message.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1><title>COMMANDS</title>
+ <variablelist>
+ <varlistentry>
+ <term><command>help</command></term>
+ <listitem>
+ <para>Show the help message.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>list</command></term>
+ <listitem>
+ <para>List the currently loaded modules.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>static-nodes</command></term>
+ <listitem>
+ <para>Output the static device nodes information provided by
+ the modules of the currently running kernel version.</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
+
+ <refsect1>
+ <title>COPYRIGHT</title>
+ <para>
+ This manual page originally Copyright 2014, Marco d'Itri.
+ Maintained by Jon Masters and others.
+ </para>
+ </refsect1>
+
+ <refsect1><title>SEE ALSO</title>
+ <para>
+ <citerefentry>
+ <refentrytitle>lsmod</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>rmmod</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>insmod</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>modinfo</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>,
+ <citerefentry>
+ <refentrytitle>depmod</refentrytitle><manvolnum>8</manvolnum>
+ </citerefentry>
+ </para>
+ </refsect1>
+</refentry>
--- 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 modinfo.8
+MAN8 = kmod.8 depmod.8 insmod.8 lsmod.8 rmmod.8 modprobe.8 modinfo.8
MAN_STUB = modules.dep.bin.5
AM_V_XSLT = $(AM_V_XSLT_$(V))
next prev parent reply other threads:[~2014-09-17 3:22 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-09-17 3:12 [patch 0/2] Documentation fixes Marco d'Itri
2014-09-17 3:12 ` [patch 1/2] Document depmod --show in depmod(8) Marco d'Itri
2014-09-20 14:21 ` Lucas De Marchi
2014-09-17 3:12 ` Marco d'Itri [this message]
2014-09-20 14:20 ` [patch 2/2] Add the man page for kmod(8) Lucas De Marchi
2014-09-20 19:10 ` Marco d'Itri
2014-09-20 19:12 ` Marco d'Itri
2014-09-22 12:06 ` Lucas De Marchi
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20140917031328.089606663@bongo.bofh.it \
--to=md@linux.it \
--cc=linux-modules@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).