sbin/modstat/modstat.8

   1 .\" $NetBSD: modstat.8,v 1.4 2009/10/02 18:50:14 elad Exp $
   2 .\"
   3 .\" Copyright (c) 1993 Christopher G. Demetriou
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"          This product includes software developed for the
  17 .\"          NetBSD Project.  See http://www.NetBSD.org/ for
  18 .\"          information about NetBSD.
  19 .\" 4. The name of the author may not be used to endorse or promote products
  20 .\"    derived from this software without specific prior written permission.
  21 .\"
  22 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
  34 .\"
  35 .Dd October 2, 2009
  36 .Dt MODSTAT 8
  37 .Os
  38 .Sh NAME
  39 .Nm modstat
  40 .Nd display status of loaded kernel modules
  41 .Sh SYNOPSIS
  42 .Nm
  43 .Op Fl n Ar name
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 utility displays the status of any kernel modules
  48 present in the kernel.
  49 .Pp
  50 The options are as follows:
  51 .Bl -tag -width indent
  52 .It Fl n Ar name
  53 Display the status of only the module with this name.
  54 .El
  55 .Pp
  56 In addition to listing the currently loaded modules' name,
  57 the information reported by
  58 .Nm
  59 includes:
  60 .Pp
  61 .Bl -tag -width Loadaddr
  62 .It Li CLASS
  63 Module class, such as
  64 "vfs", "driver", "exec", "misc" or "secmodel".
  65 .It Li SOURCE
  66 Where the module was loaded from.
  67 .Qq Dv builtin
  68 indicates that the module was built into the running kernel.
  69 .Qq Dv boot
  70 indicates that the module was loaded during system bootstrap.
  71 .Qq Dv filesys
  72 indicates that the module was loaded from the file system.
  73 .It Li SIZE
  74 Size of the module in bytes.
  75 .It Li REFS
  76 Number of references held on the module.
  77 .It Li REQUIRES
  78 Additional modules that must be present.
  79 .El
  80 .Sh EXIT STATUS
  81 The
  82 .Nm
  83 utility exits with a status of 0 on success
  84 and with a nonzero status if an error occurs.
  85 .Sh SEE ALSO
  86 .Xr modload 8 ,
  87 .Xr modunload 8
  88 .Sh HISTORY
  89 The
  90 .Nm
  91 command was designed to be similar in functionality
  92 to the corresponding command in
  93 .Tn "SunOS 4.1.3" .