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