usr.bin/mk_cmds/mk_cmds.1

   1 .\" Copyright (c) 1999 Jeroen Ruigrok van der Werven
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .Dd November 14, 1999
  27 .Dt MK_CMDS 1
  28 .Os
  29 .Sh NAME
  30 .Nm mk_cmds
  31 .Nd generate commands from table file
  32 .Sh SYNOPSIS
  33 .Nm
  34 .Ar cmdtbl.ct
  35 .Sh DESCRIPTION
  36 The
  37 .Nm
  38 utility takes a command table file as input and produces a C source file
  39 as output which is intended to be used with the subsystem library, libss.
  40 This source file automatically includes
  41 .Aq Pa ss/ss.h .
  42 .Pp
  43 The format of the table file to be specified is as follows:
  44 .Pp
  45 command_table name_of_table
  46 .Pp
  47 keyword ss_command_name,
  48 .Qq description_of_command ,
  49 command_binding
  50 .Op ,command_binding ;
  51 .Pp
  52 keyword ss_command_name,
  53 .Qq description_of_command ,
  54 command_name,
  55 (dont_option
  56 .Op , dont_option ) ;
  57 .Pp
  58 end;
  59 .Pp
  60 Keyword is one of the following:
  61 .Pp
  62 .Bl -tag -width "unimplemented" -compact
  63 .It request
  64 A command that can be requested
  65 .It unimplemented
  66 An unimplemented command
  67 .El
  68 .Pp
  69 Dont_option is one of the following:
  70 .Pp
  71 .Bl -tag -width "dont_summarize" -compact
  72 .It dont_list
  73 Do not list the command
  74 .It dont_summarize
  75 Do not list the command in the command summary
  76 .El
  77 .Sh EXAMPLES
  78 request ss_testfunction,
  79 .Qq This is the explanation for testfunction ,
  80 testfunction, tf;
  81 .Pp
  82 request ss_anothertest,
  83 .Qq This is the explanation for anothertest ,
  84 anothertest, (dont_list, dont_summarize);
  85 .Pp
  86 unimplemented ss_lasttest,
  87 .Qq This is the explanation for lasttest ,
  88 lasttest, lt;
  89 .Sh HISTORY
  90 The
  91 .Nm
  92 utility
  93 was written by the MIT Student Information Processing Board and
  94 appeared before
  95 .Fx 2.0.5 .
  96 .Sh AUTHORS
  97 This manual page was written by
  98 .An Jeroen Ruigrok van der Werven
  99 .Aq asmodai@wxs.nl