SF.net SVN: geany:[4250] trunk
eht16 at users.sourceforge.net
eht16 at xxxxx
Sun Sep 27 16:54:27 UTC 2009
Revision: 4250
http://geany.svn.sourceforge.net/geany/?rev=4250&view=rev
Author: eht16
Date: 2009-09-27 16:54:03 +0000 (Sun, 27 Sep 2009)
Log Message:
-----------
Several documentation improvements (patch by Lex Trotman, thanks).
Modified Paths:
--------------
trunk/ChangeLog
trunk/doc/geany.html
trunk/doc/geany.txt
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2009-09-27 16:51:37 UTC (rev 4249)
+++ trunk/ChangeLog 2009-09-27 16:54:03 UTC (rev 4250)
@@ -5,6 +5,8 @@
* doc/images/build_menu_commands_dialog.png,
doc/images/main_window.png:
Add new images referenced in the documentation.
+ * doc/geany.html, doc/geany.txt:
+ Several documentation improvements (patch by Lex Trotman, thanks).
2009-09-27 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
Modified: trunk/doc/geany.html
===================================================================
--- trunk/doc/geany.html 2009-09-27 16:51:37 UTC (rev 4249)
+++ trunk/doc/geany.html 2009-09-27 16:54:03 UTC (rev 4250)
@@ -3,10 +3,10 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils 0.5: http://docutils.sourceforge.net/" />
<title>Geany</title>
<meta name="authors" content="Enrico Tröger Nick Treleaven Frank Lanitz" />
-<meta name="date" content="2009-09-22" />
+<meta name="date" content="$Date$" />
<style type="text/css">
/*
@@ -139,7 +139,7 @@
<br />Nick Treleaven
<br />Frank Lanitz</td></tr>
<tr><th class="docinfo-name">Date:</th>
-<td>2009-09-22</td></tr>
+<td>$Date$</td></tr>
<tr><th class="docinfo-name">Version:</th>
<td>0.19</td></tr>
</tbody>
@@ -149,334 +149,338 @@
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 also in the chapter <a class="reference" href="#gnu-general-public-license">GNU General Public License</a>.</p>
-<div class="contents topic">
-<p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
+of this program, and also in the chapter <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
+<div class="contents topic" id="contents">
+<p class="topic-title first">Contents</p>
<ul class="simple">
-<li><a class="reference" href="#introduction" id="id12" name="id12">Introduction</a><ul>
-<li><a class="reference" href="#about-geany" id="id13" name="id13">About Geany</a></li>
-<li><a class="reference" href="#where-to-get-it" id="id14" name="id14">Where to get it</a></li>
-<li><a class="reference" href="#license" id="id15" name="id15">License</a></li>
-<li><a class="reference" href="#about-this-document" id="id16" name="id16">About this document</a></li>
+<li><a class="reference internal" href="#introduction" id="id12">Introduction</a><ul>
+<li><a class="reference internal" href="#about-geany" id="id13">About Geany</a></li>
+<li><a class="reference internal" href="#where-to-get-it" id="id14">Where to get it</a></li>
+<li><a class="reference internal" href="#license" id="id15">License</a></li>
+<li><a class="reference internal" href="#about-this-document" id="id16">About this document</a></li>
</ul>
</li>
-<li><a class="reference" href="#installation" id="id17" name="id17">Installation</a><ul>
-<li><a class="reference" href="#requirements" id="id18" name="id18">Requirements</a></li>
-<li><a class="reference" href="#binary-packages" id="id19" name="id19">Binary packages</a></li>
-<li><a class="reference" href="#source-compilation" id="id20" name="id20">Source compilation</a><ul>
-<li><a class="reference" href="#autotools-based-build-system" id="id21" name="id21">Autotools based build system</a></li>
-<li><a class="reference" href="#waf-based-build-system" id="id22" name="id22">Waf based build system</a><ul>
-<li><a class="reference" href="#waf-cache" id="id23" name="id23">Waf Cache</a><ul>
-<li><a class="reference" href="#cleaning-the-cache" id="id24" name="id24">Cleaning the Cache</a></li>
+<li><a class="reference internal" href="#installation" id="id17">Installation</a><ul>
+<li><a class="reference internal" href="#requirements" id="id18">Requirements</a></li>
+<li><a class="reference internal" href="#binary-packages" id="id19">Binary packages</a></li>
+<li><a class="reference internal" href="#source-compilation" id="id20">Source compilation</a><ul>
+<li><a class="reference internal" href="#autotools-based-build-system" id="id21">Autotools based build system</a></li>
+<li><a class="reference internal" href="#waf-based-build-system" id="id22">Waf based build system</a><ul>
+<li><a class="reference internal" href="#waf-cache" id="id23">Waf Cache</a><ul>
+<li><a class="reference internal" href="#cleaning-the-cache" id="id24">Cleaning the Cache</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#custom-installation" id="id25" name="id25">Custom installation</a></li>
-<li><a class="reference" href="#dynamic-linking-loader-support" id="id26" name="id26">Dynamic linking loader support</a></li>
-<li><a class="reference" href="#build-problems" id="id27" name="id27">Build problems</a></li>
+<li><a class="reference internal" href="#custom-installation" id="id25">Custom installation</a></li>
+<li><a class="reference internal" href="#dynamic-linking-loader-support-and-vte" id="id26">Dynamic linking loader support and VTE</a></li>
+<li><a class="reference internal" href="#build-problems" id="id27">Build problems</a></li>
</ul>
</li>
-<li><a class="reference" href="#installation-prefix" id="id28" name="id28">Installation prefix</a></li>
+<li><a class="reference internal" href="#installation-prefix" id="id28">Installation prefix</a></li>
</ul>
</li>
-<li><a class="reference" href="#usage" id="id29" name="id29">Usage</a><ul>
-<li><a class="reference" href="#getting-started" id="id30" name="id30">Getting started</a></li>
-<li><a class="reference" href="#command-line-options" id="id31" name="id31">Command line options</a></li>
-<li><a class="reference" href="#general" id="id32" name="id32">General</a><ul>
-<li><a class="reference" href="#startup" id="id33" name="id33">Startup</a></li>
-<li><a class="reference" href="#opening-files-from-the-command-line-in-a-running-instance" id="id34" name="id34">Opening files from the command-line in a running instance</a></li>
-<li><a class="reference" href="#virtual-terminal-emulator-widget-vte" id="id35" name="id35">Virtual terminal emulator widget (VTE)</a></li>
-<li><a class="reference" href="#defining-own-widget-styles-using-gtkrc-2-0" id="id36" name="id36">Defining own widget styles using .gtkrc-2.0</a></li>
+<li><a class="reference internal" href="#usage" id="id29">Usage</a><ul>
+<li><a class="reference internal" href="#getting-started" id="id30">Getting started</a></li>
+<li><a class="reference internal" href="#the-geany-workspace" id="id31">The Geany workspace</a></li>
+<li><a class="reference internal" href="#command-line-options" id="id32">Command line options</a></li>
+<li><a class="reference internal" href="#general" id="id33">General</a><ul>
+<li><a class="reference internal" href="#startup" id="id34">Startup</a></li>
+<li><a class="reference internal" href="#opening-files-from-the-command-line-in-a-running-instance" id="id35">Opening files from the command-line in a running instance</a></li>
+<li><a class="reference internal" href="#virtual-terminal-emulator-widget-vte" id="id36">Virtual terminal emulator widget (VTE)</a></li>
+<li><a class="reference internal" href="#defining-own-widget-styles-using-gtkrc-2-0" id="id37">Defining own widget styles using .gtkrc-2.0</a></li>
</ul>
</li>
-<li><a class="reference" href="#documents" id="id37" name="id37">Documents</a><ul>
-<li><a class="reference" href="#switching-between-documents" id="id38" name="id38">Switching between documents</a></li>
+<li><a class="reference internal" href="#documents" id="id38">Documents</a><ul>
+<li><a class="reference internal" href="#switching-between-documents" id="id39">Switching between documents</a></li>
</ul>
</li>
-<li><a class="reference" href="#character-sets-and-unicode-byte-order-mark-bom" id="id39" name="id39">Character sets and Unicode Byte-Order-Mark (BOM)</a><ul>
-<li><a class="reference" href="#using-character-sets" id="id40" name="id40">Using character sets</a></li>
-<li><a class="reference" href="#in-file-encoding-specification" id="id41" name="id41">In-file encoding specification</a></li>
-<li><a class="reference" href="#special-encoding-none" id="id42" name="id42">Special encoding "None"</a></li>
-<li><a class="reference" href="#unicode-byte-order-mark-bom" id="id43" name="id43">Unicode Byte-Order-Mark (BOM)</a></li>
+<li><a class="reference internal" href="#character-sets-and-unicode-byte-order-mark-bom" id="id40">Character sets and Unicode Byte-Order-Mark (BOM)</a><ul>
+<li><a class="reference internal" href="#using-character-sets" id="id41">Using character sets</a></li>
+<li><a class="reference internal" href="#in-file-encoding-specification" id="id42">In-file encoding specification</a></li>
+<li><a class="reference internal" href="#special-encoding-none" id="id43">Special encoding "None"</a></li>
+<li><a class="reference internal" href="#unicode-byte-order-mark-bom" id="id44">Unicode Byte-Order-Mark (BOM)</a></li>
</ul>
</li>
-<li><a class="reference" href="#editing" id="id44" name="id44">Editing</a><ul>
-<li><a class="reference" href="#folding" id="id45" name="id45">Folding</a></li>
-<li><a class="reference" href="#column-mode-editing-rectangular-selections" id="id46" name="id46">Column mode editing (rectangular selections)</a></li>
-<li><a class="reference" href="#drag-and-drop-of-text" id="id47" name="id47">Drag and drop of text</a></li>
-<li><a class="reference" href="#indentation" id="id48" name="id48">Indentation</a></li>
-<li><a class="reference" href="#auto-indentation" id="id49" name="id49">Auto-indentation</a></li>
-<li><a class="reference" href="#bookmarks" id="id50" name="id50">Bookmarks</a></li>
-<li><a class="reference" href="#code-navigation-history" id="id51" name="id51">Code navigation history</a></li>
-<li><a class="reference" href="#send-text-through-definable-commands" id="id52" name="id52">Send text through definable commands</a></li>
-<li><a class="reference" href="#context-actions" id="id53" name="id53">Context actions</a></li>
-<li><a class="reference" href="#autocompletion" id="id54" name="id54">Autocompletion</a><ul>
-<li><a class="reference" href="#scope-autocompletion" id="id55" name="id55">Scope autocompletion</a></li>
+<li><a class="reference internal" href="#editing" id="id45">Editing</a><ul>
+<li><a class="reference internal" href="#folding" id="id46">Folding</a></li>
+<li><a class="reference internal" href="#column-mode-editing-rectangular-selections" id="id47">Column mode editing (rectangular selections)</a></li>
+<li><a class="reference internal" href="#drag-and-drop-of-text" id="id48">Drag and drop of text</a></li>
+<li><a class="reference internal" href="#indentation" id="id49">Indentation</a></li>
+<li><a class="reference internal" href="#auto-indentation" id="id50">Auto-indentation</a></li>
+<li><a class="reference internal" href="#bookmarks" id="id51">Bookmarks</a></li>
+<li><a class="reference internal" href="#code-navigation-history" id="id52">Code navigation history</a></li>
+<li><a class="reference internal" href="#sending-text-through-custom-commands" id="id53">Sending text through custom commands</a></li>
+<li><a class="reference internal" href="#context-actions" id="id54">Context actions</a></li>
+<li><a class="reference internal" href="#autocompletion" id="id55">Autocompletion</a><ul>
+<li><a class="reference internal" href="#scope-autocompletion" id="id56">Scope autocompletion</a></li>
</ul>
</li>
-<li><a class="reference" href="#user-definable-snippets" id="id56" name="id56">User-definable snippets</a></li>
-<li><a class="reference" href="#inserting-unicode-characters" id="id57" name="id57">Inserting Unicode characters</a></li>
+<li><a class="reference internal" href="#user-definable-snippets" id="id57">User-definable snippets</a></li>
+<li><a class="reference internal" href="#inserting-unicode-characters" id="id58">Inserting Unicode characters</a></li>
</ul>
</li>
-<li><a class="reference" href="#search-replace-and-go-to" id="id58" name="id58">Search, replace and go to</a><ul>
-<li><a class="reference" href="#toolbar-entries" id="id59" name="id59">Toolbar entries</a><ul>
-<li><a class="reference" href="#search-bar" id="id60" name="id60">Search bar</a></li>
+<li><a class="reference internal" href="#search-replace-and-go-to" id="id59">Search, replace and go to</a><ul>
+<li><a class="reference internal" href="#toolbar-entries" id="id60">Toolbar entries</a><ul>
+<li><a class="reference internal" href="#search-bar" id="id61">Search bar</a></li>
</ul>
</li>
-<li><a class="reference" href="#find" id="id61" name="id61">Find</a><ul>
-<li><a class="reference" href="#matching-options" id="id62" name="id62">Matching options</a></li>
-<li><a class="reference" href="#find-all" id="id63" name="id63">Find all</a></li>
-<li><a class="reference" href="#change-font-in-search-dialog-text-fields" id="id64" name="id64">Change font in search dialog text fields</a></li>
+<li><a class="reference internal" href="#find" id="id62">Find</a><ul>
+<li><a class="reference internal" href="#matching-options" id="id63">Matching options</a></li>
+<li><a class="reference internal" href="#find-all" id="id64">Find all</a></li>
+<li><a class="reference internal" href="#change-font-in-search-dialog-text-fields" id="id65">Change font in search dialog text fields</a></li>
</ul>
</li>
-<li><a class="reference" href="#find-usage" id="id65" name="id65">Find usage</a></li>
-<li><a class="reference" href="#find-in-files" id="id66" name="id66">Find in files</a><ul>
-<li><a class="reference" href="#filtering-out-version-control-files" id="id67" name="id67">Filtering out version control files</a></li>
+<li><a class="reference internal" href="#find-usage" id="id66">Find usage</a></li>
+<li><a class="reference internal" href="#find-in-files" id="id67">Find in files</a><ul>
+<li><a class="reference internal" href="#filtering-out-version-control-files" id="id68">Filtering out version control files</a></li>
</ul>
</li>
-<li><a class="reference" href="#replace" id="id68" name="id68">Replace</a><ul>
-<li><a class="reference" href="#replace-all" id="id69" name="id69">Replace all</a></li>
+<li><a class="reference internal" href="#replace" id="id69">Replace</a><ul>
+<li><a class="reference internal" href="#replace-all" id="id70">Replace all</a></li>
</ul>
</li>
-<li><a class="reference" href="#go-to-tag-definition" id="id70" name="id70">Go to tag definition</a></li>
-<li><a class="reference" href="#go-to-tag-declaration" id="id71" name="id71">Go to tag declaration</a></li>
-<li><a class="reference" href="#go-to-line" id="id72" name="id72">Go to line</a></li>
-<li><a class="reference" href="#regular-expressions" id="id73" name="id73">Regular expressions</a></li>
+<li><a class="reference internal" href="#go-to-tag-definition" id="id71">Go to tag definition</a></li>
+<li><a class="reference internal" href="#go-to-tag-declaration" id="id72">Go to tag declaration</a></li>
+<li><a class="reference internal" href="#go-to-line" id="id73">Go to line</a></li>
+<li><a class="reference internal" href="#regular-expressions" id="id74">Regular expressions</a></li>
</ul>
</li>
-<li><a class="reference" href="#tags" id="id74" name="id74">Tags</a><ul>
-<li><a class="reference" href="#workspace-tags" id="id75" name="id75">Workspace tags</a></li>
-<li><a class="reference" href="#global-tags" id="id76" name="id76">Global tags</a><ul>
-<li><a class="reference" href="#default-global-tags-files" id="id77" name="id77">Default global tags files</a></li>
-<li><a class="reference" href="#global-tags-file-format" id="id78" name="id78">Global tags file format</a></li>
-<li><a class="reference" href="#generating-a-global-tags-file" id="id79" name="id79">Generating a global tags file</a></li>
+<li><a class="reference internal" href="#tags" id="id75">Tags</a><ul>
+<li><a class="reference internal" href="#workspace-tags" id="id76">Workspace tags</a></li>
+<li><a class="reference internal" href="#global-tags" id="id77">Global tags</a><ul>
+<li><a class="reference internal" href="#default-global-tags-files" id="id78">Default global tags files</a></li>
+<li><a class="reference internal" href="#global-tags-file-format" id="id79">Global tags file format</a></li>
+<li><a class="reference internal" href="#generating-a-global-tags-file" id="id80">Generating a global tags file</a></li>
</ul>
</li>
-<li><a class="reference" href="#ignore-tags" id="id80" name="id80">Ignore tags</a></li>
+<li><a class="reference internal" href="#ignore-tags" id="id81">Ignore tags</a></li>
</ul>
</li>
-<li><a class="reference" href="#preferences" id="id81" name="id81">Preferences</a><ul>
-<li><a class="reference" href="#general-startup-preferences" id="id82" name="id82">General Startup preferences</a><ul>
-<li><a class="reference" href="#id1" id="id83" name="id83">Startup</a></li>
-<li><a class="reference" href="#shutdown" id="id84" name="id84">Shutdown</a></li>
-<li><a class="reference" href="#paths" id="id85" name="id85">Paths</a></li>
+<li><a class="reference internal" href="#preferences" id="id82">Preferences</a><ul>
+<li><a class="reference internal" href="#general-startup-preferences" id="id83">General Startup preferences</a><ul>
+<li><a class="reference internal" href="#id1" id="id84">Startup</a></li>
+<li><a class="reference internal" href="#shutdown" id="id85">Shutdown</a></li>
+<li><a class="reference internal" href="#paths" id="id86">Paths</a></li>
</ul>
</li>
-<li><a class="reference" href="#general-miscellaneous-preferences" id="id86" name="id86">General Miscellaneous preferences</a><ul>
-<li><a class="reference" href="#miscellaneous" id="id87" name="id87">Miscellaneous</a></li>
-<li><a class="reference" href="#search" id="id88" name="id88">Search</a></li>
-<li><a class="reference" href="#projects" id="id89" name="id89">Projects</a></li>
+<li><a class="reference internal" href="#general-miscellaneous-preferences" id="id87">General Miscellaneous preferences</a><ul>
+<li><a class="reference internal" href="#miscellaneous" id="id88">Miscellaneous</a></li>
+<li><a class="reference internal" href="#search" id="id89">Search</a></li>
+<li><a class="reference internal" href="#projects" id="id90">Projects</a></li>
</ul>
</li>
-<li><a class="reference" href="#interface-preferences" id="id90" name="id90">Interface preferences</a><ul>
-<li><a class="reference" href="#sidebar" id="id91" name="id91">Sidebar</a></li>
-<li><a class="reference" href="#fonts" id="id92" name="id92">Fonts</a></li>
-<li><a class="reference" href="#editor-tabs" id="id93" name="id93">Editor tabs</a></li>
-<li><a class="reference" href="#tab-positions" id="id94" name="id94">Tab positions</a></li>
-<li><a class="reference" href="#id2" id="id95" name="id95">Miscellaneous</a></li>
+<li><a class="reference internal" href="#interface-preferences" id="id91">Interface preferences</a><ul>
+<li><a class="reference internal" href="#sidebar" id="id92">Sidebar</a></li>
+<li><a class="reference internal" href="#fonts" id="id93">Fonts</a></li>
+<li><a class="reference internal" href="#editor-tabs" id="id94">Editor tabs</a></li>
+<li><a class="reference internal" href="#tab-positions" id="id95">Tab positions</a></li>
+<li><a class="reference internal" href="#id2" id="id96">Miscellaneous</a></li>
</ul>
</li>
-<li><a class="reference" href="#toolbar-preferences" id="id96" name="id96">Toolbar preferences</a><ul>
-<li><a class="reference" href="#toolbar" id="id97" name="id97">Toolbar</a></li>
-<li><a class="reference" href="#appearance" id="id98" name="id98">Appearance</a></li>
+<li><a class="reference internal" href="#toolbar-preferences" id="id97">Toolbar preferences</a><ul>
+<li><a class="reference internal" href="#toolbar" id="id98">Toolbar</a></li>
+<li><a class="reference internal" href="#appearance" id="id99">Appearance</a></li>
</ul>
</li>
-<li><a class="reference" href="#editor-features-preferences" id="id99" name="id99">Editor Features preferences</a><ul>
-<li><a class="reference" href="#features" id="id100" name="id100">Features</a></li>
+<li><a class="reference internal" href="#editor-features-preferences" id="id100">Editor Features preferences</a><ul>
+<li><a class="reference internal" href="#features" id="id101">Features</a></li>
</ul>
</li>
-<li><a class="reference" href="#editor-indentation-preferences" id="id101" name="id101">Editor Indentation preferences</a><ul>
-<li><a class="reference" href="#indentation-group" id="id102" name="id102">Indentation group</a></li>
+<li><a class="reference internal" href="#editor-indentation-preferences" id="id102">Editor Indentation preferences</a><ul>
+<li><a class="reference internal" href="#indentation-group" id="id103">Indentation group</a></li>
</ul>
</li>
-<li><a class="reference" href="#editor-completions-preferences" id="id103" name="id103">Editor Completions preferences</a><ul>
-<li><a class="reference" href="#completions" id="id104" name="id104">Completions</a></li>
-<li><a class="reference" href="#auto-close-quotes-and-brackets" id="id105" name="id105">Auto-close quotes and brackets</a></li>
+<li><a class="reference internal" href="#editor-completions-preferences" id="id104">Editor Completions preferences</a><ul>
+<li><a class="reference internal" href="#completions" id="id105">Completions</a></li>
+<li><a class="reference internal" href="#auto-close-quotes-and-brackets" id="id106">Auto-close quotes and brackets</a></li>
</ul>
</li>
-<li><a class="reference" href="#editor-display-preferences" id="id106" name="id106">Editor Display preferences</a><ul>
-<li><a class="reference" href="#display" id="id107" name="id107">Display</a></li>
-<li><a class="reference" href="#long-line-marker" id="id108" name="id108">Long line marker</a></li>
+<li><a class="reference internal" href="#editor-display-preferences" id="id107">Editor Display preferences</a><ul>
+<li><a class="reference internal" href="#display" id="id108">Display</a></li>
+<li><a class="reference internal" href="#long-line-marker" id="id109">Long line marker</a></li>
</ul>
</li>
-<li><a class="reference" href="#files-preferences" id="id109" name="id109">Files preferences</a><ul>
-<li><a class="reference" href="#new-files" id="id110" name="id110">New files</a></li>
-<li><a class="reference" href="#saving-files" id="id111" name="id111">Saving files</a></li>
-<li><a class="reference" href="#id3" id="id112" name="id112">Miscellaneous</a></li>
+<li><a class="reference internal" href="#files-preferences" id="id110">Files preferences</a><ul>
+<li><a class="reference internal" href="#new-files" id="id111">New files</a></li>
+<li><a class="reference internal" href="#saving-files" id="id112">Saving files</a></li>
+<li><a class="reference internal" href="#id3" id="id113">Miscellaneous</a></li>
</ul>
</li>
-<li><a class="reference" href="#tools-preferences" id="id113" name="id113">Tools preferences</a><ul>
-<li><a class="reference" href="#tool-paths" id="id114" name="id114">Tool paths</a></li>
-<li><a class="reference" href="#commands" id="id115" name="id115">Commands</a></li>
+<li><a class="reference internal" href="#tools-preferences" id="id114">Tools preferences</a><ul>
+<li><a class="reference internal" href="#tool-paths" id="id115">Tool paths</a></li>
+<li><a class="reference internal" href="#commands" id="id116">Commands</a></li>
</ul>
</li>
-<li><a class="reference" href="#template-preferences" id="id116" name="id116">Template preferences</a><ul>
-<li><a class="reference" href="#template-data" id="id117" name="id117">Template data</a></li>
+<li><a class="reference internal" href="#template-preferences" id="id117">Template preferences</a><ul>
+<li><a class="reference internal" href="#template-data" id="id118">Template data</a></li>
</ul>
</li>
-<li><a class="reference" href="#keybinding-preferences" id="id118" name="id118">Keybinding preferences</a></li>
-<li><a class="reference" href="#printing-preferences" id="id119" name="id119">Printing preferences</a></li>
-<li><a class="reference" href="#terminal-vte-preferences" id="id120" name="id120">Terminal (VTE) preferences</a><ul>
-<li><a class="reference" href="#terminal-widget" id="id121" name="id121">Terminal widget</a></li>
+<li><a class="reference internal" href="#keybinding-preferences" id="id119">Keybinding preferences</a></li>
+<li><a class="reference internal" href="#printing-preferences" id="id120">Printing preferences</a></li>
+<li><a class="reference internal" href="#terminal-vte-preferences" id="id121">Terminal (VTE) preferences</a><ul>
+<li><a class="reference internal" href="#terminal-widget" id="id122">Terminal widget</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#project-management" id="id122" name="id122">Project Management</a><ul>
-<li><a class="reference" href="#new-project" id="id123" name="id123">New Project</a></li>
-<li><a class="reference" href="#project-properties" id="id124" name="id124">Project Properties</a><ul>
-<li><a class="reference" href="#set-base-path-button" id="id125" name="id125">Set Base Path Button</a></li>
+<li><a class="reference internal" href="#project-management" id="id123">Project Management</a><ul>
+<li><a class="reference internal" href="#new-project" id="id124">New Project</a></li>
+<li><a class="reference internal" href="#project-properties" id="id125">Project Properties</a><ul>
+<li><a class="reference internal" href="#set-base-path-button" id="id126">Set Base Path Button</a></li>
</ul>
</li>
-<li><a class="reference" href="#open-project" id="id126" name="id126">Open Project</a></li>
-<li><a class="reference" href="#close-project" id="id127" name="id127">Close Project</a></li>
+<li><a class="reference internal" href="#open-project" id="id127">Open Project</a></li>
+<li><a class="reference internal" href="#close-project" id="id128">Close Project</a></li>
</ul>
</li>
-<li><a class="reference" href="#build-menu" id="id128" name="id128">Build Menu</a><ul>
-<li><a class="reference" href="#indicators" id="id129" name="id129">Indicators</a></li>
-<li><a class="reference" href="#default-build-menu-items" id="id130" name="id130">Default Build Menu Items</a><ul>
-<li><a class="reference" href="#compile" id="id131" name="id131">Compile</a></li>
-<li><a class="reference" href="#build" id="id132" name="id132">Build</a></li>
-<li><a class="reference" href="#make" id="id133" name="id133">Make</a></li>
-<li><a class="reference" href="#make-custom-target" id="id134" name="id134">Make custom target</a></li>
-<li><a class="reference" href="#make-object" id="id135" name="id135">Make object</a></li>
-<li><a class="reference" href="#next-error" id="id136" name="id136">Next Error</a></li>
-<li><a class="reference" href="#previous-error" id="id137" name="id137">Previous Error</a></li>
-<li><a class="reference" href="#execute" id="id138" name="id138">Execute</a></li>
-<li><a class="reference" href="#stopping-running-processes" id="id139" name="id139">Stopping running processes</a><ul>
-<li><a class="reference" href="#terminal-emulators" id="id140" name="id140">Terminal emulators</a></li>
+<li><a class="reference internal" href="#build-menu" id="id129">Build Menu</a><ul>
+<li><a class="reference internal" href="#indicators" id="id130">Indicators</a></li>
+<li><a class="reference internal" href="#default-build-menu-items" id="id131">Default Build Menu Items</a><ul>
+<li><a class="reference internal" href="#compile" id="id132">Compile</a></li>
+<li><a class="reference internal" href="#build" id="id133">Build</a></li>
+<li><a class="reference internal" href="#make" id="id134">Make</a></li>
+<li><a class="reference internal" href="#make-custom-target" id="id135">Make custom target</a></li>
+<li><a class="reference internal" href="#make-object" id="id136">Make object</a></li>
+<li><a class="reference internal" href="#next-error" id="id137">Next Error</a></li>
+<li><a class="reference internal" href="#previous-error" id="id138">Previous Error</a></li>
+<li><a class="reference internal" href="#execute" id="id139">Execute</a></li>
+<li><a class="reference internal" href="#stopping-running-processes" id="id140">Stopping running processes</a><ul>
+<li><a class="reference internal" href="#terminal-emulators" id="id141">Terminal emulators</a></li>
</ul>
</li>
-<li><a class="reference" href="#set-build-commands" id="id141" name="id141">Set Build Commands</a></li>
+<li><a class="reference internal" href="#set-build-commands" id="id142">Set Build Commands</a></li>
</ul>
</li>
-<li><a class="reference" href="#build-menu-configuration" id="id142" name="id142">Build Menu Configuration</a></li>
-<li><a class="reference" href="#build-menu-commands-dialog" id="id143" name="id143">Build Menu Commands Dialog</a><ul>
-<li><a class="reference" href="#substitutions-in-commands-and-working-directories" id="id144" name="id144">Substitutions in Commands and Working Directories</a></li>
-<li><a class="reference" href="#build-menu-keyboard-shortcuts" id="id145" name="id145">Build Menu Keyboard Shortcuts</a></li>
-<li><a class="reference" href="#configuration-files" id="id146" name="id146">Configuration Files</a></li>
+<li><a class="reference internal" href="#build-menu-configuration" id="id143">Build Menu Configuration</a></li>
+<li><a class="reference internal" href="#build-menu-commands-dialog" id="id144">Build Menu Commands Dialog</a><ul>
+<li><a class="reference internal" href="#substitutions-in-commands-and-working-directories" id="id145">Substitutions in Commands and Working Directories</a></li>
+<li><a class="reference internal" href="#build-menu-keyboard-shortcuts" id="id146">Build Menu Keyboard Shortcuts</a></li>
+<li><a class="reference internal" href="#configuration-files" id="id147">Configuration Files</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#printing-support" id="id147" name="id147">Printing support</a></li>
-<li><a class="reference" href="#plugins" id="id148" name="id148">Plugins</a></li>
-<li><a class="reference" href="#keybindings" id="id149" name="id149">Keybindings</a><ul>
-<li><a class="reference" href="#switching-documents" id="id150" name="id150">Switching documents</a></li>
-<li><a class="reference" href="#configurable-keybindings" id="id151" name="id151">Configurable keybindings</a><ul>
-<li><a class="reference" href="#file-keybindings" id="id152" name="id152">File keybindings</a></li>
-<li><a class="reference" href="#editor-keybindings" id="id153" name="id153">Editor keybindings</a></li>
-<li><a class="reference" href="#clipboard-keybindings" id="id154" name="id154">Clipboard keybindings</a></li>
-<li><a class="reference" href="#select-keybindings" id="id155" name="id155">Select keybindings</a></li>
-<li><a class="reference" href="#insert-keybindings" id="id156" name="id156">Insert keybindings</a></li>
-<li><a class="reference" href="#format-keybindings" id="id157" name="id157">Format keybindings</a></li>
-<li><a class="reference" href="#settings-keybindings" id="id158" name="id158">Settings keybindings</a></li>
-<li><a class="reference" href="#search-keybindings" id="id159" name="id159">Search keybindings</a></li>
-<li><a class="reference" href="#go-to-keybindings" id="id160" name="id160">Go to keybindings</a></li>
-<li><a class="reference" href="#view-keybindings" id="id161" name="id161">View keybindings</a></li>
-<li><a class="reference" href="#focus-keybindings" id="id162" name="id162">Focus keybindings</a></li>
-<li><a class="reference" href="#notebook-tab-keybindings" id="id163" name="id163">Notebook tab keybindings</a></li>
-<li><a class="reference" href="#document-keybindings" id="id164" name="id164">Document keybindings</a></li>
-<li><a class="reference" href="#build-keybindings" id="id165" name="id165">Build keybindings</a></li>
-<li><a class="reference" href="#tools-keybindings" id="id166" name="id166">Tools keybindings</a></li>
-<li><a class="reference" href="#help-keybindings" id="id167" name="id167">Help keybindings</a></li>
+<li><a class="reference internal" href="#printing-support" id="id148">Printing support</a></li>
+<li><a class="reference internal" href="#plugins" id="id149">Plugins</a></li>
+<li><a class="reference internal" href="#keybindings" id="id150">Keybindings</a><ul>
+<li><a class="reference internal" href="#switching-documents" id="id151">Switching documents</a></li>
+<li><a class="reference internal" href="#configurable-keybindings" id="id152">Configurable keybindings</a><ul>
+<li><a class="reference internal" href="#file-keybindings" id="id153">File keybindings</a></li>
+<li><a class="reference internal" href="#editor-keybindings" id="id154">Editor keybindings</a></li>
+<li><a class="reference internal" href="#clipboard-keybindings" id="id155">Clipboard keybindings</a></li>
+<li><a class="reference internal" href="#select-keybindings" id="id156">Select keybindings</a></li>
+<li><a class="reference internal" href="#insert-keybindings" id="id157">Insert keybindings</a></li>
+<li><a class="reference internal" href="#format-keybindings" id="id158">Format keybindings</a></li>
+<li><a class="reference internal" href="#settings-keybindings" id="id159">Settings keybindings</a></li>
+<li><a class="reference internal" href="#search-keybindings" id="id160">Search keybindings</a></li>
+<li><a class="reference internal" href="#go-to-keybindings" id="id161">Go to keybindings</a></li>
+<li><a class="reference internal" href="#view-keybindings" id="id162">View keybindings</a></li>
+<li><a class="reference internal" href="#focus-keybindings" id="id163">Focus keybindings</a></li>
+<li><a class="reference internal" href="#notebook-tab-keybindings" id="id164">Notebook tab keybindings</a></li>
+<li><a class="reference internal" href="#document-keybindings" id="id165">Document keybindings</a></li>
+<li><a class="reference internal" href="#build-keybindings" id="id166">Build keybindings</a></li>
+<li><a class="reference internal" href="#tools-keybindings" id="id167">Tools keybindings</a></li>
+<li><a class="reference internal" href="#help-keybindings" id="id168">Help keybindings</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#id4" id="id168" name="id168">Configuration files</a><ul>
-<li><a class="reference" href="#tools-menu-items" id="id169" name="id169">Tools menu items</a></li>
-<li><a class="reference" href="#global-configuration-file" id="id170" name="id170">Global configuration file</a></li>
-<li><a class="reference" href="#filetype-definition-files" id="id171" name="id171">Filetype definition files</a><ul>
-<li><a class="reference" href="#format" id="id172" name="id172">Format</a><ul>
-<li><a class="reference" href="#styling-section" id="id173" name="id173">[styling] Section</a><ul>
-<li><a class="reference" href="#using-a-named-style" id="id174" name="id174">Using a named style</a></li>
+<li><a class="reference internal" href="#id4" id="id169">Configuration files</a><ul>
+<li><a class="reference internal" href="#tools-menu-items" id="id170">Tools menu items</a></li>
+<li><a class="reference internal" href="#global-configuration-file" id="id171">Global configuration file</a></li>
+<li><a class="reference internal" href="#filetype-definition-files" id="id172">Filetype definition files</a><ul>
+<li><a class="reference internal" href="#format" id="id173">Format</a><ul>
+<li><a class="reference internal" href="#styling-section" id="id174">[styling] Section</a><ul>
+<li><a class="reference internal" href="#using-a-named-style" id="id175">Using a named style</a></li>
</ul>
</li>
-<li><a class="reference" href="#keywords-section" id="id175" name="id175">[keywords] Section</a></li>
-<li><a class="reference" href="#settings-section" id="id176" name="id176">[settings] Section</a></li>
-<li><a class="reference" href="#build-settings-section" id="id177" name="id177">[build_settings] Section</a></li>
+<li><a class="reference internal" href="#keywords-section" id="id176">[keywords] Section</a></li>
+<li><a class="reference internal" href="#settings-section" id="id177">[settings] Section</a></li>
+<li><a class="reference internal" href="#build-settings-section" id="id178">[build_settings] Section</a></li>
</ul>
</li>
-<li><a class="reference" href="#special-file-filetypes-common" id="id178" name="id178">Special file filetypes.common</a><ul>
-<li><a class="reference" href="#named-styles-section" id="id179" name="id179">[named_styles] Section</a></li>
-<li><a class="reference" href="#id5" id="id180" name="id180">[styling] Section</a></li>
-<li><a class="reference" href="#id6" id="id181" name="id181">[settings] Section</a></li>
+<li><a class="reference internal" href="#special-file-filetypes-common" id="id179">Special file filetypes.common</a><ul>
+<li><a class="reference internal" href="#named-styles-section" id="id180">[named_styles] Section</a></li>
+<li><a class="reference internal" href="#id5" id="id181">[styling] Section</a></li>
+<li><a class="reference internal" href="#id6" id="id182">[settings] Section</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#filetype-extensions" id="id182" name="id182">Filetype extensions</a></li>
-<li><a class="reference" href="#preferences-file-format" id="id183" name="id183">Preferences File Format</a><ul>
-<li><a class="reference" href="#hidden-preferences" id="id184" name="id184">Hidden preferences</a></li>
-<li><a class="reference" href="#build-menu-section" id="id185" name="id185">[build-menu] Section</a></li>
+<li><a class="reference internal" href="#filetype-extensions" id="id183">Filetype extensions</a></li>
+<li><a class="reference internal" href="#preferences-file-format" id="id184">Preferences File Format</a><ul>
+<li><a class="reference internal" href="#hidden-preferences" id="id185">Hidden preferences</a></li>
+<li><a class="reference internal" href="#build-menu-section" id="id186">[build-menu] Section</a></li>
</ul>
</li>
-<li><a class="reference" href="#project-file-format" id="id186" name="id186">Project File Format</a><ul>
-<li><a class="reference" href="#build-menu-additions" id="id187" name="id187">[build-menu] Additions</a></li>
+<li><a class="reference internal" href="#project-file-format" id="id187">Project File Format</a><ul>
+<li><a class="reference internal" href="#build-menu-additions" id="id188">[build-menu] Additions</a></li>
</ul>
</li>
-<li><a class="reference" href="#templates" id="id188" name="id188">Templates</a><ul>
-<li><a class="reference" href="#template-meta-data" id="id189" name="id189">Template meta data</a></li>
-<li><a class="reference" href="#file-templates" id="id190" name="id190">File templates</a><ul>
-<li><a class="reference" href="#custom-file-templates" id="id191" name="id191">Custom file templates</a></li>
-<li><a class="reference" href="#filetype-templates" id="id192" name="id192">Filetype templates</a></li>
+<li><a class="reference internal" href="#templates" id="id189">Templates</a><ul>
+<li><a class="reference internal" href="#template-meta-data" id="id190">Template meta data</a></li>
+<li><a class="reference internal" href="#file-templates" id="id191">File templates</a><ul>
+<li><a class="reference internal" href="#custom-file-templates" id="id192">Custom file templates</a></li>
+<li><a class="reference internal" href="#filetype-templates" id="id193">Filetype templates</a></li>
</ul>
</li>
-<li><a class="reference" href="#customizing-templates" id="id193" name="id193">Customizing templates</a><ul>
-<li><a class="reference" href="#template-wildcards" id="id194" name="id194">Template wildcards</a></li>
+<li><a class="reference internal" href="#customizing-templates" id="id194">Customizing templates</a><ul>
+<li><a class="reference internal" href="#template-wildcards" id="id195">Template wildcards</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#customizing-the-toolbar" id="id195" name="id195">Customizing the toolbar</a><ul>
-<li><a class="reference" href="#manually-editing-of-the-toolbar-layout" id="id196" name="id196">Manually editing of the toolbar layout</a></li>
-<li><a class="reference" href="#available-toolbar-elements" id="id197" name="id197">Available toolbar elements</a></li>
+<li><a class="reference internal" href="#customizing-the-toolbar" id="id196">Customizing the toolbar</a><ul>
+<li><a class="reference internal" href="#manually-editing-of-the-toolbar-layout" id="id197">Manually editing of the toolbar layout</a></li>
+<li><a class="reference internal" href="#available-toolbar-elements" id="id198">Available toolbar elements</a></li>
</ul>
</li>
</ul>
</li>
-<li><a class="reference" href="#plugin-documentation" id="id198" name="id198">Plugin documentation</a><ul>
-<li><a class="reference" href="#instant-save" id="id199" name="id199">Instant Save</a></li>
-<li><a class="reference" href="#backup-copy" id="id200" name="id200">Backup Copy</a></li>
+<li><a class="reference internal" href="#plugin-documentation" id="id199">Plugin documentation</a><ul>
+<li><a class="reference internal" href="#save-actions" id="id200">Save Actions</a><ul>
+<li><a class="reference internal" href="#instant-save" id="id201">Instant Save</a></li>
+<li><a class="reference internal" href="#backup-copy" id="id202">Backup Copy</a></li>
</ul>
</li>
-<li><a class="reference" href="#contributing-to-this-document" id="id201" name="id201">Contributing to this document</a></li>
-<li><a class="reference" href="#scintilla-keyboard-commands" id="id202" name="id202">Scintilla keyboard commands</a><ul>
-<li><a class="reference" href="#keyboard-commands" id="id203" name="id203">Keyboard commands</a></li>
</ul>
</li>
-<li><a class="reference" href="#tips-and-tricks" id="id204" name="id204">Tips and tricks</a><ul>
-<li><a class="reference" href="#document-notebook" id="id205" name="id205">Document notebook</a></li>
-<li><a class="reference" href="#editor" id="id206" name="id206">Editor</a></li>
-<li><a class="reference" href="#interface" id="id207" name="id207">Interface</a></li>
-<li><a class="reference" href="#gtk-related" id="id208" name="id208">GTK-related</a></li>
+<li><a class="reference internal" href="#contributing-to-this-document" id="id203">Contributing to this document</a></li>
+<li><a class="reference internal" href="#scintilla-keyboard-commands" id="id204">Scintilla keyboard commands</a><ul>
+<li><a class="reference internal" href="#keyboard-commands" id="id205">Keyboard commands</a></li>
</ul>
</li>
-<li><a class="reference" href="#compile-time-options" id="id209" name="id209">Compile-time options</a><ul>
-<li><a class="reference" href="#src-geany-h" id="id210" name="id210">src/geany.h</a></li>
-<li><a class="reference" href="#project-h" id="id211" name="id211">project.h</a></li>
-<li><a class="reference" href="#editor-h" id="id212" name="id212">editor.h</a></li>
-<li><a class="reference" href="#keyfile-c" id="id213" name="id213">keyfile.c</a></li>
-<li><a class="reference" href="#build-h" id="id214" name="id214">build.h</a></li>
-<li><a class="reference" href="#build-c" id="id215" name="id215">build.c</a></li>
+<li><a class="reference internal" href="#tips-and-tricks" id="id206">Tips and tricks</a><ul>
+<li><a class="reference internal" href="#document-notebook" id="id207">Document notebook</a></li>
+<li><a class="reference internal" href="#editor" id="id208">Editor</a></li>
+<li><a class="reference internal" href="#interface" id="id209">Interface</a></li>
+<li><a class="reference internal" href="#gtk-related" id="id210">GTK-related</a></li>
</ul>
</li>
-<li><a class="reference" href="#gnu-general-public-license" id="id216" name="id216">GNU General Public License</a></li>
-<li><a class="reference" href="#license-for-scintilla-and-scite" id="id217" name="id217">License for Scintilla and SciTE</a></li>
+<li><a class="reference internal" href="#compile-time-options" id="id211">Compile-time options</a><ul>
+<li><a class="reference internal" href="#src-geany-h" id="id212">src/geany.h</a></li>
+<li><a class="reference internal" href="#project-h" id="id213">project.h</a></li>
+<li><a class="reference internal" href="#editor-h" id="id214">editor.h</a></li>
+<li><a class="reference internal" href="#keyfile-c" id="id215">keyfile.c</a></li>
+<li><a class="reference internal" href="#build-h" id="id216">build.h</a></li>
+<li><a class="reference internal" href="#build-c" id="id217">build.c</a></li>
</ul>
+</li>
+<li><a class="reference internal" href="#gnu-general-public-license" id="id218">GNU General Public License</a></li>
+<li><a class="reference internal" href="#license-for-scintilla-and-scite" id="id219">License for Scintilla and SciTE</a></li>
+</ul>
</div>
-<div class="section">
-<h1><a class="toc-backref" href="#id12" id="introduction" name="introduction">Introduction</a></h1>
-<div class="section">
-<h2><a class="toc-backref" href="#id13" id="about-geany" name="about-geany">About Geany</a></h2>
+<div class="section" id="introduction">
+<h1><a class="toc-backref" href="#id12">Introduction</a></h1>
+<div class="section" id="about-geany">
+<h2><a class="toc-backref" href="#id13">About Geany</a></h2>
<p>Geany 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 -
+dependencies on other packages. Another goal was to be as independent
+as possible from a particular Desktop Environment like KDE or GNOME -
Geany only requires the GTK2 runtime libraries.</p>
<p>Some basic features of Geany:</p>
<ul class="simple">
@@ -495,56 +499,56 @@
<li>Plugin interface</li>
</ul>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id14" id="where-to-get-it" name="where-to-get-it">Where to get it</a></h2>
-<p>You can obtain Geany from <a class="reference" href="http://www.geany.org/">http://www.geany.org/</a> or perhaps also from
-your distributor. For a list of available packages, please see
-<a class="reference" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
+<div class="section" id="where-to-get-it">
+<h2><a class="toc-backref" href="#id14">Where to get it</a></h2>
+<p>You can obtain Geany from <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a> or perhaps also from
+your distribution. For a list of available packages, please see
+<a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id15" id="license" name="license">License</a></h2>
+<div class="section" id="license">
+<h2><a class="toc-backref" href="#id15">License</a></h2>
<p>Geany 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 chapter, <a class="reference" href="#gnu-general-public-license">GNU General Public License</a>.</p>
+code of this program and in the chapter, <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
<p>The included Scintilla library (found in the subdirectory
<tt class="docutils literal"><span class="pre">scintilla/</span></tt>) has its own license, which can be found in the chapter,
-<a class="reference" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
+<a class="reference internal" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id16" id="about-this-document" name="about-this-document">About this document</a></h2>
+<div class="section" id="about-this-document">
+<h2><a class="toc-backref" href="#id16">About this document</a></h2>
<p>This documentation is available in HTML and text formats.
-The latest version can always be found at <a class="reference" href="http://www.geany.org/">http://www.geany.org/</a>.</p>
-<p>If you want to contribute to it, see <a class="reference" href="#contributing-to-this-document">Contributing to this document</a>.</p>
+The latest version can always be found at <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a>.</p>
+<p>If you want to contribute to it, see <a class="reference internal" href="#contributing-to-this-document">Contributing to this document</a>.</p>
</div>
</div>
-<div class="section">
-<h1><a class="toc-backref" href="#id17" id="installation" name="installation">Installation</a></h1>
-<div class="section">
-<h2><a class="toc-backref" href="#id18" id="requirements" name="requirements">Requirements</a></h2>
+<div class="section" id="installation">
+<h1><a class="toc-backref" href="#id17">Installation</a></h1>
+<div class="section" id="requirements">
+<h2><a class="toc-backref" href="#id18">Requirements</a></h2>
<p>You will need the GTK (>= 2.8.0) libraries and their dependencies
(Pango, GLib and ATK). Your distro should provide packages for these,
usually installed by default. For Windows, you can download an installer
-which bundles these libraries from the website.</p>
+from the website which bundles these libraries.</p>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id19" id="binary-packages" name="binary-packages">Binary packages</a></h2>
+<div class="section" id="binary-packages">
+<h2><a class="toc-backref" href="#id19">Binary packages</a></h2>
<p>There are many binary packages available. For an up-to-date but maybe
-incomplete list see <a class="reference" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
+incomplete list see <a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id20" id="source-compilation" name="source-compilation">Source compilation</a></h2>
+<div class="section" id="source-compilation">
+<h2><a class="toc-backref" href="#id20">Source compilation</a></h2>
<p>Compiling Geany is quite easy.
To do so, you need the GTK (>= 2.8.0) libraries and header files.
You also need the Pango, GLib and ATK libraries and header files.
-All these files are available at <a class="reference" href="http://www.gtk.org">http://www.gtk.org</a>, but very often
+All these files are available at <a class="reference external" href="http://www.gtk.org">http://www.gtk.org</a>, but very often
your distro will provide development packages to save the trouble of
building these yourself.</p>
<p>Furthermore you need, of course, a C and C++ compiler. The GNU versions
of these tools are recommended.</p>
-<div class="section">
-<h3><a class="toc-backref" href="#id21" id="autotools-based-build-system" name="autotools-based-build-system">Autotools based build system</a></h3>
+<div class="section" id="autotools-based-build-system">
+<h3><a class="toc-backref" href="#id21">Autotools based build system</a></h3>
<p>The Autotools based build system is very mature and has been well tested.
To use it, you just need the Make tool, preferably GNU Make.</p>
<p>Then run the following commands:</p>
@@ -557,17 +561,17 @@
% make install
</pre>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id22" id="waf-based-build-system" name="waf-based-build-system">Waf based build system</a></h3>
-<p>The Waf build system is still quite young and under heavy development but already in an
-usable state. In contrary to the Autotools, Waf needs Python. So before using Waf, you need
+<div class="section" id="waf-based-build-system">
+<h3><a class="toc-backref" href="#id22">Waf based build system</a></h3>
+<p>The Waf build system is still quite young and under heavy development but already in a
+usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
to install Python on your system.
The advantage of the Waf build system over the Autotools based build system is that the whole
-build process might be a bit faster. Especially when you use the Waf cache feature repetitive
-builds (e.g. when changing only a few source files to test something) will become much faster
-since Waf will cache and re-use the unchanged built files and only compile the changed code
-again. See <a class="reference" href="#waf-cache">Waf Cache</a> for details.
-To build Geany with Waf as usual run:</p>
+build process might be a bit faster. Especially when you use the Waf
+cache feature for repetitive builds (e.g. when changing only a few source files
+to test something) will become much faster since Waf will cache and re-use the
+unchanged built files and only compile the changed code again. See <a class="reference internal" href="#waf-cache">Waf Cache</a> for details.
+To build Geany with Waf as run:</p>
<pre class="literal-block">
$ ./waf configure
$ ./waf build
@@ -576,11 +580,11 @@
<pre class="literal-block">
% ./waf install
</pre>
-<div class="section">
-<h4><a class="toc-backref" href="#id23" id="waf-cache" name="waf-cache">Waf Cache</a></h4>
-<p>The Waf build system has a nice and interesting feature which can help a lot to avoid
-unnecessary rebuilding of unchanged code. This often happens when developing new features
-or trying to debug something.
+<div class="section" id="waf-cache">
+<h4><a class="toc-backref" href="#id23">Waf Cache</a></h4>
+<p>The Waf build system has a nice and interesting feature which can help to avoid
+a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
+or trying to debug something in Geany.
Waf is able to store and retrieve the object files from a cache. This cache is declared
using the environment variable <tt class="docutils literal"><span class="pre">WAFCACHE</span></tt>.
A possible location of the cache directory could be <tt class="docutils literal"><span class="pre">~/.cache/waf</span></tt>. In order to make use of
@@ -595,11 +599,12 @@
</pre>
<p>Remember to replace <tt class="docutils literal"><span class="pre">username</span></tt> with your actual username.</p>
<p>More information about the Waf cache feature are available at
-<a class="reference" href="http://code.google.com/p/waf/wiki/CacheObjectFiles">http://code.google.com/p/waf/wiki/CacheObjectFiles</a>.</p>
-<div class="section">
-<h5><a class="toc-backref" href="#id24" id="cleaning-the-cache" name="cleaning-the-cache">Cleaning the Cache</a></h5>
-<p>You should take care about the size of the cache directory as it may grow rapidly by time.
-Waf doesn't do any cleaning or other house-keeping of the cache yet so you need to keep it
+<a class="reference external" href="http://code.google.com/p/waf/wiki/CacheObjectFiles">http://code.google.com/p/waf/wiki/CacheObjectFiles</a>.</p>
+<div class="section" id="cleaning-the-cache">
+<h5><a class="toc-backref" href="#id24">Cleaning the Cache</a></h5>
+<p>You should be careful about the size of the cache directory as it may
+grow rapidly over time.
+Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
clean by yourself.
An easy way to keep it clean is to run the following command regularly to remove old
cached files:</p>
@@ -611,8 +616,8 @@
</div>
</div>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id25" id="custom-installation" name="custom-installation">Custom installation</a></h3>
+<div class="section" id="custom-installation">
+<h3><a class="toc-backref" href="#id25">Custom installation</a></h3>
<p>The configure script supports several common options, for a detailed
list, type:</p>
<pre class="literal-block">
@@ -626,39 +631,40 @@
<p>You may also want to read the INSTALL file for advanced installation
options.</p>
<ul class="simple">
-<li>See also <a class="reference" href="#compile-time-options">Compile-time options</a>.</li>
+<li>See also <a class="reference internal" href="#compile-time-options">Compile-time options</a>.</li>
</ul>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id26" id="dynamic-linking-loader-support" name="dynamic-linking-loader-support">Dynamic linking loader support</a></h3>
+<div class="section" id="dynamic-linking-loader-support-and-vte">
+<h3><a class="toc-backref" href="#id26">Dynamic linking loader support and VTE</a></h3>
<p>In the case that your system lacks dynamic linking loader support, you
probably want to pass the option <tt class="docutils literal"><span class="pre">--disable-vte</span></tt> to the <tt class="docutils literal"><span class="pre">configure</span></tt>
script. This prevents compiling Geany with dynamic linking loader
-support to automatically load <tt class="docutils literal"><span class="pre">libvte.so.4</span></tt> if available.</p>
+support for automatically loading <tt class="docutils literal"><span class="pre">libvte.so.4</span></tt> if available.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id27" id="build-problems" name="build-problems">Build problems</a></h3>
+<div class="section" id="build-problems">
+<h3><a class="toc-backref" href="#id27">Build problems</a></h3>
<p>If there are any errors during compilation, check your build
environment and try to find the error, otherwise contact the mailing
list or one the authors. Sometimes you might need to ask for specific
-help from your distro.</p>
+help from your distribution.</p>
</div>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id28" id="installation-prefix" name="installation-prefix">Installation prefix</a></h2>
+<div class="section" id="installation-prefix">
+<h2><a class="toc-backref" href="#id28">Installation prefix</a></h2>
<p>If you want to edit any of Geany's system configuration files after
installation you will need to know the installation prefix. Usually this
-is not necessary as you can just use user configuration files.</p>
-<p>Use the <tt class="docutils literal"><span class="pre">--print-prefix</span></tt> option to check - see <a class="reference" href="#command-line-options">Command line
+is not necessary as you can just use per user configuration files and
+you will not need root permissions.</p>
+<p>Use the <tt class="docutils literal"><span class="pre">--print-prefix</span></tt> option to Geany to check - see <a class="reference internal" href="#command-line-options">Command line
options</a>. The first path is the prefix.</p>
<p>This is commonly <tt class="docutils literal"><span class="pre">/usr</span></tt> if you installed from a binary package, or
<tt class="docutils literal"><span class="pre">/usr/local</span></tt> if you build from source.</p>
</div>
</div>
-<div class="section">
-<h1><a class="toc-backref" href="#id29" id="usage" name="usage">Usage</a></h1>
-<div class="section">
-<h2><a class="toc-backref" href="#id30" id="getting-started" name="getting-started">Getting started</a></h2>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#id29">Usage</a></h1>
+<div class="section" id="getting-started">
+<h2><a class="toc-backref" href="#id30">Getting started</a></h2>
<p>You can start Geany in the following ways:</p>
<ul>
<li><p class="first">From the Desktop Environment menu:</p>
@@ -674,8 +680,37 @@
</li>
</ul>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id31" id="command-line-options" name="command-line-options">Command line options</a></h2>
+<div class="section" id="the-geany-workspace">
+<h2><a class="toc-backref" href="#id31">The Geany workspace</a></h2>
+<p>The Geany window is shown in the following figure:</p>
+<img alt="./images/main_window.png" src="./images/main_window.png" />
+<p>The workspace has the following parts:</p>
+<ul class="simple">
+<li>The menu.</li>
+<li>An optional toolbar.</li>
+<li>An optional sidebar that can show the following tabs:<ul>
+<li>Documents - A document list, and</li>
+<li>Symbols - A list of symbols in your code.</li>
+</ul>
+</li>
+<li>The main editor window.</li>
+<li>An optional message window which can show the following tabs:<ul>
+<li>Status - A list of status messages.</li>
+<li>Compiler - The output of compiling or building programs.</li>
+<li>Messages - Results of 'Find Usage', 'Find Usage' 'Find in Files' and other actions</li>
+<li>Scribble - A text scratchpad for any use.</li>
+<li>Terminal - An optional terminal window.</li>
+</ul>
+</li>
+<li>A status bar</li>
+</ul>
+<p>Additional tabs may be added to the sidebar and message window by plugins.</p>
+<p>The position of the tabs can be selected in the interface preferences.</p>
+<p>The sizes of the sidebar and message window can be adjusted by
+dragging the dividers.</p>
+</div>
+<div class="section" id="command-line-options">
+<h2><a class="toc-backref" href="#id32">Command line options</a></h2>
<table border="1" class="docutils">
<colgroup>
<col width="13%" />
@@ -702,9 +737,10 @@
</tr>
<tr><td>-c dir_name</td>
<td>--config=directory_name</td>
-<td>Use an alternate configuration directory. Default
-configuration directory is <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt> and there
-resides <tt class="docutils literal"><span class="pre">geany.conf</span></tt> and other configuration files.</td>
+<td>Use an alternate configuration directory. The default
+configuration directory is <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt> and that
+is where <tt class="docutils literal"><span class="pre">geany.conf</span></tt> and other configuration files
+reside.</td>
</tr>
<tr><td><em>none</em></td>
<td>--ft-names</td>
@@ -714,7 +750,7 @@
<tr><td>-g</td>
<td>--generate-tags</td>
<td>Generate a global tags file (see
-<a class="reference" href="#generating-a-global-tags-file">Generating a global tags file</a>).</td>
+<a class="reference internal" href="#generating-a-global-tags-file">Generating a global tags file</a>).</td>
</tr>
<tr><td>-P</td>
<td>--no-preprocessing</td>
@@ -748,7 +784,7 @@
<td>--print-prefix</td>
<td>Print installation prefix, the data directory, the lib
directory and the locale directory (in this order) to
-stdout, each per line. This is mainly intended for plugin
+stdout, one line each. This is mainly intended for plugin
authors to detect installation paths.</td>
</tr>
<tr><td>-s</td>
@@ -806,27 +842,27 @@
<p>Geany supports all generic GTK options, a list is available on the
help screen.</p>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id32" id="general" name="general">General</a></h2>
-<div class="section">
-<h3><a class="toc-backref" href="#id33" id="startup" name="startup">Startup</a></h3>
+<div class="section" id="general">
+<h2><a class="toc-backref" href="#id33">General</a></h2>
+<div class="section" id="startup">
+<h3><a class="toc-backref" href="#id34">Startup</a></h3>
<p>At startup, Geany loads all files from the last time Geany was
launched. You can disable this feature in the preferences dialog
-(see <a class="reference" href="#general-startup-preferences">General Startup preferences</a>). If you specify some
+(see <a class="reference internal" href="#general-startup-preferences">General Startup preferences</a>). If you specify some
files on the command line, only these files will be opened, but you
can find the files from the last session in the file menu under the
"Recent files" item. By default this contains the last 10 recently
-opened files. You can change the amount of recently opened files in
+opened files. You can change the number of recently opened files in
the preferences dialog.</p>
<p>You can start several instances of Geany, but only the first will
load files from the last session. To run a second instance of Geany,
do not specify any filenames on the command-line, or disable opening
files in a running instance using the appropriate command line option.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id34" id="opening-files-from-the-command-line-in-a-running-instance" name="opening-files-from-the-command-line-in-a-running-instance">Opening files from the command-line in a running instance</a></h3>
-<p>Geany detects an already running instance of itself and opens files
-from the command-line in the already running instance. So, Geany can
+<div class="section" id="opening-files-from-the-command-line-in-a-running-instance">
+<h3><a class="toc-backref" href="#id35">Opening files from the command-line in a running instance</a></h3>
+<p>Geany detects if there is an an instance of itself already running and opens files
+from the command-line in that instance. So, Geany can
be used to view and edit files by opening them from other programs
such as a file manager.</p>
<p>You can also pass line number and column number information, e.g.:</p>
@@ -837,22 +873,22 @@
column 4.</p>
<p>If you do not like this for some reason, you can disable using the first
instance by using the appropriate command line option -- see the section
-called <a class="reference" href="#command-line-options">Command line options</a>.</p>
+called <a class="reference internal" href="#command-line-options">Command line options</a>.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id35" id="virtual-terminal-emulator-widget-vte" name="virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a></h3>
-<p>If you have installed <tt class="docutils literal"><span class="pre">libvte.so</span></tt> in your system, it is loaded
+<div class="section" id="virtual-terminal-emulator-widget-vte">
+<h3><a class="toc-backref" href="#id36">Virtual terminal emulator widget (VTE)</a></h3>
+<p>If you have installed <tt class="docutils literal"><span class="pre">libvte.so</span></tt> on your system, it is loaded
automatically by Geany, and you will have a terminal widget in the
notebook at the bottom.</p>
<p>If Geany cannot find any <tt class="docutils literal"><span class="pre">libvte.so</span></tt> 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 Geany. Additionally, you can disable the use
of the terminal widget by command line option, for more information
-see the section called <a class="reference" href="#command-line-options">Command line options</a>.</p>
-<p>You can use this terminal (from now on called VTE) nearly as an usual
-terminal program like xterm. There is basic clipboard support. You
+see the section called <a class="reference internal" href="#command-line-options">Command line options</a>.</p>
+<p>You can use this terminal (from now on called VTE) much as you would
+a terminal program like xterm. There is basic clipboard support. You
can paste the contents of the clipboard by pressing the right mouse
-button to open the popup menu and choosing Paste. To copy text from
+button to open the popup menu, and choosing 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. On systems running the
X Window System you can paste the last selected text by pressing the
@@ -867,11 +903,11 @@
<p class="first admonition-title">Note</p>
<p class="last">Geany tries to load <tt class="docutils literal"><span class="pre">libvte.so</span></tt>. If this fails, it tries to load
some other filenames. If this fails too, you should check whether you
-installed libvte correctly. Again, Geany also runs without this
+installed libvte correctly. Again note, Geany will run without this
library.</p>
</div>
<p>It could be, that the library is called something else than
-<tt class="docutils literal"><span class="pre">libvte.so</span></tt> (e.g. on FreeBSD 6.0 it is called <tt class="docutils literal"><span class="pre">libvte.so.8</span></tt>). So
+<tt class="docutils literal"><span class="pre">libvte.so</span></tt> (e.g. on FreeBSD 6.0 it is called <tt class="docutils literal"><span class="pre">libvte.so.8</span></tt>). If so
please set a link to the correct file (as root):</p>
<pre class="literal-block">
# ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
@@ -879,22 +915,22 @@
<p>Obviously, you have to adjust the paths and set X to the number of your
<tt class="docutils literal"><span class="pre">libvte.so</span></tt>.</p>
<p>You can also specify the filename of the VTE library to use on the command
-line (see the section called <a class="reference" href="#command-line-options">Command line options</a>) or at compile time
+line (see the section called <a class="reference internal" href="#command-line-options">Command line options</a>) or at compile time
by specifying the command line option <tt class="docutils literal"><span class="pre">--with-vte-module-path</span></tt> to
./configure.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id36" id="defining-own-widget-styles-using-gtkrc-2-0" name="defining-own-widget-styles-using-gtkrc-2-0">Defining own widget styles using .gtkrc-2.0</a></h3>
+<div class="section" id="defining-own-widget-styles-using-gtkrc-2-0">
+<h3><a class="toc-backref" href="#id37">Defining own widget styles using .gtkrc-2.0</a></h3>
<p>You can define your widget style for many of Geany's GUI parts. To
do this, just edit your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home
directory on UNIX-like systems and in the etc subdirectory of your
Geany installation on Windows).</p>
-<p>To get a defined style get noticed by Geany you must it assign to
-one of Geany's widgets. To do so, use the following line:</p>
+<p>To have a defined style used by Geany you must assign it to
+at least one of Geany's widgets. For example use the following line:</p>
<pre class="literal-block">
widget "Geany*" style "geanyStyle"
</pre>
-<p>This would assign your already defined style "geany_style" to all Geany
+<p>This would assign your style "geany_style" to all Geany
widgets. You can also assign styles only to specific widgets. At the
moment you can use the following widgets:</p>
<ul class="simple">
@@ -908,7 +944,7 @@
<li>GeanyMenubar</li>
<li>GeanyToolbar</li>
</ul>
-<p>Example of a simple <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>:</p>
+<p>An example of a simple <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>:</p>
<pre class="literal-block">
style "geanyStyle"
{
@@ -924,42 +960,44 @@
</pre>
</div>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id37" id="documents" name="documents">Documents</a></h2>
-<div class="section">
-<h3><a class="toc-backref" href="#id38" id="switching-between-documents" name="switching-between-documents">Switching between documents</a></h3>
+<div class="section" id="documents">
+<h2><a class="toc-backref" href="#id38">Documents</a></h2>
+<div class="section" id="switching-between-documents">
+<h3><a class="toc-backref" href="#id39">Switching between documents</a></h3>
<p>The documents list and the editor tabs are two different ways
to switch between documents using the mouse. When you hit the key
combination to move between tabs, the order is determined by the tab
-order, not alphabetical as shown in the documents list (regardless
-of whether or not editor tabs are visible).</p>
-<p>See the <a class="reference" href="#notebook-tab-keybindings">Notebook tab keybindings</a> section for useful
+order. Its is not alphabetical as shown in the documents list
+(regardless of whether or not editor tabs are visible).</p>
+<p>The tabs can be positioned at the top, bottom, left, or right of the
+main editing window, by a selection in the interface preferences.</p>
+<p>See the <a class="reference internal" href="#notebook-tab-keybindings">Notebook tab keybindings</a> section for useful
shortcuts including for Most-Recently-Used document switching.</p>
</div>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id39" id="character-sets-and-unicode-byte-order-mark-bom" name="character-sets-and-unicode-byte-order-mark-bom">Character sets and Unicode Byte-Order-Mark (BOM)</a></h2>
-<div class="section">
-<h3><a class="toc-backref" href="#id40" id="using-character-sets" name="using-character-sets">Using character sets</a></h3>
+<div class="section" id="character-sets-and-unicode-byte-order-mark-bom">
+<h2><a class="toc-backref" href="#id40">Character sets and Unicode Byte-Order-Mark (BOM)</a></h2>
+<div class="section" id="using-character-sets">
+<h3><a class="toc-backref" href="#id41">Using character sets</a></h3>
<p>Geany provides support for detecting and converting character sets. So
-you can open and save files in different character sets and even
-can convert a file from a character set to another one. To do this,
-Geany uses the character conversion capabilities of the GLib.</p>
+you can open and save files in different character sets, and even
+convert a file from one character set to another. To do this,
+Geany uses the character conversion capabilities of the GLib library.</p>
<p>Only text files are supported, i.e. opening files which contain
NULL-bytes may fail. Geany will try to open the file anyway but it is
-likely that the file will be truncated because it can only opened up
+likely that the file will be truncated because it can only be read up
to the first occurrence of a NULL-byte. All characters after this
position are lost and are not written when you save the file.</p>
-<p>Geany tries to detect the encoding of a file while opening it. It
-might be that the encoding of a file cannot be detected correctly so
-you have to set manually the encoding of the file in order to display
-it correctly. You can this in the file open dialog by selecting
-an encoding in the drop down box or by reloading the file with the
+<p>Geany tries to detect the encoding of a file while opening it, but
+auto-detecting the encoding of a file is not easy and sometimes an
+encoding might not be detected correctly. In this case you have to
+set the encoding of the file manually in order to display it
+correctly. You can this in the file open dialog by selecting an
+encoding in the drop down box or by reloading the file with the
file menu item "Reload as". The auto-detection works well for most
-encodings but there are also some encodings known where auto-detection
-has its problems. Auto-detecting the encoding of a file is not easy
-and sometimes an encoding might be detected not correctly.</p>
-<p>There are different ways to use different encodings in Geany:</p>
+encodings but there are also some encodings where it is known that
+auto-detection has problems.</p>
+<p>There are different ways to set different encodings in Geany:</p>
<ul>
<li><p class="first">Using the file open dialog</p>
<p>This opens the file with the encoding specified in the encoding drop
@@ -970,29 +1008,30 @@
</li>
<li><p class="first">Using the "Reload as" menu item</p>
<p>This item reloads the current file with the specified encoding. It can
-help if you opened a file and found out that a wrong encoding was used.</p>
+help if you opened a file and found out that the wrong encoding was used.</p>
</li>
<li><p class="first">Using the "Set encoding" menu item</p>
-<p>In contrary to the above two options, this will not change or reload
+<p>Contrary to the above two options, this will not change or reload
the current file unless you save it. It is useful when you want to
change the encoding of the file.</p>
</li>
<li><p class="first">Specifying the encoding in the file itself</p>
<p>As mentioned above, auto-detecting the encoding of a file may fail on
some encodings. If you know that Geany doesn't open a certain file,
-you can add a special line to the beginning of the file to force an
-encoding when opening the file (for details see below).</p>
+you can add the specification line, described in the next section,
+to the beginning of the file to force Geany to use a specific
+encoding when opening the file.</p>
</li>
</ul>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id41" id="in-file-encoding-specification" name="in-file-encoding-specification">In-file encoding specification</a></h3>
+<div class="section" id="in-file-encoding-specification">
+<h3><a class="toc-backref" href="#id42">In-file encoding specification</a></h3>
<p>Geany detects meta tags of HTML files which contain charset information
like:</p>
<pre class="literal-block">
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
</pre>
-<p>and the found charset is used when opening the file. This is useful if the
+<p>and the specified charset is used when opening the file. This is useful if the
encoding of the file cannot be detected properly.
For non-HTML files you can also define a line like:</p>
<pre class="literal-block">
@@ -1002,8 +1041,8 @@
<pre class="literal-block">
# geany_encoding=ISO-8859-15 #
</pre>
-<p>to force an encoding to be used. The used #, /* and */ are only examples
-for filetype-specific comment characters. It doesn't matter which
+<p>to force an encoding to be used. The #, /* and */ are examples
+of filetype-specific comment characters. It doesn't matter which
characters are around the string " geany_encoding=ISO-8859-15 " as long
as there is at least one whitespace character before and after this
string. Whitespace characters are in this case a space or tab character.
@@ -1011,7 +1050,15 @@
encoding but Geany constantly detects the file encoding as ISO-8859-1.
Then you simply add such a line to the file and Geany will open it
correctly the next time.</p>
-<p>Since Geany 0.15 you can also use lines like:</p>
+<p>Since Geany 0.15 you can also use lines which match the
+regular expression used to find the encoding string:
+<tt class="docutils literal"><span class="pre">coding[\t</span> <span class="pre">]*[:=][\t</span> <span class="pre">]*([a-z0-9-]+)[\t</span> <span class="pre">]*</span></tt></p>
+<div class="note">
+<p class="first admonition-title">Note</p>
+<p class="last">These specifications must be in the first 512 bytes of the file.
+Anything after the first 512 bytes will not be recognized.</p>
+</div>
+<p>Some examples are:</p>
<pre class="literal-block">
# encoding = ISO-8859-15
</pre>
@@ -1019,17 +1066,10 @@
<pre class="literal-block">
# coding: ISO-8859-15
</pre>
-<p>The used regular expression to find the encoding string is:
-<tt class="docutils literal"><span class="pre">coding[\t</span> <span class="pre">]*[:=][\t</span> <span class="pre">]*([a-z0-9-]+)[\t</span> <span class="pre">]*</span></tt></p>
-<div class="note">
-<p class="first admonition-title">Note</p>
-<p class="last">These specifications must be in the first 512 bytes of the file.
-Anything after the first 512 bytes will not be recognized.</p>
</div>
-</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id42" id="special-encoding-none" name="special-encoding-none">Special encoding "None"</a></h3>
-<p>There is a special encoding "None" which is actually no real
+<div class="section" id="special-encoding-none">
+<h3><a class="toc-backref" href="#id43">Special encoding "None"</a></h3>
+<p>There is a special encoding "None" which uses no
encoding. It is useful when you know that Geany cannot auto-detect
the encoding of a file and it is not displayed correctly. Especially
when the file contains NULL-bytes this can be useful to skip auto
@@ -1037,18 +1077,20 @@
of the first NULL-byte. Using this encoding opens the file as it is
without any character conversion.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id43" id="unicode-byte-order-mark-bom" name="unicode-byte-order-mark-bom">Unicode Byte-Order-Mark (BOM)</a></h3>
-<p>Furthermore, Geany detects an Unicode Byte Order Mark (see
-<a class="reference" href="http://en.wikipedia.org/wiki/Byte_Order_Mark">http://en.wikipedia.org/wiki/Byte_Order_Mark</a> for details). Of course,
-this feature is only available if the opened file is in an Unicode
+<div class="section" id="unicode-byte-order-mark-bom">
+<h3><a class="toc-backref" href="#id44">Unicode Byte-Order-Mark (BOM)</a></h3>
+<p>Furthermore, Geany detects a Unicode Byte Order Mark (see
+<a class="reference external" href="http://en.wikipedia.org/wiki/Byte_Order_Mark">http://en.wikipedia.org/wiki/Byte_Order_Mark</a> for details). Of course,
+this feature is only available if the opened file is in a Unicode
encoding. The Byte Order Mark helps to detect the encoding of a file,
e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
-using a Byte Order Mark could cause some problems, e.g. the gcc stops
+using a Byte Order Mark could cause some problems for programs not
+expecting it, e.g. the compiler gcc stops
with stray errors, PHP does not parse a script containing a BOM and
script files starting with a she-bang maybe cannot be started. In the
status bar you can easily see whether the file starts with a BOM or
-not. If you want to set a BOM for a file or if you want to remove it
+not.</p>
+<p>If you want to set a BOM for a file or if you want to remove it
from a file, just use the document menu and toggle the checkbox.</p>
<div class="note">
<p class="first admonition-title">Note</p>
@@ -1058,15 +1100,16 @@
</div>
</div>
</div>
-<div class="section">
-<h2><a class="toc-backref" href="#id44" id="editing" name="editing">Editing</a></h2>
-<div class="section">
-<h3><a class="toc-backref" href="#id45" id="folding" name="folding">Folding</a></h3>
+<div class="section" id="editing">
+<h2><a class="toc-backref" href="#id45">Editing</a></h2>
+<div class="section" id="folding">
+<h3><a class="toc-backref" href="#id46">Folding</a></h3>
<p>Geany provides basic code folding support. Folding means the ability to
show and hide parts of the text in the current file. You can hide
unimportant code sections and concentrate on the parts you are working on
-and later you can show these sections again. In the editor window there is
-a small grey margin on the left side with some [+] and [-] symbols. By
+and later you can show hidden sections again. In the editor window there is
+a small grey margin on the left side with [+] and [-] symbols which
+show hidden parts and hide parts of the file respectively. By
clicking on these icons you can simply show and hide sections which are
marked by vertical lines within this margin. For many filetypes nested
folding is supported, so there may be several fold points within other
@@ -1079,13 +1122,13 @@
folded (when clicking on a [+] symbol).
When clicking on a [-] symbol, Geany will fold all nested fold points
below the current one if they are unfolded.</p>
-<p>The usage of this option can be instantly inverted by pressing the Shift
+<p>This option can be inverted by pressing the Shift
key while clicking on a fold symbol. That means, if the "Fold/Unfold all
children of a fold point" option is enabled, pressing Shift will disable
it for this click and vice versa.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id46" id="column-mode-editing-rectangular-selections" name="column-mode-editing-rectangular-selections">Column mode editing (rectangular selections)</a></h3>
+<div class="section" id="column-mode-editing-rectangular-selections">
+<h3><a class="toc-backref" href="#id47">Column mode editing (rectangular selections)</a></h3>
<p>There is basic support for column mode editing. To use it, create a
rectangular selection by holding down the Control and Shift keys
(or Control and Alt if it doesn't work) while
@@ -1095,18 +1138,18 @@
this selection and the modifications will be done for every line in the
selection.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id47" id="drag-and-drop-of-text" name="drag-and-drop-of-text">Drag and drop of text</a></h3>
+<div class="section" id="drag-and-drop-of-text">
+<h3><a class="toc-backref" href="#id48">Drag and drop of text</a></h3>
<p>If you drag selected text in the editor widget of Geany the text is
moved to the position where the mouse pointer is when releasing the
mouse button. Holding Control when releasing the mouse button will
copy the text instead. This behaviour was changed in Geany 0.11 -
before the selected text was copied to the new position.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id48" id="indentation" name="indentation">Indentation</a></h3>
+<div class="section" id="indentation">
+<h3><a class="toc-backref" href="#id49">Indentation</a></h3>
<p>Geany allows each document to indent either with a tab character or
-multiple spaces. The default indent mode is set in the <a class="reference" href="#editor-features-preferences">Editor Features
+multiple spaces. The default indent mode is set in the <a class="reference internal" href="#editor-features-preferences">Editor Features
preferences</a> (see the link for more information). But
this can be overridden using either the <em>Document->Indent Type</em> menu,
or by using the <em>Detect from file</em> indentation preference. When enabled,
@@ -1124,12 +1167,12 @@
on a line.</dd>
</dl>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id49" id="auto-indentation" name="auto-indentation">Auto-indentation</a></h3>
+<div class="section" id="auto-indentation">
+<h3><a class="toc-backref" href="#id50">Auto-indentation</a></h3>
<p>When enabled, auto-indentation happens when pressing <em>Enter</em> in the
Editor. It adds a certain amount of indentation to the new line so the
user doesn't always have to indent each line manually.</p>
-<p>Geany knows four types of auto-indentation:</p>
+<p>Geany has four types of auto-indentation:</p>
<dl class="docutils">
<dt>None</dt>
<dd>Disables auto-indentation completely.</dd>
@@ -1145,13 +1188,13 @@
match the indentation of the line with the opening brace.</dd>
</dl>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id50" id="bookmarks" name="bookmarks">Bookmarks</a></h3>
+<div class="section" id="bookmarks">
+<h3><a class="toc-backref" href="#id51">Bookmarks</a></h3>
<p>Geany provides a handy bookmarking feature that lets you mark one
or more lines in a document, and return the cursor to them using a
key combination.</p>
<p>To place a mark on a line, either left-mouse-click in the left margin
-of the editor window, or else use Ctrl-m. Either way, this will
+of the editor window, or else use Ctrl-m. This will
produce a small green plus symbol in the margin. You can have as many
marks in a document as you like. Click again (or use Ctrl-m again)
to remove the bookmark. To remove all the marks in a given document,
@@ -1163,14 +1206,14 @@
(Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
navigate around multiple files.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id51" id="code-navigation-history" name="code-navigation-history">Code navigation history</a></h3>
+<div class="section" id="code-navigation-history">
+<h3><a class="toc-backref" href="#id52">Code navigation history</a></h3>
<p>To ease navigation in source files and especially between
different files, Geany lets you jump between different navigation
points. Currently, this works for the following:</p>
<ul class="simple">
-<li><a class="reference" href="#go-to-tag-declaration">Go to tag declaration</a></li>
-<li><a class="reference" href="#go-to-tag-definition">Go to tag definition</a></li>
+<li><a class="reference internal" href="#go-to-tag-declaration">Go to tag declaration</a></li>
+<li><a class="reference internal" href="#go-to-tag-definition">Go to tag definition</a></li>
<li>Symbol list items</li>
<li>Build errors</li>
<li>Message items</li>
@@ -1182,11 +1225,13 @@
location". This makes it easier to navigate in e.g. foreign code
and between different files.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id52" id="send-text-through-definable-commands" name="send-text-through-definable-commands">Send text through definable commands</a></h3>
+<div class="section" id="sending-text-through-custom-commands">
+<h3><a class="toc-backref" href="#id53">Sending text through custom commands</a></h3>
<p>You can define several custom commands in Geany and send the current
-selection to one of these commands. The output of the command will be
-used to replace the current selection. So, it is possible to use text
+selection to one of these commands using the "Edit->Format->Send
+Selection to" menu or keybindings.
+The output of the command will be
+used to replace the current selection. This makes it possible to use text
formatting tools with Geany in a general way. The selected text will
be sent to the standard input of the executed command, so the command
should be able to read from it and it should print all results to its
@@ -1199,22 +1244,24 @@
some command line options. To delete a command, just clear the text
entry and press OK. It will be deleted automatically.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id53" id="context-actions" name="context-actions">Context actions</a></h3>
-<p>You can execute a specified command on the current word near the
-cursor position or an available selection and this word is passed
-as an argument to this command. It can be used for example to open
-some API documentation in a browser window or open any other external
-program. To do this, there is a menu entry in the popup menu of the
-editor widget and also a keyboard shortcut (see <a class="reference" href="#editor-keybindings">Editor keybindings</a>).</p>
-<p>The command can be specified in the preferences dialog and additionally
-for each filetype (see "context_action_cmd" in the section called
-<a class="reference" href="#format">Format</a>). At executing, the filetype specific command is used if
-available otherwise the command specified in the preferences dialog
-is executed.</p>
-<p>The passed word can be referred with the wildcard "%s" everywhere
-in the command, before executing it will be replaced by the current
-word. For example, the command to open the PHP API documentation
+<div class="section" id="context-actions">
+<h3><a class="toc-backref" href="#id54">Context actions</a></h3>
+<p>You can execute the context action command on the current word at the
+cursor position or the available selection. This word or selection
+can be used as an argument to the command.
+The context action is invoked by a menu entry in the popup menu of the
+editor and also a keyboard shortcut (see the section called
+<a class="reference internal" href="#keybindings">Keybindings</a>).</p>
+<p>The command can be specified in the preferences dialog and also for
+each filetype (see "context_action_cmd" in the section called
+<a class="reference internal" href="#format">Format</a>). When the context action is invoked, the filetype
+specific command is used if available, otherwise the command
+specified in the preferences dialog is executed.</p>
+<p>The current word or selection can be referred with the wildcard "%s"
+in the command, it will be replaced by the current word or
+selection before the command is executed.</p>
+<p>For example a context action can be used to open API documentation
+in a browser window, the command to open the PHP API documentation
would be:</p>
<pre class="literal-block">
firefox "http://www.php.net/%s"
@@ -1222,19 +1269,19 @@
<p>when executing the command, the %s is substituted by the word near
the cursor position or by the current selection. If the cursor is at
the word "echo", a browser window will open(assumed your browser is
-called firefox) and it will open the address: <a class="reference" href="http://www.php.net/echo">http://www.php.net/echo</a>.</p>
+called firefox) and it will open the address: <a class="reference external" href="http://www.php.net/echo">http://www.php.net/echo</a>.</p>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id54" id="autocompletion" name="autocompletion">Autocompletion</a></h3>
+<div class="section" id="autocompletion">
+<h3><a class="toc-backref" href="#id55">Autocompletion</a></h3>
<p>Geany can offer a list of possible completions for symbols defined in the
tags and for all words in a document.</p>
<p>The autocompletion list for symbols is presented when the first few
-characters of the symbol are typed (configurable, see <a class="reference" href="#editor-completions-preferences">Editor Completions
+characters of the symbol are typed (configurable, see <a class="reference internal" href="#editor-completions-preferences">Editor Completions
preferences</a>, default 4) or when the <em>Complete word</em>
-keybinding is pressed (configurable, see <a class="reference" href="#editor-keybindings">Editor keybindings</a>,
+keybinding is pressed (configurable, see <a class="reference internal" href="#editor-keybindings">Editor keybindings</a>,
default Ctrl-Space).</p>
<p>When the defined keybinding is typed and the <em>Autocomplete all words in
-document</em> preference (in <a class="reference" href="#editor-completions-preferences">Editor Completions preferences</a>)
+document</em> preference (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions preferences</a>)
is selected then the autocompletion list will show all matching words
in the document, if there are no matching symbols.</p>
<p>If you don't want to use autocompletion it can be dismissed until
@@ -1246,11 +1293,11 @@
item on the autocompletion list can be chosen from the list by Tab or
Enter/Return. You can also double-click to select an item. The sequence
will be completed to match the chosen item, and if the <em>Drop rest of
-word on completion</em> preference is set (in <a class="reference" href="#editor-completions-preferences">Editor Completions
+word on completion</em> preference is set (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions
preferences</a>) then any characters after the cursor that match
a symbol or word are deleted.</p>
-<div class="section">
-<h4><a class="toc-backref" href="#id55" id="scope-autocompletion" name="scope-autocompletion">Scope autocompletion</a></h4>
+<div class="section" id="scope-autocompletion">
+<h4><a class="toc-backref" href="#id56">Scope autocompletion</a></h4>
<p>E.g.:</p>
<pre class="literal-block">
struct
@@ -1267,16 +1314,25 @@
in local scope.</p>
</div>
</div>
-<div class="section">
-<h3><a class="toc-backref" href="#id56" id="user-definable-snippets" name="user-definable-snippets">User-definable snippets</a></h3>
+<div class="section" id="user-definable-snippets">
+<h3><a class="toc-backref" href="#id57">User-definable snippets</a></h3>
<p>Snippets are small strings or code constructs which can be replaced or
-completed to a more complex string. So you can save a lot of time by
-not typing often used strings and letting Geany do the work for you.
+completed to a more complex string. So you can save a lot of time when
+typing common strings and letting Geany do the work for you.
To know what to complete or replace Geany reads a configuration file
called <tt class="docutils literal"><span class="pre">snippets.conf</span></tt> at startup.</p>
+<p>Maybe you need to often type your name, so define a snippet like this:</p>
+<pre class="literal-block">
+[Default]
+myname=Enrico Tröger
+</pre>
+<p>Every time you write <tt class="docutils literal"><span class="pre">myname</span></tt> <TAB> in Geany, it will replace "myname"
+with "Enrico Tröger". The key to start autocompletion can be changed
+in the preferences dialog, by default it is TAB. The corresponding keybinding
+is called <tt class="docutils literal"><span class="pre">Complete</span> <span class="pre">snippet</span></tt>.</p>
<p>The system-wide configuration file can be found in
<tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt>, where <tt class="docutils literal"><span class="pre">$prefix</span></tt> is the path where Geany is
-installed (see <a class="reference" href="#installation-prefix">Installation prefix</a>). It is not recommended to edit the
+installed (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>). It is not recommended to edit the
system-wide file, because it will be overridden when Geany is updated.</p>
<p>To change the settings, copy the file from <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt>
in your configuration directory (usually <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>).</p>
@@ -1284,27 +1340,28 @@
<pre class="literal-block">
% cp /usr/local/share/geany/snippets.conf /home/username/.config/geany/
</pre>
-<p>Then you can edit the file and the changes are also available
+<p>Then you can edit the file and the changes will remain available
after an update of Geany because the file resides in your
configuration directory. Alternatively, you can create a file
<tt class="docutils literal"><span class="pre">~/.config/geany/snippets.conf</span></tt> and add only these settings you want
to change. All missing settings will be read from the global snippets
file in <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt>.</p>
-<p>The file <tt class="docutils literal"><span class="pre">snippets.conf</span></tt> may contain several sections for each
-filetype. It also contains two additional sections "Default" and
-"Special". Default contains all snippets which are available
-for every filetype. You may define another section for a certain
-filetype(e.g. C++) containing the same snippets. Then when using
-such a snippet in a C++ file the snippet defined in the C++ section will
-be used. In any other file the snippet defined in the Default section will
-be used unless a section for the current filetype exists and the used
-snippet is defined in this section. The section "Special" contains special
-snippets which can only be used in other snippets. So you can define often
-used parts of snippets and just use the special snippet as a placeholder
-(see the <tt class="docutils literal"><span class="pre">snippets.conf</span></tt> for details).</p>
-<p>To define snippets you can use several special characters which
+<p>The file <tt class="docutils literal"><span class="pre">snippets.conf</span></tt> contains sections defining snippets that
+are available for particular filetypes and in general.</p>
+<p>The two sections "Default" and "Special" apply to all filetypes.
+"Default" contains all snippets which are available for every
+filetype and "Special" contains snippets which can only be used in
+other snippets. So you can define often used parts of snippets and
+just use the special snippet as a placeholder (see the
+<tt class="docutils literal"><span class="pre">snippets.conf</span></tt> for details).</p>
+<p>You can define sections with the name of a filetype eg "C++". The
+snippets in that section are only available for use in files with that
+filetype. Snippets in filetype sections will hide snippets with the
+same name in the "Default" section when used in a file of that
+filetype.</p>
+<p>To define snippets you can use several special character sequences which
will be replaced when using the snippet:</p>
-<p><strong>Wildcards for snippets</strong></p>
+<p><strong>Substitution Sequences for snippets</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="22%" />
@@ -1333,7 +1390,7 @@
<tr><td>%...%</td>
<td>"..." means the name of a key in the "Special" section.
If you have defined a key "brace_open" in the "Special"
-section you can use %brace_open" in any other snippet.</td>
+section you can use %brace_open% in any other snippet.</td>
</tr>
</tbody>
</table>
@@ -1342,17 +1399,8 @@
string as a snippet and use it later in Geany. It is not limited
to existing contructs of certain programming languages(like <tt class="docutils literal"><span class="pre">if</span></tt>,
<tt class="docutils literal"><span class="pre">for</span></tt>, <tt class="docutils literal"><span class="pre">switch</span></tt>). Define whatever you need.</p>
-<p>Maybe you need to often type your name, so define a snippet like this:</p>
-<pre class="literal-block">
-[Default]
-myname=Enrico Tröger
-</pre>
-<p>Every time you write <tt class="docutils literal"><span class="pre">myname</span></tt> <TAB> in Geany, it will replace "myname"
@@ Diff output truncated at 100000 characters. @@
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the Commits
mailing list