Subversion Repositories svn LFS-FR

Rev

Rev 557 | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
547 gleu 1
<?xml version="1.0" encoding="ISO-8859-1"?>
1127 jmengual 2
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
547 gleu 4
  <!ENTITY % general-entities SYSTEM "../../general.ent">
5
  %general-entities;
6
 
1127 jmengual 7
  <!ENTITY gtk-doc-download-http "&gnome-download-http;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
8
  <!ENTITY gtk-doc-download-ftp  "&gnome-download-ftp;/gtk-doc/&gtk-doc-version;/gtk-doc-&gtk-doc-version;.tar.bz2">
9
  <!ENTITY gtk-doc-md5sum        "b5e268c71fa90aad890cf53715664d0a">
10
  <!ENTITY gtk-doc-size          "443 Kio">
11
  <!ENTITY gtk-doc-buildsize     "4.8 Mio">
12
  <!ENTITY gtk-doc-time          "moins de 0.1 SBU">
547 gleu 13
]>
14
 
15
<sect1 id="gtk-doc" xreflabel="GTK-Doc-&gtk-doc-version;">
1127 jmengual 16
  <?dbhtml filename="gtk-doc.html"?>
547 gleu 17
 
1127 jmengual 18
  <sect1info>
19
    <othername>$LastChangedBy: ken $</othername>
20
    <date>$Date: 2009-06-27 12:10:28 +0200 (sam 27 jun 2009) $</date>
21
  </sect1info>
547 gleu 22
 
1127 jmengual 23
  <title>GTK-Doc-&gtk-doc-version;</title>
547 gleu 24
 
1127 jmengual 25
  <indexterm zone="gtk-doc">
26
    <primary sortas="a-GTK-Doc">GTK-Doc</primary>
27
  </indexterm>
547 gleu 28
 
1127 jmengual 29
  <sect2 role="package">
30
    <title>Introduction à GTK-Doc</title>
547 gleu 31
 
1127 jmengual 32
    <para>Le paquet <application>GTK-Doc</application> contient
33
    un documentateur de code. C'est utile pour extraire des commentaires spécialement
34
    formatés du code pour créer des documentations d'API. Ce paquet
35
    est <emphasis>facultatif</emphasis>&nbsp;; si vous ne l'installez pas, les paquets
36
    ne construiront pas la documentation. Cela ne veut pas dire que vous n'aurez
37
    aucune documentation. Si <application>GTK-Doc</application> n'est pas
38
    disponible, le processus d'installation copiera toute la
39
    documentation préconstruite sur votre système.</para>
547 gleu 40
 
1127 jmengual 41
    <bridgehead renderas="sect3">Informations sur le paquet</bridgehead>
42
    <itemizedlist spacing="compact">
43
      <listitem>
44
        <para>Téléchargement (HTTP)&nbsp;: <ulink url="&gtk-doc-download-http;"/></para>
45
      </listitem>
46
      <listitem>
47
        <para>Téléchargement (FTP)&nbsp;: <ulink url="&gtk-doc-download-ftp;"/></para>
48
      </listitem>
49
      <listitem>
50
        <para>Somme de contrôle MD5 du téléchargement&nbsp;: &gtk-doc-md5sum;</para>
51
      </listitem>
52
      <listitem>
53
        <para>Taille du téléchargement&nbsp;: &gtk-doc-size;</para>
54
      </listitem>
55
      <listitem>
56
        <para>Estimation de l'espace disque requis&nbsp;: &gtk-doc-buildsize;</para>
57
      </listitem>
58
      <listitem>
59
        <para>Estimation du temps de construction&nbsp;: &gtk-doc-time;</para>
60
      </listitem>
61
    </itemizedlist>
547 gleu 62
 
1127 jmengual 63
    <bridgehead renderas="sect3">GTK-Doc Dependencies</bridgehead>
547 gleu 64
 
1127 jmengual 65
    <bridgehead renderas="sect4">Requises</bridgehead>
66
    <para role="required"><xref linkend="gnome-doc-utils"/>,
67
    <xref linkend="DocBook"/> et
68
    <xref linkend="docbook-xsl"/></para>
547 gleu 69
 
1127 jmengual 70
    <bridgehead renderas="sect4">Recommandées</bridgehead>
