share/man/man9/DB_COMMAND.9

   1 .\"-
   2 .\" Copyright (c) 2008 Guillaume Ballet
   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 .\" $FreeBSD$
  27 .\"
  28 .Dd August 27, 2008
  29 .Dt DB_COMMAND 9
  30 .Os
  31 .Sh NAME
  32 .Nm DB_COMMAND ,
  33 .Nm DB_SHOW_COMMAND ,
  34 .Nm DB_SHOW_ALL_COMMAND
  35 .Nd Extends the ddb command set
  36 .Sh SYNOPSIS
  37 .In ddb/ddb.h
  38 .Fo DB_COMMAND
  39 .Fa command_name
  40 .Fa command_function
  41 .Fc
  42 .Fn DB_SHOW_COMMAND "command_name" "command_function"
  43 .Fn DB_SHOW_ALL_COMMAND "command_name" "command_function"
  44 .Sh DESCRIPTION
  45 .Pp
  46 The
  47 .Fn DB_COMMAND
  48 macro adds
  49 .Fa command_name
  50 to the list of top-level commands.
  51 Invoking
  52 .Fa command_name
  53 from ddb will call
  54 .Fa command_function .
  55 .Pp
  56 The
  57 .Fn DB_SHOW_COMMAND
  58 and
  59 .Fn DB_SHOW_ALL_COMMAND
  60 are roughly equivalent to
  61 .Fn DB_COMMAND
  62 but in these cases,
  63 .Fa command_name
  64 is a sub-command of the ddb
  65 .Sy show
  66 command and
  67 .Sy show all
  68 command, respectively.
  69 .Pp
  70 The general command syntax:
  71 .Cm command Ns Op Li \&/ Ns Ar modifier
  72 .Ar address Ns Op Li , Ns Ar count ,
  73 translates into the following parameters for
  74 .Fa command_function :
  75 .Bl -tag -width Fa -offset indent
  76 .It Fa addr
  77 The address passed to the command as an argument.
  78 .It Fa have_addr
  79 A boolean value that is true if the addr field is valid.
  80 .It Fa count
  81 The number of quad words starting at offset
  82 .Fa addr
  83 that the command must process.
  84 .It Fa modif
  85 A pointer to the string of modifiers. That is, a series of symbols used to pass some options to the command. For example, the
  86 .Sy examine
  87 command will display words in decimal form if it is passed the modifier "d".
  88 .El
  89 .Sh EXAMPLE
  90 In your module, the command is declared as:
  91 .Bd -literal
  92 DB_COMMAND(mycmd, my_cmd_func)
  93 {
  94         if (have_addr)
  95                 db_printf("Calling my command with address %p\\n", addr);
  96 }
  97 .Ed
  98 .Pp
  99 Then, when in ddb:
 100 .Bd -literal
 101 .Bf Sy
 102 db> mycmd 0x1000
 103 Calling my command with address 0x1000
 104 db>
 105 .Ef
 106 .Ed
 107 .Sh "SEE ALSO"
 108 .Xr ddb 4
 109 .Sh AUTHOR
 110 This manual page was written by
 111 .An Guillaume Ballet Aq gballet@gmail.com .