README.dev 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. This README.dev file gives some information about developing texi2html.
  2. Copyright 2010, 2015 Free Software Foundation, Inc.
  3. Copying and distribution of this file, with or without modification,
  4. are permitted in any medium without royalty provided the copyright
  5. notice and this notice are preserved.
  6. [incomplete]
  7. Customizing texi2html
  8. =====================
  9. Initialisation options are read first from
  10. '/usr/local/etc/texi2html/Config' (the exact location being changeable with
  11. the '--sysconfdir=dir' option to the configure script), then from
  12. $HOME/.texi2html/Config, then any command-line options including --init-file
  13. options; with later settings overriding earlier ones.
  14. The default initialisation options are defined in the
  15. 'texi2html.pm' and built-in formats files in formats/*.pm files
  16. contained in the Texi2html distribution (in fact, a script pastes
  17. those files into the beginning of the perl file generated by
  18. `./configure' from texi2html.pl and generates the actual 'texi2html'
  19. script this way.).
  20. To customize 'texi2html' it is best if you copy the appropriate
  21. sections from the 'texi2html.pm' file into an appropriate local
  22. initialization file, make the necessary changes there, and then have
  23. 'texi2html' read this initialisation file by one of the means described
  24. above.
  25. Documentation of texi2html
  26. ==========================
  27. The texi2html Texinfo manual is lagging behind the development. In
  28. addition, you might want to have a look at the comments in the
  29. 'texi2html.pm' file for explanations about customizable parameters
  30. and at the (not up-to-date) texi2html man page for an overview of
  31. texi2html's synopsis.
  32. Files
  33. =====
  34. This distribution includes the following files, among others:
  35. README This file.
  36. NEWS Summary of new features by release.
  37. INSTALL Generic installation instructions.
  38. TODO Things which are yet to be done.
  39. Texi2html source files:
  40. texi2html Actual script to run. Generated by
  41. make, `buildt2h.sh' and `addformats.sh'
  42. from texi2html.pl, texi2html.pm,
  43. MySimple.pm, T2h_i18n.pm, examples/l2h.init,
  44. translations.pl and formats/*.pm.
  45. texi2html.pl Main source file of the converter.
  46. texi2html_configured.pl File generated by `./configure' from
  47. texi2html.pl.
  48. texi2html.pm Default values of configurable
  49. parameters. `buildt2h.sh' inserts this
  50. file into texi2html_configured.pl when
  51. it generates the actual `texi2html' script.
  52. MySimple.pm Perl module which handles the
  53. processing of command-line options.
  54. `buildt2h.sh' inserts this file into
  55. texi2html_configured.pl when it generates
  56. the actual `texi2html' script.
  57. T2h_i18n.pm Code used to handle strings
  58. internationalization (obsolete).
  59. translations.pl translations of strings generated by
  60. the script `manage_i18n.pl' from source
  61. files and files in the `i18n' directory
  62. (obsolete).
  63. po_document/ Directory containing po files used for
  64. translation of strings. The primary source
  65. for the file are outside of texi2html,
  66. in the texinfo po_document/ directory.
  67. po_messages/ Directory containing po files used for
  68. translation of strings. The primary source
  69. for the file are outside of texi2html,
  70. in the texinfo po/ directory.
  71. i18n/ Directory containing one file per language
  72. with translation of strings (obsolete,
  73. generated from po_document/ files).
  74. Helper scripts
  75. gettext_to_separated.pl Helper scripts used to convert gettext po
  76. separated_to_hash.pl files to the former format used by texi2html
  77. up to version 1.82.
  78. manage_i18n.pl Helper script used to regenerate translations
  79. from the source files and the files in the
  80. `i18n/' directory.
  81. buildt2h.sh Helper script used to regenerate the texi2html
  82. script. A simple wrapper around a sed
  83. one-liner.
  84. addformats.sh Other helper script used to regenerate the
  85. texi2html script, for all the built-in formats.
  86. A simple wrapper around a sed one-liner.
  87. Documentation files:
  88. texi2html.texi Texinfo manual of texi2html.
  89. texi2html.1.in Template for generation of man pages
  90. of texi2html (`texi2html.1'). This man
  91. page is incomplete.
  92. Installation files:
  93. configure This file creates creates a Makefile
  94. which in turn creates the other files.
  95. configure.ac This is a template for creating
  96. `configure' using Autoconf.
  97. Makefile.in This is a template for `configure'
  98. to use to make a Makefile. Created by
  99. Automake.
  100. Makefile.am This is a template for Automake
  101. to use to make a Makefile.in.