71
    <para role="optional"><xref linkend="python"/></para>
547 gleu 72
 
1127 jmengual 73
    <bridgehead renderas="sect4">Facultatives</bridgehead>
74
    <para role="optional"><xref linkend="pkgconfig"/>,
75
    <xref linkend="scrollkeeper"/>,
76
    <xref linkend="openjade"/>,
77
    <xref linkend="sgml-dtd"/>,
78
    <xref linkend="docbook-dsssl"/>, also
79
    <xref linkend="glib2"/> (for the testsuite)</para>
547 gleu 80
 
1127 jmengual 81
    <para condition="html" role="usernotes">Notes utilisateur&nbsp;:
82
    <ulink url="&blfs-wiki;/gtk-doc"/></para>
547 gleu 83
 
1127 jmengual 84
  </sect2>
547 gleu 85
 
1127 jmengual 86
  <sect2 role="installation">
87
    <title>Installation de GTK-Doc</title>
547 gleu 88
 
1127 jmengual 89
    <para>Installez <application>GTK-Doc</application> dn lançant
90
    les commandes suivantes&nbsp;:</para>
547 gleu 91
 
1127 jmengual 92
<screen><userinput>./configure --prefix=/usr &amp;&amp;
93
make</userinput></screen>
547 gleu 94
 
1127 jmengual 95
    <para>Maintenant, en tant qu'utilisateur <systemitem class="username">root</systemitem>&nbsp;:</para>
96
 
97
<screen role="root"><userinput>make install</userinput></screen>
98
 
99
    <para>La suite de tests exige que le paquet ait été d'abord installé, mais
100
    il n'y a aucune de raison de la lancer car il manque un fichier qui fait
101
    échouer la suite de tests. Si vous tenez à voir les résultats, et si vous êtes un utilisateur
102
    non privilégié, lancez&nbsp;: <command>make check</command>.</para>
103
 
104
  </sect2>
105
 
106
<!--  <sect2 role="commands">
107
    <title>Explication des commandes</title>
108
 
109
    \<\!\-\- no scrollkeeper files with this version
110
    <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
111
    href="../../xincludes/scrollkeeper-dir.xml"/> \-\-\>
112
 
113
  </sect2> -->
114
 
115
  <sect2 role="content">
116
    <title>Contenu</title>
117
 
118
    <segmentedlist>
119
      <segtitle>Programmes installés</segtitle>
120
      <segtitle>Bibliothèques installées</segtitle>
121
      <segtitle>Répertoires installés</segtitle>
122
 
123
      <seglistitem>
124
        <seg>gtkdocize, gtkdoc-check, gtkdoc-depscan, gtkdoc-fixxref, gtkdoc-mkdb,
125
        gtkdoc-mkhtml, gtkdoc-mkman, gtkdoc-mktmpl, gtkdoc-rebase, gtkdoc-scan,
126
        gtkdoc-scangobj, et gtkdoc-scanobj</seg>
127
        <seg>Aucune</seg>
128
        <seg>Les sous-répertoires suivants de /usr/share/&nbsp;:
129
        <!--doc/gtk-doc-&gtk-doc-version;, -->
130
        gnome/help/gtk-doc-manual,
131
        gtk-doc/data et
132
        {omf,sgml}/gtk-doc</seg>
133
      </seglistitem>
134
    </segmentedlist>
135
 
136
    <variablelist>
137
      <bridgehead renderas="sect3">Descriptions courtes</bridgehead>
138
      <?dbfo list-presentation="list"?>
139
      <?dbhtml list-presentation="table"?>
140
 
141
      <varlistentry id="gtkdoc">
142
        <term><command>gtkdoc*</command></term>
143
        <listitem>
144
          <para>ce sont tout des scripts shell, <application>Perl</application>, ou
145
          <application>Python</application> utilisés par les scripts
146
          <filename>Makefile</filename> du paquet pour générer la
147
          documentation du paquet qui va être construit.</para>
148
          <indexterm zone="gtk-doc gtkdoc">
149
            <primary sortas="b-gtkdoc*">gtkdoc*</primary>
150
          </indexterm>
151
        </listitem>
152
      </varlistentry>
153
 
154
    </variablelist>
155
 
156
  </sect2>
157
 
547 gleu 158
</sect1>