tooldocs.txt 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360
  1. #############################################################################
  2. SHORT USAGE INFORMATION of included PCTOOLS
  3. -----------------------------------------------------------------------------
  4. NOTE: tooldocs.txt will be automatically generated by calling each tool
  5. without any commandline parameter.
  6. Don't modify this document by hand. You will loose your changes
  7. when builddocs(.bat) will be run again
  8. #############################################################################
  9. TTArchive 1.11 - TI-68k Developer Utilities v1.40
  10. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:54
  11. Usage: ttarchive [flags] <cfgfile> <varname> [folder]
  12. -89 .... generate TI89 variable
  13. -92 .... generate TI92p variable
  14. -v .... verbose (unsets -quiet)
  15. -quiet ... don't output standard messages (unsets -v)
  16. -e <extension> .... use special extension
  17. cfgfile .... configuration file to use
  18. varname .... on-calc variable name of output
  19. folder .... on-calc destination folder (OPTIONAL)
  20. generates an archive file. The contents of the archive
  21. have to be specified in a configfile where each line contains
  22. one file which should be added to the archive.
  23. An archive file can hold compressed or uncompressed entries.
  24. If an entry should be compressed add tag "compress" at the
  25. end of the config line.
  26. [-------- format of one line in the configfile --------]
  27. <file_to_store> <varname> <attr1> <attr2> [compress]
  28. file_to_store ... name including path to inputfile
  29. varname ... name used to find data in archive (max. 8 chars)
  30. attr1 attr2 ... misc. attributes which may be queried from program
  31. (0..65536)
  32. compress ... if this tag is set on the end of the line the
  33. given inputfile will be compressed before adding
  34. it to the archive
  35. -----------------------------------------------------------------------------
  36. TTBin2Str 1.8 - TI-68k Developer Utilities v1.40
  37. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:53
  38. Usage: ttbin2str <-s89 | -s92> <infile> <name> [folder]
  39. -s89 .... generate TI89 string
  40. -s92 .... generate TI92 string
  41. -f .... don't print a warning if the string contains at least one 0x00
  42. (strings containing 0x00 may prove problematic to transfer using TI-Connect)
  43. enwraps any file into a TI89 or TI92 string variable
  44. -----------------------------------------------------------------------------
  45. TTBin2Hex 1.10 - TI-68k Developer Utilities v1.40
  46. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:51
  47. Usage: ttbin2hex [flags] <infile> <outfile>
  48. -quiet .... don't output standard messages
  49. -slash .... append backslash at end of line
  50. -c <count> .... number of items per line
  51. -b1 .... generate unsigned char array
  52. -b2 .... generate unsigned int array
  53. -b4 .... generate unsigned long array
  54. -a <name> .... generate an array with given name
  55. -ss <nr> .... skip number of bytes at begin of inputfile
  56. -se <nr> .... skip number of bytes at end of inputfile
  57. -lb <nr> .... insert an additionally linebreak every nr items
  58. infile .... name of infile
  59. outfile .... name of outfile (use "-" for stdout)
  60. converts binary file to C array data
  61. -----------------------------------------------------------------------------
  62. TTBin2OTH 1.11 - TI-68k Developer Utilities v1.40
  63. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:52
  64. Usage: ttbin2oth [flags] <-89 | -92> <extension> <infile> <varname> [folder]
  65. -quiet ... don't output standard messages
  66. -strip ... MUST be set if the input is already a TI file
  67. (generates a temporary file called bin2oth.tmp for
  68. the stripped inputfile)
  69. -89 ... generate a TI89 file
  70. -92 ... generate a TI92p file
  71. extension ... on-calc extension (up to 4 characters)
  72. varname ... on-calc variable name (up to 8 characters)
  73. folder ... on-calc destination folder (OPTIONAL)
  74. enwraps file into a custom TI89 or TI92p variable with given <extension>
  75. NOTE1: the extension length may vary between 1 and 4 characters
  76. NOTE2: the output filename is generated by taking the given varname and
  77. appending ".89y" or ".9xy" to it.
  78. NOTE3: if a generated file CAN'T BE UPLOADED, you are probably using a
  79. reserved AMS name for your variable. Just try another name in
  80. this case.
  81. -----------------------------------------------------------------------------
  82. TTBin2Bin 1.7 - TI-68k Developer Utilities v1.40
  83. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:00
  84. Usage: ttbin2bin [-quiet] <infile>
  85. quiet ... don't output standard messages
  86. converts TI89 binary to TI92p binary or TI92p binary to TI89 binary
  87. by just patching the header information. the generated outputfile
  88. will have the same name, but a different extension.
  89. NOTE1: this should be only applied to datafiles or executables
  90. which uses no compiled in calc depending constants
  91. NOTE2: the program auto-detects the infile type by the extension
  92. if the extension starts with '.89' it will treated as
  93. TI89 inputfile. if it starts with '.9x' it will be treated
  94. as TI92p inputfile.
  95. -----------------------------------------------------------------------------
  96. TTChecksum 1.7 - TI-68k Developer Utilities v1.40
  97. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:59
  98. Usage: ttchecksum <infile>
  99. corrects the checksum of 89z/89s/89y/9xz/9xs/9xy calculator files.
  100. NOTE: if the embedded filelength doesn't match the real filelength
  101. (for example: caused by an invalid FTP transfer) the file
  102. cannot be corrected.
  103. -----------------------------------------------------------------------------
  104. TTDos2EBK 1.9 - TI-68k Developer Utilities v1.40
  105. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:04
  106. Usage: ttdos2ebk [-v] <infile> <outfile>
  107. -v ... print verbose messages
  108. converts a plain dos text to an ebook conform text
  109. by discarding all 0x0D and by handling the following
  110. inlined metatags:
  111. <mt ff> ... inserts a form feed
  112. <mt hr> ... inserts a horizontal ruler
  113. <mt left> ... text alignment left
  114. <mt right> ... text alignment right
  115. <mt center> ... text alignment right
  116. and the following preprocessing metatags:
  117. <mt r=on> ... replace single 0x0A by space ON
  118. <mt r=off> ... replace single 0x0A by space OFF
  119. <mt c=on> ... collapse spaces ON
  120. <mt c=off> ... collapse spaces OFF
  121. <mt t=on> ... metatag translation ON
  122. <mt t=off> ... metatag translation OFF
  123. -----------------------------------------------------------------------------
  124. TTEbkGen 1.10 - TI-68k Developer Utilities v1.40
  125. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:04
  126. Usage: ttebkgen [flags] <infile> <varname> "description"
  127. -t titlefile ... own title image - see Note (8)
  128. -89 ... generate ONLY TI89 ebook
  129. -92 ... generate ONLY TI92p ebook
  130. -v ... verbose (unsets -quiet)
  131. -quiet ... don't output standard messages (unsets -v)
  132. -keepfiles ... keep all temporary generated files (for debugging only)
  133. the infile must contain the complete text of the final ebook.
  134. split points must be marked within the inputfile with tag
  135. <--split--> on a single line.
  136. NOTES:
  137. (1) the maximum uncompressed size of a ebook part is 65518 bytes.
  138. (2) the final size of the ebook cannot extend 65608 bytes
  139. (including PC header infos)
  140. (3) if a part is too long, define more splitpoints in the infile
  141. (4) if the complete text will not fit into one ebook, split
  142. the text into two or more ebooks
  143. (5) varname is used as outfile name and as varname on the calculator
  144. (6) don't forget to enclose the description in quotes !!
  145. (7) just the first 19 character of the description are used
  146. (8) titlefile must be a 4-grayscale pic with 160x100 pixels in binary form
  147. generated with ImageStudio (not compressed binary)
  148. -----------------------------------------------------------------------------
  149. TTExtract 1.8 - TI-68k Developer Utilities v1.40
  150. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:53
  151. Usage: ttextract [flags] <infile> <outfile> <starttoken> [<endtoken>]
  152. -quiet .... don't output standard messages (unsets -v)
  153. -v .... output additional messages (unsets -quiet)
  154. -sh .... treat start token as hexcode
  155. -eh .... treat end token as hexcode
  156. Extract part of infile which starts right after the start token.
  157. If an endtoken is given it ends just before the end token.
  158. NOTE1: If you use -sh or -eh the given tokens have to be plain
  159. hexcodes WITHOUT any prefix like "0x" or "0h"
  160. NOTE2: if you want the extracted data to be correct, you have to
  161. use -fno-unit-at-a-time, as long as this switch is
  162. supported by GCC
  163. -----------------------------------------------------------------------------
  164. TTInfo 1.6 - TI-68k Developer Utilities v1.40
  165. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:59
  166. Usage: ttinfo <infile>
  167. prints infos about a 89z/89s/89y/9xz/9xs/9xy file
  168. -----------------------------------------------------------------------------
  169. TTPack 1.9 - TI-68k Developer Utilities v1.40
  170. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:56
  171. Usage: ttpack [-<flags>] <infile> <outfile>
  172. -quiet don't output standard messages (unsets v)
  173. -hti treat input as hex textinput
  174. -hto generate hex textoutput
  175. -fdelta use delta-lz77 -- shortens some files
  176. e<val> force escape bits
  177. r<val> restrict lz search range
  178. n no RLE/LZ length optimization
  179. s full statistics
  180. v verbose (unsets -quiet)
  181. p<val> force extralzposbits
  182. m<val> max len 5..7 (2*2^5..2*2^7)
  183. -----------------------------------------------------------------------------
  184. TTPPGGen 1.8 - TI-68k Developer Utilities v1.40
  185. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:00
  186. Usage: ttppggen [flags] <infile> <varname>
  187. -quiet ... don't output standard messages
  188. -nowarn ... optional flag to turn off signature missmatch warning
  189. infile ... a valid 89z or 9xz program (NOSTUB or kernel-dependent)
  190. varname ... name of output ppg (without extension)
  191. NOTE: the type of file (89y or 9xy) which will be generated depends
  192. on the extension of the given infile
  193. -----------------------------------------------------------------------------
  194. TTSetName 1.2 - TI-68k Developer Utilities v1.40
  195. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:03
  196. Usage: ttsetname [flags] file
  197. -quit ... don't output standard messages
  198. -name string ... set oncalc name to given string (max. 8 chars)
  199. -folder string ... set oncalc folder to given string (max. 8 chars)
  200. sets oncalc name and folder of given TI89/TI92p file
  201. -----------------------------------------------------------------------------
  202. TTSplit 1.7 - TI-68k Developer Utilities v1.40
  203. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:00
  204. Usage: ttsplit [flags] <-t | -b> <offsetfile> <infile>
  205. -t ... treat offsets as linenumbers (starting at 1)
  206. -b ... treat offsets as byteoffsets (starting at 0)
  207. -s <string> ... use inline split tag instead of offset file
  208. -v ... output additionally messages
  209. offsets are read from file offsetfile, which must contain offsets only
  210. in ascending numbers (maximum: 999 offsets). each offset is treated as
  211. the start of a new file. the first offset is the start of the second (!!!)
  212. file and so on.
  213. The outputfile names are generated from the inputfilename using
  214. the following pattern:
  215. <inputname>p<nr>.<inputextension>
  216. nr ranges from 000 to 999
  217. -----------------------------------------------------------------------------
  218. TTStrip 1.8 - TI-68k Developer Utilities v1.40
  219. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:54
  220. Usage: ttstrip [-quiet] <infile> <outfile>
  221. -quiet ... don't output standard messages
  222. extracts the raw binary content of a TI file by stripping
  223. the header and trailing checksum which are only necessary
  224. for the link software to send the data to the calc.
  225. NOTE: after stripping these informations it is no longer
  226. possible to distinguish between a TI89 and a TI92p file.
  227. So be careful!
  228. -----------------------------------------------------------------------------
  229. TTTiler 1.7 - TI-68k Developer Utilities v1.40
  230. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:02
  231. Usage: tttiler [-h|-v|-ht|-vt] <infile> <width> <height> <t_width> <t_height> <entries> <outfile> (array_name)
  232. -h ... tile from left to right and up to down
  233. -v ... tile from up to down and left to right
  234. -ht ... like -h, but generates complete test program
  235. -vt ... like -v, but generates complete test program
  236. infile ... binary image file generated with ImageStudio
  237. width ... width of infile in pixel
  238. height ... height of infile in pixel
  239. t_width ... width of one tile in pixel (<=32)
  240. t_height ... height of one tile in pixel
  241. entries ... number of data fields per line (0<entries<=20)
  242. outfile ... output filename (use - as name for output to stdout)
  243. array_name ... optional name of array to generate
  244. splits binary image file generated with ImageStudio in single
  245. sprites (tiles) and generates C source code
  246. including the necessary macros to access them.
  247. NOTE: only 8, 16 and 32 pixel wide tiles are generated.
  248. If the tilewidth is not exactly one of these widths,
  249. the sprites are filled up to the right with empty pixels
  250. NOTE2: the width of the input file have to be a multiple of 8
  251. otherwise ImageStudio and tttiler will not treat it correctly
  252. -----------------------------------------------------------------------------
  253. TTUnArchive 1.3 - TI-68k Developer Utilities v1.40
  254. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:03
  255. Usage: ttunarchive <infile> [<entry_number> <outfile>]
  256. extracts one entry of an TTArchive into a file
  257. (entry_number starts with 0). If no entry number
  258. and outfile are given, ttunarchive lists only
  259. the contents of the TTArchive
  260. -----------------------------------------------------------------------------
  261. TTUnEbk 1.3 - TI-68k Developer Utilities v1.40
  262. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:59:06
  263. Usage: ttunebk <infile> <outfile>
  264. exports the complete text of an ebook to a plain textfile
  265. -----------------------------------------------------------------------------
  266. TTUnpack 1.8 - TI-68k Developer Utilities v1.40
  267. (c) thomas.nussbaumer@gmx.net Dec 30 2009 20:58:58
  268. Usage: ttunpack [-<flags>] <infile> <outfile>
  269. -hti treat input as hex-text input
  270. -hto generate hex-text output
  271. -t just test (generates no outfile)
  272. -----------------------------------------------------------------------------