2 .\" Copyright (c) 2008 Guillaume Ballet
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
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.
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
26 .\" $FreeBSD: src/share/man/man9/DB_COMMAND.9,v 1.6 2012/05/20 16:43:47 gjb Exp $
34 .Nd Extends the ddb command set
41 .Fn DB_SHOW_COMMAND "command_name" "command_function"
47 to the list of top-level commands.
51 .Fa command_function .
55 is roughly equivalent to
59 is a sub-command of the ddb
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
70 The address passed to the command as an argument.
72 A boolean value that is true if the addr field is valid.
74 The number of quad words starting at offset
76 that the command must process.
78 A pointer to the string of modifiers.
79 That is, a series of symbols used to pass some options to the command.
82 command will display words in decimal form if it is passed the modifier "d".
85 In your module, the command is declared as:
87 DB_COMMAND(mycmd, my_cmd_func)
90 db_printf("Calling my command with address %p\en", addr);
98 Calling my command with address 0x1000
105 This manual page was written by
106 .An Guillaume Ballet Aq Mt gballet@gmail.com .