geany/doc/geany.docbook

<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
        "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY app "Geany">
<!ENTITY app_small "geany">
<!ENTITY appversion "0.7">
<!ENTITY appurl "http://geany.uvena.de">
<!ENTITY deburl "http://debian.uvena.de">
<!ENTITY author_mail "enrico.troeger@uvena.de">
<!ENTITY date "June 2, 2006">
<!ENTITY legal SYSTEM "geany_gpl.docbook">
]>

<book lang="en">
	<bookinfo>
		<author>
			<firstname>Enrico</firstname>
			<surname>Troeger</surname>
			<address><email>&author_mail;</email></address>
		</author>
		<author>
			<firstname>Nick</firstname>
			<surname>Treleaven</surname>
			<address><email>nick.treleaven@btinternet.com</email></address>
		</author>
		<author>
			<firstname>Frank</firstname>
			<surname>Lanitz</surname>
			<address><email>frank@frank.uvena.de</email></address>
		</author>
		<copyright>
			<year>2005-2006</year>
		</copyright>
		<legalnotice>
			<para>
				This document is distributed under the terms of the GNU General Public License as published by the Free
				Software Foundation; either version 2 of the License, or (at your option) any later version.
				A copy of this license can be found in the file COPYING included with the source code of this
				program and in the appendix of this document.
			</para>
		</legalnotice>
		<title>
			&app; &appversion;
		</title>
	</bookinfo>

	<chapter id="intro">
		<title>
			Introduction
		</title>
		<section>
			<title>About Geany</title>
			<para>
				<application>&app;</application> is a small and lightweight Integrated Development Environment.
				It was developed to provide a small and fast IDE, which has only a few dependencies from other
				packages. Another goal was to be as independent as possible from a special Desktop Environment
				like KDE or GNOME. So it is using only the GTK2 toolkit and therefore you need only the
				GTK2 runtime libraries to run <application>&app;</application>.
			</para>
			<para>
				The basic features of <application>&app;</application> are:
				<itemizedlist>
					<listitem><para>Syntax highlighting</para></listitem>
					<listitem><para>Code completion</para></listitem>
					<listitem><para>Auto completion of often used constructs like if, for and while</para></listitem>
					<listitem><para>Auto completion of XML and HTML tags</para></listitem>
					<listitem><para>Call tips</para></listitem>
					<listitem><para>Many supported filetypes like C, Java, PHP, HTML, Python, Perl, Pascal</para></listitem>
					<listitem><para>Symbol lists</para></listitem>
				</itemizedlist>
			</para>
		</section>
		<section>
			<title>About this document</title>
			<para>
				This documentation is available in various formats like HTML, text and PDF. The latest version is
				always available at <ulink url="&appurl;">&appurl;</ulink>.
			</para>
		</section>
		<section>
			<title>Where to get it</title>
			<para>
				You can obtain <application>&app;</application> from <ulink url="&appurl;">&appurl;</ulink>
				or perhaps from your distributor.
			</para>
		</section>
		<section>
			<title>License</title>
			<para>
				<application>&app;</application> is distributed under the terms of the GNU General Public License as published
				by the Free	Software Foundation; either version 2 of the License, or (at your option) any later version.
				A copy of this license can be found in the file COPYING included with the source code of this
				program and in the appendix of this document.
			</para>
		</section>
	</chapter>

	<chapter id="installation">
		<title>
			Installation
		</title>
		<section>
			<title>Requirements</title>
			<para>
				For compiling <application>&app;</application> yourself, you will need the GTK (>= 2.6.0)
				libraries and header files. You will also need the Pango, Glib and ATK libraries and header files.
				All these files are available at <ulink url="http://www.gtk.org">http://www.gtk.org</ulink>.
			</para>
			<para>
				Further more you need, of course, a C compiler, for the included Scintilla library a C++
				compiler and the make tool.
			</para>
		</section>
		<section>
			<title>Source Compilation</title>
			<para>
				Compiling <application>&app;</application> is quite easy. The following should do it:
				<screen>
					<prompt>%</prompt> <userinput><command>./configure</command></userinput>
					<prompt>%</prompt> <userinput><command>make</command></userinput>
					<prompt>%</prompt> <userinput><command>make</command> install</userinput>
				</screen>
			</para>
			<para>
				The configure script supports several common options, for a detailed list, type
				<screen>
					<prompt>%</prompt> <userinput><command>./configure</command> --help</userinput>
				</screen>
			</para>
			<para>
				In the case, that your system lacks dynamic linking loader support, you probably want
				to pass the option --disable-vte to the configure script. This prevents compiling
				&app; with dynamic linking loader support to automatically load
				<filename>libvte.so.4</filename> if available.
			</para>
			<para>&app; has been successfully compiled and tested under Debian 3.1 Sarge, Debian 3.2 Etch,
				  Fedora Core 4, LinuxFromScratch and FreeBSD 6.0. It also compiles under
				  <trademark class="trade">Mircosoft Windows</trademark>, but there are lots of changes
				  to the makefiles necessary.
			</para>
			<para>
				If there are any errors during compilation, check your build environment and try to find the error,
				otherwise contact the author at <email>&author_mail;</email>.
			</para>
		</section>
		<section>
			<title>Binary Packages</title>
			<section>
				<title>Fedora</title>
				<para>
					You can use the Fedora Core 4 repository from
					<ulink url="http://naturidentisch.de/packages/fc4/">http://naturidentisch.de/packages/fc4/</ulink>.
				</para>
			</section>
			<section>
				<title>Debian</title>
				<para>
					Binary packages for Debian are available at <ulink url="&deburl;">&deburl;/</ulink>.
					You can add one of the following lines(depending on your system) to your apt
					<filename>sources.list</filename> to get automatically get the latest version of
					<application>&app;</application>:
				</para>
				<para>
					<command>deb &deburl;/ ./stable/</command>
				</para>
				<para>
					<command>deb &deburl;/ ./testing/</command>
				</para>
			</section>
			<section>
				<title>SuSE</title>
				<para>
					There are not yet packages for SuSE available.
				</para>
			</section>
			<section>
				<title>Gentoo</title>
				<para>
					An ebuild for Gentoo can be found on <ulink url="http://www.gentoo.de/">http://www.gentoo.de</ulink>.
				</para>
			</section>
		</section>
	</chapter>

	<chapter id="usage">
		<title>Usage</title>
		<section>
			<title>Getting Started</title>
			<para>
				You can start <application>&app;</application> in the following ways:
				<itemizedlist>
						<listitem>
						<para>
							From the Desktop Environment menu
						</para>
						<para>
							Choose in your application menu of your used Desktop Environment:
							<menuchoice>
							<guisubmenu>Development</guisubmenu>
							<guimenuitem>&app;</guimenuitem>
							</menuchoice>.
						</para>
					</listitem>
					<listitem>
						<para>
							From the command line
						</para>
						<para>
							To start <application>&app;</application> from a command line, type the following
							and press <keycap>Return</keycap>:
							<screen>
								<prompt>%</prompt> <userinput><command>&app_small;</command></userinput>
							</screen>
						</para>
					</listitem>
				</itemizedlist>
			</para>
		</section>
		<section id="clo">
			<title>Commandline options</title>
			<para>
				<table frame="all">
					<title>Commandline Options</title>
					<tgroup cols="3">
						<?dbhtml cellpadding="4" ?>
						<?dbhtml cellspacing="0" ?>
						<colspec colnum="1" colname="col1"/>
						<colspec colnum="2" colname="col2"/>
						<colspec colnum="3" colname="col3"/>
						<thead>
							<row>
								<entry>Short option</entry>
								<entry>Long option</entry>
								<entry>Function</entry>

							</row>
						</thead>
						<tbody>
							<row>
								<entry>-n</entry>
								<entry>--no-ctags</entry>
								<entry>Do not load auto completion and call tip data.
									   Use this option, if you do not want to use them. For more
									   information see <xref linkend="general_ctags"/>.
								</entry>
							</row>
							<row>
								<entry>-m</entry>
								<entry>--no-msgwin</entry>
								<entry>Do not show the message window. Use this option if you do not
									   need compiler messages or VTE support.
								</entry>
							</row>
							<row>
								<entry>-p</entry>
								<entry>--no-pipe</entry>
								<entry>Do not open files in a running instance, force opening a new instance.
								</entry>
							</row>
							<row>
								<entry>-t</entry>
								<entry>--no-terminal</entry>
								<entry>Do not load terminal support. Use this option, if you do not
									   want to load the virtual terminal emulator widget at startup.
									   If you do not have <filename>libvte.so.4</filename> installed,
									   then terminal-support is automatically disabled.
								</entry>
							</row>
							<row>
								<entry>-l</entry>
								<entry>--vte-lib</entry>
								<entry>Specify explicitly the path including filename or only the filename
									   to the VTE library, e.g. <filename>/usr/lib/libvte.so</filename> or
									   <filename>libvte.so</filename>. This option is only needed, when the
									   autodetection does not work.
								</entry>
							</row>
							<row>
								<entry>-c directory_name</entry>
								<entry>--config=directory_name</entry>
								<entry>Use an alternate configuration directory. Default
									   configuration directory is <filename>~/.&app_small;/</filename>
									   and there resides <filename>&app_small;.conf</filename> and some
									   template files.
								</entry>
							</row>
							<row>
								<entry>-d</entry>
								<entry>--debug</entry>
								<entry>Runs &app; in debug mode, which means being verbose
									   and printing lots of information.
								</entry>
							</row>
							<row>
								<entry>-?</entry>
								<entry>--help</entry>
								<entry>Show help information and exit.</entry>
							</row>
							<row>
								<entry>-v</entry>
								<entry>--version</entry>
								<entry>Show version information and exit.</entry>
							</row>
							<row>
								<entry></entry>
								<entry>[files ...]</entry>
								<entry>Opens all given files at startup. This option causes &app; to
									   ignore loading stored files from the last session (if enabled).
								</entry>
							</row>
						</tbody>
					</tgroup>
				</table>
				&app; supports all generic GTK options, a list is available on the help screen.
			</para>
		</section>
		<section id="general">
			<title>General</title>
			<section id="general_startup">
				<title>Startup</title>
				<para>
					At startup, &app; loads the 15 first files from the last time,
					<application>&app;</application> was launched. You can disable this feature in the
					preferences dialog(see <xref linkend="confdialog_gen"/>). If you specify some files on
					the commandline, only these files will be opened. But you can find the files from the
					last session in the file menu. There is an item "Recent files". It contains the last
					15 recently opened files. It may be that &app; not exactly loads 15 files, this depends
					on the compile time option GEANY_SESSION_FILES, the default is 15. For details see
					<xref linkend="cto"/>.
				</para>
			</section>
			<section id="general_fifo">
				<title>Detection of a running instance</title>
				<para>
					&app; detects an already running instance of it and open new files in the running one.
					So, you can use &app; like an editor to view and edit files by opening them from other
					programs. If you do not like this for some reason, you can it disable with the appropriate
					commandline option.
				</para>
				<para>
					In the case that &app; crashed, you will get a message dialog at the next start,
					which asks you whether to delete an existing named pipe. If you are sure that there is
					no other instance of &app; running, you can say Yes and &app; will start as usual.
					Otherwise click No and Geany will not start.
				</para>
			</section>
			<section id="general_ctags">
				<title>Global C tags</title>
				<para>
					If a C file(with extension is c, cpp, h, etc.) is opened, a global tags file is
					loaded once, which contains	many function declarations from the glibc and some other
					libraries, like X, Bonobo, Gnome, GTK, Glib and so on. These declarations are used
					for call tips and auto completion. These tags are only useful if you are writing
					C or C++ source code. So if you know, that you do not need these things, you can skip
					loading this tag file. To do so, start <application>&app;</application> with the
					argument "-n" or "--no-ctags", for more information see <xref linkend="clo"/>.
				</para>
			</section>
			<section id="general_vte">
				<title>Virtual terminal emulator widget (VTE)</title>
				<para>
					If you have installed <filename>libvte.so</filename> in your system, it is loaded
					automatically by <application>&app;</application>. Then you have a terminal widget
					in the notebook	at the bottom.
				</para>
				<para>
					If <application>&app;</application> cannot find <filename>libvte.so</filename> at
					startup, the terminal widget will not be loaded. So there is no need to install the
					package containing this	file in order to run <application>&app;</application>.
					Additionally, you can disable the use of the terminal widget by commandline option,
					for more information see <xref linkend="clo"/>.
				</para>
				<para>
					 You can use this terminal (from now on called VTE) nearly as an usual terminal program
					 like xterm. There is a basic clipboard support. You can paste the content
					 of the clipboard by pressing the middle mouse button in the VTE (on 2-button mice,
					 the middle button can often be simulated by pressing both mouse buttons together) or by
					 pressing the right mouse button to open the popup menu and choose Paste.
					 To copy text from the VTE, just select the desired text and then press the
					 right mouse button and choose Copy from the popup menu.
				</para>
				<note>
					<para>&app; tries to load <filename>libvte.so</filename>. If this fails, it tries to
						  load <filename>libvte.so.4</filename>. If this fails too, you should check whether
						  you installed libvte correctly. Again, &app; runs also without this library.
						  But it could be, that the library is called something else than
						  <filename>libvte.so.4</filename> (e.g. on FreeBSD 6.0 it is called
						  <filename>libvte.so.8</filename>). So please set a link to the correct file (as root).
						  <screen><prompt>#</prompt> <userinput><command>ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so.4</command></userinput></screen>
						  Obviously, you have to adjust the paths and set X to the number of your
						  <filename>libvte.so</filename>.
					</para>
				</note>
			</section>
		</section>
