From 88838f421c1d218531cb0ddcc2599ae90e744759 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Wed, 7 Dec 2011 19:13:44 -0600 Subject: Rename KDEHOME and KDEDIR --- doc/api/HowToAddApplicationTemplates.dox | 4 ++-- doc/api/Mainpage.dox | 2 +- doc/kdearch/index.docbook | 8 +++---- doc/tdevelop/app-files.docbook | 28 ++++++++++++------------- doc/tdevelop/nutshell.docbook | 4 ++-- doc/tdevelop/setup.docbook | 6 +++--- doc/tdevelop/tdevelop-install.docbook | 36 ++++++++++++++++---------------- doc/tdevelop/tdevelop-scripting.docbook | 2 +- 8 files changed, 45 insertions(+), 45 deletions(-) (limited to 'doc') diff --git a/doc/api/HowToAddApplicationTemplates.dox b/doc/api/HowToAddApplicationTemplates.dox index b948c934..6a9ac48b 100644 --- a/doc/api/HowToAddApplicationTemplates.dox +++ b/doc/api/HowToAddApplicationTemplates.dox @@ -27,7 +27,7 @@ applications like kedit as well as plugins for example for tdevelop or noatun.\n \section templates_1 I. Example: How To Create a Simple KDE Application Template "KHello" -You can find this template in $KDEDIR/share/apps/kdevappwizard/template-khello. +You can find this template in $TDEDIR/share/apps/kdevappwizard/template-khello. \subsection templates_1_1 I.1. Step 1: Basic Skeleton @@ -64,7 +64,7 @@ wizard will replace: - \%{YEAR} ........ by the year . -All this can be found in $KDEDIR/share/apps/kdevappwizard/template-common/tdevelop.pm. +All this can be found in $TDEDIR/share/apps/kdevappwizard/template-common/tdevelop.pm. \subsubsection templates_1_2a I.2.1. The Source Files The files template-khello/app.cpp, template-khello/app.h and diff --git a/doc/api/Mainpage.dox b/doc/api/Mainpage.dox index 48640827..44fa64db 100644 --- a/doc/api/Mainpage.dox +++ b/doc/api/Mainpage.dox @@ -71,7 +71,7 @@ To build your local copy of this documentation you have two choices, depending o - make install-apidox (as root) . - If you have an older system then - - setenv KDEDIR=/location_of_your_kde_instalation + - setenv TDEDIR=/location_of_your_kde_instalation - setenv QTDIR=/location_of_your_qt_instalation - doxygen Doxyfile - make install-apidox (as root) diff --git a/doc/kdearch/index.docbook b/doc/kdearch/index.docbook index fff7cd57..7b5b45f1 100644 --- a/doc/kdearch/index.docbook +++ b/doc/kdearch/index.docbook @@ -1907,7 +1907,7 @@ a complex query language. New service types are added by installing a description of them into the -directory KDEDIR/share/servicetypes. In an automake +directory TDEDIR/share/servicetypes. In an automake framework, this can be done with this Makefile.am snippet: @@ -1955,7 +1955,7 @@ Possible types are everything that can be stored in a Service definitions are stored in the directory -KDEDIR/share/services: +TDEDIR/share/services: @@ -2246,7 +2246,7 @@ cases the file name extension). For example, a file extension is stripped off this is not safe, and you actually have to look at the contents of the file. This is of course slower, in particular for files that have to be downloaded via HTTP first. The content-based method is based -on the file KDEDIR/share/mimelnk/magic and therefore +on the file TDEDIR/share/mimelnk/magic and therefore difficult to extend. But in general, MIME type information can easily be made available to the system by installing a .desktop file, and it is efficiently and conveniently available through the KDE libraries. @@ -2262,7 +2262,7 @@ it is efficiently and conveniently available through the KDE libraries. Let us define a type "application/x-foo" for our new foobar program. To this end, you have to write a file foo.desktop and install it into -KDEDIR/share/mimelnk/application. (This is the usual +TDEDIR/share/mimelnk/application. (This is the usual location, which may differ between distributions). This can be done by adding this to the Makefile.am: diff --git a/doc/tdevelop/app-files.docbook b/doc/tdevelop/app-files.docbook index f79b81c1..547010ec 100644 --- a/doc/tdevelop/app-files.docbook +++ b/doc/tdevelop/app-files.docbook @@ -28,20 +28,20 @@ &tdevelop; Default Configuration -On installation, &tdevelop; writes some default information files for setup and configuration purposes into subdirectories of the $KDEDIR installation directory (usually something like /opt/kde, /usr/local/kde, or some other user-defined installation directory, see Installing &tdevelop;). +On installation, &tdevelop; writes some default information files for setup and configuration purposes into subdirectories of the $TDEDIR installation directory (usually something like /opt/kde, /usr/local/kde, or some other user-defined installation directory, see Installing &tdevelop;). Default &tdevelop; Configuration -There is only one &tdevelop; specific default configuration file in the $KDEDIR/share/config/ directory: +There is only one &tdevelop; specific default configuration file in the $TDEDIR/share/config/ directory: tdeveloprc - This file contains the basic settings &tdevelop; needs to start. It will be copied to the user's $KDEHOME/share/config directory when &tdevelop; does not find a tdeveloprc file there on startup. + This file contains the basic settings &tdevelop; needs to start. It will be copied to the user's $TDEHOME/share/config directory when &tdevelop; does not find a tdeveloprc file there on startup. @@ -52,11 +52,11 @@ There is only one &tdevelop; specific default configuration file in the Application Specific Defaults -Most &tdevelop; features are provided by KParts. These are basically applications specially designed to run in the &tdevelop; framework (see the overview in the Plugin Tools appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the $KDEDIR/share/apps/ installation directory. +Most &tdevelop; features are provided by KParts. These are basically applications specially designed to run in the &tdevelop; framework (see the overview in the Plugin Tools appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the $TDEDIR/share/apps/ installation directory. -There are quite a lot of default configuration subdirectories in $KDEDIR/share/apps/ whose names all start with a kdev sequence. Most of them are for &tdevelop; internal use only. They might be deliberately grouped for readability as: +There are quite a lot of default configuration subdirectories in $TDEDIR/share/apps/ whose names all start with a kdev sequence. Most of them are for &tdevelop; internal use only. They might be deliberately grouped for readability as: Stand-alone Applications Task Specific Parts @@ -201,10 +201,10 @@ There are quite a lot of default configuration subdirectories in User Oriented Configuration -All information about user defined settings is kept in two subdirectories of $KDEHOME, namely: +All information about user defined settings is kept in two subdirectories of $TDEHOME, namely: - Application Specific Configuration in the $KDEHOME/share/apps/ directory, and - Resource Configuration File in the $KDEHOME/share/config/ directory. + Application Specific Configuration in the $TDEHOME/share/apps/ directory, and + Resource Configuration File in the $TDEHOME/share/config/ directory. @@ -212,13 +212,13 @@ All information about user defined settings is kept in two subdirectories of Application Specific Configuration -Any user changes to the &tdevelop; Default Configuration settings as well as user specific settings which are not kept in any of the Resource Configuration Files are found in kdev... subdirectories of the $KDEHOME/share/apps/ directory. +Any user changes to the &tdevelop; Default Configuration settings as well as user specific settings which are not kept in any of the Resource Configuration Files are found in kdev... subdirectories of the $TDEHOME/share/apps/ directory. Most of these configuration files are however used by various &tdevelop; plugins in order to provide some specific menu and/or toolbar entries. Thus they are of interest only in case something went really wrong with the user interface. -In case the contents of these directories mirror those of the Default Configuration settings, &tdevelop; will have copied them from $KDEDIR/apps/ into the $KDEHOME/apps/ directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case. +In case the contents of these directories mirror those of the Default Configuration settings, &tdevelop; will have copied them from $TDEDIR/apps/ into the $TDEHOME/apps/ directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case. @@ -270,7 +270,7 @@ In case the contents of these directories mirror those of the Default Configurat kdevdocumentation/ — contains the actual files used by the Documentation plugin in addition to the default configuration files. See there for more detail. - The directories in kdevdocumentation/ mainly hold actual bookkeeping information. The actually set up documentation files are kept in doc...pluginrc files in the $KDEHOME/share/config/ directory. + The directories in kdevdocumentation/ mainly hold actual bookkeeping information. The actually set up documentation files are kept in doc...pluginrc files in the $TDEHOME/share/config/ directory. bookmarks/ — maintains the entries in the Bookmarks tab of the &tdevelop; Documentation plugin. @@ -345,7 +345,7 @@ In case the contents of these directories mirror those of the Default Configurat Resource Configuration Files -There are two groups of &tdevelop; configuration files in the $KDEHOME/share/config/ directory, distiguished by their surrounding character sequences: +There are two groups of &tdevelop; configuration files in the $TDEHOME/share/config/ directory, distiguished by their surrounding character sequences: doc...pluginrc denotes files used by the documentation plugin. kdev...rc denotes configuration files used by &tdevelop; itself and its available plugins. @@ -356,7 +356,7 @@ There are two groups of &tdevelop; configuration files in the $KDEHOME/share/apps/kdevcppsupport/pcs/ directory. +There can be additional Persistant Code Store files be set up on the Code Completion tab of the C++ Specific project configuration page. Information about these additional .pcs is kept globally in the $TDEHOME/share/apps/kdevcppsupport/pcs/ directory. diff --git a/doc/tdevelop/nutshell.docbook b/doc/tdevelop/nutshell.docbook index 59ee283b..ca0a4276 100644 --- a/doc/tdevelop/nutshell.docbook +++ b/doc/tdevelop/nutshell.docbook @@ -43,7 +43,7 @@ Interface). may not be available. To change the toolview tabs display manually, place a entry under the tag in your -$KDEHOME/share/config/tdeveloprc configuration file as +$TDEHOME/share/config/tdeveloprc configuration file as follows: @@ -65,7 +65,7 @@ this may help: In your -$KDEHOME/share/config/tdeveloprc +$TDEHOME/share/config/tdeveloprc configuration file find the line containing Style=Checked and remove it. Then restart &tdevelop;. diff --git a/doc/tdevelop/setup.docbook b/doc/tdevelop/setup.docbook index 5dd15c06..6f8577e3 100644 --- a/doc/tdevelop/setup.docbook +++ b/doc/tdevelop/setup.docbook @@ -1600,7 +1600,7 @@ In short, such an &API; documents the interface to certain library functions. Th There are some structural constraints assumed when searching for &doxygen; generated &API; documentation. The directory in which the index.html file resides should contain subdirectories with separate documentation collections. Each of these subdirectories is assumed to contain a .tag file and a html/ subdirectory. -You may have a look at $KDEDIR/share/doc/HTML/en/tdelibs-apidocs for an example of such a &doxygen; &API; documentation layout. +You may have a look at $TDEDIR/share/doc/HTML/en/tdelibs-apidocs for an example of such a &doxygen; &API; documentation layout. @@ -1621,7 +1621,7 @@ The older &kde; KDoc gener Or the configure command did automatically find a &doxygen; generated &kde; Libraries &API; in one of several standard locations it knows of. - Or as a last resort the $KDEDIR/share/doc/HTML/en/tdelibs-apidocs/ was found at the first &tdevelop; startup. + Or as a last resort the $TDEDIR/share/doc/HTML/en/tdelibs-apidocs/ was found at the first &tdevelop; startup. @@ -1720,7 +1720,7 @@ Such structured access is made possible through the use of special table Standard Directory of &tdevelop; TOC Files -When &tdevelop; was installed usually a series of predefined .toc files has been put into the $KDEDIR/share/apps/kdevdocumentation/tocs directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility. +When &tdevelop; was installed usually a series of predefined .toc files has been put into the $TDEDIR/share/apps/kdevdocumentation/tocs directory. These are fairly simple, structured text files. You may look at them using a text editor or other text display facility. diff --git a/doc/tdevelop/tdevelop-install.docbook b/doc/tdevelop/tdevelop-install.docbook index 62123433..94b42ac0 100644 --- a/doc/tdevelop/tdevelop-install.docbook +++ b/doc/tdevelop/tdevelop-install.docbook @@ -319,7 +319,7 @@ In order to successfully compile and use &tdevelop;, you need the following prog (your-tdevelop-directory)> - ln -s $KDEDIR/share/apps/tdelibs/admin admin + ln -s $TDEDIR/share/apps/tdelibs/admin admin at the console. This causes &tdevelop; to use the standard settings in the &kde; admin directory instead. @@ -369,7 +369,7 @@ Once all requirements are met, you are ready to compile and install &tdevelop;. preliminaries &tdevelop; installation - KDEDIR + TDEDIR QTDIR @@ -395,11 +395,11 @@ If you use the bash shell add the following lines: - export KDEDIR=(path to your KDE installation) + export TDEDIR=(path to your KDE installation) export QTDIR=(path to your Qt library) - export LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH - export LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LIBRARY_PATH - export PATH=$QTDIR/bin:$KDEDIR/bin:$PATH + export LD_LIBRARY_PATH=$QTDIR/lib:$TDEDIR/lib:$LD_LIBRARY_PATH + export LIBRARY_PATH=$QTDIR/lib:$TDEDIR/lib:$LIBRARY_PATH + export PATH=$QTDIR/bin:$TDEDIR/bin:$PATH @@ -413,11 +413,11 @@ If you use the tcsh shell add the following lines: - setenv KDEDIR (path to your KDE installation) + setenv TDEDIR (path to your KDE installation) setenv QTDIR (path to your Qt library) - setenv LD_LIBRARY_PATH=$QTDIR/lib:$KDEDIR/lib:$LD_LIBRARY_PATH - setenv LIBRARY_PATH $QTDIR/lib:$KDEDIR/lib:$LIBRARY_PATH - setenv PATH $QTDIR/bin:$KDEDIR/bin:$PATH + setenv LD_LIBRARY_PATH=$QTDIR/lib:$TDEDIR/lib:$LD_LIBRARY_PATH + setenv LIBRARY_PATH $QTDIR/lib:$TDEDIR/lib:$LIBRARY_PATH + setenv PATH $QTDIR/bin:$TDEDIR/bin:$PATH @@ -539,7 +539,7 @@ If you want to build your own API documentation ~/trinitysrc/tdevelop> - ./configure --(options-as-above) \ --with-tdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/tdelibs-apidocs + ./configure --(options-as-above) \ --with-tdelibsdoxy-dir=$TDEDIR/share/doc/HTML/en/tdelibs-apidocs @@ -606,7 +606,7 @@ That's all. If you installed &tdevelop; in the default &kde; directory you may n non-default directory - KDEDIRS + TDEDIRS kbuildsycoca @@ -625,13 +625,13 @@ Call up a shell and have the following commands executed before you start &tdeve - Take care to use the plural: It is KDEDIRS, not just KDEDIR) + Take care to use the plural: It is TDEDIRS, not just TDEDIR) ~> - export KDEDIRS=/usr/local/kde:/opt/trinity + export TDEDIRS=/usr/local/kde:/opt/trinity ~> @@ -647,7 +647,7 @@ Call up a shell and have the following commands executed before you start &tdeve - The KDEDIRS environment variable must be set to the list of active &kde; directories in your system. We use + The TDEDIRS environment variable must be set to the list of active &kde; directories in your system. We use /usr/local/kde:/opt/trinity as an example only. The /usr/local/kde directory may for instance contain an incomplete &kde; version you compiled for debug purposes, and the /opt/trinity directory may in addition contain the standard &kde; version from your distribution that is used for everyday work. @@ -658,7 +658,7 @@ In a tcsh shell you must set the environment variables using: ~> - setenv KDEDIRS /usr/local/kde:/opt/trinity + setenv TDEDIRS /usr/local/kde:/opt/trinity The kbuildsycoca command (build system control cache) 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. @@ -711,12 +711,12 @@ Alas, this version is best used read-only over the internet. If you do not alway ./configure --(options-as-usual) \ - --with-tdelibsdoxy-dir=$KDEDIR/share/doc/HTML/en/tdelibs-apidocs + --with-tdelibsdoxy-dir=$TDEDIR/share/doc/HTML/en/tdelibs-apidocs -(make will replace the global $KDEDIR variable with the actual &kde; directory setting recorded therein.) Then issue a make command as usual. After the &tdevelop; IDE has been built you have the option to build the API as well. For this you must issue +(make will replace the global $TDEDIR variable with the actual &kde; directory setting recorded therein.) Then issue a make command as usual. After the &tdevelop; IDE has been built you have the option to build the API as well. For this you must issue ~/trinitysrc/tdevelop> diff --git a/doc/tdevelop/tdevelop-scripting.docbook b/doc/tdevelop/tdevelop-scripting.docbook index 177a0b65..1b722f2d 100644 --- a/doc/tdevelop/tdevelop-scripting.docbook +++ b/doc/tdevelop/tdevelop-scripting.docbook @@ -38,7 +38,7 @@ The next step is to create the actual script. For the above example the Type of The KDCOP tool allows script developers to browse and debug the current interfaces of the host application. KDCOP also provides a neat feature of allowing users to select a method and drag the current code to their text editor. This simplifies use for people who are not savvy to the DCOP methods of the host language. Currently KDCOP supports KJSEmbed, Python, and UNIX Shell method for accessing DCOP. -Once the script is complete it is ready to be installed. Application developers should document the location that will be scanned for scripts. In the case of the above example for Kate the scripts are located in "$KDEDIRS/share/apps/kate/scripts". +Once the script is complete it is ready to be installed. Application developers should document the location that will be scanned for scripts. In the case of the above example for Kate the scripts are located in "$TDEDIRS/share/apps/kate/scripts".
&tdevelop; Scripts on the Filesystem -- cgit v1.2.1