manual/e2fsprogs/original/man1/mk_cmds.1

   1 .\" Copyright (c) 2003 Theodore Ts'o
   2 .\"
   3 .TH MK_CMDS 1 "2003" E2FSPROGS
   4 .SH NAME
   5 mk_cmds \- error table compiler
   6 .SH SYNOPSIS
   7 .B mk_cmds
   8 file
   9 .SH DESCRIPTION
  10 .B Mk_cmds
  11 converts a table listing command names and associated help messages
  12 into a C source file suitable for use with the
  13 .IR ss (3)
  14 library.
  15
  16 The source file name must end with a suffix of ``.ct''; the file
  17 consists of a declaration supplying the name of the command table:
  18
  19 .B command_table
  20 .I name
  21
  22 followed by entries of the form:
  23
  24 [
  25 .B request
  26 |
  27 .B unimplemented
  28 ]
  29 .I name,
  30 "
  31 .I string
  32 "[, abbrev]...;
  33
  34 and a final
  35
  36 .B end
  37
  38 to indicate the end of the table.
  39
  40 A C source file is generated which should be compiled and linked
  41 with the object files use the ss library.
  42
  43 A ``#'' in the source file is treated as a comment character, and all
  44 remaining text to the end of the source line will be ignored.
  45
  46 .SH BUGS
  47
  48 Since the original
  49 .B mk_cmds
  50 uses a very simple parser based on
  51 .IR yacc (1),
  52 and this current version of
  53 .B mk_cmds
  54 uses an awk/sed combination of scripts,
  55 its error recovery leaves much to be desired.
  56
  57 .SH "SEE ALSO"
  58 ss (3)
  59