diff options
Diffstat (limited to 'doc/kdevelop/kdevelop-install.docbook')
| -rw-r--r-- | doc/kdevelop/kdevelop-install.docbook | 190 |
1 files changed, 95 insertions, 95 deletions
diff --git a/doc/kdevelop/kdevelop-install.docbook b/doc/kdevelop/kdevelop-install.docbook index 028f5e10..62123433 100644 --- a/doc/kdevelop/kdevelop-install.docbook +++ b/doc/kdevelop/kdevelop-install.docbook @@ -1,4 +1,4 @@ -<appendix id="kdevelop-install"> +<appendix id="tdevelop-install"> <appendixinfo> <authorgroup> @@ -8,54 +8,54 @@ </authorgroup> </appendixinfo> -<title>Installing &kdevelop;</title> +<title>Installing &tdevelop;</title> -<indexterm zone="kdevelop-install"> +<indexterm zone="tdevelop-install"> <primary>installation</primary></indexterm> <para> -In this chapter we will discuss the steps necessary to compile and install the &kdevelop; IDE: +In this chapter we will discuss the steps necessary to compile and install the &tdevelop; IDE: <itemizedlist> <listitem><para> - <link linkend="kdevelop-install-howto">How to obtain &kdevelop;</link> mainly concentrates on downloading the most recent &kdevelop; sources from svn. + <link linkend="tdevelop-install-howto">How to obtain &tdevelop;</link> mainly concentrates on downloading the most recent &tdevelop; sources from svn. </para></listitem> <listitem><para> - <link linkend="requirements">&kdevelop; requirements</link> lists the programs and libraries which you need installed to successfully compile the IDE. + <link linkend="requirements">&tdevelop; requirements</link> lists the programs and libraries which you need installed to successfully compile the IDE. </para></listitem> <listitem><para> - <link linkend="compile-and-install">&kdevelop; compilation and installation</link> leads you through all the steps of compilation and installation of the application. + <link linkend="compile-and-install">&tdevelop; compilation and installation</link> leads you through all the steps of compilation and installation of the application. </para></listitem> <listitem><para> -<link linkend="make-api">How to obtain a &kdevelop; &API; documentation</link> tells what an API is and how you get such a useful tool for navigating the &kdevelop; sources. +<link linkend="make-api">How to obtain a &tdevelop; &API; documentation</link> tells what an API is and how you get such a useful tool for navigating the &tdevelop; sources. </para></listitem> </itemizedlist> </para> -<sect1 id="kdevelop-install-howto"> -<title>How to Obtain &kdevelop;</title> +<sect1 id="tdevelop-install-howto"> +<title>How to Obtain &tdevelop;</title> -<indexterm zone="kdevelop-install-howto"> - <primary>obtain &kdevelop;</primary></indexterm> -<indexterm zone="kdevelop-install-howto"> - <primary>&kdevelop;</primary> +<indexterm zone="tdevelop-install-howto"> + <primary>obtain &tdevelop;</primary></indexterm> +<indexterm zone="tdevelop-install-howto"> + <primary>&tdevelop;</primary> <secondary>obtain</secondary></indexterm> <para> -&kdevelop; is available in binary form from many different &Linux; distributions such as <!--&SuSE;, &RedHat;//--> SuSE, RedHat and others. These binaries are packed in some convenient format, mostly RPM, for easy installation. To install, follow the standard instructions given in your distribution. +&tdevelop; is available in binary form from many different &Linux; distributions such as <!--&SuSE;, &RedHat;//--> SuSE, RedHat and others. These binaries are packed in some convenient format, mostly RPM, for easy installation. To install, follow the standard instructions given in your distribution. </para> <para> -You may as well obtain the &kdevelop; sources, compile and install them by yourself. These sources can be found via the project home page at <ulink url="http://www.kdevelop.org"> http://www.kdevelop.org</ulink> or via the <ulink url="http://download.kde.org">&kde; ftp site</ulink>. +You may as well obtain the &tdevelop; sources, compile and install them by yourself. These sources can be found via the project home page at <ulink url="http://www.tdevelop.org"> http://www.tdevelop.org</ulink> or via the <ulink url="http://download.kde.org">&kde; ftp site</ulink>. </para> <sect2 id="howto-svn"> -<title>Get Daily &kdevelop; Snapshots from svn</title> +<title>Get Daily &tdevelop; Snapshots from svn</title> <indexterm zone="howto-svn"> <primary>svn</primary></indexterm> <para>If you want to be in front of current development, anonymous svn repository snapshots are available.</para> -<para>The module name is <emphasis>kdevelop</emphasis> at <filename class="directory">svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop</filename>. +<para>The module name is <emphasis>tdevelop</emphasis> at <filename class="directory">svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/tdevelop</filename>. </para> <sect3 id="howto-svn-co"> @@ -64,16 +64,16 @@ You may as well obtain the &kdevelop; sources, compile and install them by yours <indexterm zone="howto-svn-co"> <primary>checkout</primary></indexterm> <indexterm zone="howto-svn-co"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>svn</secondary> <tertiary>checkout</tertiary></indexterm> <para> -To obtain an initial version of &kdevelop; you must download it from anonymous svn. For this so-called <emphasis>checkout</emphasis> operation follow these steps. +To obtain an initial version of &tdevelop; you must download it from anonymous svn. For this so-called <emphasis>checkout</emphasis> operation follow these steps. </para> <note><para> -We assume you want to put your &kdevelop; copy into the <filename class="directory">trinitysrc</filename> subdirectory of your home directory (<filename class="directory">~</filename>). +We assume you want to put your &tdevelop; copy into the <filename class="directory">trinitysrc</filename> subdirectory of your home directory (<filename class="directory">~</filename>). </para></note> <informalexample><simplelist> @@ -90,24 +90,24 @@ We assume you want to put your &kdevelop; copy into the <filename class="directo </member> <member> <prompt>~/trinitysrc> </prompt> - <userinput>svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kdevelop</userinput> + <userinput>svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/tdevelop</userinput> </member> <member> <prompt>~/trinitysrc> </prompt> - <userinput>cd kdevelop</userinput> + <userinput>cd tdevelop</userinput> </member> </simplelist></informalexample> <note><para> - Once you have successfully checked out your &kdevelop; version, you may keep up with the changes using the update procedure shown in the next section. + Once you have successfully checked out your &tdevelop; version, you may keep up with the changes using the update procedure shown in the next section. </para></note> <important><para> - Keep the server load low. <emphasis>Please do not checkout every time you want to keep your &kdevelop; up to date!</emphasis> Use svn update for this purpose. + Keep the server load low. <emphasis>Please do not checkout every time you want to keep your &tdevelop; up to date!</emphasis> Use svn update for this purpose. </para></important> <para> -Now you may compile your &kdevelop; version as shown in the <link linkend="compile-and-install">&kdevelop; Compilation and Installation</link> section. +Now you may compile your &tdevelop; version as shown in the <link linkend="compile-and-install">&tdevelop; Compilation and Installation</link> section. </para> </sect3> <!-- howto-svn-co --> @@ -118,12 +118,12 @@ Now you may compile your &kdevelop; version as shown in the <link linkend="compi <indexterm zone="howto-svn-up"> <primary>update</primary></indexterm> <indexterm zone="howto-svn-up"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>svn</secondary> <tertiary>update</tertiary></indexterm> <para> -After you checked out (and successfully compiled) &kdevelop; from svn as shown above, you'll want to keep it up to date in order to get all the patches. Follow these steps. (We again assume you have put your &kdevelop; copy into the <filename class="directory">trinitysrc</filename> directory.) +After you checked out (and successfully compiled) &tdevelop; from svn as shown above, you'll want to keep it up to date in order to get all the patches. Follow these steps. (We again assume you have put your &tdevelop; copy into the <filename class="directory">trinitysrc</filename> directory.) </para> <para> Note the <command>up</command> (= <emphasis>update</emphasis>) command instead of the <command>co</command> (which stands for <emphasis>checkout</emphasis>). @@ -136,7 +136,7 @@ Note the <command>up</command> (= <emphasis>update</emphasis>) command instead o </member> <member> <prompt>~/trinitysrc> </prompt> - <userinput>cd kdevelop</userinput> + <userinput>cd tdevelop</userinput> </member> <member> <prompt>~/trinitysrc> </prompt> @@ -149,7 +149,7 @@ Keep an eye on the messages svn produces during the update sequence. The exact s </para></note> <para> -Now you can compile a new &kdevelop; version as shown in the <link linkend="compile-and-install-make-svn">Special svn compilation considerations</link> chapter. +Now you can compile a new &tdevelop; version as shown in the <link linkend="compile-and-install-make-svn">Special svn compilation considerations</link> chapter. </para> </sect3> <!-- howto-svn-up --> @@ -160,19 +160,19 @@ Now you can compile a new &kdevelop; version as shown in the <link linkend="comp <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> <sect1 id="requirements"> -<title>&kdevelop; Requirements</title> +<title>&tdevelop; Requirements</title> <indexterm zone="requirements"> <primary>requirements</primary></indexterm> <indexterm zone="requirements"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>requirements</secondary></indexterm> <indexterm zone="requirements"> <primary>GNU</primary> <secondary>requirements</secondary></indexterm> <para> -In order to successfully compile and use &kdevelop;, you need the following programs and libraries. They are available on most platforms as distribution packages and thereby can be installed easily. +In order to successfully compile and use &tdevelop;, you need the following programs and libraries. They are available on most platforms as distribution packages and thereby can be installed easily. </para> <itemizedlist> @@ -306,7 +306,7 @@ In order to successfully compile and use &kdevelop;, you need the following prog <orderedlist> <listitem> <para> - You can, to a certain extent, circumvent the need for &autoconf; ≥ 2.52 and &automake; ≥ 1.6. Just remove the <filename class="directory">admin</filename> directory in your &kdevelop; installation directory and type + You can, to a certain extent, circumvent the need for &autoconf; ≥ 2.52 and &automake; ≥ 1.6. Just remove the <filename class="directory">admin</filename> directory in your &tdevelop; installation directory and type <indexterm> <primary>autoconf</primary> <secondary>circumvent version need</secondary></indexterm> @@ -318,16 +318,16 @@ In order to successfully compile and use &kdevelop;, you need the following prog <secondary>circumvent for autoconf/automake</secondary></indexterm> </para> <informalexample><simplelist> - <member><prompt>(your-kdevelop-directory)> </prompt> - <userinput>ln -s $KDEDIR/share/apps/kdelibs/admin admin</userinput></member> + <member><prompt>(your-tdevelop-directory)> </prompt> + <userinput>ln -s $KDEDIR/share/apps/tdelibs/admin admin</userinput></member> </simplelist></informalexample> <para> - at the console. This causes &kdevelop; to use the standard settings in the &kde; <filename class="directory">admin</filename> directory instead. + at the console. This causes &tdevelop; to use the standard settings in the &kde; <filename class="directory">admin</filename> directory instead. </para> </listitem> <listitem> <para> - Be careful <emphasis>not to mix &Qt; versions</emphasis>. Always link &kdevelop; to the same &Qt; version your &kde; library was compiled. Otherwise you will most likely experience <emphasis>very strange</emphasis> behaviours. + Be careful <emphasis>not to mix &Qt; versions</emphasis>. Always link &tdevelop; to the same &Qt; version your &kde; library was compiled. Otherwise you will most likely experience <emphasis>very strange</emphasis> behaviours. </para> </listitem> </orderedlist> @@ -338,27 +338,27 @@ In order to successfully compile and use &kdevelop;, you need the following prog <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - --> <sect1 id="compile-and-install"> -<title>&kdevelop; Compilation and Installation</title> +<title>&tdevelop; Compilation and Installation</title> <indexterm zone="compile-and-install"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>compilation</secondary></indexterm> <indexterm zone="compile-and-install"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>installation</secondary></indexterm> <para> -Once all requirements are met, you are ready to compile and install &kdevelop;. This appendix will discuss the necessary steps to do so. +Once all requirements are met, you are ready to compile and install &tdevelop;. This appendix will discuss the necessary steps to do so. </para> <itemizedlist> <listitem><para> <link linkend="compile-and-install-preliminaries">Preliminary Steps</link> tells you about setting up a proper environment. </para></listitem> <listitem><para> - <link linkend="compile-and-install-make">Compile &kdevelop;</link> deals with obtaining the &kdevelop; sources from svn, how to prepare them for the installation process, and finally shows the steps necessary to compile and install &kdevelop;. + <link linkend="compile-and-install-make">Compile &tdevelop;</link> deals with obtaining the &tdevelop; sources from svn, how to prepare them for the installation process, and finally shows the steps necessary to compile and install &tdevelop;. </para></listitem> <listitem><para> - <link linkend="compile-and-install-options">Some Notes on configure Options</link> tells you how to run &kdevelop; if it has been installed in a location other than the &kde; directory. + <link linkend="compile-and-install-options">Some Notes on configure Options</link> tells you how to run &tdevelop; if it has been installed in a location other than the &kde; directory. </para></listitem> </itemizedlist> @@ -367,7 +367,7 @@ Once all requirements are met, you are ready to compile and install &kdevelop;. <indexterm zone="compile-and-install-preliminaries"> <primary>preliminaries</primary> - <secondary>&kdevelop; installation</secondary></indexterm> + <secondary>&tdevelop; installation</secondary></indexterm> <indexterm zone="compile-and-install-preliminaries"> <primary>KDEDIR</primary></indexterm> <indexterm zone="compile-and-install-preliminaries"> @@ -426,24 +426,24 @@ If you use the tcsh shell add the following lines: </sect2> <!-- compile-and-install-preliminaries --> <sect2 id="compile-and-install-make"> -<title>Compile &kdevelop;</title> +<title>Compile &tdevelop;</title> <indexterm zone="compile-and-install-make"> <primary>make</primary> - <secondary>&kdevelop; installation</secondary></indexterm> + <secondary>&tdevelop; installation</secondary></indexterm> <indexterm zone="compile-and-install-make"> <primary>compiling</primary> - <secondary>&kdevelop;</secondary></indexterm> + <secondary>&tdevelop;</secondary></indexterm> <note><para> -In the following discussion we assume that you have put your &kdevelop; sources in the <filename class="directory">~/trinitysrc/kdevelop</filename> directory. +In the following discussion we assume that you have put your &tdevelop; sources in the <filename class="directory">~/trinitysrc/tdevelop</filename> directory. </para></note> <sect3 id="compile-and-install-make-svn"> <title>Special svn Compilation Considerations</title> <para> -In case you use a &kdevelop; snapshot from svn the initial compilation steps depend on whether you just did a complete checkout or only updated the source. +In case you use a &tdevelop; snapshot from svn the initial compilation steps depend on whether you just did a complete checkout or only updated the source. </para> <variablelist> @@ -455,7 +455,7 @@ You must <emphasis>initialize the make system</emphasis> after a fresh checkout. </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make -f admin/Makefile.common svn-clean</userinput> </member></simplelist></informalexample> <para> @@ -484,7 +484,7 @@ U /some_directory_path/Makefile.am or if you just did a full checkout, you must enter: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make -f Makefile.svn</userinput> </member></simplelist></informalexample> <para> @@ -499,11 +499,11 @@ before you proceed with <emphasis>all of the following steps</emphasis>. <title>Basic <command>make</command> Command Sequence</title> <para> -Once the basic make system is set up you must decide which type of the &kdevelop; system you want to use. This is done in the following configure step which builds the actual <filename>Makefile</filename>s the <command>make</command> command will use. +Once the basic make system is set up you must decide which type of the &tdevelop; system you want to use. This is done in the following configure step which builds the actual <filename>Makefile</filename>s the <command>make</command> command will use. </para> <note><para> -You may drop the <option>--prefix</option> option in the following <command>configure</command> command lines if you want &kdevelop; be installed in the default &kde; directory. See the <link linkend="compile-and-install-options">Some notes on configure options</link> chapter for this. +You may drop the <option>--prefix</option> option in the following <command>configure</command> command lines if you want &tdevelop; be installed in the default &kde; directory. See the <link linkend="compile-and-install-options">Some notes on configure options</link> chapter for this. </para></note> <variablelist> @@ -511,11 +511,11 @@ You may drop the <option>--prefix</option> option in the following <command>conf <term>A Debug-Compiled Version</term> <listitem> <para> -If you want to keep track of what your &kdevelop; application does at run-time you may build a debug-compiled version. Just command <command>configure</command> to do so: +If you want to keep track of what your &tdevelop; application does at run-time you may build a debug-compiled version. Just command <command>configure</command> to do so: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --enable-debug=full --prefix=</userinput>(where-your-trinity-is) </member></simplelist></informalexample> </listitem> @@ -524,64 +524,64 @@ If you want to keep track of what your &kdevelop; application does at run-time y <varlistentry> <term>A Release-Compiled Version</term> <listitem> -<para>If you only want to use &kdevelop; as-is a (smaller and faster +<para>If you only want to use &tdevelop; as-is a (smaller and faster running) release version suffices. <command>configure</command> defaults to this.</para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --prefix=</userinput>(where-your-trinity-is) </member></simplelist></informalexample> <note> <para> -If you want to build your own <link linkend="make-api">API documentation</link> for &kdevelop; you must include yet another option in the <command>configure</command> command: +If you want to build your own <link linkend="make-api">API documentation</link> for &tdevelop; you must include yet another option in the <command>configure</command> command: </para> <informalexample><simplelist> - <member><prompt>~/trinitysrc/kdevelop> </prompt> - <userinput>./configure --</userinput>(options-as-above) <userinput>\</userinput></member> <member><userinput>--with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs</userinput></member> + <member><prompt>~/trinitysrc/tdevelop> </prompt> + <userinput>./configure --</userinput>(options-as-above) <userinput>\</userinput></member> <member><userinput>--with-tdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/tdelibs-apidocs</userinput></member> </simplelist></informalexample> </note> </listitem> </varlistentry> <varlistentry> -<term>Make and Install &kdevelop;</term> +<term>Make and Install &tdevelop;</term> <listitem> <para> <command>configure</command> will check the system and build some <filename>Makefile</filename>s according to what it found. The <command>make</command> command will use the main <filename>Makefile</filename> by default. Thus </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make</userinput> </member></simplelist></informalexample> <para> suffices. If necessary, now gain root user rights using the command </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>su</userinput> </member></simplelist></informalexample> <para> and entering the root password. Then install the application: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make install</userinput> </member></simplelist></informalexample> <para> -That's all. If you installed &kdevelop; in the default &kde; directory you may now run the IDE. Otherwise some additional steps will be necessary as shown in the <link linkend="compile-and-install-options-dir">Non-default installation directory</link> section below. +That's all. If you installed &tdevelop; in the default &kde; directory you may now run the IDE. Otherwise some additional steps will be necessary as shown in the <link linkend="compile-and-install-options-dir">Non-default installation directory</link> section below. </para> <note> <para> - In fact there usually will have been three &kdevelop;-based applications installed: + In fact there usually will have been three &tdevelop;-based applications installed: </para> <itemizedlist> - <listitem><para>The &kdevelop; IDE — this is the place where you will usually work.</para></listitem> - <listitem><para>The stand-alone &kdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &kdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem> - <listitem><para>The &kdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &kdevelop; IDE.</para></listitem> + <listitem><para>The &tdevelop; IDE — this is the place where you will usually work.</para></listitem> + <listitem><para>The stand-alone &tdevelop; Assistant documentation browser — isolates all the powerful documentation facilities of the &tdevelop; IDE in a separate tool. This comes in handy when you want to look up some programming documentation but do not want to start the full IDE.</para></listitem> + <listitem><para>The &tdevelop; Designer — enhances the &Qt; User Interface Designer by &kde; specific elements and integrates nicely in the &tdevelop; IDE.</para></listitem> </itemizedlist> </note> </listitem> @@ -600,7 +600,7 @@ That's all. If you installed &kdevelop; in the default &kde; directory you may n <title>Non-default Installation Directory</title> <indexterm zone="compile-and-install-options-dir"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>installation</secondary> <tertiary>non-default directory</tertiary></indexterm> <indexterm zone="compile-and-install-options-dir"> @@ -611,17 +611,17 @@ That's all. If you installed &kdevelop; in the default &kde; directory you may n <primary>kbuildsycoca</primary></indexterm> <para> -By default <command>configure</command> prepares the IDE to be installed in the default &kde; directory. This is necessary because &kdevelop; assumes direct access to some tools and parts which reside there. If want to use your own installation directory, you must tell <command>configure</command> this by the <option>--prefix</option> option: +By default <command>configure</command> prepares the IDE to be installed in the default &kde; directory. This is necessary because &tdevelop; assumes direct access to some tools and parts which reside there. If want to use your own installation directory, you must tell <command>configure</command> this by the <option>--prefix</option> option: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --prefix=</userinput>(where-your-trinity-is) </member></simplelist></informalexample> <para> -There is a caveat if you do so. You must provide a means for &kdevelop; to access the needed tools and parts in the &kde; directory when running. (You can still use the IDE without doing so, but with very restrained capabilities.) +There is a caveat if you do so. You must provide a means for &tdevelop; to access the needed tools and parts in the &kde; directory when running. (You can still use the IDE without doing so, but with very restrained capabilities.) </para> <para> -Call up a shell and have the following commands executed before you start &kdevelop; at the shell prompt. +Call up a shell and have the following commands executed before you start &tdevelop; at the shell prompt. </para> <note><para> @@ -638,11 +638,11 @@ Call up a shell and have the following commands executed before you start &kdeve <userinput>kbuildsycoca</userinput> </member> <member> - (Now start &kdevelop;:) + (Now start &tdevelop;:) </member> <member> <prompt>~> </prompt> - <userinput>kdevelop</userinput> + <userinput>tdevelop</userinput> </member> </simplelist></informalexample> @@ -661,7 +661,7 @@ In a tcsh shell you must set the environment variables using: <userinput>setenv KDEDIRS /usr/local/kde:/opt/trinity</userinput> </member></simplelist></informalexample> <para> -The <command>kbuildsycoca</command> command (<quote>build system control cache</quote>) looks around for libraries and caches their location and version, so that &kdevelop; can find them. The caveat is that it takes noticeable time—and it has to be run any time you call up the shell to start &kdevelop; from a non-default directory. You may want to put the above commands into a shell script to reduce the typing effort. +The <command>kbuildsycoca</command> command (<quote>build system control cache</quote>) looks around for libraries and caches their location and version, so that &tdevelop; can find them. The caveat is that it takes noticeable time—and it has to be run any time you call up the shell to start &tdevelop; from a non-default directory. You may want to put the above commands into a shell script to reduce the typing effort. </para> <para> (You could as well put the lines in your <filename>.bashrc</filename> or <filename>.cshrc</filename> file, but this is not advisable as <command>kbuildsycoca</command> will then be run any time you call up the shell.) @@ -679,56 +679,56 @@ The <command>kbuildsycoca</command> command does not run from within the root. Y </sect1> <!-- compile-and-install --> <sect1 id="make-api"> -<title>How to Obtain a &kdevelop; API Documentation</title> +<title>How to Obtain a &tdevelop; API Documentation</title> <indexterm zone="make-api"> <primary>API</primary> - <secondary>&kdevelop;</secondary></indexterm> + <secondary>&tdevelop;</secondary></indexterm> <indexterm zone="make-api"> - <primary>&kdevelop;</primary> + <primary>&tdevelop;</primary> <secondary>API</secondary></indexterm> <indexterm zone="make-api"> <primary>compiling</primary> - <secondary>&kdevelop;</secondary> + <secondary>&tdevelop;</secondary> <tertiary>API</tertiary></indexterm> <indexterm zone="make-api"> <primary>configure</primary> - <secondary>&kdevelop; API</secondary></indexterm> + <secondary>&tdevelop; API</secondary></indexterm> <para> API is the short form of <quote>Application Program Interface</quote>. Actually such an API cotains a series of descriptions (&ie; calling conventions) by which an application program can access the operating system and other services. In our context, however, a broader definition was adopted. The API of a &kde; or &Qt; application is an abstract of the classes and methods interfaces, a synopsis to be used like a dictionary to navigate the sources. </para> <para> -There is a version of the most current API available at the <ulink url="http://www.kdevelop.org/HEAD/doc/api/html/index.html">KDevelop-Home website</ulink>. It will be automatically updated every 24 hours so you can keep up. +There is a version of the most current API available at the <ulink url="http://www.tdevelop.org/HEAD/doc/api/html/index.html">KDevelop-Home website</ulink>. It will be automatically updated every 24 hours so you can keep up. </para> <para> -Alas, this version is best used read-only over the internet. If you do not always have internet access you may as well build your own API documentation from the &kdevelop; sources. To do so, you must tell the automake system where to find the KDELIBS API in your system. This is accomplished by the special option <option>--with-kdelibsdoxy-dir</option> in the <command>configure</command> command when you prepare to compile the &kdevelop; sources: +Alas, this version is best used read-only over the internet. If you do not always have internet access you may as well build your own API documentation from the &tdevelop; sources. To do so, you must tell the automake system where to find the KDELIBS API in your system. This is accomplished by the special option <option>--with-tdelibsdoxy-dir</option> in the <command>configure</command> command when you prepare to compile the &tdevelop; sources: </para> <informalexample><simplelist> <member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>./configure --</userinput>(options-as-usual)<userinput> \</userinput> </member> <member> - <userinput>--with-kdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/kdelibs-apidocs</userinput> + <userinput>--with-tdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/tdelibs-apidocs</userinput> </member> </simplelist></informalexample> <para> -(<command>make</command> will replace the global <varname>$KDEDIR</varname> variable with the actual &kde; directory setting recorded therein.) Then issue a <command>make</command> command <link linkend="compile-and-install-make-basic">as usual</link>. After the &kdevelop; IDE has been built you have the option to build the API as well. For this you must issue +(<command>make</command> will replace the global <varname>$KDEDIR</varname> variable with the actual &kde; directory setting recorded therein.) Then issue a <command>make</command> command <link linkend="compile-and-install-make-basic">as usual</link>. After the &tdevelop; IDE has been built you have the option to build the API as well. For this you must issue </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make apidocs</userinput> </member></simplelist></informalexample> <para> -This will build a <filename>Doxyfile</filename> in your &kdevelop; base directory which in turn will be processed by the <application>Doxygen</application> application to build quite a lot of <filename>.html</filename> API files. When this rather lengthy API building process (may last more than an hour on a slow system) finally comes to an end, you must install the API just like you have to install the &kdevelop; IDE itself. If necessary obtain superuser rights by +This will build a <filename>Doxyfile</filename> in your &tdevelop; base directory which in turn will be processed by the <application>Doxygen</application> application to build quite a lot of <filename>.html</filename> API files. When this rather lengthy API building process (may last more than an hour on a slow system) finally comes to an end, you must install the API just like you have to install the &tdevelop; IDE itself. If necessary obtain superuser rights by </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>su</userinput> </member></simplelist></informalexample> @@ -737,18 +737,18 @@ and entering the root password. Then install the API files: </para> <informalexample><simplelist><member> - <prompt>~/trinitysrc/kdevelop> </prompt> + <prompt>~/trinitysrc/tdevelop> </prompt> <userinput>make install-apidox</userinput> </member></simplelist></informalexample> <para> -Once this is done, <command>make</command> will inform you about the directory where you can finally look at the API documentation's contents. Note this address, you can use it from &konqueror; as well as from inside &kdevelop;, in case you have set up the &kdevelop; sources themselves as a project to work on. +Once this is done, <command>make</command> will inform you about the directory where you can finally look at the API documentation's contents. Note this address, you can use it from &konqueror; as well as from inside &tdevelop;, in case you have set up the &tdevelop; sources themselves as a project to work on. </para> <note><para> -You will most probably see a lot of warning and/or error messages during the API build run by <application>Doxygen</application>. It is best to ignore them, they are of interest to the &kdevelop; developers only. If the API generation ever comes to a successful end, the <filename>.html</filename> API files will be usable. +You will most probably see a lot of warning and/or error messages during the API build run by <application>Doxygen</application>. It is best to ignore them, they are of interest to the &tdevelop; developers only. If the API generation ever comes to a successful end, the <filename>.html</filename> API files will be usable. </para></note> </sect1> <!-- make-api --> -</appendix> <!-- kdevelop-install --> +</appendix> <!-- tdevelop-install --> |