.\" Copyright (c) 1999 Jeroen Ruigrok van der Werven
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.Dd November 14, 1999
.Dt MK_CMDS 1
.Os FreeBSD
.Sh NAME
.Nm mk_cmds
.Nd generate commands from table file
.Sh SYNOPSIS
.Nm mk_cmds
.Ar cmdtbl.ct
.Sh DESCRIPTION
The
.Nm
utility takes a command table file as input and produces a C source file
as output which is intended to be used with the subsystem library, libss.
This source file automatically includes
.Aq Pa ss/ss.h .
.Pp
The format of the table file to be specified is as follows:
.Pp
command_table name_of_table
.Pp
keyword ss_command_name,
.Qq description_of_command ,
command_binding
.Op ,command_binding ;
.Pp
keyword ss_command_name,
.Qq description_of_command ,
command_name,
(dont_option
.Op ", dont_option"
);
.Pp
end;
.Pp
Keyword is one of the following:
.Pp
.Bl -tag -width "unimplemented" -compact
.It request
A command that can be requested
.It unimplemented
An unimplemented command
.El
.Pp
Dont_option is one of the following:
.Pp
.Bl -tag -width "dont_summarize" -compact
.It dont_list
Do not list the command
.It dont_summarize
Do not list the command in the command summary
.Sh EXAMPLES
request ss_testfunction,
.Qq This is the explanation for testfunction ,
testfunction, tf;
.Pp
request ss_anothertest,
.Qq This is the explanation for anothertest ,
anothertest, (dont_list, dont_summarize);
.Pp
unimplemented ss_lasttest
.Qq This is the explanation for lasttest ,
lasttest, lt;
.Sh HISTORY
The
.Nm mk_cmds
utility
was written by the MIT Student Information Processing Board and
appeared before
.Fx 2.0.5 .
.Sh AUTHORS
This manual page was written by
.An Jeroen Ruigrok van der Werven
.Aq asmodai@wxs.nl