diff options
Diffstat (limited to 'doc/kdevelop/app-files.docbook')
| -rw-r--r-- | doc/kdevelop/app-files.docbook | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/doc/kdevelop/app-files.docbook b/doc/kdevelop/app-files.docbook index 210e1469..f79b81c1 100644 --- a/doc/kdevelop/app-files.docbook +++ b/doc/kdevelop/app-files.docbook @@ -10,38 +10,38 @@ </authorgroup> </appendixinfo> -<title>Configuration Files Used by &kdevelop;</title> +<title>Configuration Files Used by &tdevelop;</title> <para> -&kdevelop; uses a series of configuration files which are distributed amongst several directories. There are two main groups of configuration files to distinguish: +&tdevelop; uses a series of configuration files which are distributed amongst several directories. There are two main groups of configuration files to distinguish: </para> <simplelist> <member> - <link linkend="app-files-default">&kdevelop; Default Configuration</link> — files set up when &kdevelop; was installed. + <link linkend="app-files-default">&tdevelop; Default Configuration</link> — files set up when &tdevelop; was installed. </member> <member> - <link linkend="app-files-user">User Oriented Configuration</link> — files which contain user modifications of the defaults as well as settings made by the &kdevelop; application itself and its plugins. + <link linkend="app-files-user">User Oriented Configuration</link> — files which contain user modifications of the defaults as well as settings made by the &tdevelop; application itself and its plugins. </member> </simplelist> <sect1 id="app-files-default"> -<title>&kdevelop; Default Configuration</title> +<title>&tdevelop; Default Configuration</title> <para> -On installation, &kdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>KDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="kdevelop-install">Installing &kdevelop;</link>). +On installation, &tdevelop; writes some default information files for setup and configuration purposes into subdirectories of the <filename class="directory">$<envar>KDEDIR</envar></filename> installation directory (usually something like <filename class="directory">/opt/kde</filename>, <filename class="directory">/usr/local/kde</filename>, or some other user-defined installation directory, see <link linkend="tdevelop-install">Installing &tdevelop;</link>). </para> <sect2 id="app-files-default-config"> -<title>Default &kdevelop; Configuration</title> +<title>Default &tdevelop; Configuration</title> <para> -There is only one &kdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory: +There is only one &tdevelop; specific default configuration file in the <filename class="directory">$<envar>KDEDIR</envar>/share/config/</filename> directory: </para> <variablelist> <varlistentry> - <term><filename>kdeveloprc</filename></term> + <term><filename>tdeveloprc</filename></term> <listitem><para> - This file contains the basic settings &kdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>KDEHOME</envar>/share/config</filename> directory when &kdevelop; does not find a <filename>kdeveloprc</filename> file there on startup. + This file contains the basic settings &tdevelop; needs to start. It will be copied to the user's <filename class="directory">$<envar>KDEHOME</envar>/share/config</filename> directory when &tdevelop; does not find a <filename>tdeveloprc</filename> file there on startup. </para></listitem> </varlistentry> </variablelist> @@ -52,11 +52,11 @@ There is only one &kdevelop; specific default configuration file in the <filenam <title>Application Specific Defaults</title> <para> -Most &kdevelop; features are provided by KParts. These are basically applications specially designed to run in the &kdevelop; framework (see the overview in the <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> 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 <link linkend="plugin-tools">Plugin Tools</link> appendix). Each KPart application has its own set of configuration files whose defaults will be stored in several subdirectories of the <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> installation directory. </para> <para> -There are quite a lot of default configuration subdirectories in <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> whose names all start with a <filename>kdev</filename> sequence. Most of them are for &kdevelop; internal use only. They might be deliberately grouped for readability as: +There are quite a lot of default configuration subdirectories in <filename class="directory">$<envar>KDEDIR</envar>/share/apps/</filename> whose names all start with a <filename>kdev</filename> sequence. Most of them are for &tdevelop; internal use only. They might be deliberately grouped for readability as: <simplelist> <member><link linkend="app-files-default-apps-stdalone">Stand-alone Applications</link></member> <member><link linkend="app-files-default-apps-task">Task Specific Parts</link></member> @@ -69,18 +69,18 @@ There are quite a lot of default configuration subdirectories in <filename class <listitem id="app-files-default-apps-stdalone"><itemizedlist> <title>Stand-alone Applications</title> <listitem> - <para><filename class="directory">kdevelop/</filename> — contains files to configure the &kdevelop; &IDE;:</para> + <para><filename class="directory">tdevelop/</filename> — contains files to configure the &tdevelop; &IDE;:</para> <itemizedlist> <listitem><para><filename class="directory">licenses/</filename> — contains various licenses texts.</para></listitem> - <listitem><para><filename class="directory">pics/</filename> — contains the picture files used for the &kdevelop;, &kdevelop; Assistant, and &kdevelop; Designer splash screens.</para></listitem> - <listitem><para><filename class="directory">profiles/</filename> — contains default plugin profile settings. (Currently there is only a <filename>tiny</filename> profile provided which defines a minimum set of active &kdevelop; plugins.)</para></listitem> + <listitem><para><filename class="directory">pics/</filename> — contains the picture files used for the &tdevelop;, &tdevelop; Assistant, and &tdevelop; Designer splash screens.</para></listitem> + <listitem><para><filename class="directory">profiles/</filename> — contains default plugin profile settings. (Currently there is only a <filename>tiny</filename> profile provided which defines a minimum set of active &tdevelop; plugins.)</para></listitem> <listitem><para><filename>eventsrc</filename> — holds a lot of <quote>Process successful</quote> localization strings.</para></listitem> - <listitem><para><filename>kdevelopui.rc</filename> — provides the basic menu and tool bar entries &kdevelop; uses.</para></listitem> + <listitem><para><filename>tdevelopui.rc</filename> — provides the basic menu and tool bar entries &tdevelop; uses.</para></listitem> <listitem><para><filename>kdevhtml_partui.rc</filename> — provides a <guimenuitem>Print...</guimenuitem> entry in the <guimenu>File</guimenu> menu, a <guimenuitem>Copy</guimenuitem> entry in the <guimenu>Edit</guimenu> menu, and <guilabel>Back</guilabel> and <guilabel>Forward</guilabel> arrows in the <guilabel>Browser Toolbar</guilabel> in case a &HTML; file is browsed from the <guilabel>Documentation</guilabel> plugin.</para></listitem> </itemizedlist> </listitem> - <listitem><para><filename class="directory">kdevassistant/</filename> — provides the menu and tool bars of the stand-alone &kdevelop; Assistant documentation browser.</para></listitem> - <listitem><para><filename class="directory">kdevdesigner/</filename> and <filename class="directory">kdevdesignerpart/</filename> — provide menu bar and tool bars of the stand-alone &kdevelop; user interface designer.</para></listitem> + <listitem><para><filename class="directory">kdevassistant/</filename> — provides the menu and tool bars of the stand-alone &tdevelop; Assistant documentation browser.</para></listitem> + <listitem><para><filename class="directory">kdevdesigner/</filename> and <filename class="directory">kdevdesignerpart/</filename> — provide menu bar and tool bars of the stand-alone &tdevelop; user interface designer.</para></listitem> </itemizedlist></listitem> <listitem><itemizedlist id="app-files-default-apps-task"> @@ -96,7 +96,7 @@ There are quite a lot of default configuration subdirectories in <filename class <listitem id="app-files-default-appwizard"> <para><filename class="directory">kdevappwizard/</filename> — contains files used by the &appwizard; part:</para> <itemizedlist> - <listitem><para><filename class="directory">importfiles/</filename> — contains <filename>.kdevelop</filename> project files which control the initialization of a new project.</para></listitem> + <listitem><para><filename class="directory">importfiles/</filename> — contains <filename>.tdevelop</filename> project files which control the initialization of a new project.</para></listitem> <listitem><para><filename class="directory">imports/</filename> — contains templates to set up project specific <filename>.desktop</filename> files.</para></listitem> <listitem><para><filename class="directory">template-common/</filename> — contains various files commonly included in the project source directories.</para></listitem> <listitem><para><filename class="directory">templates/</filename> — contains configuration files which describe the information to be included in a given project source directory.</para></listitem> @@ -105,7 +105,7 @@ There are quite a lot of default configuration subdirectories in <filename class </itemizedlist> </listitem> <listitem><para><filename class="directory">kdevastyle/</filename> — provides the <guimenuitem>Reformat Source</guimenuitem> entry in the <guimenu>Edit</guimenu> menu.</para></listitem> - <listitem><para><filename class="directory">kdevautoproject/</filename> — provides most of the entries in the <guimenu>Build</guimenu> menu and the <guilabel>Build Toolbar (&kdevelop;)</guilabel> toolbar.</para></listitem> + <listitem><para><filename class="directory">kdevautoproject/</filename> — provides most of the entries in the <guimenu>Build</guimenu> menu and the <guilabel>Build Toolbar (&tdevelop;)</guilabel> toolbar.</para></listitem> <listitem> <para><filename class="directory">kdevclassview/</filename> — contains files used by the <guilabel>Class View</guilabel> project plugin:</para> <itemizedlist> @@ -123,7 +123,7 @@ There are quite a lot of default configuration subdirectories in <filename class <para><filename class="directory">kdevdocumentation/</filename> — contains files used by the <guilabel>Documentation</guilabel> plugin:</para> <itemizedlist> <listitem><para><filename class="directory">en/</filename> and <filename class="directory">pics/</filename> — contain files used by the <application>htdig</application> search tool.</para></listitem> - <listitem><para><filename class="directory">tocs/</filename> — contain the default &kdevelop; documentation content description files (see the description in <link linkend="toc-file-structure">Basic Structure of &kdevelop; TOC Files</link>).</para></listitem> + <listitem><para><filename class="directory">tocs/</filename> — contain the default &tdevelop; documentation content description files (see the description in <link linkend="toc-file-structure">Basic Structure of &tdevelop; TOC Files</link>).</para></listitem> <listitem><para><filename>kdevpart_documentation.rc</filename> — provides the search related entries in the <guimenu>Help</guimenu> menu.</para></listitem> </itemizedlist> </listitem> @@ -212,20 +212,20 @@ All information about user defined settings is kept in two subdirectories of <fi <title>Application Specific Configuration</title> <para> -Any user changes to the <link linkend="app-files-default">&kdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory. +Any user changes to the <link linkend="app-files-default">&tdevelop; Default Configuration</link> settings as well as user specific settings which are not kept in any of the <link linkend="app-files-user-config">Resource Configuration Files</link> are found in <filename>kdev...</filename> subdirectories of the <filename class="directory">$<envar>KDEHOME</envar>/share/apps/</filename> directory. </para> <para> -Most of these configuration files are however used by various &kdevelop; 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. +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. </para> <note><para> -In case the contents of these directories mirror those of the Default Configuration settings, &kdevelop; will have copied them from <filename class="directory">$<envar>KDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>KDEHOME</envar>/apps/</filename> 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 <filename class="directory">$<envar>KDEDIR</envar>/apps/</filename> into the <filename class="directory">$<envar>KDEHOME</envar>/apps/</filename> directory on its initial start. Any subsequent changes will be made to these copies only. The Default Configuration settings remain unchanged in any case. </para></note> <itemizedlist> <listitem> <para><filename class="directory">kdevabbrev/</filename> — contains files used by the <guilabel>Abbreviation Expansion</guilabel> plugin:</para> <itemizedlist> - <listitem><para><filename class="directory">sources/</filename> — currently empty; &kdevelop; uses the <link linkend="app-files-default-abbrev">default keyword definition</link> files for <guilabel>Expand Text</guilabel> commands.</para></listitem> + <listitem><para><filename class="directory">sources/</filename> — currently empty; &tdevelop; uses the <link linkend="app-files-default-abbrev">default keyword definition</link> files for <guilabel>Expand Text</guilabel> commands.</para></listitem> <listitem><para><filename class="directory">templates/</filename> — contains the user modified template definition files used by the <guilabel>Expand Abbreviation</guilabel> command.</para></listitem> <listitem><para><filename>kdevabbrev.rc</filename> — provides the <guimenuitem>Expand Text</guimenuitem> and <guimenuitem>Expand Abbreviation</guimenuitem> entries in the <guimenu>Edit</guimenu> menu.</para></listitem> </itemizedlist> @@ -252,7 +252,7 @@ In case the contents of these directories mirror those of the Default Configurat <para><filename class="directory">newclass/</filename> — contains the actual header and source templates from which the &appwizard; builds the according source files.</para> </listitem> <listitem> - <para><filename class="directory">pcs/</filename> — contains database files &kdevelop; uses build the actual Persistent Code Store (<filename>.pcs</filename>) file of a &kde; C++ project.</para> + <para><filename class="directory">pcs/</filename> — contains database files &tdevelop; uses build the actual Persistent Code Store (<filename>.pcs</filename>) file of a &kde; C++ project.</para> </listitem> <listitem> <para><filename>kdevcppsupport.rc</filename> — provides the <guimenuitem>Complete Text</guimenuitem> and <guimenuitem>Make Member</guimenuitem> entries fo the <guimenu>Edit</guimenu> menu, the <guimenuitem>Switch Header/Implementation</guimenuitem> entry for the <guimenu>View</guimenu> menu, and the <guimenuitem>New Class</guimenuitem> entry for the <guimenu>Project</guimenu> menu as well as a <guiicon>New Class</guiicon> icon for the <guilabel>Browser Toolbar</guilabel>.</para> @@ -273,10 +273,10 @@ In case the contents of these directories mirror those of the Default Configurat <para>The directories in <filename class="directory">kdevdocumentation/</filename> mainly hold actual bookkeeping information. The actually set up documentation files are kept in <link linkend="app-files-user-config-doc"> <quote><filename>doc...pluginrc</filename></quote> files</link> in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory.</para> <itemizedlist> <listitem> - <para><filename class="directory">bookmarks/</filename> — maintains the entries in the <guilabel>Bookmarks</guilabel> tab of the &kdevelop; <guilabel>Documentation</guilabel> plugin.</para> + <para><filename class="directory">bookmarks/</filename> — maintains the entries in the <guilabel>Bookmarks</guilabel> tab of the &tdevelop; <guilabel>Documentation</guilabel> plugin.</para> </listitem> <listitem> - <para><filename class="directory">index/</filename> — holds various cache files &kdevelop; uses to speed up indexed documentation searches in the <guilabel>Index</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para> + <para><filename class="directory">index/</filename> — holds various cache files &tdevelop; uses to speed up indexed documentation searches in the <guilabel>Index</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para> </listitem> <listitem> <para><filename class="directory">search/</filename> — contains files used by the <application>htdig</application> search tool which serves search calls from the <guilabel>Search</guilabel> tab of the <guilabel>Documentation</guilabel> plugin.</para> @@ -290,10 +290,10 @@ In case the contents of these directories mirror those of the Default Configurat <para><filename class="directory">kdevdoxygen/</filename> — provides the menu entries for the <guilabel>Doxygen Support</guilabel> project plugin.</para> </listitem> <listitem> - <para><filename class="directory">kdevelop/</filename> — contains some actual settings &kdevelop; uses for its basic setup:</para> + <para><filename class="directory">tdevelop/</filename> — contains some actual settings &tdevelop; uses for its basic setup:</para> <itemizedlist> - <listitem><para><filename class="directory">profiles/</filename> — provides actual plugin profile setting. (Initially there is only a <filename>FullIDE</filename> profile which defines a full set of initially active &kdevelop; plugins.)</para></listitem> - <listitem><para><filename>kdevelopui.rc</filename> — provides the basic menu and tool bar entries &kdevelop; uses.</para></listitem> + <listitem><para><filename class="directory">profiles/</filename> — provides actual plugin profile setting. (Initially there is only a <filename>FullIDE</filename> profile which defines a full set of initially active &tdevelop; plugins.)</para></listitem> + <listitem><para><filename>tdevelopui.rc</filename> — provides the basic menu and tool bar entries &tdevelop; uses.</para></listitem> </itemizedlist> </listitem> <listitem> @@ -345,32 +345,32 @@ In case the contents of these directories mirror those of the Default Configurat <title>Resource Configuration Files</title> <para> -There are two groups of &kdevelop; configuration files in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory, distiguished by their surrounding character sequences: +There are two groups of &tdevelop; configuration files in the <filename class="directory">$<envar>KDEHOME</envar>/share/config/</filename> directory, distiguished by their surrounding character sequences: <simplelist> <member><quote><filename>doc...pluginrc</filename></quote> denotes <link linkend="app-files-user-config-doc">files used by the documentation plugin.</link></member> - <member><quote><filename>kdev...rc</filename></quote> denotes configuration <link linkend="app-files-user-config-kdev">files used by &kdevelop;</link> itself and its available plugins.</member> + <member><quote><filename>kdev...rc</filename></quote> denotes configuration <link linkend="app-files-user-config-kdev">files used by &tdevelop;</link> itself and its available plugins.</member> </simplelist> </para> <itemizedlist id="app-files-user-config-kdev"> -<title>Configuration Files Used by &kdevelop;</title> +<title>Configuration Files Used by &tdevelop;</title> <listitem> <para><filename>kdevabbrevrc</filename> — holds the current state of the <guilabel>Abbreviations</guilabel> configuration provided by the <guilabel>Abbreviation Expansion</guilabel> plugin.</para> <note><para>This only records whether the abbreviations will be used or not. The actual definitions of new abbreviations will go into the <filename>$<envar>KDEHOME</envar>/share/apps/kdevabbrev/templates/templates</filename> file.</para></note> </listitem> <listitem> - <para><filename>kdevassistantrc</filename> — holds some configuration states specific of the stand-alone &kdevelop; Assistant documentation browser.</para> - <note><para>Most common configuration settings are shared with the &kdevelop; IDE <filename>kdeveloprc</filename> file.</para></note> + <para><filename>kdevassistantrc</filename> — holds some configuration states specific of the stand-alone &tdevelop; Assistant documentation browser.</para> + <note><para>Most common configuration settings are shared with the &tdevelop; IDE <filename>tdeveloprc</filename> file.</para></note> </listitem> - <listitem><para><filename>kdevassistantuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the stand-alone &kdevelop; Assistant documentation browser.</para></listitem> + <listitem><para><filename>kdevassistantuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the stand-alone &tdevelop; Assistant documentation browser.</para></listitem> <listitem> <para><filename>kdevclassviewrc</filename> — holds the <guilabel>View Mode</guilabel> setting of the <guilabel>Classes</guilabel> class browser tab provided by the <guilabel>Class View</guilabel> project plugin.</para> <note><para>This is a global setting, although the <guilabel>Class View</guilabel> plugin may be disabled on a per project basis. Any change in this setting will be globally updated whenever the current project is closed and thus affect all subsequently loaded projects.</para></note> </listitem> <listitem><para><filename>kdevcppsupportrc</filename> — holds some settings used to set up CPP source files. In particular you will find the settings made on the <guilabel>C++ Class Generator</guilabel> configuration dialog in here.</para></listitem> <listitem><para><filename>kdevdocumentationrc</filename> — holds actual settings the <guilabel>Documentation</guilabel> plugin uses.</para></listitem> - <listitem><para><filename>kdeveloprc</filename> — holds the global settings the &kdevelop; IDE and the &kdevelop; Assistant stand-alone documentation browser will use.</para></listitem> - <listitem><para><filename>kdevelopuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the &kdevelop; IDE.</para></listitem> + <listitem><para><filename>tdeveloprc</filename> — holds the global settings the &tdevelop; IDE and the &tdevelop; Assistant stand-alone documentation browser will use.</para></listitem> + <listitem><para><filename>tdevelopuimode4rc</filename> — holds the current MDI configuration states (dock positions &etc;) of the &tdevelop; IDE.</para></listitem> <listitem><para><filename>kdevfileselectorrc</filename> — holds actual settings the <guilabel>File Selector</guilabel> plugin uses.</para></listitem> <listitem><para><filename>kdevfileviewrc</filename> — holds the actual filename color settings the <guilabel>CVS Integration (Cervisia)</guilabel> project plugin uses for display.</para></listitem> <listitem><para><filename>kdevfilterrc</filename> — holds actual settings the <guilabel>Shell Filtering and Insertion</guilabel> plugin uses.</para></listitem> @@ -399,10 +399,10 @@ There are two groups of &kdevelop; configuration files in the <filename class="d <title>Project Dependent Configuration</title> <para> -Most project dependend configuration is kept in the <filename><project-name>.kdevelop</filename> and <filename><project-name>.kdevses</filename> &kdevelop; project configuration files rather than in separate files as the other, more global, configuration settings. In short, those files are meant for: +Most project dependend configuration is kept in the <filename><project-name>.tdevelop</filename> and <filename><project-name>.kdevses</filename> &tdevelop; project configuration files rather than in separate files as the other, more global, configuration settings. In short, those files are meant for: </para> <simplelist> - <member><filename><project-name>.kdevelop</filename> — global project configuration information.</member> + <member><filename><project-name>.tdevelop</filename> — global project configuration information.</member> <member><filename><project-name>.kdevses</filename> — configuration information needed to restore the specific behaviours of the running session.</member> </simplelist> <para> @@ -412,7 +412,7 @@ Both are &XML; coded files. They can be viewed and (cautiously) altered using an <sect2> <title>Persistent Code Store Files</title> -<para>There is a third project dependend configuration file, the <filename><project-name>.kdevelop.pcs</filename> Persistant Code Store. This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the project. Additionally, this Persistant Code Store keeps information use by the <guilabel>Code Completion</guilabel> facility of &kdevelop;. +<para>There is a third project dependend configuration file, the <filename><project-name>.tdevelop.pcs</filename> Persistant Code Store. This is a binary coded file holding an internal parser cache for the most part in order to speed up the loading sequence of the project. Additionally, this Persistant Code Store keeps information use by the <guilabel>Code Completion</guilabel> facility of &tdevelop;. </para> <note><para> |