<!--
		<section>
			<title>Editing</title>
			<para>
				&app; has a light improvement using the HOME and END keys. If you press END the cursor
				is positioned at the end of the line, as expected.  If you then press the END key again,
				the cursor gets back to the position where it was before. By pressing the HOME key,
				you get a similar behaviour. The first time you press the HOME key, the cursor jumps
				to the first non-blank character in the line. If you press it again, the cursor gets
				to the very first column in the line. And at the third time your press the key, it
				jumps back to the position where you started.
			</para>
		</section>
-->
		<section>
			<title>Search and Replace</title>
			<para>
				You can use regular expressions in the search dialog, just by activating the check box(see
				the image below). Detailed information about special characters can be found in the
				<xref linkend="regexp"/>.
				<figure>
				   <title>Search dialog</title>
				   <graphic fileref="images/find_dialog.jpg"></graphic>
				</figure>

			</para>
			<para>
				<table frame="all" id="regexp">
					<title>Regular expressions</title>
					<tgroup cols="2">
						<?dbhtml cellpadding="4" ?>
						<?dbhtml cellspacing="0" ?>
						<colspec colnum="1" colname="col1"/>
						<colspec colnum="2" colname="col2"/>
						<spanspec spanname="hspan" namest="col1" nameend="col2" align="left"/>
						<thead>
							<row>
								<entry spanname="hspan">
									In a regular expression, the following characters are interpreted:
								</entry>
							</row>
						</thead>
						<tbody>
							<row>
								<entry>.</entry>
								<entry>Matches any character.</entry>
							</row>
							<row>
								<entry>\(</entry>
								<entry>This marks the start of a region for tagging a match.</entry>
							</row>
							<row>
								<entry>\)</entry>
								<entry>This marks the end of a tagged region.</entry>
							</row>
							<row>
								<entry>\n</entry>
								<entry>Where n is 1 through 9 refers to the first through ninth tagged region
									   when replacing. For example, if the search string was Fred\([1-9]\)XXX
									   and the replace string was Sam\1YYY, when applied to Fred2XXX this would
									   generate Sam2YYY.
								</entry>
							</row>
							<row>
								<entry>\&lt;</entry>
								<entry>This matches the start of a word.</entry>
							</row>
							<row>
								<entry>\&gt;</entry>
								<entry>This matches the end of a word.</entry>
							</row>
							<row>
								<entry>\x</entry>
								<entry>This allows you to use a character x that would otherwise have a special
									   meaning. For example, \[ would be interpreted as [ and not as the start
									   of a character set.
								</entry>
							</row>
							<row>
								<entry>[...]</entry>
								<entry>This indicates a set of characters, for example, [abc] means any of the
									   characters a, b or c. You can also use ranges, for example [a-z] for any
									   lower case character.
								</entry>
							</row>
							<row>
								<entry>[^...]</entry>
								<entry>The complement of the characters in the set. For example, [^A-Za-z] means
									   any character except an alphabetic character.
								</entry>
							</row>
							<row>
								<entry>$</entry>
								<entry>This matches the end of a line.</entry>
							</row>
							<row>
								<entry>*</entry>
								<entry>This matches 0 or more times. For example, Sa*m matches Sm, Sam, Saam, Saaam and so on.</entry>
							</row>
							<row>
								<entry>+</entry>
								<entry>This matches 1 or more times. For example, Sa+m matches Sam, Saam, Saaam and so on.</entry>
							</row>
						</tbody>
					</tgroup>
				</table>
			</para>
		</section>
		<section id="confdialog">
			<title>Preferences</title>
			<para>
				should be written
				<!-- I know that <mediaobject> is better than <graphic> but <mediaobject> does not work with PDF -->
				<figure id="confdialog_gen">
				   <title>General tab in preferences dialog</title>
				   <graphic fileref="images/pref_dialog_gen.jpg"></graphic>
				</figure>
				<figure>
				   <title>Editor tab in preferences dialog</title>
				   <graphic fileref="images/pref_dialog_edit.jpg"></graphic>
				</figure>
				<figure>
				   <title>Tools tab in preferences dialog</title>
				   <graphic fileref="images/pref_dialog_tools.jpg"></graphic>
				</figure>
				<figure id="confdialog_templ">
				   <title>Template tab in preferences dialog</title>
				   <graphic fileref="images/pref_dialog_templ.jpg"></graphic>
				</figure>
				<figure id="confdialog_keys">
				   <title>Keybinding tab in preferences dialog</title>
				   <graphic fileref="images/pref_dialog_keys.jpg"></graphic>
				</figure>
			   <note>
					<para>For more information see <xref linkend="keybindings"/>.</para>
			   </note>
				<figure id="confdialog_vte">
				   <title>VTE tab in preferences dialog</title>
				   <graphic fileref="images/pref_dialog_vte.jpg"></graphic>
				</figure>
			</para>
			<section id="cto">
				<title>Compile time options</title>
				<para>
					There are some options which can only changed at compile time. To change these
					options, look into <filename>src/geany.h</filename> to change these settings.
					To find it, look for a block of lines starting with <quote>#define GEANY_*</quote>.
					All definitions which are not listed here, should not be changed.
					<table frame="all">
						<title>Compile time options</title>
						<tgroup cols="3">
							<?dbhtml cellpadding="4" ?>
							<?dbhtml cellspacing="0" ?>
							<colspec colnum="1" colname="col1"/>
							<colspec colnum="2" colname="col2"/>
							<colspec colnum="3" colname="col3"/>
							<thead>
								<row>
									<entry>Option</entry>
									<entry>Description</entry>
									<entry>Default</entry>
								</row>
							</thead>
							<tbody>
								<row>
									<entry>GEANY_MAX_OPEN_FILES</entry>
									<entry>The limit how many files can be open at the same time.</entry>
									<entry>25</entry>
								</row>
								<row>
									<entry>GEANY_SESSION_FILES</entry>
									<entry>How many files should be reopened from the last run. Obviously,
									the value should be smaller than GEANY_MAX_OPEN_FILES.</entry>
									<entry>15</entry>
								</row>
								<row>
									<entry>GEANY_WORDCHARS</entry>
									<entry>These characters define the word boundaries.</entry>
									<entry>(look at sourcecode)</entry>
								</row>
								<row>
									<entry>GEANY_MAX_AUTOCOMPLETE_WORDS</entry>
									<entry>How many auto complete suggestions should &app; provide.</entry>
									<entry>30</entry>
								</row>
								<row>
									<entry>GEANY_STRING_UNTITLED</entry>
									<entry>A string used as name for new files. Be aware that the string can be translated,
										   so change it only if you know what you are doing.</entry>
									<entry>untitled</entry>
								</row>
								<row>
									<entry>GEANY_CHECK_FILE_DELAY</entry>
									<entry>Time in seconds between a file is checked for changes.</entry>
									<entry>30</entry>
								</row>
								<row>
									<entry>GEANY_WINDOW_MINIMAL_WIDTH</entry>
									<entry>The minimal width of the main window.</entry>
									<entry>620</entry>
								</row>
								<row>
									<entry>GEANY_WINDOW_MINIMAL_HEIGHT</entry>
									<entry>The minimal height of the main window.</entry>
									<entry>440</entry>
								</row>
								<row>
									<entry>GEANY_WINDOW_DEFAULT_WIDTH</entry>
									<entry>The default width of the main window at the first start.</entry>
									<entry>900</entry>
								</row>
								<row>
									<entry>GEANY_WINDOW_DEFAULT_HEIGHT</entry>
									<entry>The default height of the main window at the first start.</entry>
									<entry>600</entry>
								</row>
							</tbody>
						</tgroup>
					</table>

				</para>
			</section>
		</section>
		<section id="keybindings">
			<title>Keybindings</title>
			<para>
				For all listed actions you can define own keybindings. Open the preferences dialog
				and selected the desired action and click on change. In the opening dialog you can
				press any key combination you want and it will be saved when you press OK.
				You can define only one key combination for one action.
			</para>
			<para>
				Some of the default key combinations cannot be changed, e.g. menu_new or menu_open.
				These are set by GTK and should be kept. But you can add a key combination for these
				actions, so for example to execute menu_open by default
				<keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo> is set and you can
				define <keycombo><keycap>Alt</keycap><keycap>O</keycap></keycombo> so, the file open
				dialog is shown by pressing
				<keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo> or
				<keycombo><keycap>Alt</keycap><keycap>O</keycap></keycombo>.
			</para>
			<para>
				The following table lists all available actions for keyboard shortcuts.
			</para>
			<para>
				<table frame="all">
					<title>Keybindings action table</title>
					<tgroup cols="2">
						<?dbhtml cellpadding="4" ?>
						<?dbhtml cellspacing="0" ?>
						<colspec colnum="1" colname="col1"/>
						<colspec colnum="2" colname="col2"/>
						<spanspec spanname="hspan" namest="col1" nameend="col2" align="center"/>
						<thead>
							<row>
								<entry>Action</entry>
								<entry>Description</entry>
							</row>
						</thead>
						<tbody>
							<row>
								<entry align="left" spanname="hspan">Menu items</entry>
							</row>
							<row>
								<entry>menu_new</entry>
								<entry>Creates a new file.</entry>
							</row>
							<row>
								<entry>menu_open</entry>
								<entry>Opens a file.</entry>
							</row>
							<row>
								<entry>menu_save</entry>
								<entry>Saves the current file.</entry>
							</row>
							<row>
								<entry>menu_saveall</entry>
								<entry>Saves all open files.</entry>
							</row>
							<row>
								<entry>menu_closeall</entry>
								<entry>Closes all open files.</entry>
							</row>
							<row>
								<entry>menu_reloadfile</entry>
								<entry>Reloads the current file. All unsaved changes will be lost.</entry>
							</row>
							<row>
								<entry>menu_undo</entry>
								<entry>Undos the last action.</entry>
							</row>
							<row>
								<entry>menu_redo</entry>
								<entry>Redos the last action.</entry>
							</row>
							<row>
								<entry>menu_preferences</entry>
								<entry>Opens preferences dialog.</entry>
							</row>
							<row>
								<entry>menu_findnext</entry>
								<entry>Finds next result.</entry>
							</row>
							<row>
								<entry>menu_findprevious</entry>
								<entry>Finds previous result.</entry>
							</row>
							<row>
								<entry>menu_replace</entry>
								<entry>Opens the replace dialog.</entry>
							</row>
							<row>
								<entry>menu_gotoline</entry>
								<entry>Opens the Go To Line dialog.</entry>
							</row>
							<row>
								<entry>menu_opencolorchooser</entry>
								<entry>Opens the colour chooser dialog.</entry>
							</row>
							<row>
								<entry>menu_fullscreen</entry>
								<entry>Switches to fullscreen mode.</entry>
							</row>
							<row>
								<entry>menu_messagewindow</entry>
								<entry>Toggles the message window(status and compiler messages) on and off.</entry>
							</row>
							<row>
								<entry>menu_zoomin</entry>
								<entry>Zooms in the text</entry>
							</row>
							<row>
								<entry>menu_zoomout</entry>
								<entry>Zooms out the text</entry>
							</row>
							<row>
								<entry>menu_replacetabs</entry>
								<entry>Replaces all tabulators with the right amount of spaces.</entry>
							</row>
							<row>
								<entry>menu_foldall</entry>
								<entry>Folds all contractible code blocks.</entry>
							</row>
							<row>
								<entry>menu_unfoldall</entry>
								<entry>Unfolds all contracted code blocks.</entry>
							</row>
							<row>
								<entry align="left" spanname="hspan">Build options</entry>
							</row>
							<row>
								<entry>build_compile</entry>
								<entry>Compiles the current file.</entry>
							</row>
							<row>
								<entry>build_link</entry>
								<entry>Builds(compiles if ncessary and links) the current file.</entry>
							</row>
							<row>
								<entry>build_make</entry>
								<entry>Builds the current file with the make tool.</entry>
							</row>
							<row>
								<entry>build_makeowntarget</entry>
								<entry>Builds the current file with the make tool and a given target.</entry>
							</row>
							<row>
								<entry>build_run</entry>
								<entry>Executes the current file in a terminal emulation.</entry>
							</row>
							<row>
								<entry>build_run2</entry>
								<entry>Executes the current file in a terminal emulation.</entry>
							</row>
							<row>
								<entry>build_options</entry>
								<entry>Opens the build options dialog.</entry>
							</row>
							<row>
								<entry align="left" spanname="hspan">Miscellaneous</entry>
							</row>
							<row>
								<entry>reloadtaglist</entry>
								<entry>Reloads the tag/symbol list.</entry>
							</row>
							<row>
								<entry>switch_editor</entry>
								<entry>Switches to editor widget.</entry>
							</row>
							<row>
								<entry>switch_scribble</entry>
								<entry>Switches to scribble widget.</entry>
							</row>
							<row>
								<entry>switch_vte</entry>
								<entry>Switches to VTE widget.</entry>
							</row>
							<row>
								<entry>switch_tableft</entry>
								<entry>Switches to the previous open document.</entry>
							</row>
							<row>
								<entry>switch_tabright</entry>
								<entry>Switches to the next open document.</entry>
							</row>
							<row>
								<entry>toggle_sidebar</entry>
								<entry>Shows or hides the sidebar.</entry>
							</row>
							<row>
								<entry align="left" spanname="hspan">Editing operations</entry>
							</row>
							<row>
								<entry>edit_duplicateline</entry>
								<entry>Duplicates the current line.</entry>
							</row>
							<row>
								<entry>edit_commentline</entry>
								<entry>Comments current line or selection.</entry>
							</row>
							<row>
								<entry>edit_autocomplete</entry>
								<entry>Shows auto completion list.</entry>
							</row>
							<row>
								<entry>edit_calltip</entry>
								<entry>Shows call tips for the current function or method.</entry>
							</row>
							<row>
								<entry>edit_macrolist</entry>
								<entry>Shows a list of (in the workspace) available macros and
									   variables.
								</entry>
							</row>
							<row>
								<entry>edit_suppresscompletion</entry>
								<entry>If you type something like if or for and press this key, it
									   will not be auto completed.
								</entry>
							</row>
						</tbody>
					</tgroup>
				</table>
			</para>
		</section>
		<section>
			<title>File types</title>
			<para>
				should be written
			</para>
		</section>
		<section>
			<title>Templates</title>
			<para>
				<application>&app;</application> supports several templates for file headers, multiline
				comments(frame comments), function descriptions, a typical ChangeLog entry and a short GPL notice.
				To use this templates, just open the edit menu or open the popup menu by right-clicking in the
				editor widget, and choose "Insert Comments" and insert templates as you want.
			</para>
			<para>
				Some templates like file header or ChangeLog entry, will always be inserted at the top of the file.
			</para>
			<para>
				To insert a function description, the cursor must be inside of the function, so that the function
				name can be determined automatically. The description will be positioned correctly one line above
				the function, just check it out. If the cursor is not inside of a function or the function name cannot
				be determined, you cannot insert a function description.
			</para>
			<para>
				Each template can be customized to your needs. The templates are in the configuration directory, which
				is in <filename>~/.&app_small;/</filename> (see <xref linkend="clo"/> for further information about
				configuration directory). Just open the desired template with an editor (ideally &app; ;-) ) and edit
				the template as your needs.	There are some wildcards which will be automatically replaced by
				<application>&app;</application> at startup.
			</para>
			<para>
				All wildcards must be enclosed by "{" and "}", e.g. {date}.
			</para>
			<para>
				In the configuration dialog you can find a tab "Templates"(see <xref linkend="confdialog_templ"/>).
				You can define the default values which will be inserted in the templates. You should restart
				<application>&app;</application> after made changes, because they are only read at startup.
			</para>
			<para>
				Since <application>&app;</application> 0.3 there are also templates for creating new files.
				They can be found in <filename>~/.&app_small;/</filename>, too.
				All template files for creating new files begin with template.filetype. followed by the filetype.
				At creating a new file with a filetype template, the template for the fileheader is automatically prepended.
				Please note, that the complete behaviour is still under development and will probably be changed in one of
				the next releases. Sorry.
			</para>
			<para>&nbsp;</para>
			<para>
				<table frame="all">
					<title>Template wildcards</title>
					<tgroup cols="3">
						<?dbhtml cellpadding="4" ?>
						<?dbhtml cellspacing="0" ?>
						<colspec colnum="1" colname="col1"/>
						<colspec colnum="2" colname="col2"/>
						<colspec colnum="3" colname="col3"/>
						<thead>
							<row>
								<entry>Wildcard</entry>
								<entry>Description</entry>
								<entry>Available in following templates</entry>
							</row>
						</thead>
						<tbody>
							<row>
								<entry>developer</entry>
								<entry>The name of the developer.</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>initial</entry>
								<entry>The initials of the developer name, e.g. "ET" for
									   Enrico Troeger or "JFD" for John Foobar Doe.</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>mail</entry>
								<entry>The email address of the developer.</entry>
								<entry>file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>company</entry>
								<entry>The company name, the developer is working for.</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>year</entry>
								<entry>The current year in the format: YYYY</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>version</entry>
								<entry>The initial version of a new file.</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>date</entry>
								<entry>The current date in the format: YYYY-MM-DD</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>untitled</entry>
								<entry>The string "untitled" (this will be translated to your locale),
									   used in filetype templates</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>geanyversion</entry>
								<entry>The actual Geany version, e.g. "&app; &appversion;"</entry>
								<entry>filetypes, file header, function description, ChangeLog entry</entry>
							</row>
							<row>
								<entry>datetime</entry>
								<entry>The current date and time in the format: DD.MM.YYYY HH:mm:ss ZZZZ</entry>
								<entry>file header, function description</entry>
							</row>
							<row>
								<entry>filename</entry>
								<entry>The filename of the current file. Only available for the file header template.</entry>
								<entry>file header</entry>
							</row>
							<row>
								<entry>gpl</entry>
								<entry>This wildcard inserts a short GPL notice.</entry>
								<entry>file header</entry>
							</row>
							<row>
								<entry>functionname</entry>
								<entry>The function name of the function at cursor position. This wildcard will only
									   be replaced in the function description template.</entry>
								<entry>function description</entry>
							</row>
						</tbody>
					</tgroup>
				</table>
				If you need any other wildcards or a special date/time format, please email the author <email>&author_mail;</email>.
			</para>
		</section>
	</chapter>

	<appendix id="shortcuts">
		<title><application>&app;</application> key mapping</title>
		<section>
			<title><application>&app;</application> key mapping</title>
			<para>
				Since <application>&app;</application> 0.7, most of the keybindings are definable
				in the preferences dialog. See <xref linkend="keybindings"/>.
			</para>
		</section>
	</appendix>

	<!-- GPL appendix -->
	&legal;

</book>