aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRobby Workman <rworkman@slackware.com>2009-05-13 13:53:21 -0500
committerRobby Workman <rworkman@slackware.com>2009-05-13 13:53:21 -0500
commita71bf40fdf676b9112e73efd1aef8c11abd2fb29 (patch)
tree45a83e63ffa16fc5aa4d95b4c0dbac572352a47d
parent17dbb9629fbad70de2626b663fcf21f6bc2517c8 (diff)
downloadmodule-init-tools-a71bf40fdf676b9112e73efd1aef8c11abd2fb29.tar.gz
manpages: general cleanup and removal of backwards-compat notes
depmod.conf.sgml: -trivial cleanups -removed the deprecated "include" mentions depmod.sgml -trivial cleanups -removed the backward-compatibility mentions (will add a global note to the toplevel README in another commit) insmod.sgml -trivial cleanups -removed the backward-compatibility mentions lsmod.sgml -removed the backward-compatibility mentions modinfo.sgml -removed the backward-compatibility mentions -I left the old -{a,d,l,p,n} options untouched, even though they are documented as being for old modutils compatibility modprobe.conf.sgml -trivial cleanups -noted preference for /etc/modprobe.d/ over /etc/modprobe.conf (as modprobe.conf is deprecated and will be removed) -removed the deprecated "include" mentions -removed the backward-compatibility mentions modprobe.sgml -trivial cleanups -clarified the -C and -c options; perhaps they should go away later -removed the backward-compatibility mentions modules.dep.sgml -trivial cleanups -bring kernel version used in examples more up to date rmmod.sgml -trivial cleanups -removed the backward-compatibility mentions
-rw-r--r--doc/depmod.conf.sgml20
-rw-r--r--doc/depmod.sgml38
-rw-r--r--doc/insmod.sgml10
-rw-r--r--doc/lsmod.sgml9
-rw-r--r--doc/modinfo.sgml14
-rw-r--r--doc/modprobe.conf.sgml81
-rw-r--r--doc/modprobe.sgml54
-rw-r--r--doc/modules.dep.sgml10
-rw-r--r--doc/rmmod.sgml23
9 files changed, 76 insertions, 183 deletions
diff --git a/doc/depmod.conf.sgml b/doc/depmod.conf.sgml
index 922b29a..0d1b5b7 100644
--- a/doc/depmod.conf.sgml
+++ b/doc/depmod.conf.sgml
@@ -41,8 +41,8 @@
</para>
<para>
The format of <filename>depmod.conf</filename> and files under <filename>depmod.d</filename> is simple: one
- command per line, with blank lines and lines starting with #
- ignored (useful for adding comments). A \ at the end of a line
+ command per line, with blank lines and lines starting with '#'
+ ignored (useful for adding comments). A '\' at the end of a line
causes it to continue on the next line, which makes the file a
bit neater.
</para>
@@ -59,9 +59,9 @@
(or other configured module location) subdirectories will
be processed by <command>depmod</command>. Directories are
listed in order, with the highest priority given to the
- first listed directory and the lowest to the last. The
- special keyword <command>built-in</command> refers to
- the standard module directories installed by the kernel.
+ first listed directory and the lowest priority given to the last
+ directory listed. The special keyword <command>built-in</command>
+ refers to the standard module directories installed by the kernel.
</para>
<para>
By default, depmod will give a higher priority to
@@ -97,16 +97,6 @@
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term>include <replaceable>filename</replaceable>
- </term>
- <listitem>
- <para>
- Using this command, you can include other configuration
- files, or whole directories, which is occasionally useful.
- </para>
- </listitem>
- </varlistentry>
</variablelist>
</refsect1>
<refsect1>
diff --git a/doc/depmod.sgml b/doc/depmod.sgml
index 054e9fa..fcde505 100644
--- a/doc/depmod.sgml
+++ b/doc/depmod.sgml
@@ -58,24 +58,24 @@
complex.
</para>
<para>
- <command>depmod</command> creates a list of module dependencies,
+ <command>depmod</command> creates a list of module dependencies
by reading each module under
<filename>/lib/modules/</filename><replaceable>version</replaceable>
- and determining what symbols it exports, and what symbols it
- needs. By default this list is written to
+ and determining what symbols it exports and what symbols it
+ needs. By default, this list is written to
<filename>modules.dep</filename> in the same directory. If
filenames are given on the command line, only those modules are
- examined (which is rarely useful, unless all modules are
+ examined (which is rarely useful unless all modules are
listed).
</para>
<para>
If a <replaceable>version</replaceable> is provided, then that
- kernel version's module directory is used, rather than the
- current kernel version (as returned by "uname -r").
+ kernel version's module directory is used rather than the
+ current kernel version (as returned by <command>uname -r</command>).
</para>
<para>
<command>depmod</command> will also generate various map files
- in this directory, for use by the hotplug infrastructure.
+ in this directory for use by the hotplug infrastructure.
</para>
</refsect1>
<refsect1>
@@ -124,8 +124,9 @@
</term>
<listitem>
<para>
- This option overrides the default configuration file
- (/etc/depmod.conf or /etc/depmod.d/ if that is not found).
+ This option overrides the default configuration file at
+ <filename>/etc/depmod.conf</filename> (or the
+ <filename>/etc/depmod.d/</filename> directory if that is not found).
</para>
</listitem>
</varlistentry>
@@ -159,7 +160,7 @@
</term>
<listitem>
<para>
- Print the help message, and exit.
+ Print the help message and exit.
</para>
</listitem>
</varlistentry>
@@ -168,8 +169,8 @@
</term>
<listitem>
<para>
- This sends the resulting modules.dep, then the various
- map files, to standard output, rather than writing them into
+ This sends the resulting modules.dep and the various
+ map files to standard output rather than writing them into
the module directory.
</para>
</listitem>
@@ -179,7 +180,7 @@
</term>
<listitem>
<para>
- In verbose mode <command>depmod</command> will print (to stdout)
+ In verbose mode, <command>depmod</command> will print (to stdout)
all the symbols each module depends on and the module's file name
which provides that symbol.
</para>
@@ -190,7 +191,7 @@
</term>
<listitem>
<para>
- Show version of program, and exit. See below for caveats when
+ Show version of program and exit. See below for caveats when
run on older kernels.
</para>
</listitem>
@@ -198,15 +199,6 @@
</variablelist>
</refsect1>
<refsect1>
- <title>BACKWARDS COMPATIBILITY</title>
-
- <para>
- This version of <command>depmod</command> is for kernels
- <literal>2.5.48</literal> and above. There is no support
- for old-style modules.
- </para>
- </refsect1>
- <refsect1>
<title>COPYRIGHT</title>
<para>
diff --git a/doc/insmod.sgml b/doc/insmod.sgml
index 61066e0..ee0b156 100644
--- a/doc/insmod.sgml
+++ b/doc/insmod.sgml
@@ -43,7 +43,7 @@
taken from standard input. Most users will want to use
<citerefentry><refentrytitle>modprobe</refentrytitle>
<manvolnum>8</manvolnum> </citerefentry> instead, which is
- cleverer.</para>
+ more clever.</para>
<para>Only the most general of error messages are reported: as the
work of trying to link the module is now done inside the kernel,
@@ -51,14 +51,6 @@
about errors.</para>
</refsect1>
<refsect1>
- <title>BACKWARDS COMPATIBILITY</title>
-
- <para>This version of <command>insmod</command> is for kernels
- <literal>2.5.48</literal> and above. There is no support for
- old-style modules (for which much of the work was done in
- userspace).</para>
- </refsect1>
- <refsect1>
<title>COPYRIGHT</title>
<para>
This manual page Copyright 2002, Rusty Russell, IBM Corporation.
diff --git a/doc/lsmod.sgml b/doc/lsmod.sgml
index 12ff06f..7e41a77 100644
--- a/doc/lsmod.sgml
+++ b/doc/lsmod.sgml
@@ -42,15 +42,6 @@
</refsect1>
<refsect1>
- <title>BACKWARDS COMPATIBILITY</title>
-
- <para>This version of <command>lsmod</command> is for kernels
- <literal>2.5.48</literal> and above. There is no support for
- old-style modules (for which much of the work was done in
- userspace).
- </para>
- </refsect1>
- <refsect1>
<title>COPYRIGHT</title>
<para>
This manual page Copyright 2002, Rusty Russell, IBM Corporation.
diff --git a/doc/modinfo.sgml b/doc/modinfo.sgml
index c98aea5..0975d0f 100644
--- a/doc/modinfo.sgml
+++ b/doc/modinfo.sgml
@@ -135,20 +135,6 @@
</variablelist>
</refsect1>
<refsect1>
- <title>BACKWARDS COMPATIBILITY</title>
-
- <para>This version of <command>modinfo</command> is for kernel
- modules <literal>2.5.48</literal> and above. There is no
- support for old-style modules.
- </para>
-
- <para>Note that the output of this version of
- <command>modinfo</command> is simpler and more regular than
- the older version: scripts attempting to use the default
- output may get confused with complex fields.
- </para>
- </refsect1>
- <refsect1>
<title>COPYRIGHT</title>
<para>
This manual page Copyright 2003, Rusty Russell, IBM Corporation.
diff --git a/doc/modprobe.conf.sgml b/doc/modprobe.conf.sgml
index 2eee2e2..cacc006 100644
--- a/doc/modprobe.conf.sgml
+++ b/doc/modprobe.conf.sgml
@@ -27,20 +27,23 @@
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
- <refname>modprobe.conf</refname><refname>modprobe.d</refname> <refpurpose>Configuration file/directory for modprobe</refpurpose>
+ <refname>modprobe.d</refname><refname>modprobe.conf</refname> <refpurpose>Configuration directory/file for modprobe</refpurpose>
</refnamediv>
<refsect1>
<title>DESCRIPTION</title>
<para>Because the <command>modprobe</command> command can add or
- remove extra more than one module, due to module dependencies,
+ remove more than one module, due to module dependencies,
we need a method of specifying what options are to be used with
- those modules. <filename>/etc/modprobe.conf</filename> (or, if that does not exist, all files under the <filename>/etc/modprobe.d</filename> directory) specifies
- those options, as required. It can also be used to create
- convenient aliases: alternate names for a module. Finally, it
- can override the normal <command>modprobe</command> behavior
- altogether, for those with very special requirements (such as
- inserting more than one module).
+ those modules. All files underneath the
+ <filename>/etc/modprobe.d</filename> directory which end with the
+ <filename>.conf</filename> extension specify those options as
+ required. (the <filename>/etc/modprobe.conf</filename> file can
+ also be used if it exists, but that will be removed in a future
+ version). They can also be used to create convenient aliases:
+ alternate names for a module, or they can override the normal
+ <command>modprobe</command> behavior altogether for those with
+ special requirements (such as inserting more than one module).
</para>
<para>
Note that module and alias names (like other module names) can
@@ -48,15 +51,13 @@
module commands.
</para>
<para>
- The format of <filename>modprobe.conf</filename> and files under <filename>modprobe.d</filename> is simple: one
- command per line, with blank lines and lines starting with #
- ignored (useful for adding comments). A \ at the end of a line
+ The format of and files under <filename>modprobe.d</filename> and
+ <filename>/etc/modprobe.conf</filename> is simple: one
+ command per line, with blank lines and lines starting with '#'
+ ignored (useful for adding comments). A '\' at the end of a line
causes it to continue on the next line, which makes the file a
bit neater.
</para>
- <para>
- The syntax is a simplification of <filename>modules.conf</filename>, used in 2.4 kernels and earlier.
- </para>
</refsect1>
<refsect1>
<title>COMMANDS</title>
@@ -95,7 +96,7 @@
<replaceable>modulename</replaceable> (which might be an
alias) every time it is inserted into the kernel: whether
directly (using <command>modprobe</command>
- <replaceable>modulename</replaceable>, or because the
+ <replaceable>modulename</replaceable> or because the
module being inserted depends on this module.
</para>
<para>
@@ -110,28 +111,27 @@
</term>
<listitem>
<para>
- This is the most powerful primitive in
- <filename>modprobe.conf</filename>: it tells
+ This is the most powerful primitive: it tells
<command>modprobe</command> to run your command instead of
inserting the module in the kernel as normal. The command
can be any shell command: this allows you to do any kind
of complex processing you might wish. For example, if the
- module "fred" worked better with the module "barney"
- already installed (but it didn't depend on it, so
+ module "fred" works better with the module "barney"
+ already installed (but it doesn't depend on it, so
<command>modprobe</command> won't automatically load it),
you could say "install fred /sbin/modprobe barney;
/sbin/modprobe --ignore-install fred", which would do what
you wanted. Note the <option>--ignore-install</option>,
which stops the second <command>modprobe</command> from
- re-running the same <command>install</command> command.
+ running the same <command>install</command> command again.
See also <command>remove</command> below.
</para>
<para>
You can also use <command>install</command> to make up
modules which don't otherwise exist. For example:
"install probe-ethernet /sbin/modprobe e100 ||
- /sbin/modprobe eepro100", which will try first the e100
- driver, then the eepro100 driver, when you do "modprobe
+ /sbin/modprobe eepro100", which will first try to load the e100
+ driver, and if it fails, then the eepro100 driver when you do "modprobe
probe-ethernet".
</para>
<para>
@@ -161,18 +161,6 @@
</listitem>
</varlistentry>
<varlistentry>
- <term>include <replaceable>filename</replaceable>
- </term>
- <listitem>
- <para>
- Using this command, you can include other configuration
- files, or whole directories, which is occasionally useful. Note that aliases in
- the included file will override aliases previously
- declared in the current file.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
<term>blacklist <replaceable>modulename</replaceable>
</term>
<listitem>
@@ -191,31 +179,6 @@
</variablelist>
</refsect1>
<refsect1>
- <title>Backwards Compatibility</title>
-
- <para>
- There is a <command>generate_modprobe.conf</command> program
- which should do a reasonable job of generating
- <filename>modprobe.conf</filename> from old (2.4 or 2.2)
- module setups.
- </para>
- <para>
- Although the syntax is similar to the older
- <filename>/etc/modules.conf</filename>, there are many features
- missing. There are two reasons for this: firstly, install and
- remove commands can do just about anything, and secondly, the
- module-init-tools modprobe is designed to be simple enough that
- it can be easily replaced.
- </para>
- <para>
- With the complexity of actual module insertion reduced to three
- system calls (open, read, init_module), and the
- <filename>modules.dep</filename> file being simple and open,
- producing a more powerful modprobe variant can be done
- independently if there is a need.
- </para>
- </refsect1>
- <refsect1>
<title>COPYRIGHT</title>
<para>
This manual page Copyright 2004, Rusty Russell, IBM Corporation.
diff --git a/doc/modprobe.sgml b/doc/modprobe.sgml
index 9095628..dd1311e 100644
--- a/doc/modprobe.sgml
+++ b/doc/modprobe.sgml
@@ -134,9 +134,9 @@
<term><option>-C</option> <option>--config</option>
</term>
<listitem>
- <para>This option overrides the default configuration file
- (<filename>/etc/modprobe.conf</filename> or
- <filename>/etc/modprobe.d/</filename> if that isn't found).
+ <para>This option overrides the default configuration directory/file
+ (<filename>/etc/modprobe.d</filename> or
+ <filename>/etc/modprobe.conf</filename>).
</para>
<para>
This option is passed through <command>install</command>
@@ -150,7 +150,7 @@
<term><option>-c</option> <option>--showconfig</option>
</term>
<listitem>
- <para>Dump out the configuration file and exit.
+ <para>Dump out the effective configuration from the config directory and exit.
</para>
</listitem>
</varlistentry>
@@ -173,7 +173,7 @@
<para>This option causes <command>modprobe</command> to
ignore <command>install</command> and
<command>remove</command> commands in the
- configuration file (if any), for the module on the
+ configuration file (if any) for the module specified on the
command line (any dependent modules are still subject
to commands set for them in the configuration file).
See <citerefentry>
@@ -202,10 +202,10 @@
</term>
<listitem>
<para>
- This option causes <command>modprobe</command> to remove,
+ This option causes <command>modprobe</command> to remove
rather than insert a module. If the modules it depends on
are also unused, <command>modprobe</command> will try to
- remove them, too. Unlike insertion, more than one module
+ remove them too. Unlike insertion, more than one module
can be specified on the command line (it does not make
sense to specify module parameters when removing modules).
</para>
@@ -223,10 +223,10 @@
<para>
This option is applicable only with the -r or --remove option.
It causes modprobe to block in the kernel (within the kernel
- module handling code itself) waiting for the specified modules'
+ module handling code itself) waiting for the specified module's
reference count to reach zero. Default operation is for modprobe
to operate like rmmod, which exits with EWOULDBLOCK if the
- modules reference count is non-zero.
+ module's reference count is non-zero.
</para>
</listitem>
</varlistentry>
@@ -234,7 +234,7 @@
<term><option>-V</option> <option>--version</option>
</term>
<listitem>
- <para>Show version of program, and exit. See below for caveats when run on older kernels.</para>
+ <para>Show version of program and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -242,7 +242,7 @@
</term>
<listitem>
<para>
- Try to strip any versioning information from the module,
+ Try to strip any versioning information from the module
which might otherwise stop it from loading: this is the
same as using both <option>--force-vermagic</option> and
<option>--force-modversion</option>. Naturally, these
@@ -251,7 +251,7 @@
</para>
<para>
This applies to any modules inserted: both the module (or
- alias) on the command line, and any modules it depends on.
+ alias) on the command line and any modules it on which it depends.
</para>
</listitem>
</varlistentry>
@@ -269,7 +269,7 @@
</para>
<para>
This applies to any modules inserted: both the module (or
- alias) on the command line, and any modules it depends on.
+ alias) on the command line and any modules on which it depends.
</para>
</listitem>
</varlistentry>
@@ -279,8 +279,8 @@
<listitem>
<para>
When modules are compiled with CONFIG_MODVERSIONS set, a
- section is created detailing the versions of every
- interface used by (or supplied by) the module. If a
+ section detailing the versions of every interfaced used
+ by (or supplied by) the module is created. If a
module fails to load and the kernel complains that the
module disagrees about a version of some interface, you
can use "--force-modversion" to remove the version
@@ -289,7 +289,7 @@
</para>
<para>
This applies any modules inserted: both the module (or
- alias) on the command line, and any modules it depends on.
+ alias) on the command line and any modules on which it depends.
</para>
</listitem>
</varlistentry>
@@ -401,9 +401,9 @@
<para>
Normally, <command>modprobe</command> will succeed (and do
nothing) if told to insert a module which is already
- present, or remove a module which isn't present. This is
- backwards compatible with the modutils, and ideal for
- simple scripts. However, more complicated scripts often
+ present or to remove a module which isn't present. This is
+ ideal for
+ simple scripts; however, more complicated scripts often
want to know whether <command>modprobe</command> really
did something: this option makes modprobe fail for that
case.
@@ -417,7 +417,7 @@
<para>
Print out a list of module versioning information required by a
module. This option is commonly used by distributions in order to
- package up a Linuxx kernel module using module versioning deps.
+ package up a Linux kernel module using module versioning deps.
</para>
</listitem>
</varlistentry>
@@ -427,7 +427,7 @@
<listitem>
<para>
This option causes <command>modprobe</command> to apply the
- <command>blacklist</command> commands in the configuration file (if
+ <command>blacklist</command> commands in the configuration files (if
any) to module names as well. It is usually used by <citerefentry>
<refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum>
</citerefentry>.
@@ -439,7 +439,7 @@
</term>
<listitem>
<para>
- Directory where modules can be found, /lib/modules/RELEASE
+ Directory where modules can be found, <filename>/lib/modules/<replaceable>RELEASE</replaceable></filename>
by default.
</para>
</listitem>
@@ -447,16 +447,6 @@
</variablelist>
</refsect1>
<refsect1>
- <title>BACKWARDS COMPATIBILITY</title>
-
- <para>
- This version of <command>modprobe</command> is for kernels
- <literal>2.5.48</literal> and above. There is no support for
- old-style modules (for which much of the work was done in
- userspace).
- </para>
- </refsect1>
- <refsect1>
<title>ENVIRONMENT</title>
<para>
The MODPROBE_OPTIONS environment variable can also be used to
diff --git a/doc/modules.dep.sgml b/doc/modules.dep.sgml
index 9e2d135..e9a77ae 100644
--- a/doc/modules.dep.sgml
+++ b/doc/modules.dep.sgml
@@ -45,20 +45,20 @@
</para>
<para>
For example, if
- <filename>/lib/modules/2.5.53/kernel/a.ko</filename> depended on
+ <filename>/lib/modules/2.6.29/kernel/a.ko</filename> depended on
<filename>b.ko</filename> and <filename>c.ko</filename> in the
same directory, and <filename>c.ko</filename> depended on
<filename>b.ko</filename> as well, the file might look like:
</para>
<screen>
# This is a comment.
-/lib/modules/2.5.53/kernel/a.ko: /lib/modules/2.5.53/kernel/c.ko /lib/modules/2.5.53/kernel/b.ko
-/lib/modules/2.5.53/kernel/b.ko:
-/lib/modules/2.5.53/kernel/c.ko: /lib/modules/2.5.53/kernel/b.ko
+/lib/modules/2.6.29/kernel/a.ko: /lib/modules/2.6.29/kernel/c.ko /lib/modules/2.6.29/kernel/b.ko
+/lib/modules/2.6.29/kernel/b.ko:
+/lib/modules/2.6.29/kernel/c.ko: /lib/modules/2.6.29/kernel/b.ko
</screen>
<para>
This file is used by <command>modprobe</command> to know the
- order to load modules (they are loaded right to left, and
+ order in which to load modules (they are loaded right to left, and
removed left to right).
</para>
</refsect1>
diff --git a/doc/rmmod.sgml b/doc/rmmod.sgml
index 42d0a37..1d975b2 100644
--- a/doc/rmmod.sgml
+++ b/doc/rmmod.sgml
@@ -44,7 +44,7 @@
module from the kernel. Most users will want to use
<citerefentry>
<refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum>
- </citerefentry> instead, with the <option>-r</option> option.
+ </citerefentry> with the <option>-r</option> option instead.
</para>
</refsect1>
<refsect1>
@@ -56,8 +56,8 @@
<listitem>
<para>
Print messages about what the program is doing.
- Usually <command>rmmod</command> only prints messages
- if something goes wrong.
+ Usually <command>rmmod</command> prints messages
+ only if something goes wrong.
</para>
</listitem>
</varlistentry>
@@ -84,7 +84,7 @@
Normally, <command>rmmod</command> will refuse to
unload modules which are in use. With this option,
<command>rmmod</command> will isolate the module, and
- wait until the module is no longer used. Noone new
+ wait until the module is no longer used. Nothing new
will be able to use the module, but it's up to you to
make sure the current users eventually finish with it.
See <citerefentry>
@@ -98,7 +98,7 @@
</term>
<listitem>
<para>
- Send errors to the syslog, instead of standard error.
+ Send errors to syslog instead of standard error.
</para>
</listitem>
</varlistentry>
@@ -107,24 +107,13 @@
</term>
<listitem>
<para>
- Show version of program, and exit. See below for caveats
- when run on older kernels.
+ Show version of program and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
- <title>BACKWARDS COMPATIBILITY</title>
-
- <para>
- This version of <command>rmmod</command> is for kernels
- <literal>2.5.48</literal> and above. There is no support for
- old-style modules (for which much of the work was done in
- userspace).
- </para>
- </refsect1>
- <refsect1>
<title>COPYRIGHT</title>
<para>
This manual page Copyright 2002, Rusty Russell, IBM Corporation.