Changeset 34d0cf2 for gnome/core
- Timestamp:
- 05/15/2005 09:39:32 AM (19 years ago)
- Branches:
- 10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 6.1, 6.2, 6.2.0, 6.2.0-rc1, 6.2.0-rc2, 6.3, 6.3-rc1, 6.3-rc2, 6.3-rc3, 7.10, 7.4, 7.5, 7.6, 7.6-blfs, 7.6-systemd, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, gnome, kde5-13430, kde5-14269, kde5-14686, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
- Children:
- 9d1e929
- Parents:
- a8de889e
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
gnome/core/gnome-doc-utils.xml
ra8de889e r34d0cf2 13 13 ]> 14 14 15 <sect1 id="gnome-doc-utils" 16 xreflabel="GNOME Doc Utils-&gnome-doc-utils-version;"> 17 <sect1info> 18 <othername>$LastChangedBy$</othername> 19 <date>$Date$</date> 20 </sect1info> 21 <?dbhtml filename="gnome-doc-utils.html"?> 22 <title><application><acronym>GNOME</acronym> Doc 23 Utils</application>-&gnome-doc-utils-version;</title> 24 <indexterm zone="gnome-doc-utils"> 25 <primary sortas="a-GNOME-Doc-Utils">GNOME Doc Utils</primary> 26 </indexterm> 15 <sect1 id="gnome-doc-utils" xreflabel="GNOME Doc Utils-&gnome-doc-utils-version;"> 16 <?dbhtml filename="gnome-doc-utils.html"?> 27 17 28 <sect2> 29 <title>Introduction to <application><acronym>GNOME</acronym> Doc 30 Utils</application></title> 18 <sect1info> 19 <othername>$LastChangedBy$</othername> 20 <date>$Date$</date> 21 </sect1info> 31 22 32 <para>The <application><acronym>GNOME</acronym> Doc Utils</application> 33 package is a collection of documentation utilities for the 34 <application><acronym>GNOME</acronym></application> project. Notably, it 35 contains utilities for building documentation and all auxiliary files in your 36 source tree, and it contains the DocBook <acronym>XSLT</acronym> stylesheets 37 that were once distributed with <application>Yelp</application>. Starting with 38 <application><acronym>GNOME</acronym></application> 2.8, 39 <application>Yelp</application> will require 40 <application><acronym>GNOME</acronym> Doc Utils</application> for the 41 <acronym>XSLT</acronym>.</para> 23 <title>GNOME Doc Utils-&gnome-doc-utils-version;</title> 42 24 43 <sect3><title>Package information</title> 44 <itemizedlist spacing="compact"> 45 <listitem><para>Download (HTTP): 46 <ulink url="&gnome-doc-utils-download-http;"/></para></listitem> 47 <listitem><para>Download (FTP): 48 <ulink url="&gnome-doc-utils-download-ftp;"/></para></listitem> 49 <listitem><para>Download MD5 sum: &gnome-doc-utils-md5sum;</para></listitem> 50 <listitem><para>Download size: &gnome-doc-utils-size;</para></listitem> 51 <listitem><para>Estimated disk space required: 52 &gnome-doc-utils-buildsize;</para></listitem> 53 <listitem><para>Estimated build time: 54 &gnome-doc-utils-time;</para></listitem></itemizedlist> 55 </sect3> 25 <indexterm zone="gnome-doc-utils"> 26 <primary sortas="a-GNOME-Doc-Utils">GNOME Doc Utils</primary> 27 </indexterm> 56 28 57 <sect3><title><application><acronym>GNOME</acronym> Doc Utils</application> 58 dependencies</title> 59 <sect4><title>Required</title> 60 <para><xref linkend="scrollkeeper"/></para> 61 </sect4> 29 <sect2 role="package"> 30 <title>Introduction to GNOME Doc Utils</title> 62 31 63 <sect4><title>Optional</title> 64 <para><xref linkend="pkgconfig"/> and <xref linkend="python"/></para> 65 </sect4> 66 </sect3> 32 <para>The <application>GNOME Doc Utils</application> package is a collection 33 of documentation utilities for the <application>GNOME</application> project. 34 Notably, it contains utilities for building documentation and all auxiliary 35 files in your source tree, and it contains the DocBook XSLT stylesheets that 36 were once distributed with <application>Yelp</application>. Starting with 37 <application>GNOME</application> 2.8, <application>Yelp</application> will 38 require <application>GNOME Doc Utils</application> for the XSLT.</para> 67 39 68 </sect2> 40 <bridgehead renderas="sect3">Package Information</bridgehead> 41 <itemizedlist spacing="compact"> 42 <listitem> 43 <para>Download (HTTP): <ulink url="&gnome-doc-utils-download-http;"/></para> 44 </listitem> 45 <listitem> 46 <para>Download (FTP): <ulink url="&gnome-doc-utils-download-ftp;"/></para> 47 </listitem> 48 <listitem> 49 <para>Download MD5 sum: &gnome-doc-utils-md5sum;</para> 50 </listitem> 51 <listitem> 52 <para>Download size: &gnome-doc-utils-size;</para> 53 </listitem> 54 <listitem> 55 <para>Estimated disk space required: &gnome-doc-utils-buildsize;</para> 56 </listitem> 57 <listitem> 58 <para>Estimated build time: &gnome-doc-utils-time;</para> 59 </listitem> 60 </itemizedlist> 69 61 70 <sect2> 71 <title>Installation of <application><acronym>GNOME</acronym> Doc 72 Utils</application></title> 62 <bridgehead renderas="sect3">GNOME Doc Utils Dependencies</bridgehead> 73 63 74 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../without-gnome.xml"/> 64 <bridgehead renderas="sect4">Required</bridgehead> 65 <para><xref linkend="scrollkeeper"/></para> 75 66 76 <para>Install <application><acronym>GNOME</acronym> Doc Utils</application> 77 by running the following commands:</para>67 <bridgehead renderas="sect4">Optional</bridgehead> 68 <para><xref linkend="pkgconfig"/> and <xref linkend="python"/></para> 78 69 79 <screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \ 70 </sect2> 71 72 <sect2 role="installation"> 73 <title>Installation of GNOME Doc Utils</title> 74 75 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" 76 href="../without-gnome.xml"/> 77 78 <para>Install <application>GNOME Doc Utils</application> 79 by running the following commands:</para> 80 81 <screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` \ 80 82 --localstatedir=/var/lib && 81 make</ command></userinput></screen>83 make</userinput></screen> 82 84 83 <para>To test the results, issue: <command>make check</command>.</para>85 <para>To test the results, issue: <command>make check</command>.</para> 84 86 85 <para>Now, as the rootuser:</para>87 <para>Now, as the <systemitem class="username">root</systemitem> user:</para> 86 88 87 <screen ><userinput role='root'><command>make install</command></userinput></screen>89 <screen role="root"><userinput>make install</userinput></screen> 88 90 89 </sect2>91 </sect2> 90 92 91 <sect2>92 <title>Command explanations</title>93 <sect2 role="commands"> 94 <title>Command Explanations</title> 93 95 94 <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts95 <application>ScrollKeeper</application> files in96 <filename class='directory'>/var/lib/scrollkeeper</filename> instead of97 <filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para>96 <para><parameter>--localstatedir=/var/lib</parameter>: This switch puts 97 <application>ScrollKeeper</application> files in 98 <filename class='directory'>/var/lib/scrollkeeper</filename> instead of 99 <filename class='directory'>$GNOME_PREFIX/var/scrollkeeper</filename>.</para> 98 100 99 </sect2>101 </sect2> 100 102 101 <sect2>102 <title>Contents</title>103 <sect2 role="content"> 104 <title>Contents</title> 103 105 104 <segmentedlist>105 <segtitle>Installed Programs</segtitle>106 <segtitle>Installed Libraries</segtitle>107 <segtitle>Installed Directories</segtitle>108 <segtitle>Installed Stylesheets</segtitle>106 <segmentedlist> 107 <segtitle>Installed Programs</segtitle> 108 <segtitle>Installed Libraries</segtitle> 109 <segtitle>Installed Directories</segtitle> 110 <segtitle>Installed Stylesheets</segtitle> 109 111 110 <seglistitem>111 <seg>gnome-doc-prepare and xml2po</seg>112 <seg>None</seg>113 <seg>$GNOME_PREFIX/share/gnome-doc-utils, 114 $GNOME_PREFIX/share/gnome/help/gnome-doc-make, 115 $GNOME_PREFIX/share/gnome/help/gnome-doc-xslt, 116 $GNOME_PREFIX/share/omf/gnome-doc-make, 117 $GNOME_PREFIX/share/omf/gnome-doc-xslt, 118 $GNOME_PREFIX/share/xml and119 $GNOME_PREFIX/share/xml2po</seg>120 <seg>Custom DocBook XSLT stylesheets used by Yelp</seg>121 </seglistitem>122 </segmentedlist>112 <seglistitem> 113 <seg>gnome-doc-prepare and xml2po</seg> 114 <seg>None</seg> 115 <seg>$GNOME_PREFIX/share/gnome-doc-utils, 116 $GNOME_PREFIX/share/gnome/help/gnome-doc-make, 117 $GNOME_PREFIX/share/gnome/help/gnome-doc-xslt, 118 $GNOME_PREFIX/share/omf/gnome-doc-make, 119 $GNOME_PREFIX/share/omf/gnome-doc-xslt, 120 $GNOME_PREFIX/share/xml and 121 $GNOME_PREFIX/share/xml2po</seg> 122 <seg>Custom DocBook XSLT stylesheets used by Yelp</seg> 123 </seglistitem> 124 </segmentedlist> 123 125 124 <variablelist> 125 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 126 <?dbfo list-presentation="list"?> 126 <variablelist> 127 <bridgehead renderas="sect3">Short Descriptions</bridgehead> 128 <?dbfo list-presentation="list"?> 129 <?dbhtml list-presentation="table"?> 127 130 128 <varlistentry id="gnome-doc-prepare"> 129 <term><command>gnome-doc-prepare</command></term> 130 <listitem><para>prepares a package to use 131 <application>gnome-doc-utils</application>.</para> 132 <indexterm zone="gnome-doc-utils gnome-doc-prepare"> 133 <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary> 134 </indexterm></listitem> 135 </varlistentry> 131 <varlistentry id="gnome-doc-prepare"> 132 <term><command>gnome-doc-prepare</command></term> 133 <listitem> 134 <para>prepares a package to use 135 <application>gnome-doc-utils</application>.</para> 136 <indexterm zone="gnome-doc-utils gnome-doc-prepare"> 137 <primary sortas="b-gnome-doc-prepare">gnome-doc-prepare</primary> 138 </indexterm> 139 </listitem> 140 </varlistentry> 136 141 137 <varlistentry id="xml2po"> 138 <term><command>xml2po</command></term> 139 <listitem><para>is a <application>Python</application> script used to 140 translate <acronym>XML</acronym> documents.</para> 141 <indexterm zone="gnome-doc-utils xml2po"> 142 <primary sortas="b-xml2po">xml2po</primary> 143 </indexterm></listitem> 144 </varlistentry> 145 </variablelist> 142 <varlistentry id="xml2po"> 143 <term><command>xml2po</command></term> 144 <listitem> 145 <para>is a <application>Python</application> script used to 146 translate XML documents.</para> 147 <indexterm zone="gnome-doc-utils xml2po"> 148 <primary sortas="b-xml2po">xml2po</primary> 149 </indexterm> 150 </listitem> 151 </varlistentry> 146 152 147 </sect2> 153 </variablelist> 154 155 </sect2> 148 156 149 157 </sect1>
Note:
See TracChangeset
for help on using the changeset viewer.