source: patches/module-init-tools-3.4-manpages-1.patch@ 2e9a7f5

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 2e9a7f5 was 370a5bba, checked in by Ken Moffat <zarniwhoop@…>, 17 years ago

Add the formatted man pages for module init tools as a patch.

  • Property mode set to 100644
File size: 34.2 KB
RevLine 
[370a5bba]1Submitted By: Ken Moffat <ken at linuxfromscratch dot org>
2Date: 2008-01-14
3Initial Package Version: 3.4
4Upstream Status: Not submitted, this is a work around for missing docbook2man
5Origin: Self
6Description: Provides the man pages (adding docbook2man with all its
7dependencies would be a major addition to the book, so I built it
8 -once- on a completed system and saved the data).
9
10diff -Naur module-init-tools-3.4/depmod.8 module-init-tools-3.4-with-man/depmod.8
11--- module-init-tools-3.4/depmod.8 1970-01-01 01:00:00.000000000 +0100
12+++ module-init-tools-3.4-with-man/depmod.8 2008-01-14 00:43:37.000000000 +0000
13@@ -0,0 +1,111 @@
14+.\" This manpage has been automatically generated by docbook2man
15+.\" from a DocBook document. This tool can be found at:
16+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
17+.\" Please send any bug reports, improvements, comments, patches,
18+.\" etc. to Steve Cheng <steve@ggi-project.org>.
19+.TH "DEPMOD" "8" "14 January 2008" "" ""
20+
21+.SH NAME
22+depmod \- program to generate modules.dep and map files.
23+.SH SYNOPSIS
24+
25+\fBdepmod\fR [ \fB-b \fIbasedir\fB\fR ] [ \fB-e\fR ] [ \fB-F \fISystem.map\fB\fR ] [ \fB-n\fR ] [ \fB-v\fR ] [ \fB\fIversion\fB\fR ] [ \fB-A\fR ]
26+
27+
28+\fBdepmod\fR [ \fB-e\fR ] [ \fB-F\fISystem.map\fB\fR ] [ \fB-n\fR ] [ \fB-v\fR ] [ \fB\fIversion\fB\fR ] [ \fB\fIfilename\fB\fR\fI ...\fR ]
29+
30+.SH "DESCRIPTION"
31+.PP
32+Linux kernel modules can provide services (called "symbols") for
33+other modules to use (using EXPORT_SYMBOL in the code). If a
34+second module uses this symbol, that second module clearly
35+depends on the first module. These dependencies can get quite
36+complex.
37+.PP
38+\fBdepmod\fR creates a list of module dependencies,
39+by reading each module under
40+\fI/lib/modules/\fR\fIversion\fR
41+and determining what symbols it exports, and what symbols it
42+needs. By default this list is written to
43+\fImodules.dep\fR in the same directory. If
44+filenames are given on the command line, only those modules are
45+examined (which is rarely useful, unless all modules are
46+listed).
47+.PP
48+If a \fIversion\fR is provided, then that
49+kernel version's module directory is used, rather than the
50+current kernel version (as returned by "uname -r").
51+.PP
52+\fBdepmod\fR will also generate various map files
53+in this directory, for use by the hotplug infrastructure.
54+.SH "OPTIONS"
55+.TP
56+\fB-a --all \fR
57+Probe all modules. This option is enabled by default if no
58+file names are given in the command-line.
59+.TP
60+\fB-A --quick \fR
61+This option scans to see if any modules are newer than the
62+\fImodules.dep\fR file before any work is done:
63+if not, it silently exits rather than regenerating the files.
64+.TP
65+\fB-b \fIbasedir\fB --basedir \fIbasedir\fB \fR
66+If your modules are not currently in the (normal)
67+directory
68+\fI/lib/modules/\fR\fIversion\fR,
69+but in a staging area, you can specify a
70+\fIbasedir\fR which is prepended to
71+the directory name. This
72+\fIbasedir\fR is stripped from the
73+resulting \fImodules.dep\fR file, so it
74+is ready to be moved into the normal location.
75+.TP
76+\fB-C --config \fIfile or directory\fB \fR
77+This option overrides the default configuration file
78+(/etc/depmod.conf or /etc/depmod.d/ if that is not found).
79+.TP
80+\fB-e --errsyms \fR
81+When combined with the \fB-F\fR option, this
82+reports any symbols which a module needs which are not
83+supplied by other modules or the kernel. Normally, any
84+symbols not provided by modules are assumed to be
85+provided by the kernel (which should be true in a
86+perfect world).
87+.TP
88+\fB-F --filesyms \fISystem.map\fB \fR
89+Supplied with the \fISystem.map\fR produced
90+when the kernel was built, this allows the
91+\fB-e\fR option to report unresolved symbols.
92+.TP
93+\fB-h --help \fR
94+Print the help message, and exit.
95+.TP
96+\fB-n --dry-run \fR
97+This sends the resulting modules.dep, then the various
98+map files, to standard output, rather than writing them into
99+the module directory.
100+.TP
101+\fB-v --verbose \fR
102+In verbose mode \fBdepmod\fR will print (to stdout)
103+all the symbols each module depends on and the module's file name
104+which provides that symbol.
105+.TP
106+\fB-V --version \fR
107+Show version of program, and exit. See below for caveats when
108+run on older kernels.
109+.SH "BACKWARDS COMPATIBILITY"
110+.PP
111+This version of \fBdepmod\fR is for kernels
112+2.5.48 and above. If it detects a kernel
113+with support for old-style modules, or the version specified is
114+before 2.5.48, it will attempt to run
115+\fBdepmod.old\fR in its place, so it is completely
116+transparent to the user.
117+.SH "COPYRIGHT"
118+.PP
119+This manual page Copyright 2002, Rusty Russell, IBM Corporation.
120+.SH "SEE ALSO"
121+.PP
122+\fBmodprobe\fR(8),
123+\fBmodules.dep\fR(5),
124+\fBdepmod.old\fR(8)
125diff -Naur module-init-tools-3.4/depmod.conf.5 module-init-tools-3.4-with-man/depmod.conf.5
126--- module-init-tools-3.4/depmod.conf.5 1970-01-01 01:00:00.000000000 +0100
127+++ module-init-tools-3.4-with-man/depmod.conf.5 2008-01-14 00:43:36.000000000 +0000
128@@ -0,0 +1,64 @@
129+.\" This manpage has been automatically generated by docbook2man
130+.\" from a DocBook document. This tool can be found at:
131+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
132+.\" Please send any bug reports, improvements, comments, patches,
133+.\" etc. to Steve Cheng <steve@ggi-project.org>.
134+.TH "DEPMOD.CONF" "5" "14 January 2008" "" ""
135+
136+.SH NAME
137+depmod.conf, depmod.d \- Configuration file/directory for depmod
138+.SH "DESCRIPTION"
139+.PP
140+The order in which modules are processed by the
141+\fBdepmod\fR command can be altered on a global or
142+per-module basis. This is typically useful in cases where built-in
143+kernel modules are complemented by custom built versions of the
144+same and the user wishes to affect the priority of processing in
145+order to override the module version supplied by the kernel.
146+.PP
147+The format of \fIdepmod.conf\fR and files under \fIdepmod.d\fR is simple: one
148+command per line, with blank lines and lines starting with #
149+ignored (useful for adding comments). A \\ at the end of a line
150+causes it to continue on the next line, which makes the file a
151+bit neater.
152+.SH "COMMANDS"
153+.TP
154+\fBsearch \fIsubdirectory...\fB \fR
155+This allows you to specify the order in which /lib/modules
156+(or other configured module location) subdirectories will
157+be processed by \fBdepmod\fR\&. Directories are
158+listed in order, with the highest priority given to the
159+first listed directory and the lowest to the last. The
160+special keyword \fBbuilt-in\fR refers to
161+the standard module directories installed by the kernel.
162+
163+By default, depmod will give a higher priority to
164+a directory with the name \fBupdates\fR
165+using this built-in search string: "updates built-in"
166+but more complex arrangements are possible and are
167+used in several popular distributions.
168+.TP
169+\fBoverride \fImodulename\fB \fIkernelversion\fB \fImodulesubdirectory\fB \fR
170+This command allows you to override which version of a
171+specific module will be used when more than one module
172+sharing the same name is processed by the
173+\fBdepmod\fR command. It is possible to
174+specify one kernel or all kernels using the * wildcard.
175+\fImodulesubdirectory\fR is the
176+name of the subdirectory under /lib/modules (or other
177+module location) where the target module is installed.
178+
179+For example, it is possible to override the priority of
180+an updated test module called \fBkmp\fR by
181+specifying the following command: "override kmp * extra".
182+This will ensure that any matching module name installed
183+under the \fBextra\fR subdirectory within
184+/lib/modules (or other module location) will take priority
185+over any likenamed module already provided by the kernel.
186+.TP
187+\fBinclude \fIfilename\fB \fR
188+Using this command, you can include other configuration
189+files, or whole directories, which is occasionally useful.
190+.SH "COPYRIGHT"
191+.PP
192+This manual page Copyright 2006, Jon Masters, Red Hat, Inc.
193diff -Naur module-init-tools-3.4/insmod.8 module-init-tools-3.4-with-man/insmod.8
194--- module-init-tools-3.4/insmod.8 1970-01-01 01:00:00.000000000 +0100
195+++ module-init-tools-3.4-with-man/insmod.8 2008-01-14 00:43:38.000000000 +0000
196@@ -0,0 +1,43 @@
197+.\" This manpage has been automatically generated by docbook2man
198+.\" from a DocBook document. This tool can be found at:
199+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
200+.\" Please send any bug reports, improvements, comments, patches,
201+.\" etc. to Steve Cheng <steve@ggi-project.org>.
202+.TH "INSMOD" "8" "14 January 2008" "" ""
203+
204+.SH NAME
205+insmod \- simple program to insert a module into the Linux Kernel
206+.SH SYNOPSIS
207+
208+\fBinsmod\fR [ \fB\fIfilename\fB\fR ] [ \fB\fImodule options\fB\fR\fI ...\fR ]
209+
210+.SH "DESCRIPTION"
211+.PP
212+\fBinsmod\fR is a trivial program to insert a
213+module into the kernel: if the
214+\fIfilename\fR is a hyphen, the module is
215+taken from standard input. Most users will want to use
216+\fBmodprobe\fR(8) instead, which is
217+cleverer.
218+.PP
219+Only the most general of error messages are reported: as the
220+work of trying to link the module is now done inside the kernel,
221+the \fBdmesg\fR usually gives more information
222+about errors.
223+.SH "BACKWARDS COMPATIBILITY"
224+.PP
225+This version of \fBinsmod\fR is for kernels
226+2.5.48 and above. If it detects a kernel
227+with support for old-style modules (for which much of the work
228+was done in userspace), it will attempt to run
229+\fBinsmod.old\fR in its place, so it is
230+completely transparent to the user.
231+.SH "COPYRIGHT"
232+.PP
233+This manual page Copyright 2002, Rusty Russell, IBM Corporation.
234+.SH "SEE ALSO"
235+.PP
236+\fBmodprobe\fR(8),
237+\fBrmmod\fR(8),
238+\fBlsmod\fR(8),
239+\fBinsmod.old\fR(8)
240diff -Naur module-init-tools-3.4/lsmod.8 module-init-tools-3.4-with-man/lsmod.8
241--- module-init-tools-3.4/lsmod.8 1970-01-01 01:00:00.000000000 +0100
242+++ module-init-tools-3.4-with-man/lsmod.8 2008-01-14 00:43:39.000000000 +0000
243@@ -0,0 +1,32 @@
244+.\" This manpage has been automatically generated by docbook2man
245+.\" from a DocBook document. This tool can be found at:
246+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
247+.\" Please send any bug reports, improvements, comments, patches,
248+.\" etc. to Steve Cheng <steve@ggi-project.org>.
249+.TH "LSMOD" "8" "14 January 2008" "" ""
250+
251+.SH NAME
252+lsmod \- program to show the status of modules in the Linux Kernel
253+.SH SYNOPSIS
254+
255+\fBlsmod\fR
256+
257+.SH "DESCRIPTION"
258+.PP
259+\fBlsmod\fR is a trivial program which nicely
260+formats the contents of the \fI/proc/modules\fR,
261+showing what kernel modules are currently loaded.
262+.SH "BACKWARDS COMPATIBILITY"
263+.PP
264+This version of \fBlsmod\fR is for kernels
265+2.5.48 and above. If it detects a kernel
266+with support for old-style modules, it will attempt to run
267+\fBlsmod.old\fR in its place, so it is completely
268+transparent to the user.
269+.SH "COPYRIGHT"
270+.PP
271+This manual page Copyright 2002, Rusty Russell, IBM Corporation.
272+.SH "SEE ALSO"
273+.PP
274+\fBmodprobe\fR(8),
275+\fBlsmod.old\fR(8)
276diff -Naur module-init-tools-3.4/modinfo.8 module-init-tools-3.4-with-man/modinfo.8
277--- module-init-tools-3.4/modinfo.8 1970-01-01 01:00:00.000000000 +0100
278+++ module-init-tools-3.4-with-man/modinfo.8 2008-01-14 00:43:42.000000000 +0000
279@@ -0,0 +1,98 @@
280+.\" This manpage has been automatically generated by docbook2man
281+.\" from a DocBook document. This tool can be found at:
282+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
283+.\" Please send any bug reports, improvements, comments, patches,
284+.\" etc. to Steve Cheng <steve@ggi-project.org>.
285+.TH "MODINFO" "8" "14 January 2008" "" ""
286+
287+.SH NAME
288+modinfo \- program to show information about a Linux Kernel module
289+.SH SYNOPSIS
290+
291+\fBmodinfo\fR [ \fB-0\fR ] [ \fB-F \fIfield\fB\fR ] [ \fB-k \fIkernel\fB\fR ] [ \fBmodulename|filename\fR\fI ...\fR ]
292+
293+
294+\fBmodinfo -V\fR
295+
296+
297+\fBmodinfo -h\fR
298+
299+.SH "DESCRIPTION"
300+.PP
301+\fBmodinfo\fR extracts information from the Linux
302+Kernel modules given on the command line. If the module name is
303+not a filename, then the
304+\fI/lib/modules/\fR\fIversion\fR
305+directory is searched, as done by
306+\fBmodprobe\fR(8)\&.
307+.PP
308+\fBmodinfo\fR by default lists each attribute
309+of the module in form \fIfieldname\fR :
310+\fIvalue\fR, for easy reading. The
311+filename is listed the same way (although it's not really an
312+attribute).
313+.PP
314+This version of \fBmodinfo\fR can understand
315+modules of any Linux Kernel architecture.
316+.SH "OPTIONS"
317+.TP
318+\fB-V --version \fR
319+Print the modinfo version. Note BACKWARDS COMPATIBILITY
320+below: you might be printing the version of
321+\fBmodinfo.old\fR\&.
322+.TP
323+\fB-F --field \fR
324+Only print this field value, one per line. This is most
325+useful for scripts. Field names are case-insenitive.
326+Common fields (which may not be in every module) include
327+author, description,
328+license, param,
329+depends, and alias\&.
330+There are often multiple param,
331+alias and depends
332+fields. The special field filename
333+lists the filename of the module.
334+.TP
335+\fB-k \fIkernel\fB \fR
336+Provide information about a kernel other than the running one. This
337+is particularly useful for distributions needing to extract
338+information from a newly installed (but not yet running) set of
339+kernel modules. For example, you wish to find which firmware files
340+are needed by various modules in a new kernel for which you must
341+make an initrd image prior to booting.
342+.TP
343+\fB-0 --null \fR
344+Use the ASCII zero character to separate field values,
345+instead of a new line. This is useful for scripts, since
346+a new line can theoretically appear inside a field.
347+.TP
348+\fB-a -d -l -p -n \fR
349+These are shortcuts for author,
350+description,
351+license\&. param and
352+filename respectively, to ease the
353+transition from the old modutils
354+\fBmodinfo\fR\&.
355+.SH "BACKWARDS COMPATIBILITY"
356+.PP
357+This version of \fBmodinfo\fR is for kernel
358+modules 2.5.48 and above. If it detects a
359+kernel with support for old-style modules, it will attempt to
360+run \fBmodprobe.old\fR in its place, so it is
361+completely transparent to the user.
362+.PP
363+Note that the output of this version of
364+\fBmodinfo\fR is simpler and more regular than
365+the older version: scripts attempting to use the default
366+output may get confused with complex fields.
367+.PP
368+You can force the new \fBmodinfo\fR to always
369+be used, by setting the NEW_MODINFO
370+environment variable.
371+.SH "COPYRIGHT"
372+.PP
373+This manual page Copyright 2003, Rusty Russell, IBM Corporation.
374+.SH "SEE ALSO"
375+.PP
376+\fBmodprobe\fR(8),
377+\fBmodinfo.old\fR(8)
378diff -Naur module-init-tools-3.4/modprobe.8 module-init-tools-3.4-with-man/modprobe.8
379--- module-init-tools-3.4/modprobe.8 1970-01-01 01:00:00.000000000 +0100
380+++ module-init-tools-3.4-with-man/modprobe.8 2008-01-14 00:43:41.000000000 +0000
381@@ -0,0 +1,254 @@
382+.\" This manpage has been automatically generated by docbook2man
383+.\" from a DocBook document. This tool can be found at:
384+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
385+.\" Please send any bug reports, improvements, comments, patches,
386+.\" etc. to Steve Cheng <steve@ggi-project.org>.
387+.TH "MODPROBE" "8" "14 January 2008" "" ""
388+
389+.SH NAME
390+modprobe \- program to add and remove modules from the Linux Kernel
391+.SH SYNOPSIS
392+
393+\fBmodprobe\fR [ \fB-v\fR ] [ \fB-V\fR ] [ \fB-C \fIconfig-file\fB\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB-q\fR ] [ \fB-o \fImodulename\fB\fR ] [ \fB\fImodulename\fB\fR ] [ \fB\fImodule parameters\fB\fR\fI ...\fR ]
394+
395+
396+\fBmodprobe\fR [ \fB-r\fR ] [ \fB-v\fR ] [ \fB-n\fR ] [ \fB-i\fR ] [ \fB\fImodulename\fB\fR\fI ...\fR ]
397+
398+
399+\fBmodprobe\fR [ \fB-l\fR ] [ \fB-t \fIdirname\fB\fR ] [ \fB\fIwildcard\fB\fR ]
400+
401+
402+\fBmodprobe\fR [ \fB-c\fR ]
403+
404+
405+\fBmodprobe\fR [ \fB--dump-modversions\fR ]
406+
407+.SH "DESCRIPTION"
408+.PP
409+\fBmodprobe\fR intelligently adds or removes a
410+module from the Linux kernel: note that for convenience, there
411+is no difference between _ and - in module names.
412+\fBmodprobe\fR looks in the module directory
413+\fI/lib/modules/`uname -r`\fR for all
414+the modules and other files, except for the optional
415+\fI/etc/modprobe.conf\fR configuration file and
416+\fI/etc/modprobe.d\fR directory
417+(see \fBmodprobe.conf\fR(5)).
418+.PP
419+Note that this version of \fBmodprobe\fR does not
420+do anything to the module itself: the work of resolving symbols
421+and understanding parameters is done inside the kernel. So
422+module failure is sometimes accompanied by a kernel message: see
423+\fBdmesg\fR(8)\&.
424+.PP
425+\fBmodprobe\fR expects an up-to-date
426+\fImodules.dep\fR file, as generated by
427+\fBdepmod\fR (see \fBdepmod\fR(8)). This file lists what other modules each
428+module needs (if any), and \fBmodprobe\fR uses this
429+to add or remove these dependencies automatically. See
430+\fBmodules.dep\fR(5)).
431+.PP
432+If any arguments are given after the
433+\fImodulename\fR, they are passed to the
434+kernel (in addition to any options listed in the configuration
435+file).
436+.SH "OPTIONS"
437+.TP
438+\fB-v --verbose \fR
439+Print messages about what the program is doing. Usually
440+\fBmodprobe\fR only prints messages if
441+something goes wrong.
442+
443+This option is passed through \fBinstall\fR
444+or \fBremove\fR commands to other
445+\fBmodprobe\fR commands in the
446+MODPROBE_OPTIONS environment variable.
447+.TP
448+\fB-C --config \fR
449+This option overrides the default configuration file
450+(\fI/etc/modprobe.conf\fR or
451+\fI/etc/modprobe.d/\fR if that isn't found).
452+
453+This option is passed through \fBinstall\fR
454+or \fBremove\fR commands to other
455+\fBmodprobe\fR commands in the
456+MODPROBE_OPTIONS environment variable.
457+.TP
458+\fB-c --showconfig \fR
459+Dump out the configuration file and exit.
460+.TP
461+\fB-n --dry-run \fR
462+This option does everything but actually insert or
463+delete the modules (or run the install or remove
464+commands). Combined with \fB-v\fR, it is
465+useful for debugging problems.
466+.TP
467+\fB-i --ignore-install --ignore-remove \fR
468+This option causes \fBmodprobe\fR to
469+ignore \fBinstall\fR and
470+\fBremove\fR commands in the
471+configuration file (if any), for the module on the
472+command line (any dependent modules are still subject
473+to commands set for them in the configuration file).
474+See \fBmodprobe.conf\fR(5)\&.
475+.TP
476+\fB-q --quiet \fR
477+Normally \fBmodprobe\fR will report an error
478+if you try to remove or insert a module it can't find (and
479+isn't an alias or
480+\fBinstall\fR/\fBremove\fR
481+command). With this flag, \fBmodprobe\fR
482+will simply ignore any bogus names (the kernel uses this
483+to opportunistically probe for modules which might exist).
484+.TP
485+\fB-r --remove \fR
486+This option causes \fBmodprobe\fR to remove,
487+rather than insert a module. If the modules it depends on
488+are also unused, \fBmodprobe\fR will try to
489+remove them, too. Unlike insertion, more than one module
490+can be specified on the command line (it does not make
491+sense to specify module parameters when removing modules).
492+
493+There is usually no reason to remove modules, but some
494+buggy modules require it. Your kernel may not support
495+removal of modules.
496+.TP
497+\fB-w --wait \fR
498+This option is applicable only with the -r or --remove option.
499+It causes modprobe to block in the kernel (within the kernel
500+module handling code itself) waiting for the specified modules'
501+reference count to reach zero. Default operation is for modprobe
502+to operate like rmmod, which exits with EWOULDBLOCK if the
503+modules reference count is non-zero.
504+.TP
505+\fB-V --version \fR
506+Show version of program, and exit. See below for caveats when run on older kernels.
507+.TP
508+\fB-f --force \fR
509+Try to strip any versioning information from the module,
510+which might otherwise stop it from loading: this is the
511+same as using both \fB--force-vermagic\fR and
512+\fB--force-modversion\fR\&. Naturally, these
513+checks are there for your protection, so using this option
514+is dangerous.
515+
516+This applies to any modules inserted: both the module (or
517+alias) on the command line, and any modules it depends on.
518+.TP
519+\fB--force-vermagic \fR
520+Every module contains a small string containing important
521+information, such as the kernel and compiler versions. If
522+a module fails to load and the kernel complains that the
523+"version magic" doesn't match, you can use this option to
524+remove it. Naturally, this check is there for your
525+protection, so this using option is dangerous.
526+
527+This applies to any modules inserted: both the module (or
528+alias) on the command line, and any modules it depends on.
529+.TP
530+\fB--force-modversion \fR
531+When modules are compiled with CONFIG_MODVERSIONS set, a
532+section is created detailing the versions of every
533+interface used by (or supplied by) the module. If a
534+module fails to load and the kernel complains that the
535+module disagrees about a version of some interface, you
536+can use "--force-modversion" to remove the version
537+information altogether. Naturally, this check is there
538+for your protection, so using this option is dangerous.
539+
540+This applies any modules inserted: both the module (or
541+alias) on the command line, and any modules it depends on.
542+.TP
543+\fB-l --list \fR
544+List all modules matching the given wildcard (or "*"
545+if no wildcard is given). This option is provided for
546+backwards compatibility: see
547+\fBfind\fR(1) and
548+\fBbasename\fR(1) for a more flexible alternative.
549+.TP
550+\fB-a --all \fR
551+Insert all module names on the command line.
552+.TP
553+\fB-t --type \fR
554+Restrict \fB-l\fR to modules
555+in directories matching the
556+\fIdirname\fR given. This option
557+is provided for backwards compatibility: see
558+\fBfind\fR(1)
559+and
560+\fBbasename\fR(1) or a more flexible alternative.
561+.TP
562+\fB-s --syslog \fR
563+This option causes any error messages to go through the
564+syslog mechanism (as LOG_DAEMON with level LOG_NOTICE)
565+rather than to standard error. This is also automatically
566+enabled when stderr is unavailable.
567+
568+This option is passed through \fBinstall\fR
569+or \fBremove\fR commands to other
570+\fBmodprobe\fR commands in the
571+MODPROBE_OPTIONS environment variable.
572+.TP
573+\fB--set-version \fR
574+Set the kernel version, rather than using
575+\fBuname\fR(2) to decide on the kernel version (which dictates where to
576+find the modules). This also disables backwards
577+compatibility checks (so
578+\fBmodprobe.old\fR(8) will never be run).
579+.TP
580+\fB--show-depends \fR
581+List the dependencies of a module (or alias), including
582+the module itself. This produces a (possibly empty) set
583+of module filenames, one per line, each starting with
584+"insmod". Install commands which apply are shown prefixed by
585+"install". It does not run any of the install commands. Note that
586+\fBmodinfo\fR(8)
587+can be used to extract dependencies of a module from the
588+module itself, but knows nothing of aliases or install commands.
589+.TP
590+\fB-o --name \fR
591+This option tries to rename the module which is being
592+inserted into the kernel. Some testing modules can
593+usefully be inserted multiple times, but the kernel
594+refuses to have two modules of the same name. Normally,
595+modules should not require multiple insertions, as that
596+would make them useless if there were no module support.
597+.TP
598+\fB--first-time \fR
599+Normally, \fBmodprobe\fR will succeed (and do
600+nothing) if told to insert a module which is already
601+present, or remove a module which isn't present. This is
602+backwards compatible with the modutils, and ideal for
603+simple scripts. However, more complicated scripts often
604+want to know whether \fBmodprobe\fR really
605+did something: this option makes modprobe fail for that
606+case.
607+.TP
608+\fB--dump-modversions \fR
609+Print out a list of module versioning information required by a
610+module. This option is commonly used by distributions in order to
611+package up a Linuxx kernel module using module versioning deps.
612+.TP
613+\fB--use-blacklist \fR
614+Apply a matchin blacklist entry also to a request by module name,
615+not only to a request by an alias.
616+.SH "BACKWARDS COMPATIBILITY"
617+.PP
618+This version of \fBmodprobe\fR is for kernels
619+2.5.48 and above. If it detects a kernel
620+with support for old-style modules (for which much of the work
621+was done in userspace), it will attempt to run
622+\fBmodprobe.old\fR in its place, so it is
623+completely transparent to the user.
624+.SH "ENVIRONMENT"
625+.PP
626+The MODPROBE_OPTIONS environment variable can also be used to
627+pass arguments to \fBmodprobe\fR\&.
628+.SH "COPYRIGHT"
629+.PP
630+This manual page Copyright 2002, Rusty Russell, IBM Corporation.
631+.SH "SEE ALSO"
632+.PP
633+\fBmodprobe.conf\fR(5),
634+\fBlsmod\fR(8),
635+\fBmodprobe.old\fR(8)
636diff -Naur module-init-tools-3.4/modprobe.conf.5 module-init-tools-3.4-with-man/modprobe.conf.5
637--- module-init-tools-3.4/modprobe.conf.5 1970-01-01 01:00:00.000000000 +0100
638+++ module-init-tools-3.4-with-man/modprobe.conf.5 2008-01-14 00:43:34.000000000 +0000
639@@ -0,0 +1,146 @@
640+.\" This manpage has been automatically generated by docbook2man
641+.\" from a DocBook document. This tool can be found at:
642+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
643+.\" Please send any bug reports, improvements, comments, patches,
644+.\" etc. to Steve Cheng <steve@ggi-project.org>.
645+.TH "MODPROBE.CONF" "5" "14 January 2008" "" ""
646+
647+.SH NAME
648+modprobe.conf, modprobe.d \- Configuration file/directory for modprobe
649+.SH "DESCRIPTION"
650+.PP
651+Because the \fBmodprobe\fR command can add or
652+remove extra more than one module, due to module dependencies,
653+we need a method of specifying what options are to be used with
654+those modules. \fI/etc/modprobe.conf\fR (or, if that does not exist, all files under the \fI/etc/modprobe.d\fR directory) specifies
655+those options, as required. It can also be used to create
656+convenient aliases: alternate names for a module. Finally, it
657+can override the normal \fBmodprobe\fR behavior
658+altogether, for those with very special requirements (such as
659+inserting more than one module).
660+.PP
661+Note that module and alias names (like other module names) can
662+have - or _ in them: both are interchangable throughout all the
663+module commands.
664+.PP
665+The format of \fImodprobe.conf\fR and files under \fImodprobe.d\fR is simple: one
666+command per line, with blank lines and lines starting with #
667+ignored (useful for adding comments). A \\ at the end of a line
668+causes it to continue on the next line, which makes the file a
669+bit neater.
670+.PP
671+The syntax is a simplification of \fImodules.conf\fR, used in 2.4 kernels and earlier.
672+.SH "COMMANDS"
673+.TP
674+\fBalias \fIwildcard\fB \fImodulename\fB \fR
675+This allows you to give alternate names for a module. For
676+example: "alias my-mod really_long_modulename"
677+means you can use "modprobe my-mod" instead of "modprobe
678+really_long_modulename". You can also use shell-style
679+wildcards, so "alias my-mod* really_long_modulename"
680+means that "modprobe my-mod-something" has the same
681+effect. You can't have aliases to other aliases (that
682+way lies madness), but aliases can have options, which
683+will be added to any other options.
684+
685+Note that modules can also contain their own aliases,
686+which you can see using \fBmodinfo\fR\&. These
687+aliases are used as a last resort (ie. if there is no real
688+module, \fBinstall\fR,
689+\fBremove\fR, or \fBalias\fR
690+command in the configuration).
691+.TP
692+\fBoptions \fImodulename\fB \fIoption...\fB \fR
693+This command allows you to add options to the module
694+\fImodulename\fR (which might be an
695+alias) every time it is inserted into the kernel: whether
696+directly (using \fBmodprobe\fR
697+\fImodulename\fR, or because the
698+module being inserted depends on this module.
699+
700+All options are added together: they can come from an
701+\fBoption\fR for the module itself, for an
702+alias, and on the command line.
703+.TP
704+\fBinstall \fImodulename\fB \fIcommand...\fB \fR
705+This is the most powerful primitive in
706+\fImodprobe.conf\fR: it tells
707+\fBmodprobe\fR to run your command instead of
708+inserting the module in the kernel as normal. The command
709+can be any shell command: this allows you to do any kind
710+of complex processing you might wish. For example, if the
711+module "fred" worked better with the module "barney"
712+already installed (but it didn't depend on it, so
713+\fBmodprobe\fR won't automatically load it),
714+you could say "install fred /sbin/modprobe barney;
715+/sbin/modprobe --ignore-install fred", which would do what
716+you wanted. Note the \fB--ignore-install\fR,
717+which stops the second \fBmodprobe\fR from
718+re-running the same \fBinstall\fR command.
719+See also \fBremove\fR below.
720+
721+You can also use \fBinstall\fR to make up
722+modules which don't otherwise exist. For example:
723+"install probe-ethernet /sbin/modprobe e100 ||
724+/sbin/modprobe eepro100", which will try first the e100
725+driver, then the eepro100 driver, when you do "modprobe
726+probe-ethernet".
727+
728+If you use the string "$CMDLINE_OPTS" in the command, it
729+will be replaced by any options specified on the modprobe
730+command line. This can be useful because users expect
731+"modprobe fred opt=1" to pass the "opt=1" arg to the
732+module, even if there's an install command in the
733+configuration file. So our above example becomes "install
734+fred /sbin/modprobe barney; /sbin/modprobe
735+--ignore-install fred $CMDLINE_OPTS"
736+.TP
737+\fBremove \fImodulename\fB \fIcommand...\fB \fR
738+This is similar to the \fBinstall\fR command
739+above, except it is invoked when "modprobe -r" is run.
740+The removal counterparts to the two examples above would
741+be: "remove fred /sbin/modprobe -r --ignore-remove fred &&
742+/sbin/modprobe -r barney", and "remove probe-ethernet
743+/sbin/modprobe -r eepro100 || /sbin/modprobe -r e100".
744+.TP
745+\fBinclude \fIfilename\fB \fR
746+Using this command, you can include other configuration
747+files, or whole directories, which is occasionally useful. Note that aliases in
748+the included file will override aliases previously
749+declared in the current file.
750+.TP
751+\fBblacklist \fImodulename\fB \fR
752+Modules can contain their own aliases: usually these are
753+aliases describing the devices they support, such as
754+"pci:123...". These "internal" aliases can be overridden
755+by normal "alias" keywords, but there are cases where two
756+or more modules both support the same devices, or a module
757+invalidly claims to support a device: the
758+\fBblacklist\fR keyword indicates that all of
759+that particular module's internal aliases are to be ignored.
760+.SH "BACKWARDS COMPATIBILITY"
761+.PP
762+There is a \fBgenerate_modprobe.conf\fR program
763+which should do a reasonable job of generating
764+\fImodprobe.conf\fR from your current (2.4 or
765+2.2) modules setup.
766+.PP
767+Although the syntax is similar to the older
768+\fI/etc/modules.conf\fR, there are many features
769+missing. There are two reasons for this: firstly, install and
770+remove commands can do just about anything, and secondly, the
771+module-init-tools modprobe is designed to be simple enough that
772+it can be easily replaced.
773+.PP
774+With the complexity of actual module insertion reduced to three
775+system calls (open, read, init_module), and the
776+\fImodules.dep\fR file being simple and open,
777+producing a more powerful modprobe variant can be done
778+independently if there is a need.
779+.SH "COPYRIGHT"
780+.PP
781+This manual page Copyright 2004, Rusty Russell, IBM Corporation.
782+.SH "SEE ALSO"
783+.PP
784+\fBmodprobe\fR(8),
785+\fBmodules.dep\fR(5)
786diff -Naur module-init-tools-3.4/modules.dep.5 module-init-tools-3.4-with-man/modules.dep.5
787--- module-init-tools-3.4/modules.dep.5 1970-01-01 01:00:00.000000000 +0100
788+++ module-init-tools-3.4-with-man/modules.dep.5 2008-01-14 00:43:35.000000000 +0000
789@@ -0,0 +1,45 @@
790+.\" This manpage has been automatically generated by docbook2man
791+.\" from a DocBook document. This tool can be found at:
792+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
793+.\" Please send any bug reports, improvements, comments, patches,
794+.\" etc. to Steve Cheng <steve@ggi-project.org>.
795+.TH "MODULES.DEP" "5" "14 January 2008" "" ""
796+
797+.SH NAME
798+modules.dep \- List of module dependencies
799+.SH "DESCRIPTION"
800+.PP
801+The \fImodules.dep\fR as generated by
802+module-init-tools \fBdepmod\fR, lists the
803+dependencies for every module in the directories under
804+\fI/lib/modules/\fR\fIversion\fR,
805+where \fImodules.dep\fR is.
806+.PP
807+Blank lines, and lines starting with a '#' (ignoring spaces) are
808+ignored. Other lines are of the form "filename: [filename]*",
809+listing the complete dependencies for the first filename in
810+descending order.
811+.PP
812+For example, if
813+\fI/lib/modules/2.5.53/kernel/a.ko\fR depended on
814+\fIb.ko\fR and \fIc.ko\fR in the
815+same directory, and \fIc.ko\fR depended on
816+\fIb.ko\fR as well, the file might look like:
817+
818+.nf
819+# This is a comment.
820+/lib/modules/2.5.53/kernel/a.ko: /lib/modules/2.5.53/kernel/c.ko /lib/modules/2.5.53/kernel/b.ko
821+/lib/modules/2.5.53/kernel/b.ko:
822+/lib/modules/2.5.53/kernel/c.ko: /lib/modules/2.5.53/kernel/b.ko
823+
824+.fi
825+.PP
826+This file is used by \fBmodprobe\fR to know the
827+order to load modules (they are loaded right to left, and
828+removed left to right).
829+.SH "COPYRIGHT"
830+.PP
831+This manual page Copyright 2002, Rusty Russell, IBM Corporation.
832+.SH "SEE ALSO"
833+.PP
834+\fBmodprobe\fR(8)
835diff -Naur module-init-tools-3.4/rmmod.8 module-init-tools-3.4-with-man/rmmod.8
836--- module-init-tools-3.4/rmmod.8 1970-01-01 01:00:00.000000000 +0100
837+++ module-init-tools-3.4-with-man/rmmod.8 2008-01-14 00:43:40.000000000 +0000
838@@ -0,0 +1,64 @@
839+.\" This manpage has been automatically generated by docbook2man
840+.\" from a DocBook document. This tool can be found at:
841+.\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
842+.\" Please send any bug reports, improvements, comments, patches,
843+.\" etc. to Steve Cheng <steve@ggi-project.org>.
844+.TH "RMMOD" "8" "14 January 2008" "" ""
845+
846+.SH NAME
847+rmmod \- simple program to remove a module from the Linux Kernel
848+.SH SYNOPSIS
849+
850+\fBrmmod\fR [ \fB-f\fR ] [ \fB-w\fR ] [ \fB-s\fR ] [ \fB-v\fR ] [ \fB\fImodulename\fB\fR ]
851+
852+.SH "DESCRIPTION"
853+.PP
854+\fBrmmod\fR is a trivial program to remove a
855+module from the kernel. Most users will want to use
856+\fBmodprobe\fR(8) instead, with the \fB-r\fR option.
857+.SH "OPTIONS"
858+.TP
859+\fB-v --verbose \fR
860+Print messages about what the program is doing.
861+Usually \fBrmmod\fR only prints messages
862+if something goes wrong.
863+.TP
864+\fB-f --force \fR
865+This option can be extremely dangerous: it has no effect unless
866+CONFIG_MODULE_FORCE_UNLOAD was set when the kernel was
867+compiled. With this option, you can remove modules which are
868+being used, or which are not designed to be removed, or have
869+been marked as unsafe (see \fBlsmod\fR(8)).
870+.TP
871+\fB-w --wait \fR
872+Normally, \fBrmmod\fR will refuse to
873+unload modules which are in use. With this option,
874+\fBrmmod\fR will isolate the module, and
875+wait until the module is no longer used. Noone new
876+will be able to use the module, but it's up to you to
877+make sure the current users eventually finish with it.
878+See \fBlsmod\fR(8)) for information on usage counts.
879+.TP
880+\fB-s --syslog \fR
881+Send errors to the syslog, instead of standard error.
882+.TP
883+\fB-V --version \fR
884+Show version of program, and exit. See below for caveats
885+when run on older kernels.
886+.SH "BACKWARDS COMPATIBILITY"
887+.PP
888+This version of \fBrmmod\fR is for kernels
889+2.5.48 and above. If it detects a kernel
890+with support for old-style modules (for which much of the work
891+was done in userspace), it will attempt to run
892+\fBrmmod.old\fR in its place, so it is completely
893+transparent to the user.
894+.SH "COPYRIGHT"
895+.PP
896+This manual page Copyright 2002, Rusty Russell, IBM Corporation.
897+.SH "SEE ALSO"
898+.PP
899+\fBmodprobe\fR(8),
900+\fBinsmod\fR(8),
901+\fBlsmod\fR(8),
902+\fBrmmod.old\fR(8)
Note: See TracBrowser for help on using the repository browser.