manual/module-init-tools/original/man8/modinfo.8

   1 .\" $Header: /JM/JM/manual/module-init-tools/original/man8/modinfo.8,v 1.1 2005/07/10 14:15:02 nakano Exp $
   2 .\"
   3 .\"     transcript compatibility for postscript use.
   4 .\"
   5 .\"     synopsis:  .P! <file.ps>
   6 .\"
   7 .de P!
   8 .fl
   9 \!!1 setgray
  10 .fl
  11 \\&.\"
  12 .fl
  13 \!!0 setgray
  14 .fl                     \" force out current output buffer
  15 \!!save /psv exch def currentpoint translate 0 0 moveto
  16 \!!/showpage{}def
  17 .fl                     \" prolog
  18 .sy sed -e 's/^/!/' \\$1\" bring in postscript file
  19 \!!psv restore
  20 .
  21 .de pF
  22 .ie     \a\\*(f1\a\a .ds f1 \\n(.f
  23 .el .ie \a\\*(f2\a\a .ds f2 \\n(.f
  24 .el .ie \a\\*(f3\a\a .ds f3 \\n(.f
  25 .el .ie \a\\*(f4\a\a .ds f4 \\n(.f
  26 .el .tm ? font overflow
  27 .ft \\$1
  28 ..
  29 .de fP
  30 .ie     !\a\\*(f4\a\a \{\
  31 .       ft \\*(f4
  32 .       ds f4\"
  33 '       br \}
  34 .el .ie !\a\\*(f3\a\a \{\
  35 .       ft \\*(f3
  36 .       ds f3\"
  37 '       br \}
  38 .el .ie !\a\\*(f2\a\a \{\
  39 .       ft \\*(f2
  40 .       ds f2\"
  41 '       br \}
  42 .el .ie !\a\\*(f1\a\a \{\
  43 .       ft \\*(f1
  44 .       ds f1\"
  45 '       br \}
  46 .el .tm ? font underflow
  47 ..
  48 .ds f1\"
  49 .ds f2\"
  50 .ds f3\"
  51 .ds f4\"
  52 '\" t
  53 .ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
  54 .TH "modinfo" "8"
  55 .SH "NAME"
  56 modinfo \(em program to show information about a Linux Kernel module
  57 .SH "SYNOPSIS"
  58 .PP
  59 \fBmodinfo\fR [\fB-0\fP]  [\fB-F \fIfield\fR\fP]  [modulename|filename \&...]
  60 .PP
  61 \fBmodinfo -V\fR
  62 .PP
  63 \fBmodinfo -h\fR
  64 .SH "DESCRIPTION"
  65 .PP
  66 \fBmodinfo\fR extracts information from the Linux
  67 Kernel modules given on the command line.  If the module name is
  68 not a filename, then the
  69 \fB/lib/modules/\fP\fIversion\fR       directory is searched, as done by
  70 \fBmodprobe\fP\fB(8)\fP.
  71
  72 .PP
  73 \fBmodinfo\fR by default lists each attribute
  74 of the module in form \fIfieldname\fR :
  75 \fIvalue\fR, for easy reading.  The
  76 filename is listed the same way (although it's not really an
  77 attribute).
  78
  79 .PP
  80 This version of \fBmodinfo\fR can understand
  81 modules of any Linux Kernel architecture.
  82 .SH "OPTIONS"
  83 .IP "\fB-V\fP \fB--version\fP         " 10
  84 Print the modinfo version.  Note BACKWARDS COMPATIBILITY
  85 below: you might be printing the version of
  86 \fBmodinfo.old\fR.
  87
  88 .IP "\fB-F\fP \fB--field\fP         " 10
  89 Only print this field value, one per line.  This is most
  90 useful for scripts.  Field names are case-insenitive.
  91 Common fields (which may not be in every module) include
  92 \fBauthor\fP, \fBdescription\fP,
  93 \fBlicense\fP, \fBparam\fP,
  94 \fBdepends\fP, and \fBalias\fP.
  95 There are often multiple \fBparam\fP,
  96 \fBalias\fP and \fBdepends\fP       fields.  The special field \fBfilename\fP       lists the filename of the module.
  97
  98 .IP "\fB-0\fP \fB--null\fP         " 10
  99 Use the ASCII zero character to separate field values,
 100 instead of a new line.  This is useful for scripts, since
 101 a new line can theoretically appear inside a field.
 102
 103 .IP "\fB-a\fP \fB-d\fP \fB-l\fP \fB-p\fP \fB-n\fP         " 10
 104 These are shortcuts for \fBauthor\fP,
 105 \fBdescription\fP,
 106 \fBlicense\fP.  \fBparam\fP and
 107 \fBfilename\fP respectively, to ease the
 108 transition from the old modutils
 109 \fBmodinfo\fR.
 110
 111 .SH "BACKWARDS COMPATIBILITY"
 112 .PP
 113 This version of \fBmodinfo\fR is for kernel
 114 modules \fB2.5.48\fP and above.  If it detects a
 115 kernel with support for old-style modules, it will attempt to
 116 run \fBmodprobe.old\fR in its place, so it is
 117 completely transparent to the user.
 118 .PP
 119 Note that the output of this version of
 120 \fBmodinfo\fR is simpler and more regular than
 121 the older version: scripts attempting to use the default
 122 output may get confused with complex fields.
 123
 124 .PP
 125 You can force the new \fBmodinfo\fR to always
 126 be used, by setting the \fBNEW_MODINFO\fP       environment variable.
 127
 128 .SH "COPYRIGHT"
 129 .PP
 130 This manual page Copyright 2003, Rusty Russell, IBM Corporation.
 131
 132 .SH "SEE ALSO"
 133 .PP
 134 \fBmodprobe\fP\fB(8)\fP,
 135 \fBmodinfo.old\fP\fB(8)\fP
 136 .\" created by instant / docbook-to-man, Tue 09 Mar 2004, 08:43