HybridDog/geany
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add Indentation subsection under Editor section.

Browse Source 
git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/trunk@2207 ea778897-0a13-0410-b9d1-a72fbfd435f5
This commit is contained in:
Nick Treleaven 2008-02-01 13:16:32 +00:00
parent 00739679ad
commit eeba2ac25d
4 changed files with 231 additions and 176 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
ChangeLog
View File

@ -1,3 +1,9 @@
2008-02-01 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
* doc/geany.txt, doc/geany.html, NEWS:
Add Indentation subsection under Editor section.
2008-01-31 Frank Lanitz <frank(at)frank(dot)uvena(dot)de>
* plugins/autosave.c: Fixed a little typo

1
NEWS
View File

@ -58,6 +58,7 @@ Geany 0.13 (TBA)
* Prevent prefs dialog being hidden after using the prefs file dialog.
Documentation:
* Add Indentation subsection under Editor section.
* HACKING: Update 'Adding a filetype' section.

367
doc/geany.html
View File

@ -6,7 +6,7 @@
<meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
<title>Geany</title>
<meta name="authors" content="Enrico Tröger Nick Treleaven Frank Lanitz" />
<meta name="date" content="2008-01-10" />
<meta name="date" content="2008-01-11" />
<style type="text/css">
/*
@ -133,7 +133,7 @@ dt {
<br />Nick Treleaven
<br />Frank Lanitz</td></tr>
<tr><th class="docinfo-name">Date:</th>
<td>2008-01-10</td></tr>
<td>2008-01-11</td></tr>
<tr><th class="docinfo-name">Version:</th>
<td>0.13</td></tr>
</tbody>
@ -180,133 +180,134 @@ of this program, and also in the chapter <a class="reference" href="#gnu-general
<li><a class="reference" href="#editing" id="id24" name="id24">Editing</a><ul>
<li><a class="reference" href="#folding" id="id25" name="id25">Folding</a></li>
<li><a class="reference" href="#drag-and-drop-of-text" id="id26" name="id26">Drag and drop of text</a></li>
<li><a class="reference" href="#auto-indentation" id="id27" name="id27">Auto indentation</a></li>
<li><a class="reference" href="#bookmarks" id="id28" name="id28">Bookmarks</a></li>
<li><a class="reference" href="#code-navigation-history" id="id29" name="id29">Code Navigation History</a></li>
<li><a class="reference" href="#send-text-through-definable-commands" id="id30" name="id30">Send text through definable commands</a></li>
<li><a class="reference" href="#context-actions" id="id31" name="id31">Context actions</a></li>
<li><a class="reference" href="#user-definable-snippets" id="id32" name="id32">User-definable snippets</a></li>
<li><a class="reference" href="#inserting-unicode-characters" id="id33" name="id33">Inserting unicode characters</a></li>
<li><a class="reference" href="#indentation" id="id27" name="id27">Indentation</a></li>
<li><a class="reference" href="#auto-indentation" id="id28" name="id28">Auto-indentation</a></li>
<li><a class="reference" href="#bookmarks" id="id29" name="id29">Bookmarks</a></li>
<li><a class="reference" href="#code-navigation-history" id="id30" name="id30">Code Navigation History</a></li>
<li><a class="reference" href="#send-text-through-definable-commands" id="id31" name="id31">Send text through definable commands</a></li>
<li><a class="reference" href="#context-actions" id="id32" name="id32">Context actions</a></li>
<li><a class="reference" href="#user-definable-snippets" id="id33" name="id33">User-definable snippets</a></li>
<li><a class="reference" href="#inserting-unicode-characters" id="id34" name="id34">Inserting unicode characters</a></li>
</ul>
</li>
<li><a class="reference" href="#search-replace-and-go-to" id="id34" name="id34">Search, replace and go to</a><ul>
<li><a class="reference" href="#find" id="id35" name="id35">Find</a><ul>
<li><a class="reference" href="#matching-options" id="id36" name="id36">Matching options</a></li>
<li><a class="reference" href="#find-all" id="id37" name="id37">Find all</a></li>
<li><a class="reference" href="#search-replace-and-go-to" id="id35" name="id35">Search, replace and go to</a><ul>
<li><a class="reference" href="#find" id="id36" name="id36">Find</a><ul>
<li><a class="reference" href="#matching-options" id="id37" name="id37">Matching options</a></li>
<li><a class="reference" href="#find-all" id="id38" name="id38">Find all</a></li>
</ul>
</li>
<li><a class="reference" href="#find-usage" id="id38" name="id38">Find usage</a></li>
<li><a class="reference" href="#find-in-files" id="id39" name="id39">Find in files</a><ul>
<li><a class="reference" href="#filtering-out-version-control-files" id="id40" name="id40">Filtering out version control files</a></li>
<li><a class="reference" href="#find-usage" id="id39" name="id39">Find usage</a></li>
<li><a class="reference" href="#find-in-files" id="id40" name="id40">Find in files</a><ul>
<li><a class="reference" href="#filtering-out-version-control-files" id="id41" name="id41">Filtering out version control files</a></li>
</ul>
</li>
<li><a class="reference" href="#replace" id="id41" name="id41">Replace</a><ul>
<li><a class="reference" href="#replace-all" id="id42" name="id42">Replace all</a></li>
<li><a class="reference" href="#replace" id="id42" name="id42">Replace</a><ul>
<li><a class="reference" href="#replace-all" id="id43" name="id43">Replace all</a></li>
</ul>
</li>
<li><a class="reference" href="#go-to-tag-definition" id="id43" name="id43">Go to tag definition</a></li>
<li><a class="reference" href="#go-to-tag-declaration" id="id44" name="id44">Go to tag declaration</a></li>
<li><a class="reference" href="#go-to-line" id="id45" name="id45">Go to line</a></li>
<li><a class="reference" href="#regular-expressions" id="id46" name="id46">Regular expressions</a><ul>
<li><a class="reference" href="#partial-posix-compatibility" id="id47" name="id47">Partial POSIX compatibility</a></li>
<li><a class="reference" href="#go-to-tag-definition" id="id44" name="id44">Go to tag definition</a></li>
<li><a class="reference" href="#go-to-tag-declaration" id="id45" name="id45">Go to tag declaration</a></li>
<li><a class="reference" href="#go-to-line" id="id46" name="id46">Go to line</a></li>
<li><a class="reference" href="#regular-expressions" id="id47" name="id47">Regular expressions</a><ul>
<li><a class="reference" href="#partial-posix-compatibility" id="id48" name="id48">Partial POSIX compatibility</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference" href="#tags" id="id48" name="id48">Tags</a><ul>
<li><a class="reference" href="#workspace-tags" id="id49" name="id49">Workspace tags</a></li>
<li><a class="reference" href="#global-tags" id="id50" name="id50">Global tags</a><ul>
<li><a class="reference" href="#default-global-tags-files" id="id51" name="id51">Default global tags files</a></li>
<li><a class="reference" href="#generating-a-global-tags-file" id="id52" name="id52">Generating a global tags file</a></li>
<li><a class="reference" href="#tags" id="id49" name="id49">Tags</a><ul>
<li><a class="reference" href="#workspace-tags" id="id50" name="id50">Workspace tags</a></li>
<li><a class="reference" href="#global-tags" id="id51" name="id51">Global tags</a><ul>
<li><a class="reference" href="#default-global-tags-files" id="id52" name="id52">Default global tags files</a></li>
<li><a class="reference" href="#generating-a-global-tags-file" id="id53" name="id53">Generating a global tags file</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference" href="#preferences" id="id53" name="id53">Preferences</a><ul>
<li><a class="reference" href="#general-tab-in-preferences-dialog" id="id54" name="id54">General tab in preferences dialog</a></li>
<li><a class="reference" href="#interface-tab-in-preferences-dialog" id="id55" name="id55">Interface tab in preferences dialog</a></li>
<li><a class="reference" href="#toolbar-tab-in-preferences-dialog" id="id56" name="id56">Toolbar tab in preferences dialog</a></li>
<li><a class="reference" href="#display-tab-in-preferences-dialog" id="id57" name="id57">Display tab in preferences dialog</a></li>
<li><a class="reference" href="#editor-tab-in-preferences-dialog" id="id58" name="id58">Editor tab in preferences dialog</a></li>
<li><a class="reference" href="#files-tab-in-preferences-dialog" id="id59" name="id59">Files tab in preferences dialog</a></li>
<li><a class="reference" href="#tools-tab-in-preferences-dialog" id="id60" name="id60">Tools tab in preferences dialog</a></li>
<li><a class="reference" href="#template-tab-in-preferences-dialog" id="id61" name="id61">Template tab in preferences dialog</a></li>
<li><a class="reference" href="#keybinding-tab-in-preferences-dialog" id="id62" name="id62">Keybinding tab in preferences dialog</a></li>
<li><a class="reference" href="#vte-tab-in-preferences-dialog" id="id63" name="id63">VTE tab in preferences dialog</a></li>
<li><a class="reference" href="#preferences" id="id54" name="id54">Preferences</a><ul>
<li><a class="reference" href="#general-tab-in-preferences-dialog" id="id55" name="id55">General tab in preferences dialog</a></li>
<li><a class="reference" href="#interface-tab-in-preferences-dialog" id="id56" name="id56">Interface tab in preferences dialog</a></li>
<li><a class="reference" href="#toolbar-tab-in-preferences-dialog" id="id57" name="id57">Toolbar tab in preferences dialog</a></li>
<li><a class="reference" href="#display-tab-in-preferences-dialog" id="id58" name="id58">Display tab in preferences dialog</a></li>
<li><a class="reference" href="#editor-tab-in-preferences-dialog" id="id59" name="id59">Editor tab in preferences dialog</a></li>
<li><a class="reference" href="#files-tab-in-preferences-dialog" id="id60" name="id60">Files tab in preferences dialog</a></li>
<li><a class="reference" href="#tools-tab-in-preferences-dialog" id="id61" name="id61">Tools tab in preferences dialog</a></li>
<li><a class="reference" href="#template-tab-in-preferences-dialog" id="id62" name="id62">Template tab in preferences dialog</a></li>
<li><a class="reference" href="#keybinding-tab-in-preferences-dialog" id="id63" name="id63">Keybinding tab in preferences dialog</a></li>
<li><a class="reference" href="#vte-tab-in-preferences-dialog" id="id64" name="id64">VTE tab in preferences dialog</a></li>
</ul>
</li>
<li><a class="reference" href="#project-management" id="id64" name="id64">Project Management</a><ul>
<li><a class="reference" href="#new-project" id="id65" name="id65">New Project</a></li>
<li><a class="reference" href="#project-properties" id="id66" name="id66">Project Properties</a><ul>
<li><a class="reference" href="#make-in-base-path" id="id67" name="id67">Make in base path</a></li>
<li><a class="reference" href="#run-command" id="id68" name="id68">Run command</a></li>
<li><a class="reference" href="#project-management" id="id65" name="id65">Project Management</a><ul>
<li><a class="reference" href="#new-project" id="id66" name="id66">New Project</a></li>
<li><a class="reference" href="#project-properties" id="id67" name="id67">Project Properties</a><ul>
<li><a class="reference" href="#make-in-base-path" id="id68" name="id68">Make in base path</a></li>
<li><a class="reference" href="#run-command" id="id69" name="id69">Run command</a></li>
</ul>
</li>
<li><a class="reference" href="#close-project" id="id69" name="id69">Close Project</a></li>
<li><a class="reference" href="#open-project" id="id70" name="id70">Open Project</a></li>
<li><a class="reference" href="#close-project" id="id70" name="id70">Close Project</a></li>
<li><a class="reference" href="#open-project" id="id71" name="id71">Open Project</a></li>
</ul>
</li>
<li><a class="reference" href="#build-system" id="id71" name="id71">Build system</a><ul>
<li><a class="reference" href="#compile" id="id72" name="id72">Compile</a></li>
<li><a class="reference" href="#build" id="id73" name="id73">Build</a></li>
<li><a class="reference" href="#make-all" id="id74" name="id74">Make all</a></li>
<li><a class="reference" href="#make-custom-target" id="id75" name="id75">Make custom target</a></li>
<li><a class="reference" href="#make-object" id="id76" name="id76">Make object</a></li>
<li><a class="reference" href="#execute" id="id77" name="id77">Execute</a></li>
<li><a class="reference" href="#stopping-running-processes" id="id78" name="id78">Stopping running processes</a><ul>
<li><a class="reference" href="#terminal-emulators" id="id79" name="id79">Terminal emulators</a></li>
<li><a class="reference" href="#build-system" id="id72" name="id72">Build system</a><ul>
<li><a class="reference" href="#compile" id="id73" name="id73">Compile</a></li>
<li><a class="reference" href="#build" id="id74" name="id74">Build</a></li>
<li><a class="reference" href="#make-all" id="id75" name="id75">Make all</a></li>
<li><a class="reference" href="#make-custom-target" id="id76" name="id76">Make custom target</a></li>
<li><a class="reference" href="#make-object" id="id77" name="id77">Make object</a></li>
<li><a class="reference" href="#execute" id="id78" name="id78">Execute</a></li>
<li><a class="reference" href="#stopping-running-processes" id="id79" name="id79">Stopping running processes</a><ul>
<li><a class="reference" href="#terminal-emulators" id="id80" name="id80">Terminal emulators</a></li>
</ul>
</li>
<li><a class="reference" href="#set-includes-and-arguments" id="id80" name="id80">Set Includes and Arguments</a><ul>
<li><a class="reference" href="#one-step-compilation" id="id81" name="id81">One step compilation</a></li>
<li><a class="reference" href="#set-includes-and-arguments" id="id81" name="id81">Set Includes and Arguments</a><ul>
<li><a class="reference" href="#one-step-compilation" id="id82" name="id82">One step compilation</a></li>
</ul>
</li>
<li><a class="reference" href="#indicators" id="id82" name="id82">Indicators</a></li>
<li><a class="reference" href="#indicators" id="id83" name="id83">Indicators</a></li>
</ul>
</li>
<li><a class="reference" href="#printing-support" id="id83" name="id83">Printing support</a></li>
<li><a class="reference" href="#plugins" id="id84" name="id84">Plugins</a></li>
<li><a class="reference" href="#keybindings" id="id85" name="id85">Keybindings</a><ul>
<li><a class="reference" href="#switching-documents" id="id86" name="id86">Switching documents</a></li>
<li><a class="reference" href="#configurable-keybindings" id="id87" name="id87">Configurable keybindings</a></li>
<li><a class="reference" href="#printing-support" id="id84" name="id84">Printing support</a></li>
<li><a class="reference" href="#plugins" id="id85" name="id85">Plugins</a></li>
<li><a class="reference" href="#keybindings" id="id86" name="id86">Keybindings</a><ul>
<li><a class="reference" href="#switching-documents" id="id87" name="id87">Switching documents</a></li>
<li><a class="reference" href="#configurable-keybindings" id="id88" name="id88">Configurable keybindings</a></li>
</ul>
</li>
</ul>
</li>
<li><a class="reference" href="#configuration-files" id="id88" name="id88">Configuration files</a><ul>
<li><a class="reference" href="#global-configuration-file" id="id89" name="id89">Global configuration file</a></li>
<li><a class="reference" href="#filetype-definition-files" id="id90" name="id90">Filetype definition files</a><ul>
<li><a class="reference" href="#format" id="id91" name="id91">Format</a><ul>
<li><a class="reference" href="#styling-section" id="id92" name="id92">[styling] Section</a></li>
<li><a class="reference" href="#keywords-section" id="id93" name="id93">[keywords] Section</a></li>
<li><a class="reference" href="#settings-section" id="id94" name="id94">[settings] Section</a></li>
<li><a class="reference" href="#build-settings-section" id="id95" name="id95">[build_settings] Section</a></li>
<li><a class="reference" href="#configuration-files" id="id89" name="id89">Configuration files</a><ul>
<li><a class="reference" href="#global-configuration-file" id="id90" name="id90">Global configuration file</a></li>
<li><a class="reference" href="#filetype-definition-files" id="id91" name="id91">Filetype definition files</a><ul>
<li><a class="reference" href="#format" id="id92" name="id92">Format</a><ul>
<li><a class="reference" href="#styling-section" id="id93" name="id93">[styling] Section</a></li>
<li><a class="reference" href="#keywords-section" id="id94" name="id94">[keywords] Section</a></li>
<li><a class="reference" href="#settings-section" id="id95" name="id95">[settings] Section</a></li>
<li><a class="reference" href="#build-settings-section" id="id96" name="id96">[build_settings] Section</a></li>
</ul>
</li>
<li><a class="reference" href="#special-file-filetypes-common" id="id96" name="id96">Special file filetypes.common</a></li>
<li><a class="reference" href="#special-file-filetypes-common" id="id97" name="id97">Special file filetypes.common</a></li>
</ul>
</li>
<li><a class="reference" href="#filetype-extensions" id="id97" name="id97">Filetype extensions</a></li>
<li><a class="reference" href="#templates" id="id98" name="id98">Templates</a><ul>
<li><a class="reference" href="#template-metadata" id="id99" name="id99">Template metadata</a></li>
<li><a class="reference" href="#filetype-templates" id="id100" name="id100">Filetype templates</a></li>
<li><a class="reference" href="#customizing-templates" id="id101" name="id101">Customizing templates</a><ul>
<li><a class="reference" href="#template-wildcards" id="id102" name="id102">Template wildcards</a></li>
<li><a class="reference" href="#filetype-extensions" id="id98" name="id98">Filetype extensions</a></li>
<li><a class="reference" href="#templates" id="id99" name="id99">Templates</a><ul>
<li><a class="reference" href="#template-metadata" id="id100" name="id100">Template metadata</a></li>
<li><a class="reference" href="#filetype-templates" id="id101" name="id101">Filetype templates</a></li>
<li><a class="reference" href="#customizing-templates" id="id102" name="id102">Customizing templates</a><ul>
<li><a class="reference" href="#template-wildcards" id="id103" name="id103">Template wildcards</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li><a class="reference" href="#contributing-to-this-document" id="id103" name="id103">Contributing to this document</a></li>
<li><a class="reference" href="#scintilla-keyboard-commands" id="id104" name="id104">Scintilla keyboard commands</a><ul>
<li><a class="reference" href="#keyboard-commands" id="id105" name="id105">Keyboard commands</a></li>
<li><a class="reference" href="#contributing-to-this-document" id="id104" name="id104">Contributing to this document</a></li>
<li><a class="reference" href="#scintilla-keyboard-commands" id="id105" name="id105">Scintilla keyboard commands</a><ul>
<li><a class="reference" href="#keyboard-commands" id="id106" name="id106">Keyboard commands</a></li>
</ul>
</li>
<li><a class="reference" href="#hidden-preferences" id="id106" name="id106">Hidden preferences</a></li>
<li><a class="reference" href="#compile-time-options" id="id107" name="id107">Compile-time options</a></li>
<li><a class="reference" href="#gnu-general-public-license" id="id108" name="id108">GNU General Public License</a></li>
<li><a class="reference" href="#license-for-scintilla-and-scite" id="id109" name="id109">License for Scintilla and SciTE</a></li>
<li><a class="reference" href="#hidden-preferences" id="id107" name="id107">Hidden preferences</a></li>
<li><a class="reference" href="#compile-time-options" id="id108" name="id108">Compile-time options</a></li>
<li><a class="reference" href="#gnu-general-public-license" id="id109" name="id109">GNU General Public License</a></li>
<li><a class="reference" href="#license-for-scintilla-and-scite" id="id110" name="id110">License for Scintilla and SciTE</a></li>
</ul>
</div>
<div class="section">
@ -790,24 +791,46 @@ 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="#id27" id="auto-indentation" name="auto-indentation">Auto indentation</a></h3>
<p>Geany knows four types of auto indentation:</p>
<h3><a class="toc-backref" href="#id27" id="indentation" name="indentation">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-tab-in-preferences-dialog">Editor
tab in preferences dialog</a>. But this can be overridden using either
the <em>Document-&gt;Indent Type</em> menu, or by using the <em>Detect from file</em>
indentation preference. When enabled, this scans each file that is opened
and sets the indent mode based on how many lines start with a tab vs. 2
or more spaces.</p>
<p>The indent mode for the current document is shown on the status bar
as follows:</p>
<dl class="docutils">
<dt>TAB</dt>
<dd>Indent with Tab characters.</dd>
<dt>SP</dt>
<dd>Indent with spaces.</dd>
</dl>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id28" id="auto-indentation" name="auto-indentation">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>
<dl class="docutils">
<dt>None</dt>
<dd>Disables auto indentation completely.</dd>
<dd>Disables auto-indentation completely.</dd>
<dt>Basic</dt>
<dd>Adds the same amount of whitespace on a new line as on the last line.</dd>
<dt>Current chars</dt>
<dd>Does the same as <em>Basic</em> but also indents a new line after an opening
brace '{', and de-indents when typing a closing brace '}'. For Python,
a new line will be indented after typing ':' at the end of a line.</dd>
a new line will be indented after typing ':' at the end of the
previous line.</dd>
<dt>Match braces</dt>
<dd>Similar to <em>Current chars</em> but the closing brace will be aligned to
match the indentation of the line with the opening brace.</dd>
</dl>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id28" id="bookmarks" name="bookmarks">Bookmarks</a></h3>
<h3><a class="toc-backref" href="#id29" id="bookmarks" name="bookmarks">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>
@ -825,7 +848,7 @@ together with the commands to switch from one editor tab to another
navigate around multiple files.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id29" id="code-navigation-history" name="code-navigation-history">Code Navigation History</a></h3>
<h3><a class="toc-backref" href="#id30" id="code-navigation-history" name="code-navigation-history">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 when using the <a class="reference" href="#go-to-tag-declaration">Go to tag declaration</a>,
@ -839,7 +862,7 @@ location&quot;. 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="#id30" id="send-text-through-definable-commands" name="send-text-through-definable-commands">Send text through definable commands</a></h3>
<h3><a class="toc-backref" href="#id31" id="send-text-through-definable-commands" name="send-text-through-definable-commands">Send text through definable 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
@ -856,7 +879,7 @@ 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="#id31" id="context-actions" name="context-actions">Context actions</a></h3>
<h3><a class="toc-backref" href="#id32" 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
@ -882,7 +905,7 @@ the word &quot;echo&quot;, 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>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id32" id="user-definable-snippets" name="user-definable-snippets">User-definable snippets</a></h3>
<h3><a class="toc-backref" href="#id33" id="user-definable-snippets" name="user-definable-snippets">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.
@ -969,7 +992,7 @@ default characters or define it to add or remove characters to fit your
needs.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id33" id="inserting-unicode-characters" name="inserting-unicode-characters">Inserting unicode characters</a></h3>
<h3><a class="toc-backref" href="#id34" id="inserting-unicode-characters" name="inserting-unicode-characters">Inserting unicode characters</a></h3>
<p>With GTK 2.10 and above, you can hit Ctrl-Shift-u, then still holding
Ctrl-Shift, type some hex digits representing the code point for the
character you want, then let go of Ctrl-Shift and hit a key such as
@ -985,7 +1008,7 @@ keys conflict with other Geany keybindings.</p>
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id34" id="search-replace-and-go-to" name="search-replace-and-go-to">Search, replace and go to</a></h2>
<h2><a class="toc-backref" href="#id35" id="search-replace-and-go-to" name="search-replace-and-go-to">Search, replace and go to</a></h2>
<p>This section describes search-related commands from the Search menu
and the editor window's popup menu:</p>
<ul class="simple">
@ -1000,11 +1023,11 @@ and the editor window's popup menu:</p>
<p>* These items are available from the editor window's popup menu, or by
using a keyboard shortcut (see the section called <a class="reference" href="#keybindings">Keybindings</a>).</p>
<div class="section">
<h3><a class="toc-backref" href="#id35" id="find" name="find">Find</a></h3>
<h3><a class="toc-backref" href="#id36" id="find" name="find">Find</a></h3>
<p>The Find dialog is used for finding text in one or more open documents.</p>
<img alt="./images/find_dialog.png" src="./images/find_dialog.png" />
<div class="section">
<h4><a class="toc-backref" href="#id36" id="matching-options" name="matching-options">Matching options</a></h4>
<h4><a class="toc-backref" href="#id37" id="matching-options" name="matching-options">Matching options</a></h4>
<p>The syntax for the Use regular expressions option is shown in
<a class="reference" href="#regular-expressions">Regular expressions</a>.</p>
<p>The Use escape sequences option will transform any escaped characters
@ -1013,7 +1036,7 @@ a tab character. Other recognised symbols are: \\, \n, \r, \uXXXX
(Unicode chararacters).</p>
</div>
<div class="section">
<h4><a class="toc-backref" href="#id37" id="find-all" name="find-all">Find all</a></h4>
<h4><a class="toc-backref" href="#id38" id="find-all" name="find-all">Find all</a></h4>
<p>To find all matches, click on the Find All expander. This will reveal
several options:</p>
<ul class="simple">
@ -1031,7 +1054,7 @@ removed by selecting the Remove Markers command from the Document menu.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id38" id="find-usage" name="find-usage">Find usage</a></h3>
<h3><a class="toc-backref" href="#id39" id="find-usage" name="find-usage">Find usage</a></h3>
<p>Find usage searches all open files. It is similar to the Find All In
Session Find dialog command.</p>
<p>If there is a selection, then it is used as the search text; otherwise
@ -1041,7 +1064,7 @@ click position when the popup menu is used. The search results are
shown in the Messages tab of the Message Window.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id39" id="find-in-files" name="find-in-files">Find in files</a></h3>
<h3><a class="toc-backref" href="#id40" id="find-in-files" name="find-in-files">Find in files</a></h3>
<p>Find in files is a more powerful version of Find usage that searches
all files in a certain directory using the Grep tool. The Grep tool
must be correctly set in Preferences to the path of the system's Grep
@ -1050,7 +1073,7 @@ utility. GNU Grep is recommended.</p>
<p>The Extra options field is used to pass any additional arguments to
the grep tool.</p>
<div class="section">
<h4><a class="toc-backref" href="#id40" id="filtering-out-version-control-files" name="filtering-out-version-control-files">Filtering out version control files</a></h4>
<h4><a class="toc-backref" href="#id41" id="filtering-out-version-control-files" name="filtering-out-version-control-files">Filtering out version control files</a></h4>
<p>When using the <em>Recurse in subfolders</em> option with a directory that's
under version control, you can set the <em>Extra options</em> field to use
grep's <tt class="docutils literal"><span class="pre">--exclude</span></tt> flag to filter out filenames.</p>
@ -1066,7 +1089,7 @@ see if your version supports it.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id41" id="replace" name="replace">Replace</a></h3>
<h3><a class="toc-backref" href="#id42" id="replace" name="replace">Replace</a></h3>
<p>The Replace dialog is used for replacing text in one or more open
documents.</p>
<img alt="./images/replace_dialog.png" src="./images/replace_dialog.png" />
@ -1076,7 +1099,7 @@ dialog. See the section called <a class="reference" href="#matching-options">Mat
and to the replacement text; for the latter back references can be
used -- see the entry for '\n' in <a class="reference" href="#regular-expressions">Regular expressions</a>.</p>
<div class="section">
<h4><a class="toc-backref" href="#id42" id="replace-all" name="replace-all">Replace all</a></h4>
<h4><a class="toc-backref" href="#id43" id="replace-all" name="replace-all">Replace all</a></h4>
<p>To replace several matches, click on the <em>Replace All</em> expander. This
will reveal several options:</p>
<ul class="simple">
@ -1091,7 +1114,7 @@ in the current selection of the current document.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id43" id="go-to-tag-definition" name="go-to-tag-definition">Go to tag definition</a></h3>
<h3><a class="toc-backref" href="#id44" id="go-to-tag-definition" name="go-to-tag-definition">Go to tag definition</a></h3>
<p>If the current word is the name of a tag definition (like a function
body) and the file containing the tag definition is open, this command
will switch to that file and go to the corresponding line number. The
@ -1100,17 +1123,17 @@ or the word underneath the popup menu click position when the popup
menu is used.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id44" id="go-to-tag-declaration" name="go-to-tag-declaration">Go to tag declaration</a></h3>
<h3><a class="toc-backref" href="#id45" id="go-to-tag-declaration" name="go-to-tag-declaration">Go to tag declaration</a></h3>
<p>Like Go to tag definition, but for a forward declaration such as a
function prototype or <tt class="docutils literal"><span class="pre">extern</span></tt> declaration instead of a function
body.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id45" id="go-to-line" name="go-to-line">Go to line</a></h3>
<h3><a class="toc-backref" href="#id46" id="go-to-line" name="go-to-line">Go to line</a></h3>
<p>Go to a particular line number in the current file.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id46" id="regular-expressions" name="regular-expressions">Regular expressions</a></h3>
<h3><a class="toc-backref" href="#id47" id="regular-expressions" name="regular-expressions">Regular expressions</a></h3>
<p>You can use regular expressions in the Find and Replace dialogs
by selecting the Use regular expressions check box. The syntax is
POSIX-like, as described below in <a class="reference" href="#regular-expressions">Regular expressions</a>.</p>
@ -1179,14 +1202,14 @@ Saam, Saaam and so on.</td>
</tbody>
</table>
<div class="section">
<h4><a class="toc-backref" href="#id47" id="partial-posix-compatibility" name="partial-posix-compatibility">Partial POSIX compatibility</a></h4>
<h4><a class="toc-backref" href="#id48" id="partial-posix-compatibility" name="partial-posix-compatibility">Partial POSIX compatibility</a></h4>
<p>Note that the POSIX '?' regular expression character for optional
matching is not supported by the Find and Replace dialogs.</p>
</div>
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id48" id="tags" name="tags">Tags</a></h2>
<h2><a class="toc-backref" href="#id49" id="tags" name="tags">Tags</a></h2>
<p>Geany has built-in functionality for generating tag information (aka
&quot;workspace tags&quot;) for supported filetypes when you open a file. You
can also have Geany automatically load external tag files (aka &quot;global
@ -1196,7 +1219,7 @@ manually using <em>File --&gt; Load Tags</em>.</p>
(but is incompatible with ctags). You use Geany to generate global
tags files, as described below.</p>
<div class="section">
<h3><a class="toc-backref" href="#id49" id="workspace-tags" name="workspace-tags">Workspace tags</a></h3>
<h3><a class="toc-backref" href="#id50" id="workspace-tags" name="workspace-tags">Workspace tags</a></h3>
<p>Tags for each document are parsed whenever a file is loaded or
saved. These are shown in the Symbol list in the Sidebar. These tags
are also used for autocompletion of symbols and calltips for all documents
@ -1205,7 +1228,7 @@ open in the current session that have the same filetype.</p>
<a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id50" id="global-tags" name="global-tags">Global tags</a></h3>
<h3><a class="toc-backref" href="#id51" id="global-tags" name="global-tags">Global tags</a></h3>
<p>Global tags are used to provide autocompletion of symbols and calltips
without having to open the corresponding source files. This is intended
for library APIs, as the tags file only has to be updated when you upgrade
@ -1225,7 +1248,7 @@ name.lang_ext.tags
with the tags. See the section called <a class="reference" href="#filetype-extensions">Filetype extensions</a> for
more information.</p>
<div class="section">
<h4><a class="toc-backref" href="#id51" id="default-global-tags-files" name="default-global-tags-files">Default global tags files</a></h4>
<h4><a class="toc-backref" href="#id52" id="default-global-tags-files" name="default-global-tags-files">Default global tags files</a></h4>
<p>For some languages, a list of global tags is loaded when the
corresponding filetype is first used. Currently these are for:</p>
<ul class="simple">
@ -1237,7 +1260,7 @@ corresponding filetype is first used. Currently these are for:</p>
</ul>
</div>
<div class="section">
<h4><a class="toc-backref" href="#id52" id="generating-a-global-tags-file" name="generating-a-global-tags-file">Generating a global tags file</a></h4>
<h4><a class="toc-backref" href="#id53" id="generating-a-global-tags-file" name="generating-a-global-tags-file">Generating a global tags file</a></h4>
<p><em>Filetypes support:</em></p>
<p>Currently this is not yet supported for Pascal, PHP and LaTeX
filetypes.</p>
@ -1286,7 +1309,7 @@ upgrading Geany.</p>
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id53" id="preferences" name="preferences">Preferences</a></h2>
<h2><a class="toc-backref" href="#id54" id="preferences" name="preferences">Preferences</a></h2>
<p>You may adjust Geany's settings using the Edit --&gt; Preferences
dialog. Any changes you make there can be applied by hitting either
the Apply or the Ok button. These settings will persist between Geany
@ -1304,12 +1327,12 @@ when restarting Geany.</p>
(if present) comes after the screenshot of that tab.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id54" id="general-tab-in-preferences-dialog" name="general-tab-in-preferences-dialog">General tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id55" id="general-tab-in-preferences-dialog" name="general-tab-in-preferences-dialog">General tab in preferences dialog</a></h3>
<p>General tab in preferences dialog</p>
<img alt="./images/pref_dialog_gen.png" src="./images/pref_dialog_gen.png" />
</div>
<div class="section">
<h3><a class="toc-backref" href="#id55" id="interface-tab-in-preferences-dialog" name="interface-tab-in-preferences-dialog">Interface tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id56" id="interface-tab-in-preferences-dialog" name="interface-tab-in-preferences-dialog">Interface tab in preferences dialog</a></h3>
<p>Interface tab in preferences dialog</p>
<img alt="./images/pref_dialog_interface.png" src="./images/pref_dialog_interface.png" />
<p>The documents list and the editor tabs are two different ways
@ -1319,17 +1342,17 @@ order, not alphabetical as shown in the documents list (regardless
whether or not editor tabs are visible).</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id56" id="toolbar-tab-in-preferences-dialog" name="toolbar-tab-in-preferences-dialog">Toolbar tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id57" id="toolbar-tab-in-preferences-dialog" name="toolbar-tab-in-preferences-dialog">Toolbar tab in preferences dialog</a></h3>
<p>Toolbar tab in preferences dialog</p>
<img alt="./images/pref_dialog_toolbar.png" src="./images/pref_dialog_toolbar.png" />
</div>
<div class="section">
<h3><a class="toc-backref" href="#id57" id="display-tab-in-preferences-dialog" name="display-tab-in-preferences-dialog">Display tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id58" id="display-tab-in-preferences-dialog" name="display-tab-in-preferences-dialog">Display tab in preferences dialog</a></h3>
<p>This is for visual elements displayed in the editor window.</p>
<!-- Display tab in preferences dialog (TODO) -->
</div>
<div class="section">
<h3><a class="toc-backref" href="#id58" id="editor-tab-in-preferences-dialog" name="editor-tab-in-preferences-dialog">Editor tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id59" id="editor-tab-in-preferences-dialog" name="editor-tab-in-preferences-dialog">Editor tab in preferences dialog</a></h3>
<p>Editor tab in preferences dialog</p>
<img alt="./images/pref_dialog_edit.png" src="./images/pref_dialog_edit.png" />
<p>Line wrapping refers to the display of the text in the
@ -1337,22 +1360,22 @@ editor. (Currently, there is no setting to have Geany automatically
insert newlines into your document while you type.)</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id59" id="files-tab-in-preferences-dialog" name="files-tab-in-preferences-dialog">Files tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id60" id="files-tab-in-preferences-dialog" name="files-tab-in-preferences-dialog">Files tab in preferences dialog</a></h3>
<p>Files tab in preferences dialog</p>
<img alt="./images/pref_dialog_files.png" src="./images/pref_dialog_files.png" />
</div>
<div class="section">
<h3><a class="toc-backref" href="#id60" id="tools-tab-in-preferences-dialog" name="tools-tab-in-preferences-dialog">Tools tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id61" id="tools-tab-in-preferences-dialog" name="tools-tab-in-preferences-dialog">Tools tab in preferences dialog</a></h3>
<p>Tools tab in preferences dialog</p>
<img alt="./images/pref_dialog_tools.png" src="./images/pref_dialog_tools.png" />
</div>
<div class="section">
<h3><a class="toc-backref" href="#id61" id="template-tab-in-preferences-dialog" name="template-tab-in-preferences-dialog">Template tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id62" id="template-tab-in-preferences-dialog" name="template-tab-in-preferences-dialog">Template tab in preferences dialog</a></h3>
<p>Template tab in preferences dialog</p>
<img alt="./images/pref_dialog_templ.png" src="./images/pref_dialog_templ.png" />
</div>
<div class="section">
<h3><a class="toc-backref" href="#id62" id="keybinding-tab-in-preferences-dialog" name="keybinding-tab-in-preferences-dialog">Keybinding tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id63" id="keybinding-tab-in-preferences-dialog" name="keybinding-tab-in-preferences-dialog">Keybinding tab in preferences dialog</a></h3>
<p>Keybinding tab in preferences dialog</p>
<img alt="./images/pref_dialog_keys.png" src="./images/pref_dialog_keys.png" />
<p>There are some handy commands in here that are not, by default,
@ -1363,13 +1386,13 @@ bound to a key combination, and may not be available as a menu item.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id63" id="vte-tab-in-preferences-dialog" name="vte-tab-in-preferences-dialog">VTE tab in preferences dialog</a></h3>
<h3><a class="toc-backref" href="#id64" id="vte-tab-in-preferences-dialog" name="vte-tab-in-preferences-dialog">VTE tab in preferences dialog</a></h3>
<p>VTE tab in preferences dialog</p>
<img alt="./images/pref_dialog_vte.png" src="./images/pref_dialog_vte.png" />
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id64" id="project-management" name="project-management">Project Management</a></h2>
<h2><a class="toc-backref" href="#id65" id="project-management" name="project-management">Project Management</a></h2>
<p>Project Management is optional in Geany. Currently it can be used for:</p>
<ul class="simple">
<li>Running <em>Make</em> from the project's base directory.</li>
@ -1382,7 +1405,7 @@ whichever document is currently displayed.</p>
Geany is shutdown. When restarting Geany, the previously opened project
file that was in use at the end of the last session will be reopened.</p>
<div class="section">
<h3><a class="toc-backref" href="#id65" id="new-project" name="new-project">New Project</a></h3>
<h3><a class="toc-backref" href="#id66" id="new-project" name="new-project">New Project</a></h3>
<p>To create a new project, fill in the <em>Name</em> field. By default this
will setup a new project file <tt class="docutils literal"><span class="pre">~/projects/name.geany</span></tt>. Usually it's
best to store all your project files in the same directory (they are
@ -1392,7 +1415,7 @@ can safely be set to any existing path -- it will not touch the file
structure contained in it.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id66" id="project-properties" name="project-properties">Project Properties</a></h3>
<h3><a class="toc-backref" href="#id67" id="project-properties" name="project-properties">Project Properties</a></h3>
<p>You can set an optional description for the project, but it is not
used elsewhere by Geany.</p>
<p>The <em>Base path</em> field is used as the directory to run the Make and Make
@ -1401,13 +1424,13 @@ specific <em>Run command</em>.
The specified path can be an absolute path or relative to the project's
file name.</p>
<div class="section">
<h4><a class="toc-backref" href="#id67" id="make-in-base-path" name="make-in-base-path">Make in base path</a></h4>
<h4><a class="toc-backref" href="#id68" id="make-in-base-path" name="make-in-base-path">Make in base path</a></h4>
<p>This setting makes the <em>Build-&gt;Make</em> command use the project's base
path. Uncheck this if you want to use the current file's directory
instead.</p>
</div>
<div class="section">
<h4><a class="toc-backref" href="#id68" id="run-command" name="run-command">Run command</a></h4>
<h4><a class="toc-backref" href="#id69" id="run-command" name="run-command">Run command</a></h4>
<p>The <em>Run command</em> overrides the default run command. You can set this
to the executable or main script file for the project, and append
any command-line arguments.</p>
@ -1420,17 +1443,17 @@ any command-line arguments.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id69" id="close-project" name="close-project">Close Project</a></h3>
<h3><a class="toc-backref" href="#id70" id="close-project" name="close-project">Close Project</a></h3>
<p>Project file settings are saved when the project is closed.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id70" id="open-project" name="open-project">Open Project</a></h3>
<h3><a class="toc-backref" href="#id71" id="open-project" name="open-project">Open Project</a></h3>
<p>The Open command displays a standard file chooser, starting in
<tt class="docutils literal"><span class="pre">~/projects</span></tt>.</p>
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id71" id="build-system" name="build-system">Build system</a></h2>
<h2><a class="toc-backref" href="#id72" id="build-system" name="build-system">Build system</a></h2>
<p>Geany has an integrated build system. Firstly this means that the
current source file will be saved before it is processed. This is
for convenience so that you don't need to keep saving small changes
@ -1454,7 +1477,7 @@ the following items:</p>
<li>Set Includes and Arguments</li>
</ul>
<div class="section">
<h3><a class="toc-backref" href="#id72" id="compile" name="compile">Compile</a></h3>
<h3><a class="toc-backref" href="#id73" id="compile" name="compile">Compile</a></h3>
<p>The Compile command has different uses for different kinds of files.</p>
<p>For compilable languages such as C and C++, the Compile command is
setup to compile the current source file into a binary object file.</p>
@ -1464,7 +1487,7 @@ language supports it, or will run a syntax check, or failing that
will run the file in its language interpreter.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id73" id="build" name="build">Build</a></h3>
<h3><a class="toc-backref" href="#id74" id="build" name="build">Build</a></h3>
<p>For compilable languages such as C and C++, the Build command will link
the current source file's equivalent object file into an executable. If
the object file does not exist, the source will be compiled and linked
@ -1472,7 +1495,7 @@ in one step, producing just the executable binary.</p>
<p>Interpreted languages do not use the Build command.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id74" id="make-all" name="make-all">Make all</a></h3>
<h3><a class="toc-backref" href="#id75" id="make-all" name="make-all">Make all</a></h3>
<p>This effectively runs &quot;make all&quot; in the same directory as the
current file.</p>
<div class="note">
@ -1482,19 +1505,19 @@ set in the Tools tab of the Preferences dialog.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id75" id="make-custom-target" name="make-custom-target">Make custom target</a></h3>
<h3><a class="toc-backref" href="#id76" id="make-custom-target" name="make-custom-target">Make custom target</a></h3>
<p>This is similar to running 'Make all' but you will be prompted for
the make target name to be passed to the Make tool. For example,
typing 'clean' in the dialog prompt will run &quot;make clean&quot;.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id76" id="make-object" name="make-object">Make object</a></h3>
<h3><a class="toc-backref" href="#id77" id="make-object" name="make-object">Make object</a></h3>
<p>Make object will run &quot;make current_file.o&quot; in the same directory as
the current file, using its prefix for 'current_file'. It is useful
for compiling just the current file without building the whole project.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id77" id="execute" name="execute">Execute</a></h3>
<h3><a class="toc-backref" href="#id78" id="execute" name="execute">Execute</a></h3>
<p>Execute will run the corresponding executable file, shell script or
interpreted script in a terminal window. Note that the Terminal tool
path must be correctly set in the Tools tab of the Preferences dialog -
@ -1505,7 +1528,7 @@ prompted to press the return key. This allows you to review any text
output from the program before the terminal window is closed.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id78" id="stopping-running-processes" name="stopping-running-processes">Stopping running processes</a></h3>
<h3><a class="toc-backref" href="#id79" id="stopping-running-processes" name="stopping-running-processes">Stopping running processes</a></h3>
<p>When there is a running program, the Run button in the toolbar
becomes a stop button and you can stop the current action. This
works by sending a signal to the process (and its child process(es))
@ -1514,7 +1537,7 @@ to stop the process. The used signal is SIGQUIT.</p>
cannot be stopped. This can happen when the process creates more than
one child process.</p>
<div class="section">
<h4><a class="toc-backref" href="#id79" id="terminal-emulators" name="terminal-emulators">Terminal emulators</a></h4>
<h4><a class="toc-backref" href="#id80" id="terminal-emulators" name="terminal-emulators">Terminal emulators</a></h4>
<p>Xterm is known to work properly. If you are using &quot;Terminal&quot;
(the terminal program of Xfce), you should add the command line
option <tt class="docutils literal"><span class="pre">--disable-server</span></tt> otherwise the started process cannot be
@ -1523,7 +1546,7 @@ tab in the terminal field.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id80" id="set-includes-and-arguments" name="set-includes-and-arguments">Set Includes and Arguments</a></h3>
<h3><a class="toc-backref" href="#id81" id="set-includes-and-arguments" name="set-includes-and-arguments">Set Includes and Arguments</a></h3>
<p>By default the Compile and Build commands invoke the compiler and
linker with only the basic arguments needed by all programs. Using
Set Includes and Arguments you can add any include paths and compile
@ -1540,14 +1563,14 @@ and any arguments you want to use when running Execute.</p>
different settings, then writing a Makefile and using the Make commands
is recommended.</p>
<div class="section">
<h4><a class="toc-backref" href="#id81" id="one-step-compilation" name="one-step-compilation">One step compilation</a></h4>
<h4><a class="toc-backref" href="#id82" id="one-step-compilation" name="one-step-compilation">One step compilation</a></h4>
<p>If you are using the Build command to compile and link in one step,
you will need to set both the compiler arguments and the linker
arguments in the linker command setting.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id82" id="indicators" name="indicators">Indicators</a></h3>
<h3><a class="toc-backref" href="#id83" id="indicators" name="indicators">Indicators</a></h3>
<p>Indicators are red squiggly underlines which are used to highlight
errors which occured while compiling the current file. So you can
easily see where your code failed to compile. To remove the indicators,
@ -1557,7 +1580,7 @@ dialog.</p>
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id83" id="printing-support" name="printing-support">Printing support</a></h2>
<h2><a class="toc-backref" href="#id84" id="printing-support" name="printing-support">Printing support</a></h2>
<p>Since Geany 0.13 there is full printing support using GTK's printing API.
The printed page(s) will look nearly the same as on your screen in Geany.
Additionally, there are some options to modify the printed page(s). You
@ -1605,7 +1628,7 @@ command line).</p>
gtklp or similar programs can be used.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id84" id="plugins" name="plugins">Plugins</a></h2>
<h2><a class="toc-backref" href="#id85" id="plugins" name="plugins">Plugins</a></h2>
<p>Plugins are loaded at startup, if the <em>Enable plugin support</em>
general preference is set. There is also a command-line option,
<tt class="docutils literal"><span class="pre">-p</span></tt>, which prevents plugins being loaded. Plugins are scanned in
@ -1625,13 +1648,13 @@ You can also configure some plugin specific options when the plugin
provides some.</p>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id85" id="keybindings" name="keybindings">Keybindings</a></h2>
<h2><a class="toc-backref" href="#id86" id="keybindings" name="keybindings">Keybindings</a></h2>
<p>Geany supports the default keyboard shortcuts for the Scintilla
editing widget. For a list of these commands, see <a class="reference" href="#scintilla-keyboard-commands">Scintilla
keyboard commands</a>. The Scintilla keyboard shortcuts will be overridden
by any custom keybindings with the same keyboard shortcut.</p>
<div class="section">
<h3><a class="toc-backref" href="#id86" id="switching-documents" name="switching-documents">Switching documents</a></h3>
<h3><a class="toc-backref" href="#id87" id="switching-documents" name="switching-documents">Switching documents</a></h3>
<p>There are a few non-configurable bindings to switch between documents,
listed below. These can also be overridden by custom keybindings.</p>
<table border="1" class="docutils">
@ -1661,7 +1684,7 @@ listed below. These can also be overridden by custom keybindings.</p>
</table>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id87" id="configurable-keybindings" name="configurable-keybindings">Configurable keybindings</a></h3>
<h3><a class="toc-backref" href="#id88" id="configurable-keybindings" name="configurable-keybindings">Configurable keybindings</a></h3>
<p>For all actions listed below you can define your own keybindings. Open
the Preferences dialog, select the desired action and click on
change. In the opening dialog you can press any key combination you
@ -2051,9 +2074,9 @@ actions</a>.</td>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id88" id="configuration-files" name="configuration-files">Configuration files</a></h1>
<h1><a class="toc-backref" href="#id89" id="configuration-files" name="configuration-files">Configuration files</a></h1>
<div class="section">
<h2><a class="toc-backref" href="#id89" id="global-configuration-file" name="global-configuration-file">Global configuration file</a></h2>
<h2><a class="toc-backref" href="#id90" id="global-configuration-file" name="global-configuration-file">Global configuration file</a></h2>
<p>You can use a global configuration file for Geany which will be used if
the user starts Geany for the first time and an user's configuration
file was not yet created or in case an user deleted the configuration
@ -2073,7 +2096,7 @@ need to do that.</p>
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id90" id="filetype-definition-files" name="filetype-definition-files">Filetype definition files</a></h2>
<h2><a class="toc-backref" href="#id91" id="filetype-definition-files" name="filetype-definition-files">Filetype definition files</a></h2>
<p>All colour definitions and other filetype specific settings are
stored in the filetype definition files. Those settings are colours
for syntax highlighting, general settings like comment characters or
@ -2101,9 +2124,9 @@ configuration directory. Alternatively, you can create a file
to change. All missing settings will be read from the corresponding
global definition file in <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt>.</p>
<div class="section">
<h3><a class="toc-backref" href="#id91" id="format" name="format">Format</a></h3>
<h3><a class="toc-backref" href="#id92" id="format" name="format">Format</a></h3>
<div class="section">
<h4><a class="toc-backref" href="#id92" id="styling-section" name="styling-section">[styling] Section</a></h4>
<h4><a class="toc-backref" href="#id93" id="styling-section" name="styling-section">[styling] Section</a></h4>
<p>In this section the colours for syntax highlighting are defined. The
format is always: key=forground_colour;background_colour;bold;italic</p>
<p>Colours have to be specified as RGB hex values prefixed by
@ -2113,7 +2136,7 @@ and italic are flags and should only be &quot;true&quot; or &quot;false&quot;. I
value is something other than &quot;true&quot; or &quot;false&quot;, &quot;false&quot; is assumed.</p>
</div>
<div class="section">
<h4><a class="toc-backref" href="#id93" id="keywords-section" name="keywords-section">[keywords] Section</a></h4>
<h4><a class="toc-backref" href="#id94" id="keywords-section" name="keywords-section">[keywords] Section</a></h4>
<p>This section contains keys for different keyword lists specific to
the filetype. Some filetypes do not support keywords, so adding a
new key will not work. You can only add or remove keywords to/from
@ -2124,7 +2147,7 @@ an existing list.</p>
</div>
</div>
<div class="section">
<h4><a class="toc-backref" href="#id94" id="settings-section" name="settings-section">[settings] Section</a></h4>
<h4><a class="toc-backref" href="#id95" id="settings-section" name="settings-section">[settings] Section</a></h4>
<dl class="docutils">
<dt>extension</dt>
<dd><p class="first">This is the default file extension used when saving files, not
@ -2185,7 +2208,7 @@ context_action_cmd=firefox &quot;<a class="reference" href="http://www.php.net/%
</dl>
</div>
<div class="section">
<h4><a class="toc-backref" href="#id95" id="build-settings-section" name="build-settings-section">[build_settings] Section</a></h4>
<h4><a class="toc-backref" href="#id96" id="build-settings-section" name="build-settings-section">[build_settings] Section</a></h4>
<dl class="docutils">
<dt>compiler</dt>
<dd><p class="first">This item specifies the command to compile source code files. But
@ -2218,7 +2241,7 @@ complete filename, e.g. for shell scripts.</p>
</div>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id96" id="special-file-filetypes-common" name="special-file-filetypes-common">Special file filetypes.common</a></h3>
<h3><a class="toc-backref" href="#id97" id="special-file-filetypes-common" name="special-file-filetypes-common">Special file filetypes.common</a></h3>
<p>There is a special filetype definition file called
filetypes.common. This file defines some general non-filetype-specific
settings.</p>
@ -2328,7 +2351,7 @@ when moving, selecting and deleting across word boundaries
</div>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id97" id="filetype-extensions" name="filetype-extensions">Filetype extensions</a></h2>
<h2><a class="toc-backref" href="#id98" id="filetype-extensions" name="filetype-extensions">Filetype extensions</a></h2>
<p>To change the default filetype extension used when saving a new file,
see <a class="reference" href="#filetype-definition-files">Filetype definition files</a>.</p>
<p>You can override the list of file extensions that Geany uses for each
@ -2354,7 +2377,7 @@ Make=Makefile*;*.mk;Buildfile;
</pre>
</div>
<div class="section">
<h2><a class="toc-backref" href="#id98" id="templates" name="templates">Templates</a></h2>
<h2><a class="toc-backref" href="#id99" id="templates" name="templates">Templates</a></h2>
<p>Geany supports the following templates:</p>
<ul class="simple">
<li>ChangeLog entry</li>
@ -2377,7 +2400,7 @@ of a function or the function name cannot be determined, the inserted
function description won't contain the correct function name but &quot;unknown&quot;
instead.</p>
<div class="section">
<h3><a class="toc-backref" href="#id99" id="template-metadata" name="template-metadata">Template metadata</a></h3>
<h3><a class="toc-backref" href="#id100" id="template-metadata" name="template-metadata">Template metadata</a></h3>
<p>Metadata can be used with all templates, but by default user set
metadata is only used for the ChangeLog and File header templates.</p>
<p>In the configuration dialog you can find a tab &quot;Templates&quot; (see
@ -2387,7 +2410,7 @@ restart Geany after making changes, because they are only read
at startup.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id100" id="filetype-templates" name="filetype-templates">Filetype templates</a></h3>
<h3><a class="toc-backref" href="#id101" id="filetype-templates" name="filetype-templates">Filetype templates</a></h3>
<p>Filetype templates are templates used as the basis of a new file. To
use them, choose the <em>New (with Template)</em> menu item from the <em>File</em>
menu.</p>
@ -2408,7 +2431,7 @@ followed by a blank line.</p>
the New command is used without a filetype. This is empty by default.</p>
</div>
<div class="section">
<h3><a class="toc-backref" href="#id101" id="customizing-templates" name="customizing-templates">Customizing templates</a></h3>
<h3><a class="toc-backref" href="#id102" id="customizing-templates" name="customizing-templates">Customizing templates</a></h3>
<p>Each template can be customized to your needs. The templates are
stored in the <tt class="docutils literal"><span class="pre">~/.geany/templates/</span></tt> directory (see the section called
<a class="reference" href="#command-line-options">Command line options</a> for further information about the configuration
@ -2416,7 +2439,7 @@ directory). Just open the desired template with an editor (ideally,
Geany ;-) ) and edit the template to your needs. There are some
wildcards which will be automatically replaced by Geany at startup.</p>
<div class="section">
<h4><a class="toc-backref" href="#id102" id="template-wildcards" name="template-wildcards">Template wildcards</a></h4>
<h4><a class="toc-backref" href="#id103" id="template-wildcards" name="template-wildcards">Template wildcards</a></h4>
<p>All wildcards must be enclosed by &quot;{&quot; and &quot;}&quot;, e.g. {date}.</p>
<table border="1" class="docutils">
<colgroup>
@ -2525,7 +2548,7 @@ templates.</td>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id103" id="contributing-to-this-document" name="contributing-to-this-document">Contributing to this document</a></h1>
<h1><a class="toc-backref" href="#id104" id="contributing-to-this-document" name="contributing-to-this-document">Contributing to this document</a></h1>
<p>This document (<tt class="docutils literal"><span class="pre">geany.txt</span></tt>) is written in <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>
(or &quot;reST&quot;). The source file for it is located in Geany's <tt class="docutils literal"><span class="pre">doc</span></tt>
subdirectory. If you intend on making changes, you should grab the
@ -2545,7 +2568,7 @@ to build the docs. The package is named <tt class="docutils literal"><span class
and Fedora systems.</p>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id104" id="scintilla-keyboard-commands" name="scintilla-keyboard-commands">Scintilla keyboard commands</a></h1>
<h1><a class="toc-backref" href="#id105" id="scintilla-keyboard-commands" name="scintilla-keyboard-commands">Scintilla keyboard commands</a></h1>
<p>Copyright © 1998, 2006 Neil Hodgson &lt;neilh(at)scintilla(dot)org&gt;</p>
<p>This appendix is distributed under the terms of the License for
Scintilla and SciTE. A copy of this license can be found in the file
@ -2554,7 +2577,7 @@ program and in the appendix of this document. See <a class="reference" href="#li
Scintilla and SciTE</a>.</p>
<p>20 June 2006</p>
<div class="section">
<h2><a class="toc-backref" href="#id105" id="keyboard-commands" name="keyboard-commands">Keyboard commands</a></h2>
<h2><a class="toc-backref" href="#id106" id="keyboard-commands" name="keyboard-commands">Keyboard commands</a></h2>
<p>Keyboard commands for Scintilla mostly follow common Windows and GTK+
conventions. All move keys (arrows, page up/down, home and end)
allows to extend or reduce the stream selection when holding the
@ -2654,7 +2677,7 @@ menus. Some less common commands with no menu equivalent are:</p>
</div>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id106" id="hidden-preferences" name="hidden-preferences">Hidden preferences</a></h1>
<h1><a class="toc-backref" href="#id107" id="hidden-preferences" name="hidden-preferences">Hidden preferences</a></h1>
<p>There are some uncommon preferences that are not shown in the Preferences
dialog. These can be set by editing <tt class="docutils literal"><span class="pre">~/.geany/geany.conf</span></tt>, then
restarting Geany. Search for the key name, then edit the value. Example:</p>
@ -2719,7 +2742,7 @@ available with GTK 2.12 or above).</td>
</table>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id107" id="compile-time-options" name="compile-time-options">Compile-time options</a></h1>
<h1><a class="toc-backref" href="#id108" id="compile-time-options" name="compile-time-options">Compile-time options</a></h1>
<p>There are some options which can only be changed at compile time. To
change these options, edit the file src/geany.h. Look for a block of
lines starting with <tt class="docutils literal"><span class="pre">#define</span> <span class="pre">GEANY_*</span></tt>. Any definitions which are
@ -2869,7 +2892,7 @@ when building on a non-Win32 system.</em></td>
</table>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id108" id="gnu-general-public-license" name="gnu-general-public-license">GNU General Public License</a></h1>
<h1><a class="toc-backref" href="#id109" id="gnu-general-public-license" name="gnu-general-public-license">GNU General Public License</a></h1>
<pre class="literal-block">
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
@ -3214,7 +3237,7 @@ Public License instead of this License.
</pre>
</div>
<div class="section">
<h1><a class="toc-backref" href="#id109" id="license-for-scintilla-and-scite" name="license-for-scintilla-and-scite">License for Scintilla and SciTE</a></h1>
<h1><a class="toc-backref" href="#id110" id="license-for-scintilla-and-scite" name="license-for-scintilla-and-scite">License for Scintilla and SciTE</a></h1>
<p>Copyright 1998-2003 by Neil Hodgson &lt;neilh(at)scintilla(dot)org&gt;</p>
<p>All Rights Reserved</p>
<p>Permission to use, copy, modify, and distribute this software and
@ -3234,7 +3257,7 @@ USE OR PERFORMANCE OF THIS SOFTWARE.</p>
<div class="footer">
<hr class="footer" />
<a class="reference" href="geany.txt">View document source</a>.
Generated on: 2008-01-11 16:41 UTC.
Generated on: 2008-02-01 13:14 UTC.
Generated by <a class="reference" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
</div>

33
doc/geany.txt
View File

@ -534,19 +534,44 @@ copy the text instead. This behaviour was changed in Geany 0.11 -
before the selected text was copied to the new position.
Auto indentation
Indentation
^^^^^^^^^^^
Geany allows each document to indent either with a tab character
or multiple spaces. The default indent mode is set in the `Editor
tab in preferences dialog`_. But this can be overridden using either
the *Document->Indent Type* menu, or by using the *Detect from file*
indentation preference. When enabled, this scans each file that is opened
and sets the indent mode based on how many lines start with a tab vs. 2
or more spaces.
The indent mode for the current document is shown on the status bar
as follows:
TAB
Indent with Tab characters.
SP
Indent with spaces.
Auto-indentation
^^^^^^^^^^^^^^^^
Geany knows four types of auto indentation:
When enabled, auto-indentation happens when pressing *Enter* 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.
Geany knows four types of auto-indentation:
None
Disables auto indentation completely.
Disables auto-indentation completely.
Basic
Adds the same amount of whitespace on a new line as on the last line.
Current chars
Does the same as *Basic* but also indents a new line after an opening
brace '{', and de-indents when typing a closing brace '}'. For Python,
a new line will be indented after typing ':' at the end of a line.
a new line will be indented after typing ':' at the end of the
previous line.
Match braces
Similar to *Current chars* but the closing brace will be aligned to
match the indentation of the line with the opening brace.