gooderp18绿色标准版
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

95 lines
8.6KB

  1. <?xml version="1.0" encoding="UTF-8" standalone="no"?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>J.2. Tool Sets</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /><link rel="prev" href="docguide-docbook.html" title="J.1. DocBook" /><link rel="next" href="docguide-build.html" title="J.3. Building the Documentation" /></head><body><div xmlns="http://www.w3.org/TR/xhtml1/transitional" class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">J.2. Tool Sets</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="docguide-docbook.html" title="J.1. DocBook">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="docguide.html" title="Appendix J. Documentation">Up</a></td><th width="60%" align="center">Appendix J. Documentation</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 12.4 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="docguide-build.html" title="J.3. Building the Documentation">Next</a></td></tr></table><hr></hr></div><div class="sect1" id="DOCGUIDE-TOOLSETS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">J.2. Tool Sets</h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="docguide-toolsets.html#id-1.11.11.5.5">J.2.1. Installation on Fedora, RHEL, and Derivatives</a></span></dt><dt><span class="sect2"><a href="docguide-toolsets.html#id-1.11.11.5.6">J.2.2. Installation on FreeBSD</a></span></dt><dt><span class="sect2"><a href="docguide-toolsets.html#id-1.11.11.5.7">J.2.3. Debian Packages</a></span></dt><dt><span class="sect2"><a href="docguide-toolsets.html#id-1.11.11.5.8">J.2.4. macOS</a></span></dt><dt><span class="sect2"><a href="docguide-toolsets.html#DOCGUIDE-TOOLSETS-CONFIGURE">J.2.5. Detection by <code class="command">configure</code></a></span></dt></dl></div><p>
  3. The following tools are used to process the documentation. Some
  4. might be optional, as noted.
  5. </p><div class="variablelist"><dl class="variablelist"><dt><span class="term"><a class="ulink" href="https://www.oasis-open.org/docbook/" target="_top">DocBook DTD</a></span></dt><dd><p>
  6. This is the definition of DocBook itself. We currently use version
  7. 4.2; you cannot use later or earlier versions. You need
  8. the <acronym class="acronym">XML</acronym> variant of the DocBook DTD, not
  9. the <acronym class="acronym">SGML</acronym> variant.
  10. </p></dd><dt><span class="term"><a class="ulink" href="https://github.com/docbook/wiki/wiki/DocBookXslStylesheets" target="_top">DocBook XSL Stylesheets</a></span></dt><dd><p>
  11. These contain the processing instructions for converting the
  12. DocBook sources to other formats, such as
  13. <acronym class="acronym">HTML</acronym>.
  14. </p><p>
  15. The minimum required version is currently 1.77.0, but it is recommended
  16. to use the latest available version for best results.
  17. </p></dd><dt><span class="term"><a class="ulink" href="http://xmlsoft.org/" target="_top">Libxml2</a> for <code class="command">xmllint</code></span></dt><dd><p>
  18. This library and the <code class="command">xmllint</code> tool it contains are
  19. used for processing XML. Many developers will already
  20. have <span class="application">Libxml2</span> installed, because it is also
  21. used when building the PostgreSQL code. Note, however,
  22. that <code class="command">xmllint</code> might need to be installed from a
  23. separate subpackage.
  24. </p></dd><dt><span class="term"><a class="ulink" href="http://xmlsoft.org/XSLT/" target="_top">Libxslt</a> for <code class="command">xsltproc</code></span></dt><dd><p>
  25. <code class="command">xsltproc</code> is an XSLT processor, that is, a program to
  26. convert XML to other formats using XSLT stylesheets.
  27. </p></dd><dt><span class="term"><a class="ulink" href="https://xmlgraphics.apache.org/fop/" target="_top">FOP</a></span></dt><dd><p>
  28. This is a program for converting, among other things, XML to PDF.
  29. </p></dd></dl></div><p>
  30. </p><p>
  31. We have documented experience with several installation methods for
  32. the various tools that are needed to process the documentation.
  33. These will be described below. There might be some other packaged
  34. distributions for these tools. Please report package status to the
  35. documentation mailing list, and we will include that information
  36. here.
  37. </p><p>
  38. You can get away with not installing DocBook XML and the DocBook XSLT
  39. stylesheets locally, because the required files will be downloaded from the
  40. Internet and cached locally. This may in fact be the preferred solution if
  41. your operating system packages provide only an old version of especially
  42. the stylesheets or if no packages are available at all. See
  43. the <code class="option">--nonet</code> option for <code class="command">xmllint</code>
  44. and <code class="command">xsltproc</code> for more information.
  45. </p><div class="sect2" id="id-1.11.11.5.5"><div class="titlepage"><div><div><h3 class="title">J.2.1. Installation on Fedora, RHEL, and Derivatives</h3></div></div></div><p>
  46. To install the required packages, use:
  47. </p><pre class="programlisting">
  48. yum install docbook-dtds docbook-style-xsl fop libxslt
  49. </pre><p>
  50. </p></div><div class="sect2" id="id-1.11.11.5.6"><div class="titlepage"><div><div><h3 class="title">J.2.2. Installation on FreeBSD</h3></div></div></div><p>
  51. To install the required packages with <code class="command">pkg</code>, use:
  52. </p><pre class="programlisting">
  53. pkg install docbook-xml docbook-xsl fop libxslt
  54. </pre><p>
  55. </p><p>
  56. When building the documentation from the <code class="filename">doc</code>
  57. directory you'll need to use <code class="command">gmake</code>, because the
  58. makefile provided is not suitable for FreeBSD's <code class="command">make</code>.
  59. </p></div><div class="sect2" id="id-1.11.11.5.7"><div class="titlepage"><div><div><h3 class="title">J.2.3. Debian Packages</h3></div></div></div><p>
  60. There is a full set of packages of the documentation tools
  61. available for <span class="productname">Debian GNU/Linux</span>.
  62. To install, simply use:
  63. </p><pre class="programlisting">
  64. apt-get install docbook-xml docbook-xsl fop libxml2-utils xsltproc
  65. </pre><p>
  66. </p></div><div class="sect2" id="id-1.11.11.5.8"><div class="titlepage"><div><div><h3 class="title">J.2.4. macOS</h3></div></div></div><p>
  67. On macOS, you can build the HTML and man documentation without installing
  68. anything extra. If you want to build PDFs or want to install a local copy
  69. of DocBook, you can get those from your preferred package manager.
  70. </p><p>
  71. If you use MacPorts, the following will get you set up:
  72. </p><pre class="programlisting">
  73. sudo port install docbook-xml-4.2 docbook-xsl fop
  74. </pre><p>
  75. If you use Homebrew, use this:
  76. </p><pre class="programlisting">
  77. brew install docbook docbook-xsl fop
  78. </pre><p>
  79. </p></div><div class="sect2" id="DOCGUIDE-TOOLSETS-CONFIGURE"><div class="titlepage"><div><div><h3 class="title">J.2.5. Detection by <code class="command">configure</code></h3></div></div></div><p>
  80. Before you can build the documentation you need to run the
  81. <code class="filename">configure</code> script as you would when building
  82. the <span class="productname">PostgreSQL</span> programs themselves.
  83. Check the output near the end of the run, it should look something
  84. like this:
  85. </p><pre class="screen">
  86. checking for xmllint... xmllint
  87. checking for DocBook XML V4.2... yes
  88. checking for dbtoepub... dbtoepub
  89. checking for xsltproc... xsltproc
  90. checking for fop... fop
  91. </pre><p>
  92. If <code class="filename">xmllint</code> was not found then some of the following
  93. tests will be skipped.
  94. </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="docguide-docbook.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="docguide.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="docguide-build.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">J.1. DocBook </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> J.3. Building the Documentation</td></tr></table></div></body></html>
上海开阖软件有限公司 沪ICP备12045867号-1