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