data2inc.1 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. .TH data2inc 1 "12 November 2004" "Free Pascal" "Binary to include file converter"
  2. .SH NAME
  3. data2inc \- Free Pascal binary to pascal include file converter.
  4. .SH SYNOPSIS
  5. .B data2inc [-ABSVH] msgfile [incfile] [constname]
  6. .SH DESCRIPTION
  7. .B data2inc
  8. reads a binary or text file and converts it to a pascal typed constant
  9. declaration. The constant is an array of characters (zero based), in which
  10. each character's ascii value is the value of the byte at the offset
  11. .I index
  12. in the binary file. (index is the index in the array). If the input file is
  13. a text file, options will be read from the file and an output file will be
  14. generated according to the options encountered.
  15. .SH USAGE
  16. .B data2inc
  17. with the
  18. .B \-B
  19. option accepts a filename of a binary file, and needs the name of an include file
  20. and constant name. The output is written to
  21. .B incfile
  22. The name of the constant
  23. .B constname
  24. is mandatory for a binary file.
  25. .B data2inc
  26. without
  27. .B \-B
  28. option takes the name of a message description file as input. It will
  29. process the message file and write the output as described in the message
  30. file to
  31. .I incfile
  32. .
  33. .SH OPTIONS
  34. data2inc has a small number of options to control its behaviour:
  35. .TP
  36. .B \-A
  37. Write bytes instead of characters. The constant array will be an array of
  38. byte instead of an array of char.
  39. .TP
  40. .B \-B
  41. If this option is given, the
  42. .I msgfile
  43. will be treated as a binary file.
  44. .TP
  45. .B \-H
  46. emit a small helptext.
  47. .TP
  48. .B \-S
  49. .B data2inc
  50. will write the output as an array of strings, or a 2 dimensional array of
  51. characters.
  52. .TP
  53. .B \-V
  54. Show the version number and exit.
  55. .SH SEE ALSO
  56. .IP
  57. .BR ppc386 (1)
  58. .BR bin2obj (1)