DB_COMMAND.9 (233422) | DB_COMMAND.9 (233648) |
---|---|
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 unchanged lines hidden (view full) --- 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.\" | 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 unchanged lines hidden (view full) --- 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: head/share/man/man9/DB_COMMAND.9 233422 2012-03-24 13:37:57Z joel $ | 26.\" $FreeBSD: head/share/man/man9/DB_COMMAND.9 233648 2012-03-29 05:02:12Z eadler $ |
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 | 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" | 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. | 44.Sh DESCRIPTION 45The 46.Fn DB_COMMAND 47macro adds 48.Fa command_name 49to the list of top-level commands. |
50Invoking | 50Invoking |
51.Fa command_name | 51.Fa command_name |
52from ddb will call | 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 | 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 | 63is a sub-command of the ddb |
64.Sy show 65command and 66.Sy show all 67command, respectively. 68.Pp 69The general command syntax: | 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 | 70.Cm command Ns Op Li \&/ Ns Ar modifier |
71.Ar address Ns Op Li , Ns Ar count , 72translates into the following parameters for 73.Fa command_function : 74.Bl -tag 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. --- 32 unchanged lines hidden --- | 71.Ar address Ns Op Li , Ns Ar count , 72translates into the following parameters for 73.Fa command_function : 74.Bl -tag 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. --- 32 unchanged lines hidden --- |