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