Changeset effdc6af


Ignore:
Timestamp:
05/01/2005 08:21:36 PM (19 years ago)
Author:
Manuel Canales Esparcia <manuel@…>
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:
a6702c70
Parents:
ab29575
Message:

Tagged gtk-doc.xml

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3929 af4574ff-66df-0310-9fd7-8a98e5e911e0

File:
1 edited

Legend:

Unmodified
Added
Removed

  • general/genutils/gtk-doc.xml

    rab29575 reffdc6af  
    55  %general-entities;
    66
    7 <!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
    8 <!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
    9 <!ENTITY gtk-doc-md5sum "d105d5b28e7e023ab1b7e85fb65e45c3">
    10 <!ENTITY gtk-doc-size "145 KB">
    11 <!ENTITY gtk-doc-buildsize "1.6 MB">
    12 <!ENTITY gtk-doc-time "0.01 SBU">
     7  <!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
     8  <!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
     9  <!ENTITY gtk-doc-md5sum "d105d5b28e7e023ab1b7e85fb65e45c3">
     10  <!ENTITY gtk-doc-size "145 KB">
     11  <!ENTITY gtk-doc-buildsize "1.6 MB">
     12  <!ENTITY gtk-doc-time "0.01 SBU">
    1313]>
    1414
    1515<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-doc-version;">
    16 <sect1info>
    17 <othername>$LastChangedBy$</othername>
    18 <date>$Date$</date>
    19 </sect1info>
    20 <?dbhtml filename="gtk-doc.html"?>
    21 <title>GTK-Doc-&gtk-doc-version;</title>
    22 <indexterm zone="gtk-doc">
    23 <primary sortas="a-GTK-Doc">GTK-Doc</primary></indexterm>
     16  <?dbhtml filename="gtk-doc.html"?>
     17 
     18  <sect1info>
     19    <othername>$LastChangedBy$</othername>
     20    <date>$Date$</date>
     21  </sect1info>
     22 
     23  <title>GTK-Doc-&gtk-doc-version;</title>
     24 
     25  <indexterm zone="gtk-doc">
     26    <primary sortas="a-GTK-Doc">GTK-Doc</primary>
     27  </indexterm>
    2428
    25 <sect2>
    26 <title>Introduction to <application><acronym>GTK</acronym>-Doc</application>
    27 </title>
     29  <sect2 role="package">
     30    <title>Introduction to GTK-Doc</title>
     31   
     32    <para>The <application>GTK-Doc</application> package
     33    contains a code documentor. This is useful for extracting specially formatted
     34    comments from the code to create API documentation. This
     35    package is <emphasis>optional</emphasis>; if it is not installed, packages will
     36    not build the documentation. This does not mean that you will not have any
     37    documentation. If <application>GTK-Doc</application> is not
     38    available, the install process will copy pre-built documentation to your
     39    system.</para>
     40   
     41    <bridgehead renderas="sect3">Package Information</bridgehead>
     42    <itemizedlist spacing="compact">
     43      <listitem>
     44        <para>Download (HTTP): <ulink url="&gtk-doc-download-http;"/></para>
     45      </listitem>
     46      <listitem>
     47        <para>Download (FTP): <ulink url="&gtk-doc-download-ftp;"/></para>
     48      </listitem>
     49      <listitem>
     50        <para>Download MD5 sum: &gtk-doc-md5sum;</para>
     51      </listitem>
     52      <listitem>
     53        <para>Download size: &gtk-doc-size;</para>
     54      </listitem>
     55      <listitem>
     56        <para>Estimated disk space required: &gtk-doc-buildsize;</para>
     57      </listitem>
     58      <listitem>
     59        <para>Estimated build time: &gtk-doc-time;</para>
     60      </listitem>
     61    </itemizedlist>
     62   
     63    <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
     64   
     65    <bridgehead renderas="sect4">Required</bridgehead>
     66    <para><xref linkend="openjade"/>,
     67    <xref linkend="libxslt"/>,
     68    <xref linkend="DocBook"/> and
     69    <xref linkend="docbook-xsl"/></para>
     70   
     71    <bridgehead renderas="sect4">Optional</bridgehead>
     72    <para><xref linkend="sgml-dtd"/> and <xref linkend="docbook-dsssl"/></para>
     73   
     74  </sect2>
     75 
     76  <sect2 role="installation">
     77    <title>Installation of GTK-Doc</title>
    2878
    29 <para>The <application><acronym>GTK</acronym>-Doc</application> package
    30 contains a code documentor. This is useful for extracting specially formatted
    31 comments from the code to create <acronym>API</acronym> documentation. This
    32 package is <emphasis>optional</emphasis>; if it is not installed, packages will
    33 not build the documentation. This does not mean that you will not have any
    34 documentation. If <application><acronym>GTK</acronym>-Doc</application> is not
    35 available, the install process will copy pre-built documentation to your
    36 system.</para>
     79    <para>Install <application>GTK-Doc</application> by running
     80    the following commands:</para>
    3781
    38 <sect3><title>Package information</title>
    39 <itemizedlist spacing='compact'>
    40 <listitem><para>Download (HTTP): <ulink
    41 url="&gtk-doc-download-http;"/></para></listitem>
    42 <listitem><para>Download (FTP): <ulink
    43 url="&gtk-doc-download-ftp;"/></para></listitem>
    44 <listitem><para>Download MD5 sum: &gtk-doc-md5sum;</para></listitem>
    45 <listitem><para>Download size: &gtk-doc-size;</para></listitem>
    46 <listitem><para>Estimated disk space required:
    47 &gtk-doc-buildsize;</para></listitem>
    48 <listitem><para>Estimated build time:
    49 &gtk-doc-time;</para></listitem></itemizedlist>
    50 </sect3>
     82<screen><userinput>./configure --prefix=/usr</userinput></screen>
     83   
     84    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     85   
     86<screen role="root"><userinput>make install</userinput></screen>
     87   
     88  </sect2>
     89 
     90  <sect2 role="content">
     91    <title>Contents</title>
    5192
    52 <sect3><title><application><acronym>GTK</acronym>-Doc</application>
    53 dependencies</title>
    54 <sect4><title>Required</title>
    55 <para><xref linkend="openjade"/>,
    56 <xref linkend="libxslt"/>,
    57 <xref linkend="DocBook"/> and
    58 <xref linkend="docbook-xsl"/></para>
    59 </sect4>
    60 
    61 <sect4><title>Optional</title>
    62 <para><xref linkend="sgml-dtd"/> and <xref linkend="docbook-dsssl"/></para>
    63 </sect4>
    64 
    65 </sect3>
    66 
    67 </sect2>
    68 
    69 <sect2>
    70 <title>Installation of <application><acronym>GTK</acronym>-Doc</application>
    71 </title>
    72 
    73 <para>Install <application><acronym>GTK</acronym>-Doc</application> by running
    74 the following commands:</para>
    75 
    76 <screen><userinput><command>./configure --prefix=/usr</command></userinput></screen>
    77 
    78 <para>Now, as the root user:</para>
    79 
    80 <screen><userinput role='root'><command>make install</command></userinput></screen>
    81 
    82 </sect2>
    83 
    84 <sect2>
    85 <title>Contents</title>
    86 
    87 <segmentedlist>
    88 <segtitle>Installed Programs</segtitle>
    89 <segtitle>Installed Libraries</segtitle>
    90 <segtitle>Installed Directories</segtitle>
    91 
    92 <seglistitem>
    93 <seg>gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman,
    94 gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj and gtkdoc-scanobj</seg>
    95 <seg>None</seg>
    96 <seg>/usr/share/gtk-doc and /usr/share/sgml/gtk-doc</seg>
    97 </seglistitem>
    98 </segmentedlist>
    99 
    100 <sect3><title> Short description</title>
    101 <para>These are all <application>Perl</application> scripts used by
    102 package <filename>Makefile</filename> scripts to generate documentation for
    103 the package being built.</para>
    104 </sect3>
    105 
    106 </sect2>
    107 
     93    <segmentedlist>
     94      <segtitle>Installed Programs</segtitle>
     95      <segtitle>Installed Libraries</segtitle>
     96      <segtitle>Installed Directories</segtitle>
     97     
     98      <seglistitem>
     99        <seg>gtkdocize, gtkdoc-fixxref, gtkdoc-mkdb, gtkdoc-mkhtml, gtkdoc-mkman,
     100        gtkdoc-mktmpl, gtkdoc-scan, gtkdoc-scangobj, and gtkdoc-scanobj</seg>
     101        <seg>None</seg>
     102        <seg>/usr/share/gtk-doc and /usr/share/sgml/gtk-doc</seg>
     103      </seglistitem>
     104    </segmentedlist>
     105   
     106    <variablelist>
     107      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     108      <?dbfo list-presentation="list"?>
     109      <?dbhtml list-presentation="table"?>
     110     
     111      <varlistentry id="gtkdoc">
     112        <term><command>gtkdoc*</command></term>
     113        <listitem>
     114          <para>these are all <application>Perl</application> scripts used by
     115          package <filename>Makefile</filename> scripts to generate
     116          documentation for the package being built.</para>
     117          <indexterm zone="gtk-doc gtkdoc">
     118            <primary sortas="b-gtkdoc*">gtkdoc*</primary>
     119          </indexterm>
     120        </listitem>
     121      </varlistentry>
     122     
     123    </variablelist>
     124   
     125  </sect2>
     126 
    108127</sect1>
    109 
Note: See TracChangeset for help on using the changeset viewer.