home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / txict100.zip / texicvt1.00 / readme.org < prev    next >
Text File  |  1997-03-22  |  5KB  |  101 lines
  1. ┌─────────────────────────────────────────────────────────────────────────┐
  2. │                                                                         │
  3. │                    Texinfo to OS/2 *.IPF Converter                      │
  4. │                    ───────────────────────────────                      │
  5. │                                                                         │
  6. │                             Version 1.20                                │
  7. │                                                                         │
  8. │       Author: Andreas Kaiser                                            │
  9. │               Danziger Str. 4                                           │
  10. │               D-7000 Stuttgart 70                                       │
  11. │               Germany                                                   │
  12. │                                                                         │
  13. │               Fidonet:  2:246/8506.9                                    │
  14. │               Internet: ak@ananke.s.bawue.de                            │
  15. └─────────────────────────────────────────────────────────────────────────┘
  16.  
  17. Legal notices:
  18. --------------
  19.  
  20.      BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
  21. WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 
  22. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
  23. OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND,
  24. EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  25. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. 
  26. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS
  27. WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
  28. ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  29.  
  30.      IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  31. WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
  32. AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
  33. FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
  34. CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
  35. PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
  36. RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
  37. FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
  38. SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  39. DAMAGES.
  40.  
  41. Usage:
  42. ------
  43.     texi2ipf [options] Texinfo-source-file IPF-source-file
  44. or
  45.     texi2ipf [options] Texinfo-source-file online-doc-file  
  46. where                          
  47.     IPF-source-file = *.IPF
  48.     online-doc-file = *.INF
  49.  
  50.     Options:
  51.         -Dflag    set Texinfo flag
  52.         -Uflag    set Texinfo flag
  53.         -i    create INF index
  54.         -n    use @node to split into panels, not @chapter
  55.         -?    display usage
  56.  
  57. If the extension of the output filename is .INF, texi2ipf automatically
  58. invokes the IPFC program, which compiles the temporary .IPF file to
  59. .INF. The IPFC program is a component of the OS/2 toolkit. Any other
  60. extension specifies an IPF source file. If you run IPFC separately, use
  61. its option /W1 to avoid warnings.
  62.  
  63. The general rule is: "garbage in garbage out". If you document contains
  64. bugs such as unterminated controls ("@end xxx" missing) you may get any
  65. kind of errors, including core dumps.
  66.  
  67. Texi2ipf normally uses both @node and @chapter/@section/... Texinfo
  68. controls to separate the text into IPF panels. Most Texinfo document
  69. are formatted with @node immediately preceding the corresponding
  70. @chapter control. The @node information is used to resolve
  71. cross-references, the @chapter controls define individual panels and
  72. their toc levels. You can use -n if a document should be interpreted
  73. using @node controls only.
  74.  
  75. Text is converted corrsponding to the printed document whenever
  76. possible. Tabulations, table spacings and indents are imprecise and
  77. sometimes implicitly defined by the IPF format. The program isn't
  78. perfect, so some documents may not appear correctly formatted,
  79. especially if the text format changes significantly within a line of
  80. text. Enumerations alway start with an arabic 1, no matter what the
  81. control specifies.
  82.  
  83.  
  84. History:
  85. --------
  86.  
  87. 1.00    - released
  88.  
  89. 1.10:   - split large index
  90.     - bugfix @if
  91.     - texinfo variables
  92.     - @strong in @table
  93.     - @break
  94.     - don't terminate on redefinition (may happen since we scan
  95.       both iftex and ifinfo)
  96.  
  97. 1.20    - true INF index
  98.     - @def* finally supported
  99.  
  100.     Can convert Emacs 19.27 manual and ELisp 2.3 documentation.
  101.