source: patches/module-init-tools-3.6-manpages-1.patch@ 791132be

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 791132be was 190e0ab, checked in by Jim Gifford <clfs@…>, 16 years ago

Readded Missing ManPages Patch to Module-Init-Tools

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