kmodload.tproj/kmodsyms.8

   1 .\"
   2 .\" Copyright (c) 1997 Doug Rabson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\"     $Id: kmodsyms.8,v 1.3 2002/04/15 20:28:31 lindak Exp $
  27 .\"
  28 .Dd April 8, 1999
  29 .Dt KMODSYMS 8
  30 .Os FreeBSD
  31 .Sh NAME
  32 .Nm kmodsyms
  33 .Nd creates a statically-linked symbol file for remote debugging
  34 .Sh SYNOPSIS
  35 .Nm kmodsyms
  36 .Op Fl v
  37 .Op Fl k Ar kernel_file
  38 .Op Fl d Ar dependency_file
  39 .Fl o Ar symbol_file
  40 .Ar module_file
  41 .Nm kmodsyms
  42 .Op Fl v
  43 .Fl k Ar kernel_file
  44 .Op Fl d Ar dependency_file@address
  45 .Fl o Ar symbol_file
  46 .Ar module_file@address
  47 .Sh DESCRIPTION
  48 .Nm kmodsyms
  49 is deprecated; use
  50 .Xr kextload 8 ,
  51 instead.
  52 .Pp
  53 The
  54 .Nm kmodsyms
  55 creates a statically-linked symbol file for remote debugging using
  56 .Ar module_file[@address] .
  57 If an address is specified for either the
  58 .Ar module_file
  59 or
  60 .Ar dependency_file
  61 they both must have the address tag.
  62 If addresses are specified,
  63 it is assumed that the command is being run on a different machine
  64 with a potentially different kernel.
  65 Thus, the
  66 .Ar kernel_file
  67 argument is also required.
  68 If addresses are not specified,
  69 they taken from the currently running host machine.
  70 .Pp
  71 The following options are available:
  72 .Bl -tag -width indent
  73 .\" ==========
  74 .It Fl d Ar dependency_file[@address]
  75 Add symbols from
  76 .Ar dependency_file
  77 to kernel symbols prior to linking of
  78 .Ar module_file .
  79 The file
  80 .Ar dependency_file
  81 must already be loaded.
  82 .\" ==========
  83 .It Fl k Ar kernel_file
  84 Use an alternate file
  85 .Ar kernel_file ,
  86 instead of the default file (/mach) for linking
  87 .Ar module_file .
  88 .\" ==========
  89 .It Fl o Ar symbol_file
  90 Creates file named
  91 .Ar symbol_file
  92 that contains statically linked output suitable
  93 for remote debugging use with
  94 .Xr gdb 1 .
  95 .\" ==========
  96 .It Fl v
  97 Be more verbose.
  98 .El
  99 .Sh FILES
 100 .Bl -tag -width /modules -compact
 101 .It Pa /System/Library/Extensions
 102 directory containing loadable kernel modules.
 103 .Sh DIAGNOSTICS
 104 The
 105 .Nm kmodsyms
 106 utility exits with a status of 0 on success.
 107 A status of 1 indicates a usage error.
 108 A status of 2 indicates a indicates a permissions error.
 109 A status of 3 indicates a problem with linking the module.
 110 A status of 4 indicates a internal or system error.
 111 .Sh SEE ALSO
 112 .Xr kmodload 8 ,
 113 .Xr kmodstat 8 ,
 114 .Xr kmodunload 8
 115 .Sh HISTORY
 116 The
 117 .Nm kmodsyms
 118 command is based on the command kldload, written by
 119 .An Doug Rabson Aq dfr@FreeBSD.org