Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 1 | <?xml version='1.0'?> |
| 2 | <!--*-nxml-*--> |
| 3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" |
| 4 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> |
| 5 | <refentry id="modinfo"> |
| 6 | <refentryinfo> |
| 7 | <title>modinfo</title> |
| 8 | <productname>kmod</productname> |
| 9 | |
| 10 | <authorgroup> |
| 11 | <author> |
| 12 | <contrib>Developer</contrib> |
| 13 | <firstname>Jon</firstname> |
| 14 | <surname>Masters</surname> |
| 15 | <email>jcm@jonmasters.org</email> |
| 16 | </author> |
| 17 | <author> |
| 18 | <contrib>Developer</contrib> |
| 19 | <firstname>Lucas</firstname> |
| 20 | <surname>De Marchi</surname> |
| 21 | <email>lucas.demarchi@profusion.mobi</email> |
| 22 | </author> |
| 23 | </authorgroup> |
| 24 | </refentryinfo> |
| 25 | |
| 26 | <refmeta> |
| 27 | <refentrytitle>modinfo</refentrytitle> |
| 28 | <manvolnum>8</manvolnum> |
| 29 | </refmeta> |
| 30 | |
| 31 | <refnamediv> |
| 32 | <refname>modinfo</refname> |
| 33 | <refpurpose>Show information about a Linux Kernel module</refpurpose> |
| 34 | </refnamediv> |
| 35 | |
| 36 | <refsynopsisdiv> |
| 37 | <cmdsynopsis> |
| 38 | <command>modinfo</command> |
| 39 | <arg><option>-0</option></arg> |
| 40 | <arg><option>-F <replaceable>field</replaceable></option></arg> |
| 41 | <arg><option>-k <replaceable>kernel</replaceable></option></arg> |
| 42 | <arg rep='repeat'>modulename|filename</arg> |
| 43 | </cmdsynopsis> |
| 44 | <cmdsynopsis> |
| 45 | <command>modinfo -V</command> |
| 46 | </cmdsynopsis> |
| 47 | <cmdsynopsis> |
| 48 | <command>modinfo -h</command> |
| 49 | </cmdsynopsis> |
| 50 | </refsynopsisdiv> |
| 51 | |
| 52 | <refsect1><title>DESCRIPTION</title> |
| 53 | <para> |
| 54 | <command>modinfo</command> extracts information from the Linux Kernel |
| 55 | modules given on the command line. If the module name is not a filename, |
| 56 | then the |
| 57 | <filename>/lib/modules/</filename><replaceable>version</replaceable> |
| 58 | directory is searched, as is also done by |
| 59 | <citerefentry><refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum></citerefentry> |
| 60 | when loading kernel modules. |
| 61 | </para> |
| 62 | <para> |
| 63 | <command>modinfo</command> by default lists each attribute of the module |
| 64 | in form <replaceable>fieldname</replaceable> : |
| 65 | <replaceable>value</replaceable>, for easy reading. The filename is |
| 66 | listed the same way (although it's not really an attribute). |
| 67 | </para> |
| 68 | <para> |
| 69 | This version of <command>modinfo</command> can understand modules of any |
| 70 | Linux Kernel architecture. |
| 71 | </para> |
| 72 | </refsect1> |
| 73 | |
| 74 | <refsect1><title>OPTIONS</title> |
| 75 | <variablelist> |
| 76 | <varlistentry> |
| 77 | <term> |
| 78 | <option>-V</option> |
| 79 | <option>--version</option> |
| 80 | </term> |
| 81 | <listitem> |
| 82 | <para> |
| 83 | Print the modinfo version. |
| 84 | </para> |
| 85 | </listitem> |
| 86 | </varlistentry> |
| 87 | <varlistentry> |
| 88 | <term> |
| 89 | <option>-F</option> |
| 90 | <option>--field</option> |
| 91 | </term> |
| 92 | <listitem> |
| 93 | <para> |
| 94 | Only print this field value, one per line. This is most useful for |
Miklos Vajna | 9be0162 | 2012-01-17 01:48:11 +0100 | [diff] [blame] | 95 | scripts. Field names are case-insensitive. Common fields (which |
Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 96 | may not be in every module) include <literal>author</literal>, |
| 97 | <literal>description</literal>, <literal>license</literal>, |
| 98 | <literal>parm</literal>, <literal>depends</literal>, and |
| 99 | <literal>alias</literal>. There are often multiple |
| 100 | <literal>parm</literal>, <literal>alias</literal> and |
| 101 | <literal>depends</literal> fields. The special field |
| 102 | <literal>filename</literal> lists the filename of the module. |
| 103 | </para> |
| 104 | </listitem> |
| 105 | </varlistentry> |
| 106 | <varlistentry> |
| 107 | <term> |
Dave Reisner | 072122f | 2012-07-25 19:29:40 -0400 | [diff] [blame] | 108 | <option>-b <replaceable>basedir</replaceable></option> |
| 109 | <option>--basedir <replaceable>basedir</replaceable></option> |
| 110 | </term> |
| 111 | <listitem> |
| 112 | <para> |
| 113 | Root directory for modules, <filename>/</filename> by default. |
| 114 | </para> |
| 115 | </listitem> |
| 116 | </varlistentry> |
| 117 | <varlistentry> |
| 118 | <term> |
Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 119 | <option>-k <replaceable>kernel</replaceable></option> |
| 120 | </term> |
| 121 | <listitem> |
| 122 | <para> |
| 123 | Provide information about a kernel other than the running one. This |
| 124 | is particularly useful for distributions needing to extract |
| 125 | information from a newly installed (but not yet running) set of |
| 126 | kernel modules. For example, you wish to find which firmware files |
| 127 | are needed by various modules in a new kernel for which you must |
| 128 | make an initrd/initramfs image prior to booting. |
| 129 | </para> |
| 130 | </listitem> |
| 131 | </varlistentry> |
| 132 | <varlistentry> |
| 133 | <term> |
| 134 | <option>-0</option> |
| 135 | <option>--null</option> |
| 136 | </term> |
| 137 | <listitem> |
| 138 | <para> |
| 139 | Use the ASCII zero character to separate field values, instead of a |
| 140 | new line. This is useful for scripts, since a new line can |
| 141 | theoretically appear inside a field. |
| 142 | </para> |
| 143 | </listitem> |
| 144 | </varlistentry> |
| 145 | <varlistentry> |
| 146 | <term> |
| 147 | <option>-a</option> |
Dave Reisner | ff99096 | 2012-07-25 19:36:40 -0400 | [diff] [blame^] | 148 | <option>--author</option> |
| 149 | </term> |
| 150 | <term> |
Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 151 | <option>-d</option> |
Dave Reisner | ff99096 | 2012-07-25 19:36:40 -0400 | [diff] [blame^] | 152 | <option>--description</option> |
| 153 | </term> |
| 154 | <term> |
Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 155 | <option>-l</option> |
Dave Reisner | ff99096 | 2012-07-25 19:36:40 -0400 | [diff] [blame^] | 156 | <option>--license</option> |
| 157 | </term> |
| 158 | <term> |
Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 159 | <option>-p</option> |
Dave Reisner | ff99096 | 2012-07-25 19:36:40 -0400 | [diff] [blame^] | 160 | <option>--parameters</option> |
| 161 | </term> |
| 162 | <term> |
Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 163 | <option>-n</option> |
Dave Reisner | ff99096 | 2012-07-25 19:36:40 -0400 | [diff] [blame^] | 164 | <option>--filename</option> |
Lucas De Marchi | 9f11c43 | 2012-01-12 14:20:10 -0200 | [diff] [blame] | 165 | </term> |
| 166 | <listitem> |
| 167 | <para> |
| 168 | These are shortcuts for <literal>author</literal>, |
| 169 | <literal>description</literal>, <literal>license</literal>. |
| 170 | <literal>parm</literal> and <literal>filename</literal> |
| 171 | respectively, to ease the transition from the old modutils |
| 172 | <command>modinfo</command>. |
| 173 | </para> |
| 174 | </listitem> |
| 175 | </varlistentry> |
| 176 | </variablelist> |
| 177 | </refsect1> |
| 178 | |
| 179 | <refsect1><title>COPYRIGHT</title> |
| 180 | <para> |
| 181 | This manual page originally Copyright 2003, Rusty Russell, IBM |
| 182 | Corporation. Maintained by Jon Masters and others. |
| 183 | </para> |
| 184 | </refsect1> |
| 185 | |
| 186 | <refsect1><title>SEE ALSO</title> |
| 187 | <para> |
| 188 | <citerefentry> |
| 189 | <refentrytitle>modprobe</refentrytitle><manvolnum>8</manvolnum> |
| 190 | </citerefentry> |
| 191 | </para> |
| 192 | </refsect1> |
| 193 | </refentry> |