doc/geany.html

   1 <?xml version="1.0" encoding="utf-8" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   6 <meta name="generator" content="Docutils 0.4: http://docutils.sourceforge.net/" />
   7 <title>Geany</title>
   8 <meta name="authors" content="Enrico Tröger  Nick Treleaven  Frank Lanitz" />
   9 <meta name="date" content="2010-05-05" />
  10 <style type="text/css">
  11
  12 /*
  13 :Author: Enrico Troeger
  14 :Contact: enrico(dot)troeger(at)uvena(dot)de
  15 :Copyright: This stylesheet has been placed in the public domain.
  16
  17 Stylesheet for Geany's documentation based on a version of John Gabriele.
  18 */
  19
  20 @media screen {
  21
  22         body {
  23                 background-color: #f2f2f2;
  24                 color: #404040;
  25                 margin-left: 0.4em;
  26                 max-width: 60em;
  27                 font-size: 90%;
  28         }
  29
  30         a {
  31                 color: #990000;
  32         }
  33
  34         a:visited {
  35                 color: #7E558E;
  36         }
  37
  38         a:hover {
  39                 text-decoration: none;
  40         }
  41
  42         h1 {
  43                 border-top: 1px dotted;
  44                 margin-top: 2em;
  45         }
  46
  47         h1, h2, h3 {
  48                 font-family: sans-serif;
  49                 color: #5D0606;
  50         }
  51
  52         h1.title {
  53           text-align: left }
  54
  55         h2 {
  56                 margin-top: 30px;
  57         }
  58
  59         h2.subtitle {
  60           text-align: left }
  61
  62         h3 {
  63                 padding-left: 3px;
  64         }
  65
  66         blockquote, pre {
  67                 border: 1px solid;
  68                 padding: 0.4em;
  69         }
  70
  71         blockquote {
  72                 font-family: sans-serif;
  73                 background-color: #DBEDD5;
  74                 border: 1px dotted;
  75                 border-left: 4px solid;
  76                 border-color: #9FD98C;
  77         }
  78
  79         pre {
  80                 background-color: #ECDFCE;
  81                 border: 1px dotted;
  82                 border-left: 4px solid;
  83                 border-color: #D9BE9A;
  84         }
  85
  86         tt, pre, code {
  87                 color: #6D4212;
  88         }
  89
  90         table {
  91                 border: 1px solid #D9BE9A;
  92         }
  93
  94         th {
  95                 background-color: #ECDFCE;
  96                 border: 1px dotted #D9BE9A;
  97         }
  98
  99         td {
 100                 border: 1px dotted #D9BE9A;
 101         }
 102
 103         .docinfo-name {
 104                 color: #5D0606;
 105         }
 106
 107         p.admonition-title {
 108                 color: #990000;
 109                 font-weight: bold;
 110         }
 111
 112         div.note {
 113                 margin: 1em 3em;
 114                 padding: 0em;
 115         }
 116
 117         dt {
 118                 font-style: italic;
 119         }
 120
 121 }
 122
 123 @media print {
 124
 125 }
 126
 127 </style>
 128 </head>
 129 <body>
 130 <div class="document" id="geany">
 131 <h1 class="title">Geany</h1>
 132 <h2 class="subtitle" id="a-fast-light-gtk-ide">A fast, light, GTK+ IDE</h2>
 133 <table class="docinfo" frame="void" rules="none">
 134 <col class="docinfo-name" />
 135 <col class="docinfo-content" />
 136 <tbody valign="top">
 137 <tr><th class="docinfo-name">Authors:</th>
 138 <td>Enrico Tröger
 139 <br />Nick Treleaven
 140 <br />Frank Lanitz</td></tr>
 141 <tr><th class="docinfo-name">Date:</th>
 142 <td>2010-05-05</td></tr>
 143 <tr><th class="docinfo-name">Version:</th>
 144 <td>0.19</td></tr>
 145 </tbody>
 146 </table>
 147 <p>Copyright © 2005-2010</p>
 148 <p>This document is distributed under the terms of the GNU General Public
 149 License as published by the Free Software Foundation; either version 2
 150 of the License, or (at your option) any later version. A copy of this
 151 license can be found in the file COPYING included with the source code
 152 of this program, and also in the chapter <a class="reference" href="#gnu-general-public-license">GNU General Public License</a>.</p>
 153 <div class="contents topic">
 154 <p class="topic-title first"><a id="contents" name="contents">Contents</a></p>
 155 <ul class="simple">
 156 <li><a class="reference" href="#introduction" id="id12" name="id12">Introduction</a><ul>
 157 <li><a class="reference" href="#about-geany" id="id13" name="id13">About Geany</a></li>
 158 <li><a class="reference" href="#where-to-get-it" id="id14" name="id14">Where to get it</a></li>
 159 <li><a class="reference" href="#license" id="id15" name="id15">License</a></li>
 160 <li><a class="reference" href="#about-this-document" id="id16" name="id16">About this document</a></li>
 161 </ul>
 162 </li>
 163 <li><a class="reference" href="#installation" id="id17" name="id17">Installation</a><ul>
 164 <li><a class="reference" href="#requirements" id="id18" name="id18">Requirements</a></li>
 165 <li><a class="reference" href="#binary-packages" id="id19" name="id19">Binary packages</a></li>
 166 <li><a class="reference" href="#source-compilation" id="id20" name="id20">Source compilation</a><ul>
 167 <li><a class="reference" href="#autotools-based-build-system" id="id21" name="id21">Autotools based build system</a></li>
 168 <li><a class="reference" href="#waf-based-build-system" id="id22" name="id22">Waf based build system</a><ul>
 169 <li><a class="reference" href="#waf-cache" id="id23" name="id23">Waf Cache</a><ul>
 170 <li><a class="reference" href="#cleaning-the-cache" id="id24" name="id24">Cleaning the Cache</a></li>
 171 </ul>
 172 </li>
 173 </ul>
 174 </li>
 175 <li><a class="reference" href="#custom-installation" id="id25" name="id25">Custom installation</a></li>
 176 <li><a class="reference" href="#dynamic-linking-loader-support-and-vte" id="id26" name="id26">Dynamic linking loader support and VTE</a></li>
 177 <li><a class="reference" href="#build-problems" id="id27" name="id27">Build problems</a></li>
 178 </ul>
 179 </li>
 180 <li><a class="reference" href="#installation-prefix" id="id28" name="id28">Installation prefix</a></li>
 181 </ul>
 182 </li>
 183 <li><a class="reference" href="#usage" id="id29" name="id29">Usage</a><ul>
 184 <li><a class="reference" href="#getting-started" id="id30" name="id30">Getting started</a></li>
 185 <li><a class="reference" href="#the-geany-workspace" id="id31" name="id31">The Geany workspace</a></li>
 186 <li><a class="reference" href="#command-line-options" id="id32" name="id32">Command line options</a></li>
 187 <li><a class="reference" href="#general" id="id33" name="id33">General</a><ul>
 188 <li><a class="reference" href="#startup" id="id34" name="id34">Startup</a></li>
 189 <li><a class="reference" href="#opening-files-from-the-command-line-in-a-running-instance" id="id35" name="id35">Opening files from the command-line in a running instance</a></li>
 190 <li><a class="reference" href="#virtual-terminal-emulator-widget-vte" id="id36" name="id36">Virtual terminal emulator widget (VTE)</a></li>
 191 <li><a class="reference" href="#defining-own-widget-styles-using-gtkrc-2-0" id="id37" name="id37">Defining own widget styles using .gtkrc-2.0</a></li>
 192 </ul>
 193 </li>
 194 <li><a class="reference" href="#documents" id="id38" name="id38">Documents</a><ul>
 195 <li><a class="reference" href="#switching-between-documents" id="id39" name="id39">Switching between documents</a></li>
 196 </ul>
 197 </li>
 198 <li><a class="reference" href="#character-sets-and-unicode-byte-order-mark-bom" id="id40" name="id40">Character sets and Unicode Byte-Order-Mark (BOM)</a><ul>
 199 <li><a class="reference" href="#using-character-sets" id="id41" name="id41">Using character sets</a></li>
 200 <li><a class="reference" href="#in-file-encoding-specification" id="id42" name="id42">In-file encoding specification</a></li>
 201 <li><a class="reference" href="#special-encoding-none" id="id43" name="id43">Special encoding &quot;None&quot;</a></li>
 202 <li><a class="reference" href="#unicode-byte-order-mark-bom" id="id44" name="id44">Unicode Byte-Order-Mark (BOM)</a></li>
 203 </ul>
 204 </li>
 205 <li><a class="reference" href="#editing" id="id45" name="id45">Editing</a><ul>
 206 <li><a class="reference" href="#folding" id="id46" name="id46">Folding</a></li>
 207 <li><a class="reference" href="#column-mode-editing-rectangular-selections" id="id47" name="id47">Column mode editing (rectangular selections)</a></li>
 208 <li><a class="reference" href="#drag-and-drop-of-text" id="id48" name="id48">Drag and drop of text</a></li>
 209 <li><a class="reference" href="#indentation" id="id49" name="id49">Indentation</a></li>
 210 <li><a class="reference" href="#auto-indentation" id="id50" name="id50">Auto-indentation</a></li>
 211 <li><a class="reference" href="#bookmarks" id="id51" name="id51">Bookmarks</a></li>
 212 <li><a class="reference" href="#code-navigation-history" id="id52" name="id52">Code navigation history</a></li>
 213 <li><a class="reference" href="#sending-text-through-custom-commands" id="id53" name="id53">Sending text through custom commands</a></li>
 214 <li><a class="reference" href="#context-actions" id="id54" name="id54">Context actions</a></li>
 215 <li><a class="reference" href="#autocompletion" id="id55" name="id55">Autocompletion</a><ul>
 216 <li><a class="reference" href="#word-part-completion" id="id56" name="id56">Word part completion</a></li>
 217 <li><a class="reference" href="#scope-autocompletion" id="id57" name="id57">Scope autocompletion</a></li>
 218 </ul>
 219 </li>
 220 <li><a class="reference" href="#user-definable-snippets" id="id58" name="id58">User-definable snippets</a></li>
 221 <li><a class="reference" href="#inserting-unicode-characters" id="id59" name="id59">Inserting Unicode characters</a></li>
 222 </ul>
 223 </li>
 224 <li><a class="reference" href="#search-replace-and-go-to" id="id60" name="id60">Search, replace and go to</a><ul>
 225 <li><a class="reference" href="#toolbar-entries" id="id61" name="id61">Toolbar entries</a><ul>
 226 <li><a class="reference" href="#search-bar" id="id62" name="id62">Search bar</a></li>
 227 </ul>
 228 </li>
 229 <li><a class="reference" href="#find" id="id63" name="id63">Find</a><ul>
 230 <li><a class="reference" href="#matching-options" id="id64" name="id64">Matching options</a></li>
 231 <li><a class="reference" href="#find-all" id="id65" name="id65">Find all</a></li>
 232 <li><a class="reference" href="#change-font-in-search-dialog-text-fields" id="id66" name="id66">Change font in search dialog text fields</a></li>
 233 </ul>
 234 </li>
 235 <li><a class="reference" href="#find-usage" id="id67" name="id67">Find usage</a></li>
 236 <li><a class="reference" href="#find-in-files" id="id68" name="id68">Find in files</a><ul>
 237 <li><a class="reference" href="#filtering-out-version-control-files" id="id69" name="id69">Filtering out version control files</a></li>
 238 </ul>
 239 </li>
 240 <li><a class="reference" href="#replace" id="id70" name="id70">Replace</a><ul>
 241 <li><a class="reference" href="#replace-all" id="id71" name="id71">Replace all</a></li>
 242 </ul>
 243 </li>
 244 <li><a class="reference" href="#go-to-tag-definition" id="id72" name="id72">Go to tag definition</a></li>
 245 <li><a class="reference" href="#go-to-tag-declaration" id="id73" name="id73">Go to tag declaration</a></li>
 246 <li><a class="reference" href="#go-to-line" id="id74" name="id74">Go to line</a></li>
 247 <li><a class="reference" href="#regular-expressions" id="id75" name="id75">Regular expressions</a></li>
 248 </ul>
 249 </li>
 250 <li><a class="reference" href="#tags" id="id76" name="id76">Tags</a><ul>
 251 <li><a class="reference" href="#workspace-tags" id="id77" name="id77">Workspace tags</a></li>
 252 <li><a class="reference" href="#global-tags" id="id78" name="id78">Global tags</a><ul>
 253 <li><a class="reference" href="#default-global-tags-files" id="id79" name="id79">Default global tags files</a></li>
 254 <li><a class="reference" href="#global-tags-file-format" id="id80" name="id80">Global tags file format</a></li>
 255 <li><a class="reference" href="#generating-a-global-tags-file" id="id81" name="id81">Generating a global tags file</a></li>
 256 </ul>
 257 </li>
 258 <li><a class="reference" href="#ignore-tags" id="id82" name="id82">Ignore tags</a></li>
 259 </ul>
 260 </li>
 261 <li><a class="reference" href="#preferences" id="id83" name="id83">Preferences</a><ul>
 262 <li><a class="reference" href="#general-startup-preferences" id="id84" name="id84">General Startup preferences</a><ul>
 263 <li><a class="reference" href="#id1" id="id85" name="id85">Startup</a></li>
 264 <li><a class="reference" href="#shutdown" id="id86" name="id86">Shutdown</a></li>
 265 <li><a class="reference" href="#paths" id="id87" name="id87">Paths</a></li>
 266 </ul>
 267 </li>
 268 <li><a class="reference" href="#general-miscellaneous-preferences" id="id88" name="id88">General Miscellaneous preferences</a><ul>
 269 <li><a class="reference" href="#miscellaneous" id="id89" name="id89">Miscellaneous</a></li>
 270 <li><a class="reference" href="#search" id="id90" name="id90">Search</a></li>
 271 <li><a class="reference" href="#projects" id="id91" name="id91">Projects</a></li>
 272 </ul>
 273 </li>
 274 <li><a class="reference" href="#interface-preferences" id="id92" name="id92">Interface preferences</a><ul>
 275 <li><a class="reference" href="#sidebar" id="id93" name="id93">Sidebar</a></li>
 276 <li><a class="reference" href="#fonts" id="id94" name="id94">Fonts</a></li>
 277 <li><a class="reference" href="#editor-tabs" id="id95" name="id95">Editor tabs</a></li>
 278 <li><a class="reference" href="#tab-positions" id="id96" name="id96">Tab positions</a></li>
 279 <li><a class="reference" href="#id2" id="id97" name="id97">Miscellaneous</a></li>
 280 </ul>
 281 </li>
 282 <li><a class="reference" href="#toolbar-preferences" id="id98" name="id98">Toolbar preferences</a><ul>
 283 <li><a class="reference" href="#toolbar" id="id99" name="id99">Toolbar</a></li>
 284 <li><a class="reference" href="#appearance" id="id100" name="id100">Appearance</a></li>
 285 </ul>
 286 </li>
 287 <li><a class="reference" href="#editor-features-preferences" id="id101" name="id101">Editor Features preferences</a><ul>
 288 <li><a class="reference" href="#features" id="id102" name="id102">Features</a></li>
 289 </ul>
 290 </li>
 291 <li><a class="reference" href="#editor-indentation-preferences" id="id103" name="id103">Editor Indentation preferences</a><ul>
 292 <li><a class="reference" href="#indentation-group" id="id104" name="id104">Indentation group</a></li>
 293 </ul>
 294 </li>
 295 <li><a class="reference" href="#editor-completions-preferences" id="id105" name="id105">Editor Completions preferences</a><ul>
 296 <li><a class="reference" href="#completions" id="id106" name="id106">Completions</a></li>
 297 <li><a class="reference" href="#auto-close-quotes-and-brackets" id="id107" name="id107">Auto-close quotes and brackets</a></li>
 298 </ul>
 299 </li>
 300 <li><a class="reference" href="#editor-display-preferences" id="id108" name="id108">Editor Display preferences</a><ul>
 301 <li><a class="reference" href="#display" id="id109" name="id109">Display</a></li>
 302 <li><a class="reference" href="#long-line-marker" id="id110" name="id110">Long line marker</a></li>
 303 <li><a class="reference" href="#virtual-spaces" id="id111" name="id111">Virtual spaces</a></li>
 304 </ul>
 305 </li>
 306 <li><a class="reference" href="#files-preferences" id="id112" name="id112">Files preferences</a><ul>
 307 <li><a class="reference" href="#new-files" id="id113" name="id113">New files</a></li>
 308 <li><a class="reference" href="#saving-files" id="id114" name="id114">Saving files</a></li>
 309 <li><a class="reference" href="#id3" id="id115" name="id115">Miscellaneous</a></li>
 310 </ul>
 311 </li>
 312 <li><a class="reference" href="#tools-preferences" id="id116" name="id116">Tools preferences</a><ul>
 313 <li><a class="reference" href="#tool-paths" id="id117" name="id117">Tool paths</a></li>
 314 <li><a class="reference" href="#commands" id="id118" name="id118">Commands</a></li>
 315 </ul>
 316 </li>
 317 <li><a class="reference" href="#template-preferences" id="id119" name="id119">Template preferences</a><ul>
 318 <li><a class="reference" href="#template-data" id="id120" name="id120">Template data</a></li>
 319 </ul>
 320 </li>
 321 <li><a class="reference" href="#keybinding-preferences" id="id121" name="id121">Keybinding preferences</a></li>
 322 <li><a class="reference" href="#printing-preferences" id="id122" name="id122">Printing preferences</a></li>
 323 <li><a class="reference" href="#terminal-vte-preferences" id="id123" name="id123">Terminal (VTE) preferences</a><ul>
 324 <li><a class="reference" href="#terminal-widget" id="id124" name="id124">Terminal widget</a></li>
 325 </ul>
 326 </li>
 327 </ul>
 328 </li>
 329 <li><a class="reference" href="#project-management" id="id125" name="id125">Project Management</a><ul>
 330 <li><a class="reference" href="#new-project" id="id126" name="id126">New Project</a></li>
 331 <li><a class="reference" href="#project-properties" id="id127" name="id127">Project Properties</a><ul>
 332 <li><a class="reference" href="#set-base-path-button" id="id128" name="id128">Set Base Path Button</a></li>
 333 </ul>
 334 </li>
 335 <li><a class="reference" href="#open-project" id="id129" name="id129">Open Project</a></li>
 336 <li><a class="reference" href="#close-project" id="id130" name="id130">Close Project</a></li>
 337 </ul>
 338 </li>
 339 <li><a class="reference" href="#build-menu" id="id131" name="id131">Build Menu</a><ul>
 340 <li><a class="reference" href="#indicators" id="id132" name="id132">Indicators</a></li>
 341 <li><a class="reference" href="#default-build-menu-items" id="id133" name="id133">Default Build Menu Items</a><ul>
 342 <li><a class="reference" href="#compile" id="id134" name="id134">Compile</a></li>
 343 <li><a class="reference" href="#build" id="id135" name="id135">Build</a></li>
 344 <li><a class="reference" href="#make" id="id136" name="id136">Make</a></li>
 345 <li><a class="reference" href="#make-custom-target" id="id137" name="id137">Make custom target</a></li>
 346 <li><a class="reference" href="#make-object" id="id138" name="id138">Make object</a></li>
 347 <li><a class="reference" href="#next-error" id="id139" name="id139">Next Error</a></li>
 348 <li><a class="reference" href="#previous-error" id="id140" name="id140">Previous Error</a></li>
 349 <li><a class="reference" href="#execute" id="id141" name="id141">Execute</a></li>
 350 <li><a class="reference" href="#stopping-running-processes" id="id142" name="id142">Stopping running processes</a><ul>
 351 <li><a class="reference" href="#terminal-emulators" id="id143" name="id143">Terminal emulators</a></li>
 352 </ul>
 353 </li>
 354 <li><a class="reference" href="#set-build-commands" id="id144" name="id144">Set Build Commands</a></li>
 355 </ul>
 356 </li>
 357 <li><a class="reference" href="#build-menu-configuration" id="id145" name="id145">Build Menu Configuration</a></li>
 358 <li><a class="reference" href="#build-menu-commands-dialog" id="id146" name="id146">Build Menu Commands Dialog</a><ul>
 359 <li><a class="reference" href="#substitutions-in-commands-and-working-directories" id="id147" name="id147">Substitutions in Commands and Working Directories</a></li>
 360 <li><a class="reference" href="#build-menu-keyboard-shortcuts" id="id148" name="id148">Build Menu Keyboard Shortcuts</a></li>
 361 <li><a class="reference" href="#configuration-files" id="id149" name="id149">Configuration Files</a></li>
 362 </ul>
 363 </li>
 364 </ul>
 365 </li>
 366 <li><a class="reference" href="#printing-support" id="id150" name="id150">Printing support</a></li>
 367 <li><a class="reference" href="#plugins" id="id151" name="id151">Plugins</a></li>
 368 <li><a class="reference" href="#keybindings" id="id152" name="id152">Keybindings</a><ul>
 369 <li><a class="reference" href="#switching-documents" id="id153" name="id153">Switching documents</a></li>
 370 <li><a class="reference" href="#configurable-keybindings" id="id154" name="id154">Configurable keybindings</a><ul>
 371 <li><a class="reference" href="#file-keybindings" id="id155" name="id155">File keybindings</a></li>
 372 <li><a class="reference" href="#editor-keybindings" id="id156" name="id156">Editor keybindings</a></li>
 373 <li><a class="reference" href="#clipboard-keybindings" id="id157" name="id157">Clipboard keybindings</a></li>
 374 <li><a class="reference" href="#select-keybindings" id="id158" name="id158">Select keybindings</a></li>
 375 <li><a class="reference" href="#insert-keybindings" id="id159" name="id159">Insert keybindings</a></li>
 376 <li><a class="reference" href="#format-keybindings" id="id160" name="id160">Format keybindings</a></li>
 377 <li><a class="reference" href="#settings-keybindings" id="id161" name="id161">Settings keybindings</a></li>
 378 <li><a class="reference" href="#search-keybindings" id="id162" name="id162">Search keybindings</a></li>
 379 <li><a class="reference" href="#go-to-keybindings" id="id163" name="id163">Go to keybindings</a></li>
 380 <li><a class="reference" href="#view-keybindings" id="id164" name="id164">View keybindings</a></li>
 381 <li><a class="reference" href="#focus-keybindings" id="id165" name="id165">Focus keybindings</a></li>
 382 <li><a class="reference" href="#notebook-tab-keybindings" id="id166" name="id166">Notebook tab keybindings</a></li>
 383 <li><a class="reference" href="#document-keybindings" id="id167" name="id167">Document keybindings</a></li>
 384 <li><a class="reference" href="#build-keybindings" id="id168" name="id168">Build keybindings</a></li>
 385 <li><a class="reference" href="#tools-keybindings" id="id169" name="id169">Tools keybindings</a></li>
 386 <li><a class="reference" href="#help-keybindings" id="id170" name="id170">Help keybindings</a></li>
 387 </ul>
 388 </li>
 389 </ul>
 390 </li>
 391 </ul>
 392 </li>
 393 <li><a class="reference" href="#id4" id="id171" name="id171">Configuration files</a><ul>
 394 <li><a class="reference" href="#tools-menu-items" id="id172" name="id172">Tools menu items</a></li>
 395 <li><a class="reference" href="#global-configuration-file" id="id173" name="id173">Global configuration file</a></li>
 396 <li><a class="reference" href="#filetype-definition-files" id="id174" name="id174">Filetype definition files</a><ul>
 397 <li><a class="reference" href="#custom-filetypes" id="id175" name="id175">Custom filetypes</a></li>
 398 <li><a class="reference" href="#system-files" id="id176" name="id176">System files</a></li>
 399 <li><a class="reference" href="#user-files" id="id177" name="id177">User files</a></li>
 400 <li><a class="reference" href="#format" id="id178" name="id178">Format</a><ul>
 401 <li><a class="reference" href="#styling-section" id="id179" name="id179">[styling] Section</a><ul>
 402 <li><a class="reference" href="#using-a-named-style" id="id180" name="id180">Using a named style</a></li>
 403 </ul>
 404 </li>
 405 <li><a class="reference" href="#keywords-section" id="id181" name="id181">[keywords] Section</a></li>
 406 <li><a class="reference" href="#lexer-properties-section" id="id182" name="id182">[lexer_properties] Section</a></li>
 407 <li><a class="reference" href="#settings-section" id="id183" name="id183">[settings] Section</a></li>
 408 <li><a class="reference" href="#build-settings-section" id="id184" name="id184">[build_settings] Section</a></li>
 409 </ul>
 410 </li>
 411 <li><a class="reference" href="#special-file-filetypes-common" id="id185" name="id185">Special file filetypes.common</a><ul>
 412 <li><a class="reference" href="#named-styles-section" id="id186" name="id186">[named_styles] Section</a></li>
 413 <li><a class="reference" href="#id5" id="id187" name="id187">[styling] Section</a></li>
 414 <li><a class="reference" href="#id6" id="id188" name="id188">[settings] Section</a></li>
 415 </ul>
 416 </li>
 417 </ul>
 418 </li>
 419 <li><a class="reference" href="#filetype-extensions" id="id189" name="id189">Filetype extensions</a></li>
 420 <li><a class="reference" href="#preferences-file-format" id="id190" name="id190">Preferences File Format</a><ul>
 421 <li><a class="reference" href="#hidden-preferences" id="id191" name="id191">Hidden preferences</a></li>
 422 <li><a class="reference" href="#build-menu-section" id="id192" name="id192">[build-menu] Section</a></li>
 423 </ul>
 424 </li>
 425 <li><a class="reference" href="#project-file-format" id="id193" name="id193">Project File Format</a><ul>
 426 <li><a class="reference" href="#build-menu-additions" id="id194" name="id194">[build-menu] Additions</a></li>
 427 </ul>
 428 </li>
 429 <li><a class="reference" href="#templates" id="id195" name="id195">Templates</a><ul>
 430 <li><a class="reference" href="#template-meta-data" id="id196" name="id196">Template meta data</a></li>
 431 <li><a class="reference" href="#file-templates" id="id197" name="id197">File templates</a><ul>
 432 <li><a class="reference" href="#custom-file-templates" id="id198" name="id198">Custom file templates</a></li>
 433 <li><a class="reference" href="#filetype-templates" id="id199" name="id199">Filetype templates</a></li>
 434 </ul>
 435 </li>
 436 <li><a class="reference" href="#customizing-templates" id="id200" name="id200">Customizing templates</a><ul>
 437 <li><a class="reference" href="#template-wildcards" id="id201" name="id201">Template wildcards</a><ul>
 438 <li><a class="reference" href="#special-command-wildcard" id="id202" name="id202">Special {command:} wildcard</a></li>
 439 </ul>
 440 </li>
 441 </ul>
 442 </li>
 443 </ul>
 444 </li>
 445 <li><a class="reference" href="#customizing-the-toolbar" id="id203" name="id203">Customizing the toolbar</a><ul>
 446 <li><a class="reference" href="#manually-editing-of-the-toolbar-layout" id="id204" name="id204">Manually editing of the toolbar layout</a></li>
 447 <li><a class="reference" href="#available-toolbar-elements" id="id205" name="id205">Available toolbar elements</a></li>
 448 </ul>
 449 </li>
 450 </ul>
 451 </li>
 452 <li><a class="reference" href="#plugin-documentation" id="id206" name="id206">Plugin documentation</a><ul>
 453 <li><a class="reference" href="#save-actions" id="id207" name="id207">Save Actions</a><ul>
 454 <li><a class="reference" href="#instant-save" id="id208" name="id208">Instant Save</a></li>
 455 <li><a class="reference" href="#backup-copy" id="id209" name="id209">Backup Copy</a></li>
 456 </ul>
 457 </li>
 458 </ul>
 459 </li>
 460 <li><a class="reference" href="#contributing-to-this-document" id="id210" name="id210">Contributing to this document</a></li>
 461 <li><a class="reference" href="#scintilla-keyboard-commands" id="id211" name="id211">Scintilla keyboard commands</a><ul>
 462 <li><a class="reference" href="#keyboard-commands" id="id212" name="id212">Keyboard commands</a></li>
 463 </ul>
 464 </li>
 465 <li><a class="reference" href="#tips-and-tricks" id="id213" name="id213">Tips and tricks</a><ul>
 466 <li><a class="reference" href="#document-notebook" id="id214" name="id214">Document notebook</a></li>
 467 <li><a class="reference" href="#editor" id="id215" name="id215">Editor</a></li>
 468 <li><a class="reference" href="#interface" id="id216" name="id216">Interface</a></li>
 469 <li><a class="reference" href="#gtk-related" id="id217" name="id217">GTK-related</a></li>
 470 </ul>
 471 </li>
 472 <li><a class="reference" href="#compile-time-options" id="id218" name="id218">Compile-time options</a><ul>
 473 <li><a class="reference" href="#src-geany-h" id="id219" name="id219">src/geany.h</a></li>
 474 <li><a class="reference" href="#project-h" id="id220" name="id220">project.h</a></li>
 475 <li><a class="reference" href="#editor-h" id="id221" name="id221">editor.h</a></li>
 476 <li><a class="reference" href="#keyfile-c" id="id222" name="id222">keyfile.c</a></li>
 477 <li><a class="reference" href="#build-h" id="id223" name="id223">build.h</a></li>
 478 <li><a class="reference" href="#build-c" id="id224" name="id224">build.c</a></li>
 479 </ul>
 480 </li>
 481 <li><a class="reference" href="#gnu-general-public-license" id="id225" name="id225">GNU General Public License</a></li>
 482 <li><a class="reference" href="#license-for-scintilla-and-scite" id="id226" name="id226">License for Scintilla and SciTE</a></li>
 483 </ul>
 484 </div>
 485 <div class="section">
 486 <h1><a class="toc-backref" href="#id12" id="introduction" name="introduction">Introduction</a></h1>
 487 <div class="section">
 488 <h2><a class="toc-backref" href="#id13" id="about-geany" name="about-geany">About Geany</a></h2>
 489 <p>Geany is a small and lightweight Integrated Development Environment. It
 490 was developed to provide a small and fast IDE, which has only a few
 491 dependencies on other packages. Another goal was to be as independent
 492 as possible from a particular Desktop Environment like KDE or GNOME -
 493 Geany only requires the GTK2 runtime libraries.</p>
 494 <p>Some basic features of Geany:</p>
 495 <ul class="simple">
 496 <li>Syntax highlighting</li>
 497 <li>Code folding</li>
 498 <li>Autocompletion of symbols/words</li>
 499 <li>Construct completion/snippets</li>
 500 <li>Auto-closing of XML and HTML tags</li>
 501 <li>Calltips</li>
 502 <li>Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
 503 Pascal, and others</li>
 504 <li>Symbol lists</li>
 505 <li>Code navigation</li>
 506 <li>Build system to compile and execute your code</li>
 507 <li>Simple project management</li>
 508 <li>Plugin interface</li>
 509 </ul>
 510 </div>
 511 <div class="section">
 512 <h2><a class="toc-backref" href="#id14" id="where-to-get-it" name="where-to-get-it">Where to get it</a></h2>
 513 <p>You can obtain Geany from <a class="reference" href="http://www.geany.org/">http://www.geany.org/</a> or perhaps also from
 514 your distribution. For a list of available packages, please see
 515 <a class="reference" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
 516 </div>
 517 <div class="section">
 518 <h2><a class="toc-backref" href="#id15" id="license" name="license">License</a></h2>
 519 <p>Geany is distributed under the terms of the GNU General Public License
 520 as published by the Free Software Foundation; either version 2 of
 521 the License, or (at your option) any later version. A copy of this
 522 license can be found in the file COPYING included with the source
 523 code of this program and in the chapter, <a class="reference" href="#gnu-general-public-license">GNU General Public License</a>.</p>
 524 <p>The included Scintilla library (found in the subdirectory
 525 <tt class="docutils literal"><span class="pre">scintilla/</span></tt>) has its own license, which can be found in the chapter,
 526 <a class="reference" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
 527 </div>
 528 <div class="section">
 529 <h2><a class="toc-backref" href="#id16" id="about-this-document" name="about-this-document">About this document</a></h2>
 530 <p>This documentation is available in HTML and text formats.
 531 The latest version can always be found at <a class="reference" href="http://www.geany.org/">http://www.geany.org/</a>.</p>
 532 <p>If you want to contribute to it, see <a class="reference" href="#contributing-to-this-document">Contributing to this document</a>.</p>
 533 </div>
 534 </div>
 535 <div class="section">
 536 <h1><a class="toc-backref" href="#id17" id="installation" name="installation">Installation</a></h1>
 537 <div class="section">
 538 <h2><a class="toc-backref" href="#id18" id="requirements" name="requirements">Requirements</a></h2>
 539 <p>You will need the GTK (&gt;= 2.8.0) libraries and their dependencies
 540 (Pango, GLib and ATK). Your distro should provide packages for these,
 541 usually installed by default. For Windows, you can download an installer
 542 from the website which bundles these libraries.</p>
 543 </div>
 544 <div class="section">
 545 <h2><a class="toc-backref" href="#id19" id="binary-packages" name="binary-packages">Binary packages</a></h2>
 546 <p>There are many binary packages available. For an up-to-date but maybe
 547 incomplete list see <a class="reference" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
 548 </div>
 549 <div class="section">
 550 <h2><a class="toc-backref" href="#id20" id="source-compilation" name="source-compilation">Source compilation</a></h2>
 551 <p>Compiling Geany is quite easy.
 552 To do so, you need the GTK (&gt;= 2.8.0) libraries and header files.
 553 You also need the Pango, GLib and ATK libraries and header files.
 554 All these files are available at <a class="reference" href="http://www.gtk.org">http://www.gtk.org</a>, but very often
 555 your distro will provide development packages to save the trouble of
 556 building these yourself.</p>
 557 <p>Furthermore you need, of course, a C and C++ compiler. The GNU versions
 558 of these tools are recommended.</p>
 559 <div class="section">
 560 <h3><a class="toc-backref" href="#id21" id="autotools-based-build-system" name="autotools-based-build-system">Autotools based build system</a></h3>
 561 <p>The Autotools based build system is very mature and has been well tested.
 562 To use it, you just need the Make tool, preferably GNU Make.</p>
 563 <p>Then run the following commands:</p>
 564 <pre class="literal-block">
 565 $ ./configure
 566 $ make
 567 </pre>
 568 <p>Then as root:</p>
 569 <pre class="literal-block">
 570 % make install
 571 </pre>
 572 </div>
 573 <div class="section">
 574 <h3><a class="toc-backref" href="#id22" id="waf-based-build-system" name="waf-based-build-system">Waf based build system</a></h3>
 575 <p>The Waf build system is still quite young and under heavy development but already in a
 576 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
 577 to install Python on your system.
 578 The advantage of the Waf build system over the Autotools based build system is that the whole
 579 build process might be a bit faster. Especially when you use the Waf
 580 cache feature for repetitive builds (e.g. when changing only a few source files
 581 to test something) will become much faster since Waf will cache and re-use the
 582 unchanged built files and only compile the changed code again. See <a class="reference" href="#waf-cache">Waf Cache</a> for details.
 583 To build Geany with Waf as run:</p>
 584 <pre class="literal-block">
 585 $ ./waf configure
 586 $ ./waf build
 587 </pre>
 588 <p>Then as root:</p>
 589 <pre class="literal-block">
 590 % ./waf install
 591 </pre>
 592 <div class="section">
 593 <h4><a class="toc-backref" href="#id23" id="waf-cache" name="waf-cache">Waf Cache</a></h4>
 594 <p>The Waf build system has a nice and interesting feature which can help  to avoid
 595 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
 596 or trying to debug something in Geany.
 597 Waf is able to store and retrieve the object files from a cache. This cache is declared
 598 using the environment variable <tt class="docutils literal"><span class="pre">WAFCACHE</span></tt>.
 599 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
 600 this, you first need to create this directory:</p>
 601 <pre class="literal-block">
 602 $ mkdir -p ~/.cache/waf
 603 </pre>
 604 <p>then add the environment variable to your shell configuration (the following example is for
 605 Bash and should be adjusted to your used shell):</p>
 606 <pre class="literal-block">
 607 export WAFCACHE=/home/username/.cache/waf
 608 </pre>
 609 <p>Remember to replace <tt class="docutils literal"><span class="pre">username</span></tt> with your actual username.</p>
 610 <p>More information about the Waf cache feature are available at
 611 <a class="reference" href="http://code.google.com/p/waf/wiki/CacheObjectFiles">http://code.google.com/p/waf/wiki/CacheObjectFiles</a>.</p>
 612 <div class="section">
 613 <h5><a class="toc-backref" href="#id24" id="cleaning-the-cache" name="cleaning-the-cache">Cleaning the Cache</a></h5>
 614 <p>You should be careful about the size of the cache directory as it may
 615 grow rapidly over time.
 616 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
 617 clean by yourself.
 618 An easy way to keep it clean is to run the following command regularly to remove old
 619 cached files:</p>
 620 <pre class="literal-block">
 621 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
 622 </pre>
 623 <p>This will delete all files in the cache directory which are older than 14 days.</p>
 624 <p>For details about the <tt class="docutils literal"><span class="pre">find</span></tt> command and its options, check its manual page.</p>
 625 </div>
 626 </div>
 627 </div>
 628 <div class="section">
 629 <h3><a class="toc-backref" href="#id25" id="custom-installation" name="custom-installation">Custom installation</a></h3>
 630 <p>The configure script supports several common options, for a detailed
 631 list, type:</p>
 632 <pre class="literal-block">
 633 $ ./configure --help
 634 </pre>
 635 <dl class="docutils">
 636 <dt>or::</dt>
 637 <dd>$ ./waf --help</dd>
 638 </dl>
 639 <p>(depending on which build system you use).</p>
 640 <p>You may also want to read the INSTALL file for advanced installation
 641 options.</p>
 642 <ul class="simple">
 643 <li>See also <a class="reference" href="#compile-time-options">Compile-time options</a>.</li>
 644 </ul>
 645 </div>
 646 <div class="section">
 647 <h3><a class="toc-backref" href="#id26" id="dynamic-linking-loader-support-and-vte" name="dynamic-linking-loader-support-and-vte">Dynamic linking loader support and VTE</a></h3>
 648 <p>In the case that your system lacks dynamic linking loader support, you
 649 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>
 650 script. This prevents compiling Geany with dynamic linking loader
 651 support for automatically loading <tt class="docutils literal"><span class="pre">libvte.so.4</span></tt> if available.</p>
 652 </div>
 653 <div class="section">
 654 <h3><a class="toc-backref" href="#id27" id="build-problems" name="build-problems">Build problems</a></h3>
 655 <p>If there are any errors during compilation, check your build
 656 environment and try to find the error, otherwise contact the mailing
 657 list or one the authors. Sometimes you might need to ask for specific
 658 help from your distribution.</p>
 659 </div>
 660 </div>
 661 <div class="section">
 662 <h2><a class="toc-backref" href="#id28" id="installation-prefix" name="installation-prefix">Installation prefix</a></h2>
 663 <p>If you want to edit any of Geany's system configuration files after
 664 installation you will need to know the installation prefix.  Usually this
 665 is not necessary as you can just use per user configuration files and
 666 you will not need root permissions.</p>
 667 <p>Use the <tt class="docutils literal"><span class="pre">--print-prefix</span></tt> option to Geany to check - see <a class="reference" href="#command-line-options">Command line
 668 options</a>. The first path is the prefix.</p>
 669 <p>This is commonly <tt class="docutils literal"><span class="pre">/usr</span></tt> if you installed from a binary package, or
 670 <tt class="docutils literal"><span class="pre">/usr/local</span></tt> if you build from source.</p>
 671 </div>
 672 </div>
 673 <div class="section">
 674 <h1><a class="toc-backref" href="#id29" id="usage" name="usage">Usage</a></h1>
 675 <div class="section">
 676 <h2><a class="toc-backref" href="#id30" id="getting-started" name="getting-started">Getting started</a></h2>
 677 <p>You can start Geany in the following ways:</p>
 678 <ul>
 679 <li><p class="first">From the Desktop Environment menu:</p>
 680 <p>Choose in your application menu of your used Desktop Environment:
 681 Development --&gt; Geany.</p>
 682 </li>
 683 <li><p class="first">From the command line:</p>
 684 <p>To start Geany from a command line, type the following and press
 685 Return:</p>
 686 <pre class="literal-block">
 687 % geany
 688 </pre>
 689 </li>
 690 </ul>
 691 </div>
 692 <div class="section">
 693 <h2><a class="toc-backref" href="#id31" id="the-geany-workspace" name="the-geany-workspace">The Geany workspace</a></h2>
 694 <p>The Geany window is shown in the following figure:</p>
 695 <img alt="./images/main_window.png" src="./images/main_window.png" />
 696 <p>The workspace has the following parts:</p>
 697 <ul class="simple">
 698 <li>The menu.</li>
 699 <li>An optional toolbar.</li>
 700 <li>An optional sidebar that can show the following tabs:<ul>
 701 <li>Documents - A document list, and</li>
 702 <li>Symbols - A list of symbols in your code.</li>
 703 </ul>
 704 </li>
 705 <li>The main editor window.</li>
 706 <li>An optional message window which can show the following tabs:<ul>
 707 <li>Status - A list of status messages.</li>
 708 <li>Compiler - The output of compiling or building programs.</li>
 709 <li>Messages - Results of 'Find Usage', 'Find Usage' 'Find in Files' and other actions</li>
 710 <li>Scribble - A text scratchpad for any use.</li>
 711 <li>Terminal - An optional terminal window.</li>
 712 </ul>
 713 </li>
 714 <li>A status bar</li>
 715 </ul>
 716 <p>Additional tabs may be added to the sidebar and message window by plugins.</p>
 717 <p>The position of the tabs can be selected in the interface preferences.</p>
 718 <p>The sizes of the sidebar and message window can be adjusted by
 719 dragging the dividers.</p>
 720 </div>
 721 <div class="section">
 722 <h2><a class="toc-backref" href="#id32" id="command-line-options" name="command-line-options">Command line options</a></h2>
 723 <table border="1" class="docutils">
 724 <colgroup>
 725 <col width="9%" />
 726 <col width="18%" />
 727 <col width="72%" />
 728 </colgroup>
 729 <thead valign="bottom">
 730 <tr><th class="head">Short option</th>
 731 <th class="head">Long option</th>
 732 <th class="head">Function</th>
 733 </tr>
 734 </thead>
 735 <tbody valign="top">
 736 <tr><td><em>none</em></td>
 737 <td>+number</td>
 738 <td>Set initial line number for the first opened file
 739 (same as --line, do not put a space between the + sign
 740 and the number). E.g. &quot;geany +7 foo.bar&quot; will open the
 741 file foo.bar and place the cursor in line 7.</td>
 742 </tr>
 743 <tr><td><em>none</em></td>
 744 <td>--column</td>
 745 <td>Set initial column number for the first opened file.</td>
 746 </tr>
 747 <tr><td>-c dir_name</td>
 748 <td>--config=directory_name</td>
 749 <td>Use an alternate configuration directory. The default
 750 configuration directory is <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt> and that
 751 is where <tt class="docutils literal"><span class="pre">geany.conf</span></tt> and other configuration files
 752 reside.</td>
 753 </tr>
 754 <tr><td><em>none</em></td>
 755 <td>--ft-names</td>
 756 <td>Print a list of Geany's internal filetype names (useful
 757 for snippets configuration).</td>
 758 </tr>
 759 <tr><td>-g</td>
 760 <td>--generate-tags</td>
 761 <td>Generate a global tags file (see
 762 <a class="reference" href="#generating-a-global-tags-file">Generating a global tags file</a>).</td>
 763 </tr>
 764 <tr><td>-P</td>
 765 <td>--no-preprocessing</td>
 766 <td>Don't preprocess C/C++ files when generating tags.</td>
 767 </tr>
 768 <tr><td>-i</td>
 769 <td>--new-instance</td>
 770 <td>Do not open files in a running instance, force opening
 771 a new instance. Only available if Geany was compiled
 772 with support for Sockets.</td>
 773 </tr>
 774 <tr><td>-l</td>
 775 <td>--line</td>
 776 <td>Set initial line number for the first opened file.</td>
 777 </tr>
 778 <tr><td><em>none</em></td>
 779 <td>--list-documents</td>
 780 <td>Return a list of open documents in a running Geany
 781 instance.
 782 This can be used to read the currently opened documents in
 783 Geany from an external script or tool. The returned list
 784 is separated by newlines (LF) and consists of the full,
 785 UTF-8 encoded filenames of the documents.
 786 Only available if Geany was compiled with support for
 787 Sockets.</td>
 788 </tr>
 789 <tr><td>-m</td>
 790 <td>--no-msgwin</td>
 791 <td>Do not show the message window. Use this option if you
 792 do not need compiler messages or VTE support.</td>
 793 </tr>
 794 <tr><td>-n</td>
 795 <td>--no-ctags</td>
 796 <td>Do not load symbol completion and call tip data. Use this
 797 option if you do not want to use them.</td>
 798 </tr>
 799 <tr><td>-p</td>
 800 <td>--no-plugins</td>
 801 <td>Do not load plugins or plugin support.</td>
 802 </tr>
 803 <tr><td><em>none</em></td>
 804 <td>--print-prefix</td>
 805 <td>Print installation prefix, the data directory, the lib
 806 directory and the locale directory (in this order) to
 807 stdout, one line each. This is mainly intended for plugin
 808 authors to detect installation paths.</td>
 809 </tr>
 810 <tr><td>-s</td>
 811 <td>--no-session</td>
 812 <td>Do not load the previous session's files.</td>
 813 </tr>
 814 <tr><td>-t</td>
 815 <td>--no-terminal</td>
 816 <td>Do not load terminal support. Use this option if you do
 817 not want to load the virtual terminal emulator widget
 818 at startup. If you do not have <tt class="docutils literal"><span class="pre">libvte.so.4</span></tt> installed,
 819 then terminal-support is automatically disabled. Only
 820 available if Geany was compiled with support for VTE.</td>
 821 </tr>
 822 <tr><td><em>none</em></td>
 823 <td>--socket-file</td>
 824 <td><p class="first">Use this socket filename for communication with a
 825 running Geany instance. This can be used with the following
 826 command to execute Geany on the current workspace:</p>
 827 <pre class="last literal-block">
 828 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
 829 </pre>
 830 </td>
 831 </tr>
 832 <tr><td><em>none</em></td>
 833 <td>--vte-lib</td>
 834 <td>Specify explicitly the path including filename or only
 835 the filename to the VTE library, e.g.
 836 <tt class="docutils literal"><span class="pre">/usr/lib/libvte.so</span></tt> or <tt class="docutils literal"><span class="pre">libvte.so</span></tt>. This option is
 837 only needed when the auto-detection does not work. Only
 838 available if Geany was compiled with support for VTE.</td>
 839 </tr>
 840 <tr><td>-v</td>
 841 <td>--verbose</td>
 842 <td>Be verbose (print useful status messages).</td>
 843 </tr>
 844 <tr><td>-V</td>
 845 <td>--version</td>
 846 <td>Show version information and exit.</td>
 847 </tr>
 848 <tr><td>-?</td>
 849 <td>--help</td>
 850 <td>Show help information and exit.</td>
 851 </tr>
 852 <tr><td><em>none</em></td>
 853 <td>[files ...]</td>
 854 <td><p class="first">Open all given files at startup. This option causes
 855 Geany to ignore loading stored files from the last
 856 session (if enabled).
 857 Geany also recognizes line and column information when
 858 appended to the filename with colons, e.g.
 859 &quot;geany foo.bar:10:5&quot; will open the file foo.bar and
 860 place the cursor in line 10 at column 5.</p>
 861 <p class="last">Projects can also be opened but a project file (*.geany)
 862 must be the first non-option argument. All additionally
 863 given files are ignored.</p>
 864 </td>
 865 </tr>
 866 </tbody>
 867 </table>
 868 <p>You can also pass line number and column number information, e.g.:</p>
 869 <pre class="literal-block">
 870 geany some_file.foo:55:4
 871 </pre>
 872 <p>Geany supports all generic GTK options, a list is available on the
 873 help screen.</p>
 874 </div>
 875 <div class="section">
 876 <h2><a class="toc-backref" href="#id33" id="general" name="general">General</a></h2>
 877 <div class="section">
 878 <h3><a class="toc-backref" href="#id34" id="startup" name="startup">Startup</a></h3>
 879 <p>At startup, Geany loads all files from the last time Geany was
 880 launched. You can disable this feature in the preferences dialog
 881 (see <a class="reference" href="#general-startup-preferences">General Startup preferences</a>). If you specify some
 882 files on the command line, only these files will be opened, but you
 883 can find the files from the last session in the file menu under the
 884 &quot;Recent files&quot; item. By default this contains the last 10 recently
 885 opened files. You can change the number of recently opened files in
 886 the preferences dialog.</p>
 887 <p>You can start several instances of Geany, but only the first will
 888 load files from the last session. To run a second instance of Geany,
 889 do not specify any filenames on the command-line, or disable opening
 890 files in a running instance using the appropriate command line option.</p>
 891 </div>
 892 <div class="section">
 893 <h3><a class="toc-backref" href="#id35" 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>
 894 <p>Geany detects if there is an an instance of itself already running and opens files
 895 from the command-line in that instance. So, Geany can
 896 be used to view and edit files by opening them from other programs
 897 such as a file manager.</p>
 898 <p>You can also pass line number and column number information, e.g.:</p>
 899 <pre class="literal-block">
 900 geany some_file.foo:55:4
 901 </pre>
 902 <p>This would open the file <tt class="docutils literal"><span class="pre">some_file.foo</span></tt> with the cursor on line 55,
 903 column 4.</p>
 904 <p>If you do not like this for some reason, you can disable using the first
 905 instance by using the appropriate command line option -- see the section
 906 called <a class="reference" href="#command-line-options">Command line options</a>.</p>
 907 </div>
 908 <div class="section">
 909 <h3><a class="toc-backref" href="#id36" id="virtual-terminal-emulator-widget-vte" name="virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a></h3>
 910 <p>If you have installed <tt class="docutils literal"><span class="pre">libvte.so</span></tt> on your system, it is loaded
 911 automatically by Geany, and you will have a terminal widget in the
 912 notebook at the bottom.</p>
 913 <p>If Geany cannot find any <tt class="docutils literal"><span class="pre">libvte.so</span></tt> at startup, the terminal widget
 914 will not be loaded. So there is no need to install the package containing
 915 this file in order to run Geany. Additionally, you can disable the use
 916 of the terminal widget by command line option, for more information
 917 see the section called <a class="reference" href="#command-line-options">Command line options</a>.</p>
 918 <p>You can use this terminal (from now on called VTE) much as you would
 919 a terminal program like xterm. There is basic clipboard support. You
 920 can paste the contents of the clipboard by pressing the right mouse
 921 button to open the popup menu, and choosing Paste. To copy text from
 922 the VTE, just select the desired text and then press the right mouse
 923 button and choose Copy from the popup menu. On systems running the
 924 X Window System you can paste the last selected text by pressing the
 925 middle mouse button in the VTE (on 2-button mice, the middle button
 926 can often be simulated by pressing both mouse buttons together).</p>
 927 <p>In the preferences dialog you can specify a shell which should be
 928 started in the VTE. To make the specified shell a login shell just
 929 use the appropriate command line options for the shell. These options
 930 should be found in the manual page of the shell. For zsh and bash
 931 you can use the argument <tt class="docutils literal"><span class="pre">--login</span></tt>.</p>
 932 <div class="note">
 933 <p class="first admonition-title">Note</p>
 934 <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
 935 some other filenames. If this fails too, you should check whether you
 936 installed libvte correctly. Again note, Geany will run without this
 937 library.</p>
 938 </div>
 939 <p>It could be, that the library is called something else than
 940 <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
 941 please set a link to the correct file (as root):</p>
 942 <pre class="literal-block">
 943 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
 944 </pre>
 945 <p>Obviously, you have to adjust the paths and set X to the number of your
 946 <tt class="docutils literal"><span class="pre">libvte.so</span></tt>.</p>
 947 <p>You can also specify the filename of the VTE library to use on the command
 948 line (see the section called <a class="reference" href="#command-line-options">Command line options</a>) or at compile time
 949 by specifying the command line option <tt class="docutils literal"><span class="pre">--with-vte-module-path</span></tt> to
 950 ./configure.</p>
 951 </div>
 952 <div class="section">
 953 <h3><a class="toc-backref" href="#id37" 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>
 954 <p>You can define your widget style for many of Geany's GUI parts. To
 955 do this, just edit your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home
 956 directory on UNIX-like systems and in the etc subdirectory of your
 957 Geany installation on Windows).</p>
 958 <p>To have a defined style used by Geany you must assign it to
 959 at least one of Geany's widgets. For example use the following line:</p>
 960 <pre class="literal-block">
 961 widget &quot;Geany*&quot; style &quot;geanyStyle&quot;
 962 </pre>
 963 <p>This would assign your style &quot;geany_style&quot; to all Geany
 964 widgets. You can also assign styles only to specific widgets. At the
 965 moment you can use the following widgets:</p>
 966 <ul class="simple">
 967 <li>GeanyMainWindow</li>
 968 <li>GeanyEditMenu</li>
 969 <li>GeanyToolbarMenu</li>
 970 <li>GeanyDialog</li>
 971 <li>GeanyDialogPrefs</li>
 972 <li>GeanyDialogProject</li>
 973 <li>GeanyDialogSearch</li>
 974 <li>GeanyMenubar</li>
 975 <li>GeanyToolbar</li>
 976 </ul>
 977 <p>An example of a simple <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>:</p>
 978 <pre class="literal-block">
 979 style &quot;geanyStyle&quot;
 980 {
 981     font_name=&quot;Sans 12&quot;
 982 }
 983 widget &quot;GeanyMainWindow&quot; style &quot;geanyStyle&quot;
 984
 985 style &quot;geanyStyle&quot;
 986 {
 987     font_name=&quot;Sans 10&quot;
 988 }
 989 widget &quot;GeanyPrefsDialog&quot; style &quot;geanyStyle&quot;
 990 </pre>
 991 </div>
 992 </div>
 993 <div class="section">
 994 <h2><a class="toc-backref" href="#id38" id="documents" name="documents">Documents</a></h2>
 995 <div class="section">
 996 <h3><a class="toc-backref" href="#id39" id="switching-between-documents" name="switching-between-documents">Switching between documents</a></h3>
 997 <p>The documents list and the editor tabs are two different ways
 998 to switch between documents using the mouse. When you hit the key
 999 combination to move between tabs, the order is determined by the tab
1000 order. Its is not alphabetical as shown in the documents list
1001 (regardless of whether or not editor tabs are visible).</p>
1002 <p>The tabs can be positioned at the top, bottom, left, or right of the
1003 main editing window, by a selection in the interface preferences.</p>
1004 <p>See the <a class="reference" href="#notebook-tab-keybindings">Notebook tab keybindings</a> section for useful
1005 shortcuts including for Most-Recently-Used document switching.</p>
1006 </div>
1007 </div>
1008 <div class="section">
1009 <h2><a class="toc-backref" href="#id40" 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>
1010 <div class="section">
1011 <h3><a class="toc-backref" href="#id41" id="using-character-sets" name="using-character-sets">Using character sets</a></h3>
1012 <p>Geany provides support for detecting and converting character sets. So
1013 you can open and save files in different character sets, and even
1014 convert a file from one character set to another. To do this,
1015 Geany uses the character conversion capabilities of the GLib library.</p>
1016 <p>Only text files are supported, i.e. opening files which contain
1017 NULL-bytes may fail. Geany will try to open the file anyway but it is
1018 likely that the file will be truncated because it can only be read up
1019 to the first occurrence of a NULL-byte. All characters after this
1020 position are lost and are not written when you save the file.</p>
1021 <p>Geany tries to detect the encoding of a file while opening it, but
1022 auto-detecting the encoding of a file is not easy and sometimes an
1023 encoding might not be detected correctly. In this case you have to
1024 set the encoding of the file manually in order to display it
1025 correctly. You can this in the file open dialog by selecting an
1026 encoding in the drop down box or by reloading the file with the
1027 file menu item &quot;Reload as&quot;. The auto-detection works well for most
1028 encodings but there are also some encodings where it is known that
1029 auto-detection has problems.</p>
1030 <p>There are different ways to set different encodings in Geany:</p>
1031 <ul>
1032 <li><p class="first">Using the file open dialog</p>
1033 <p>This opens the file with the encoding specified in the encoding drop
1034 down box. If the encoding is set to &quot;Detect from file&quot; auto-detection
1035 will be used. If the encoding is set to &quot;Without encoding (None)&quot; the
1036 file will be opened without any character conversion and Geany will
1037 not try to auto-detect the encoding (see below for more information).</p>
1038 </li>
1039 <li><p class="first">Using the &quot;Reload as&quot; menu item</p>
1040 <p>This item reloads the current file with the specified encoding. It can
1041 help if you opened a file and found out that the wrong encoding was used.</p>
1042 </li>
1043 <li><p class="first">Using the &quot;Set encoding&quot; menu item</p>
1044 <p>Contrary to the above two options, this will not change or reload
1045 the current file unless you save it. It is useful when you want to
1046 change the encoding of the file.</p>
1047 </li>
1048 <li><p class="first">Specifying the encoding in the file itself</p>
1049 <p>As mentioned above, auto-detecting the encoding of a file may fail on
1050 some encodings. If you know that Geany doesn't open a certain file,
1051 you can add the specification line, described in the next section,
1052 to the beginning of the file to force Geany to use a specific
1053 encoding when opening the file.</p>
1054 </li>
1055 </ul>
1056 </div>
1057 <div class="section">
1058 <h3><a class="toc-backref" href="#id42" id="in-file-encoding-specification" name="in-file-encoding-specification">In-file encoding specification</a></h3>
1059 <p>Geany detects meta tags of HTML files which contain charset information
1060 like:</p>
1061 <pre class="literal-block">
1062 &lt;meta http-equiv=&quot;content-type&quot; content=&quot;text/html; charset=ISO-8859-15&quot; /&gt;
1063 </pre>
1064 <p>and the specified charset is used when opening the file. This is useful if the
1065 encoding of the file cannot be detected properly.
1066 For non-HTML files you can also define a line like:</p>
1067 <pre class="literal-block">
1068 /* geany_encoding=ISO-8859-15 */
1069 </pre>
1070 <p>or:</p>
1071 <pre class="literal-block">
1072 # geany_encoding=ISO-8859-15 #
1073 </pre>
1074 <p>to force an encoding to be used. The #, /* and */ are examples
1075 of filetype-specific comment characters. It doesn't matter which
1076 characters are around the string &quot; geany_encoding=ISO-8859-15 &quot; as long
1077 as there is at least one whitespace character before and after this
1078 string. Whitespace characters are in this case a space or tab character.
1079 An example to use this could be you have a file with ISO-8859-15
1080 encoding but Geany constantly detects the file encoding as ISO-8859-1.
1081 Then you simply add such a line to the file and Geany will open it
1082 correctly the next time.</p>
1083 <p>Since Geany 0.15 you can also use lines which match the
1084 regular expression used to find the encoding string:
1085 <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>
1086 <div class="note">
1087 <p class="first admonition-title">Note</p>
1088 <p class="last">These specifications must be in the first 512 bytes of the file.
1089 Anything after the first 512 bytes will not be recognized.</p>
1090 </div>
1091 <p>Some examples are:</p>
1092 <pre class="literal-block">
1093 # encoding = ISO-8859-15
1094 </pre>
1095 <p>or:</p>
1096 <pre class="literal-block">
1097 # coding: ISO-8859-15
1098 </pre>
1099 </div>
1100 <div class="section">
1101 <h3><a class="toc-backref" href="#id43" id="special-encoding-none" name="special-encoding-none">Special encoding &quot;None&quot;</a></h3>
1102 <p>There is a special encoding &quot;None&quot; which uses no
1103 encoding. It is useful when you know that Geany cannot auto-detect
1104 the encoding of a file and it is not displayed correctly. Especially
1105 when the file contains NULL-bytes this can be useful to skip auto
1106 detection and open the file properly at least until the occurrence
1107 of the first NULL-byte. Using this encoding opens the file as it is
1108 without any character conversion.</p>
1109 </div>
1110 <div class="section">
1111 <h3><a class="toc-backref" href="#id44" id="unicode-byte-order-mark-bom" name="unicode-byte-order-mark-bom">Unicode Byte-Order-Mark (BOM)</a></h3>
1112 <p>Furthermore, Geany detects a Unicode Byte Order Mark (see
1113 <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,
1114 this feature is only available if the opened file is in a Unicode
1115 encoding. The Byte Order Mark helps to detect the encoding of a file,
1116 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
1117 using a Byte Order Mark could cause some problems for programs not
1118 expecting it, e.g. the compiler gcc stops
1119 with stray errors, PHP does not parse a script containing a BOM and
1120 script files starting with a she-bang maybe cannot be started. In the
1121 status bar you can easily see whether the file starts with a BOM or
1122 not.</p>
1123 <p>If you want to set a BOM for a file or if you want to remove it
1124 from a file, just use the document menu and toggle the checkbox.</p>
1125 <div class="note">
1126 <p class="first admonition-title">Note</p>
1127 <p class="last">If you are unsure what a BOM is or if you do not understand where
1128 to use it, then it is probably not important for you and you can
1129 safely ignore it.</p>
1130 </div>
1131 </div>
1132 </div>
1133 <div class="section">
1134 <h2><a class="toc-backref" href="#id45" id="editing" name="editing">Editing</a></h2>
1135 <div class="section">
1136 <h3><a class="toc-backref" href="#id46" id="folding" name="folding">Folding</a></h3>
1137 <p>Geany provides basic code folding support. Folding means the ability to
1138 show and hide parts of the text in the current file. You can hide
1139 unimportant code sections and concentrate on the parts you are working on
1140 and later you can show hidden sections again. In the editor window there is
1141 a small grey margin on the left side with [+] and [-] symbols which
1142 show hidden parts and hide parts of the file respectively. By
1143 clicking on these icons you can simply show and hide sections which are
1144 marked by vertical lines within this margin. For many filetypes nested
1145 folding is supported, so there may be several fold points within other
1146 fold points.</p>
1147 <div class="note">
1148 <p class="first admonition-title">Note</p>
1149 <p class="last">You can customize the folding icon and line styles - see the
1150 filetypes.common <a class="reference" href="#folding-settings">Folding Settings</a>.</p>
1151 </div>
1152 <p>If you don't like it or don't need it at all, you can simply disable
1153 folding support completely in the preferences dialog.</p>
1154 <p>The folding behaviour can be changed with the &quot;Fold/Unfold all children of
1155 a fold point&quot; option in the preference dialog. If activated, Geany will
1156 unfold all nested fold points below the current one if they are already
1157 folded (when clicking on a [+] symbol).
1158 When clicking on a [-] symbol, Geany will fold all nested fold points
1159 below the current one if they are unfolded.</p>
1160 <p>This option can be inverted by pressing the Shift
1161 key while clicking on a fold symbol. That means, if the &quot;Fold/Unfold all
1162 children of a fold point&quot; option is enabled, pressing Shift will disable
1163 it for this click and vice versa.</p>
1164 </div>
1165 <div class="section">
1166 <h3><a class="toc-backref" href="#id47" id="column-mode-editing-rectangular-selections" name="column-mode-editing-rectangular-selections">Column mode editing (rectangular selections)</a></h3>
1167 <p>There is basic support for column mode editing. To use it, create a
1168 rectangular selection by holding down the Control and Shift keys
1169 (or Control and Alt if it doesn't work) while
1170 selecting some text. It is also possible to create a zero-column selection.
1171 Once a rectangular selection exists you can start editing the text within
1172 this selection and the modifications will be done for every line in the
1173 selection.</p>
1174 </div>
1175 <div class="section">
1176 <h3><a class="toc-backref" href="#id48" id="drag-and-drop-of-text" name="drag-and-drop-of-text">Drag and drop of text</a></h3>
1177 <p>If you drag selected text in the editor widget of Geany the text is
1178 moved to the position where the mouse pointer is when releasing the
1179 mouse button. Holding Control when releasing the mouse button will
1180 copy the text instead. This behaviour was changed in Geany 0.11 -
1181 before the selected text was copied to the new position.</p>
1182 </div>
1183 <div class="section">
1184 <h3><a class="toc-backref" href="#id49" id="indentation" name="indentation">Indentation</a></h3>
1185 <p>Geany allows each document to indent either with a tab character or
1186 multiple spaces. The default indent mode is set in the <a class="reference" href="#editor-features-preferences">Editor Features
1187 preferences</a> (see the link for more information). But
1188 this can be overridden using either the <em>Document-&gt;Indent Type</em> menu,
1189 or by using the <em>Detect from file</em> indentation preference. When enabled,
1190 this scans each file that is opened and sets the indent mode based on
1191 how many lines start with a tab vs. 2 or more spaces.</p>
1192 <p>The indent mode for the current document is shown on the status bar
1193 as follows:</p>
1194 <dl class="docutils">
1195 <dt>TAB</dt>
1196 <dd>Indent with Tab characters.</dd>
1197 <dt>SP</dt>
1198 <dd>Indent with spaces.</dd>
1199 <dt>T/S</dt>
1200 <dd>Indent with tabs and spaces, depending on how much indentation is
1201 on a line.</dd>
1202 </dl>
1203 </div>
1204 <div class="section">
1205 <h3><a class="toc-backref" href="#id50" id="auto-indentation" name="auto-indentation">Auto-indentation</a></h3>
1206 <p>When enabled, auto-indentation happens when pressing <em>Enter</em> in the
1207 Editor. It adds a certain amount of indentation to the new line so the
1208 user doesn't always have to indent each line manually.</p>
1209 <p>Geany has four types of auto-indentation:</p>
1210 <dl class="docutils">
1211 <dt>None</dt>
1212 <dd>Disables auto-indentation completely.</dd>
1213 <dt>Basic</dt>
1214 <dd>Adds the same amount of whitespace on a new line as on the last line.</dd>
1215 <dt>Current chars</dt>
1216 <dd>Does the same as <em>Basic</em> but also indents a new line after an opening
1217 brace '{', and de-indents when typing a closing brace '}'. For Python,
1218 a new line will be indented after typing ':' at the end of the
1219 previous line.</dd>
1220 <dt>Match braces</dt>
1221 <dd>Similar to <em>Current chars</em> but the closing brace will be aligned to
1222 match the indentation of the line with the opening brace.</dd>
1223 </dl>
1224 </div>
1225 <div class="section">
1226 <h3><a class="toc-backref" href="#id51" id="bookmarks" name="bookmarks">Bookmarks</a></h3>
1227 <p>Geany provides a handy bookmarking feature that lets you mark one
1228 or more lines in a document, and return the cursor to them using a
1229 key combination.</p>
1230 <p>To place a mark on a line, either left-mouse-click in the left margin
1231 of the editor window, or else use Ctrl-m. This will
1232 produce a small green plus symbol in the margin. You can have as many
1233 marks in a document as you like. Click again (or use Ctrl-m again)
1234 to remove the bookmark. To remove all the marks in a given document,
1235 use &quot;Remove Markers&quot; in the Document menu.</p>
1236 <p>To navigate down your document, jumping from one mark to the next,
1237 use Ctrl-. (control period). To go in the opposite direction on
1238 the page, use Ctrl-, (control comma). Using the bookmarking feature
1239 together with the commands to switch from one editor tab to another
1240 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
1241 navigate around multiple files.</p>
1242 </div>
1243 <div class="section">
1244 <h3><a class="toc-backref" href="#id52" id="code-navigation-history" name="code-navigation-history">Code navigation history</a></h3>
1245 <p>To ease navigation in source files and especially between
1246 different files, Geany lets you jump between different navigation
1247 points. Currently, this works for the following:</p>
1248 <ul class="simple">
1249 <li><a class="reference" href="#go-to-tag-declaration">Go to tag declaration</a></li>
1250 <li><a class="reference" href="#go-to-tag-definition">Go to tag definition</a></li>
1251 <li>Symbol list items</li>
1252 <li>Build errors</li>
1253 <li>Message items</li>
1254 </ul>
1255 <p>When using one of these actions, Geany remembers your current position
1256 and jumps to the new one. If you decide to go back to your previous
1257 position in the file, just use &quot;Navigate back a location&quot;. To
1258 get back to the new position again, just use &quot;Navigate forward a
1259 location&quot;. This makes it easier to navigate in e.g.  foreign code
1260 and between different files.</p>
1261 </div>
1262 <div class="section">
1263 <h3><a class="toc-backref" href="#id53" id="sending-text-through-custom-commands" name="sending-text-through-custom-commands">Sending text through custom commands</a></h3>
1264 <p>You can define several custom commands in Geany and send the current
1265 selection to one of these commands using the &quot;Edit-&gt;Format-&gt;Send
1266 Selection to&quot; menu or keybindings.
1267 The output of the command will be
1268 used to replace the current selection. This makes it possible to use text
1269 formatting tools with Geany in a general way. The selected text will
1270 be sent to the standard input of the executed command, so the command
1271 should be able to read from it and it should print all results to its
1272 standard output which will be read by Geany. To help finding errors
1273 in executing the command, the output of the program's standard error
1274 will be printed on Geany's standard output.</p>
1275 <p>To add a custom command, just go to the Set Custom Commands dialog
1276 in the Format sub menu of the Edit and Popup menu. Then click on Add
1277 to get a new text entry and type the command. You can also specify
1278 some command line options. To delete a command, just clear the text
1279 entry and press OK. It will be deleted automatically.</p>
1280 </div>
1281 <div class="section">
1282 <h3><a class="toc-backref" href="#id54" id="context-actions" name="context-actions">Context actions</a></h3>
1283 <p>You can execute the context action command on the current word at the
1284 cursor position or the available selection.  This word or selection
1285 can be used as an argument to the command.
1286 The context action is invoked by a menu entry in the popup menu of the
1287 editor and also a keyboard shortcut (see the section called
1288 <a class="reference" href="#keybindings">Keybindings</a>).</p>
1289 <p>The command can be specified in the preferences dialog and also for
1290 each filetype (see &quot;context_action_cmd&quot; in the section called
1291 <a class="reference" href="#format">Format</a>). When the context action is invoked, the filetype
1292 specific command is used if available, otherwise the command
1293 specified in the preferences dialog is executed.</p>
1294 <p>The current word or selection can be referred with the wildcard &quot;%s&quot;
1295 in the command, it will be replaced by the current word or
1296 selection before the command is executed.</p>
1297 <p>For example a context action can be used to open API documentation
1298 in a browser window, the command to open the PHP API documentation
1299 would be:</p>
1300 <pre class="literal-block">
1301 firefox &quot;http://www.php.net/%s&quot;
1302 </pre>
1303 <p>when executing the command, the %s is substituted by the word near
1304 the cursor position or by the current selection. If the cursor is at
1305 the word &quot;echo&quot;, a browser window will open(assumed your browser is
1306 called firefox) and it will open the address: <a class="reference" href="http://www.php.net/echo">http://www.php.net/echo</a>.</p>
1307 </div>
1308 <div class="section">
1309 <h3><a class="toc-backref" href="#id55" id="autocompletion" name="autocompletion">Autocompletion</a></h3>
1310 <p>Geany can offer a list of possible completions for symbols defined in the
1311 tags and for all words in a document.</p>
1312 <p>The autocompletion list for symbols is presented when the first few
1313 characters of the symbol are typed (configurable, see <a class="reference" href="#editor-completions-preferences">Editor Completions
1314 preferences</a>, default 4) or when the <em>Complete word</em>
1315 keybinding is pressed (configurable, see <a class="reference" href="#editor-keybindings">Editor keybindings</a>,
1316 default Ctrl-Space).</p>
1317 <p>When the defined keybinding is typed and the <em>Autocomplete all words in
1318 document</em> preference (in <a class="reference" href="#editor-completions-preferences">Editor Completions preferences</a>)
1319 is selected then the autocompletion list will show all matching words
1320 in the document, if there are no matching symbols.</p>
1321 <p>If you don't want to use autocompletion it can be dismissed until
1322 the next symbol by pressing Escape. The autocompletion list is updated
1323 as more characters are typed so that it only shows completions that start
1324 with the characters typed so far. If no symbols begin with the sequence,
1325 the autocompletion window is closed.</p>
1326 <p>The up and down arrows will move the selected item. The highlighted
1327 item on the autocompletion list can be chosen from the list by pressing
1328 Enter/Return. You can also double-click to select an item. The sequence
1329 will be completed to match the chosen item, and if the <em>Drop rest of
1330 word on completion</em> preference is set (in <a class="reference" href="#editor-completions-preferences">Editor Completions
1331 preferences</a>) then any characters after the cursor that match
1332 a symbol or word are deleted.</p>
1333 <div class="section">
1334 <h4><a class="toc-backref" href="#id56" id="word-part-completion" name="word-part-completion">Word part completion</a></h4>
1335 <p>By default, pressing Tab will complete the selected item by word part;
1336 useful e.g. for adding the prefix <tt class="docutils literal"><span class="pre">gtk_combo_box_entry_</span></tt> without typing it
1337 manually:</p>
1338 <ul class="simple">
1339 <li>gtk_com&lt;TAB&gt;</li>
1340 <li>gtk_combo_&lt;TAB&gt;</li>
1341 <li>gtk_combo_box_&lt;e&gt;&lt;TAB&gt;</li>
1342 <li>gtk_combo_box_entry_&lt;s&gt;&lt;ENTER&gt;</li>
1343 <li>gtk_combo_box_entry_set_text_column</li>
1344 </ul>
1345 <p>The key combination can be changed from Tab - See <a class="reference" href="#editor-keybindings">Editor keybindings</a>.
1346 If you clear/change the key combination for word part completion, Tab
1347 will complete the whole word instead, like Enter.</p>
1348 </div>
1349 <div class="section">
1350 <h4><a class="toc-backref" href="#id57" id="scope-autocompletion" name="scope-autocompletion">Scope autocompletion</a></h4>
1351 <p>E.g.:</p>
1352 <pre class="literal-block">
1353 struct
1354 {
1355     int i;
1356     char c;
1357 } foo;
1358 </pre>
1359 <p>When you type <tt class="docutils literal"><span class="pre">foo.</span></tt> it will show an autocompletion list with 'i' and
1360 'c' symbols.</p>
1361 <p>It only works for languages that set parent scope names for e.g. struct
1362 members. Currently this means C-like languages. The C tag parser only
1363 parses global scopes, so this won't work for structs or objects declared
1364 in local scope.</p>
1365 </div>
1366 </div>
1367 <div class="section">
1368 <h3><a class="toc-backref" href="#id58" id="user-definable-snippets" name="user-definable-snippets">User-definable snippets</a></h3>
1369 <p>Snippets are small strings or code constructs which can be replaced or
1370 completed to a more complex string. So you can save a lot of time when
1371 typing common strings and letting Geany do the work for you.
1372 To know what to complete or replace Geany reads a configuration file
1373 called <tt class="docutils literal"><span class="pre">snippets.conf</span></tt> at startup.</p>
1374 <p>Maybe you need to often type your name, so define a snippet like this:</p>
1375 <pre class="literal-block">
1376 [Default]
1377 myname=Enrico Tröger
1378 </pre>
1379 <p>Every time you write <tt class="docutils literal"><span class="pre">myname</span></tt> &lt;TAB&gt; in Geany, it will replace &quot;myname&quot;
1380 with &quot;Enrico Tröger&quot;. The key to start autocompletion can be changed
1381 in the preferences dialog, by default it is TAB. The corresponding keybinding
1382 is called <tt class="docutils literal"><span class="pre">Complete</span> <span class="pre">snippet</span></tt>.</p>
1383 <p>The system-wide configuration file can be found in
1384 <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
1385 installed (see <a class="reference" href="#installation-prefix">Installation prefix</a>). It is not recommended to edit the
1386 system-wide file, because it will be overridden when Geany is updated.</p>
1387 <p>To change the settings, copy the file from <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt>
1388 in your configuration directory (usually <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>).</p>
1389 <p>For example:</p>
1390 <pre class="literal-block">
1391 % cp /usr/local/share/geany/snippets.conf /home/username/.config/geany/
1392 </pre>
1393 <p>Then you can edit the file and the changes will remain available
1394 after an update of Geany because the file resides in your
1395 configuration directory. Alternatively, you can create a file
1396 <tt class="docutils literal"><span class="pre">~/.config/geany/snippets.conf</span></tt> and add only these settings you want
1397 to change. All missing settings will be read from the global snippets
1398 file in <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt>.</p>
1399 <p>The file <tt class="docutils literal"><span class="pre">snippets.conf</span></tt> contains sections defining snippets that
1400 are available for particular filetypes and in general.</p>
1401 <p>The two sections &quot;Default&quot; and &quot;Special&quot; apply to all filetypes.
1402 &quot;Default&quot; contains all snippets which are available for every
1403 filetype and &quot;Special&quot; contains snippets which can only be used in
1404 other snippets. So you can define often used parts of snippets and
1405 just use the special snippet as a placeholder (see the
1406 <tt class="docutils literal"><span class="pre">snippets.conf</span></tt> for details).</p>
1407 <p>You can define sections with the name of a filetype eg &quot;C++&quot;.  The
1408 snippets in that section are only available for use in files with that
1409 filetype.  Snippets in filetype sections will hide snippets with the
1410 same name in the &quot;Default&quot; section when used in a file of that
1411 filetype.</p>
1412 <p>To define snippets you can use several special character sequences which
1413 will be replaced when using the snippet:</p>
1414 <p><strong>Substitution Sequences for snippets</strong></p>
1415 <table border="1" class="docutils">
1416 <colgroup>
1417 <col width="22%" />
1418 <col width="78%" />
1419 </colgroup>
1420 <tbody valign="top">
1421 <tr><td>\n or %newline%</td>
1422 <td>Insert a new line (it will be replaced by the used EOL
1423 char(s): LF, CR/LF, or CR).</td>
1424 </tr>
1425 <tr><td>\t or %ws%</td>
1426 <td>Insert an indentation step, it will be replaced according
1427 to the current document's indent mode.</td>
1428 </tr>
1429 <tr><td>\s</td>
1430 <td>\s to force whitespace at beginning or end of a value
1431 ('key= value' won't work, use 'key=\svalue')</td>
1432 </tr>
1433 <tr><td>%cursor%</td>
1434 <td>Place the cursor at this position after completion has
1435 been done. You can define multiple %cursor% wildcards
1436 and use the keybinding <tt class="docutils literal"><span class="pre">Move</span> <span class="pre">cursor</span> <span class="pre">in</span> <span class="pre">snippet</span></tt> to jump
1437 to the next defined cursor position in the completed
1438 snippet.</td>
1439 </tr>
1440 <tr><td>%...%</td>
1441 <td>&quot;...&quot; means the name of a key in the &quot;Special&quot; section.
1442 If you have defined a key &quot;brace_open&quot; in the &quot;Special&quot;
1443 section you can use %brace_open% in any other snippet.</td>
1444 </tr>
1445 </tbody>
1446 </table>
1447 <p>Snippet names must not contain spaces otherwise they won't
1448 work correctly. But beside that you can define almost any
1449 string as a snippet and use it later in Geany. It is not limited
1450 to existing contructs of certain programming languages(like <tt class="docutils literal"><span class="pre">if</span></tt>,
1451 <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>
1452 <p>Since Geany 0.15 you can also use most of the available templates wildcards
1453 listed in <a class="reference" href="#template-wildcards">Template wildcards</a>. All wildcards which are listed as
1454 <cite>available in snippets</cite> can be used. For instance to improve the above example:</p>
1455 <pre class="literal-block">
1456 [Default]
1457 myname=My name is {developer}
1458 mysystem=My system: {command:uname -a}
1459 </pre>
1460 <p>this will replace <tt class="docutils literal"><span class="pre">myname</span></tt> with &quot;My name is &quot; and the value of the template
1461 preference <tt class="docutils literal"><span class="pre">developer</span></tt>.</p>
1462 <p>You can change the way Geany recognizes the word to complete,
1463 that is how the start and end of a word is recognised when the
1464 snippet completion is requested. The section &quot;Special&quot; may
1465 contain a key &quot;wordchars&quot; which lists all characters a string may contain
1466 to be recognized as a word for completion. Leave it commented to use
1467 default characters or define it to add or remove characters to fit your
1468 needs.</p>
1469 </div>
1470 <div class="section">
1471 <h3><a class="toc-backref" href="#id59" id="inserting-unicode-characters" name="inserting-unicode-characters">Inserting Unicode characters</a></h3>
1472 <p>With GTK 2.10 and above, you can insert Unicode code points by hitting
1473 Ctrl-Shift-u, then still holding Ctrl-Shift, type some hex digits representing
1474 the code point for the character you want and hit Enter or Return (still
1475 holding Ctrl-Shift). If you release Ctrl-Shift before hitting Enter or Return
1476 (or any other character), the code insertion is completed, but the typed
1477 character is also entered.  In the case of Enter/Return, it is a newline, as
1478 you might expect.</p>
1479 <p>In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1480 in the <a class="reference" href="#keybinding-preferences">keybinding preferences</a>, then select <em>Tools-&gt;Reload Configuration</em>
1481 or restart Geany. Note that it works slightly differently from other GTK
1482 applications, in that you'll need to continue to hold down the Ctrl and Shift
1483 keys while typing the code point hex digits (and the Enter or Return to finish the code point).</p>
1484 <p>For GTK &lt; 2.10, it is also possible, but typing the first Ctrl-Shift-u
1485 is not necessary. One problem is that you may find the alphabetic
1486 keys conflict with other Geany keybindings.</p>
1487 </div>
1488 </div>
1489 <div class="section">
1490 <h2><a class="toc-backref" href="#id60" id="search-replace-and-go-to" name="search-replace-and-go-to">Search, replace and go to</a></h2>
1491 <p>This section describes search-related commands from the Search menu
1492 and the editor window's popup menu:</p>
1493 <ul class="simple">
1494 <li>Find</li>
1495 <li>Find usage *</li>
1496 <li>Find in files</li>
1497 <li>Replace</li>
1498 <li>Go to tag definition *</li>
1499 <li>Go to tag declaration *</li>
1500 <li>Go to line</li>
1501 </ul>
1502 <p>* These items are available from the editor window's popup menu, or by
1503 using a keyboard shortcut (see <a class="reference" href="#search-keybindings">Search keybindings</a>).</p>
1504 <div class="section">
1505 <h3><a class="toc-backref" href="#id61" id="toolbar-entries" name="toolbar-entries">Toolbar entries</a></h3>
1506 <p>There are also two toolbar entries:</p>
1507 <ul class="simple">
1508 <li>Search bar</li>
1509 <li>Go to line entry</li>
1510 </ul>
1511 <p>There are keybindings to focus each of these - see <a class="reference" href="#focus-keybindings">Focus
1512 keybindings</a>. Pressing Escape will then focus the editor.</p>
1513 <div class="section">
1514 <h4><a class="toc-backref" href="#id62" id="search-bar" name="search-bar">Search bar</a></h4>
1515 <p>The quickest way to find some text is to use the search bar entry in
1516 the toolbar. This performs a case-insensitive search in the current
1517 document whilst you type. Pressing Enter will search again.</p>
1518 </div>
1519 </div>
1520 <div class="section">
1521 <h3><a class="toc-backref" href="#id63" id="find" name="find">Find</a></h3>
1522 <p>The Find dialog is used for finding text in one or more open documents.</p>
1523 <img alt="./images/find_dialog.png" src="./images/find_dialog.png" />
1524 <div class="section">
1525 <h4><a class="toc-backref" href="#id64" id="matching-options" name="matching-options">Matching options</a></h4>
1526 <p>The syntax for the <em>Use regular expressions</em> option is shown in
1527 <a class="reference" href="#regular-expressions">Regular expressions</a>.</p>
1528 <div class="note">
1529 <p class="first admonition-title">Note</p>
1530 <p class="last"><em>Use escape sequences</em> is implied for regular expressions.</p>
1531 </div>
1532 <p>The <em>Use escape sequences</em> option will transform any escaped characters
1533 into their UTF-8 equivalent. For example, \t will be transformed into
1534 a tab character. Other recognized symbols are: \\, \n, \r, \uXXXX
1535 (Unicode characters).</p>
1536 </div>
1537 <div class="section">
1538 <h4><a class="toc-backref" href="#id65" id="find-all" name="find-all">Find all</a></h4>
1539 <p>To find all matches, click on the Find All expander. This will reveal
1540 several options:</p>
1541 <ul class="simple">
1542 <li>In Document</li>
1543 <li>In Session</li>
1544 <li>Mark</li>
1545 </ul>
1546 <p>Find All In Document will show a list of matching lines in the
1547 current document in the Messages tab of the Message Window. <em>Find All
1548 In Session</em> does the same for all open documents.</p>
1549 <p>Mark will highlight all matches in the current document with a
1550 colored box. These markers can be removed by selecting the
1551 Remove Markers command from the Document menu.</p>
1552 </div>
1553 <div class="section">
1554 <h4><a class="toc-backref" href="#id66" id="change-font-in-search-dialog-text-fields" name="change-font-in-search-dialog-text-fields">Change font in search dialog text fields</a></h4>
1555 <p>All search related dialogs use a Monospace for the text input fields to
1556 increase the readability of input text. This is useful when you are
1557 typing input such as regular expressions with spaces, periods and commas which
1558 might it hard to read with a proportional font.</p>
1559 <p>If you want to change the font, you can do this easily
1560 by inserting the following style into your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>
1561 (usually found in your home directory on UNIX-like systems and in the
1562 etc subdirectory of your Geany installation on Windows):</p>
1563 <pre class="literal-block">
1564 style &quot;search_style&quot;
1565 {
1566     font_name=&quot;Monospace 8&quot;
1567 }
1568 widget &quot;GeanyDialogSearch.*.GtkEntry&quot; style:highest &quot;search_style&quot;
1569 </pre>
1570 <p>Please note the addition of &quot;:highest&quot; in the last line which sets the priority
1571 of this style to the highest available. Otherwise, the style is ignored
1572 for the search dialogs.</p>
1573 </div>
1574 </div>
1575 <div class="section">
1576 <h3><a class="toc-backref" href="#id67" id="find-usage" name="find-usage">Find usage</a></h3>
1577 <p>Find usage searches all open files. It is similar to the Find All In
1578 Session option in the Find dialog.</p>
1579 <p>If there is a selection, then it is used as the search text; otherwise
1580 the current word is used. The current word is either taken from the
1581 word nearest the edit cursor, or the word underneath the popup menu
1582 click position when the popup menu is used. The search results are
1583 shown in the Messages tab of the Message Window.</p>
1584 </div>
1585 <div class="section">
1586 <h3><a class="toc-backref" href="#id68" id="find-in-files" name="find-in-files">Find in files</a></h3>
1587 <p>Find in files is a more powerful version of Find usage that searches
1588 all files in a certain directory using the Grep tool. The Grep tool
1589 must be correctly set in Preferences to the path of the system's Grep
1590 utility. GNU Grep is recommended.</p>
1591 <img alt="./images/find_in_files_dialog.png" src="./images/find_in_files_dialog.png" />
1592 <p>The Encoding combo box can be used to define the encoding of the files
1593 to be searched. The entered search text is converted to the chosen encoding
1594 and the search results are converted back to UTF-8.
1595 The Extra options field is used to pass any additional arguments to
1596 the grep tool.</p>
1597 <div class="section">
1598 <h4><a class="toc-backref" href="#id69" id="filtering-out-version-control-files" name="filtering-out-version-control-files">Filtering out version control files</a></h4>
1599 <p>When using the <em>Recurse in subfolders</em> option with a directory that's
1600 under version control, you can set the <em>Extra options</em> field to use
1601 grep's <tt class="docutils literal"><span class="pre">--exclude</span></tt> flag to filter out filenames.</p>
1602 <p>SVN Example: <tt class="docutils literal"><span class="pre">--exclude=*.svn-base</span></tt></p>
1603 <p>The --exclude argument only matches the file name part, not the path. If
1604 you have GNU Grep &gt;= 2.5.2 you can use the <tt class="docutils literal"><span class="pre">--exclude-dir</span></tt> argument to
1605 filter out CVS and hidden directories like <tt class="docutils literal"><span class="pre">.svn</span></tt>.</p>
1606 <p>Example: <tt class="docutils literal"><span class="pre">--exclude-dir=.*</span> <span class="pre">--exclude-dir=CVS</span></tt></p>
1607 </div>
1608 </div>
1609 <div class="section">
1610 <h3><a class="toc-backref" href="#id70" id="replace" name="replace">Replace</a></h3>
1611 <p>The Replace dialog is used for replacing text in one or more open
1612 documents.</p>
1613 <img alt="./images/replace_dialog.png" src="./images/replace_dialog.png" />
1614 <p>The Replace dialog has the same options for matching text as the Find
1615 dialog. See the section <a class="reference" href="#matching-options">Matching options</a>.</p>
1616 <p>The <em>Use regular expressions</em> option allows regular expressions to
1617 be used in the search string and back references in the replacement
1618 text -- see the entry for '\n' in <a class="reference" href="#regular-expressions">Regular expressions</a>.</p>
1619 <div class="section">
1620 <h4><a class="toc-backref" href="#id71" id="replace-all" name="replace-all">Replace all</a></h4>
1621 <p>To replace several matches, click on the <em>Replace All</em> expander. This
1622 will reveal several options:</p>
1623 <ul class="simple">
1624 <li>In Document</li>
1625 <li>In Session</li>
1626 <li>In Selection</li>
1627 </ul>
1628 <p><em>Replace All In Document</em> will replace all matching text in the
1629 current document. <em>Replace All In Session</em> does the same for all open
1630 documents. <em>Replace All In Selection</em> will replace all matching text
1631 in the current selection of the current document.</p>
1632 </div>
1633 </div>
1634 <div class="section">
1635 <h3><a class="toc-backref" href="#id72" id="go-to-tag-definition" name="go-to-tag-definition">Go to tag definition</a></h3>
1636 <p>If the current word is the name of a tag definition (like a function
1637 body) and the file containing the tag definition is open, this command
1638 will switch to that file and go to the corresponding line number. The
1639 current word is either the word nearest the edit cursor,
1640 or the word underneath the popup menu click position when the popup
1641 menu is used.</p>
1642 </div>
1643 <div class="section">
1644 <h3><a class="toc-backref" href="#id73" id="go-to-tag-declaration" name="go-to-tag-declaration">Go to tag declaration</a></h3>
1645 <p>Like Go to tag definition, but for a forward declaration such as a
1646 function prototype or <tt class="docutils literal"><span class="pre">extern</span></tt> declaration instead of a function
1647 body.</p>
1648 </div>
1649 <div class="section">
1650 <h3><a class="toc-backref" href="#id74" id="go-to-line" name="go-to-line">Go to line</a></h3>
1651 <p>Go to a particular line number in the current file.</p>
1652 </div>
1653 <div class="section">
1654 <h3><a class="toc-backref" href="#id75" id="regular-expressions" name="regular-expressions">Regular expressions</a></h3>
1655 <p>You can use regular expressions in the Find and Replace dialogs
1656 by selecting the <em>Use regular expressions</em> check box (see <a class="reference" href="#matching-options">Matching
1657 options</a>). The syntax is POSIX compatible, as described in the table
1658 below.</p>
1659 <div class="note">
1660 <p class="first admonition-title">Note</p>
1661 <ol class="last arabic simple">
1662 <li>The <em>Use escape sequences</em> dialog option always applies for regular
1663 expressions.</li>
1664 <li>Searching backwards with regular expressions is not supported.</li>
1665 <li>\b, \d, \s, \w are GNU extensions and may not be available
1666 on non-GNU POSIX systems unless you built Geany with the
1667 <tt class="docutils literal"><span class="pre">--enable-gnu-regex</span></tt> option (this is always used on Windows).</li>
1668 </ol>
1669 </div>
1670 <p><strong>In a regular expression, the following characters are interpreted:</strong></p>
1671 <table border="1" class="docutils">
1672 <colgroup>
1673 <col width="10%" />
1674 <col width="90%" />
1675 </colgroup>
1676 <tbody valign="top">
1677 <tr><td>.</td>
1678 <td>Matches any character.</td>
1679 </tr>
1680 <tr><td>(</td>
1681 <td>This marks the start of a region for tagging a match.</td>
1682 </tr>
1683 <tr><td>)</td>
1684 <td>This marks the end of a tagged region.</td>
1685 </tr>
1686 <tr><td>\n</td>
1687 <td><p class="first">Where n is 1 through 9 refers to the first through ninth tagged
1688 region when searching or replacing.</p>
1689 <p>Searching for (Wiki)\1 matches WikiWiki.</p>
1690 <p class="last">If the search string was Fred([1-9])XXX and the
1691 replace string was Sam\1YYY, when applied to Fred2XXX this
1692 would generate Sam2YYY.</p>
1693 </td>
1694 </tr>
1695 <tr><td>\0</td>
1696 <td>When replacing, the whole matching text.</td>
1697 </tr>
1698 <tr><td>\b</td>
1699 <td>This matches a word boundary.</td>
1700 </tr>
1701 <tr><td>\c</td>
1702 <td><p class="first">A backslash followed by d, D, s, S, w or W, becomes a
1703 character class (both inside and outside sets []).</p>
1704 <ul class="last simple">
1705 <li>d: decimal digits</li>
1706 <li>D: any char except decimal digits</li>
1707 <li>s: whitespace (space, \t \n \r \f \v)</li>
1708 <li>S: any char except whitespace (see above)</li>
1709 <li>w: alphanumeric &amp; underscore</li>
1710 <li>W: any char except alphanumeric &amp; underscore</li>
1711 </ul>
1712 </td>
1713 </tr>
1714 <tr><td>\x</td>
1715 <td>This allows you to use a character x that would otherwise have
1716 a special meaning. For example, \[ would be interpreted as [
1717 and not as the start of a character set. Use \\ for a literal
1718 backslash.</td>
1719 </tr>
1720 <tr><td>[...]</td>
1721 <td><p class="first">Matches one of the characters in the set. If the first
1722 character in the set is ^, it matches the characters NOT in
1723 the set, i.e. complements the set. A shorthand S-E (start
1724 dash end) is used to specify a set of characters S up to E,
1725 inclusive.</p>
1726 <p>The special characters ] and - have no special
1727 meaning if they appear first in the set. - can also be last
1728 in the set. To include both, put ] first: []A-Z-].</p>
1729 <p>Examples:</p>
1730 <pre class="last literal-block">
1731 []|-]    matches these 3 chars
1732 []-|]    matches from ] to | chars
1733 [a-z]    any lowercase alpha
1734 [^]-]    any char except - and ]
1735 [^A-Z]   any char except uppercase alpha
1736 [a-zA-Z] any alpha
1737 </pre>
1738 </td>
1739 </tr>
1740 <tr><td>^</td>
1741 <td>This matches the start of a line (unless used inside a set, see
1742 above).</td>
1743 </tr>
1744 <tr><td>$</td>
1745 <td>This matches the end of a line.</td>
1746 </tr>
1747 <tr><td>*</td>
1748 <td>This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1749 Saam, Saaam and so on.</td>
1750 </tr>
1751 <tr><td>+</td>
1752 <td>This matches 1 or more times. For example, Sa+m matches Sam,
1753 Saam, Saaam and so on.</td>
1754 </tr>
1755 <tr><td>?</td>
1756 <td>This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.</td>
1757 </tr>
1758 </tbody>
1759 </table>
1760 <div class="note">
1761 <p class="first admonition-title">Note</p>
1762 <p class="last">This table is adapted from Scintilla and SciTE documentation,
1763 distributed under the <a class="reference" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
1764 </div>
1765 </div>
1766 </div>
1767 <div class="section">
1768 <h2><a class="toc-backref" href="#id76" id="tags" name="tags">Tags</a></h2>
1769 <p>Tags are information that relates symbols in a program with the
1770 source file location of the declaration and definition.</p>
1771 <p>Geany has built-in functionality for generating tag information (aka
1772 &quot;workspace tags&quot;) for supported filetypes when you open a file.  You
1773 can also have Geany automatically load external tag files (aka &quot;global
1774 tags files&quot;) upon startup, or manually using <em>Tools --&gt; Load Tags</em>.</p>
1775 <p>Geany uses its own tag file format, similar to what <tt class="docutils literal"><span class="pre">ctags</span></tt> uses
1776 (but is incompatible with ctags). You use Geany to generate global
1777 tags files, as described below.</p>
1778 <div class="section">
1779 <h3><a class="toc-backref" href="#id77" id="workspace-tags" name="workspace-tags">Workspace tags</a></h3>
1780 <p>Tags for each document are parsed whenever a file is loaded or
1781 saved. These are shown in the Symbol list in the Sidebar. These tags
1782 are also used for autocompletion of symbols and calltips for all documents
1783 open in the current session that have the same filetype.</p>
1784 <p>The <em>Go to Tag</em> commands can be used with all workspace tags. See
1785 <a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</p>
1786 </div>
1787 <div class="section">
1788 <h3><a class="toc-backref" href="#id78" id="global-tags" name="global-tags">Global tags</a></h3>
1789 <p>Global tags are used to provide autocompletion of symbols and calltips
1790 without having to open the corresponding source files. This is intended
1791 for library APIs, as the tags file only has to be updated when you upgrade
1792 the library.</p>
1793 <p>You can load a custom global tags file in two ways:</p>
1794 <ul class="simple">
1795 <li>Using the <em>Load Tags</em> command in the Tools menu.</li>
1796 <li>By creating a directory <tt class="docutils literal"><span class="pre">~/.config/geany/tags</span></tt>, and moving or symlinking
1797 the tags files there before starting Geany.</li>
1798 <li>By creating a directory <tt class="docutils literal"><span class="pre">$prefix/share/geany/tags</span></tt>, and moving
1799 or symlinking the tags files there before starting Geany.
1800 <tt class="docutils literal"><span class="pre">$prefix</span></tt> is the installation prefix (see <a class="reference" href="#installation-prefix">Installation prefix</a>).</li>
1801 </ul>
1802 <p>You can either download these files or generate your own. They have
1803 the format:</p>
1804 <pre class="literal-block">
1805 name.lang_ext.tags
1806 </pre>
1807 <p><em>lang_ext</em> is one of the extensions set for the filetype associated
1808 with the tags. See the section called <a class="reference" href="#filetype-extensions">Filetype extensions</a> for
1809 more information.</p>
1810 <div class="section">
1811 <h4><a class="toc-backref" href="#id79" id="default-global-tags-files" name="default-global-tags-files">Default global tags files</a></h4>
1812 <p>For some languages, a list of global tags is loaded when the
1813 corresponding filetype is first used. Currently these are for:</p>
1814 <ul class="simple">
1815 <li>C -- GTK+ and GLib</li>
1816 <li>Pascal</li>
1817 <li>PHP</li>
1818 <li>HTML -- &amp;symbol; completion, e.g. for ampersand, copyright, etc.</li>
1819 <li>LaTeX</li>
1820 <li>Python</li>
1821 </ul>
1822 </div>
1823 <div class="section">
1824 <h4><a class="toc-backref" href="#id80" id="global-tags-file-format" name="global-tags-file-format">Global tags file format</a></h4>
1825 <p>Global tags files can have two different formats:</p>
1826 <ul class="simple">
1827 <li>Tagmanager format</li>
1828 <li>Pipe-separated format</li>
1829 </ul>
1830 <p>The first line of global tags files should be a comment, introduced
1831 by <tt class="docutils literal"><span class="pre">#</span></tt> followed by a space and a string like <tt class="docutils literal"><span class="pre">format=pipe</span></tt>
1832 or <tt class="docutils literal"><span class="pre">format=tagmanager</span></tt> respectively, these are case-sensitive.
1833 This helps Geany to read the file properly. If this line
1834 is missing, Geany tries to auto-detect the used format but this
1835 might fail.</p>
1836 <p>The Tagmanager format is a bit more complex and is used for files
1837 created by the <tt class="docutils literal"><span class="pre">geany</span> <span class="pre">-g</span></tt> command. There is one tag per line.
1838 Different tag attributes like the return value or the argument list
1839 are separated with different characters indicating the type of the
1840 following argument.</p>
1841 <p>The Pipe-separated format is easier to read and write.
1842 There is one tag per line and different tag attributes are separated
1843 by the pipe character (<tt class="docutils literal"><span class="pre">|</span></tt>). A line looks like:</p>
1844 <pre class="literal-block">
1845 basename|string|(string path [, string suffix])|
1846 </pre>
1847 <div class="line-block">
1848 <div class="line">The first field is the tag name (usually a function name).</div>
1849 <div class="line">The second field is the type of the return value.</div>
1850 <div class="line">The third field is the argument list for this tag.</div>
1851 <div class="line">The fourth field is the description for this tag but
1852 currently unused and should be left empty.</div>
1853 </div>
1854 <p>Except for the first field (tag name), all other field can be left
1855 empty but the pipe separator must appear for them.</p>
1856 <p>You can easily write your own global tag files using this format.
1857 Just save them in your tags directory, as described earlier in the
1858 section <a class="reference" href="#global-tags">Global tags</a>.</p>
1859 </div>
1860 <div class="section">
1861 <h4><a class="toc-backref" href="#id81" id="generating-a-global-tags-file" name="generating-a-global-tags-file">Generating a global tags file</a></h4>
1862 <p>You can generate your own global tags files by parsing a list of
1863 source files. The command is:</p>
1864 <pre class="literal-block">
1865 geany -g [-P] &lt;Tag File&gt; &lt;File list&gt;
1866 </pre>
1867 <ul class="simple">
1868 <li>Tag File filename should be in the format described earlier --
1869 see the section called <a class="reference" href="#global-tags">Global tags</a>.</li>
1870 <li>File list is a list of filenames, each with a full path (unless
1871 you are generating C/C++ tags and have set the CFLAGS environment
1872 variable appropriately).</li>
1873 <li><tt class="docutils literal"><span class="pre">-P</span></tt> or <tt class="docutils literal"><span class="pre">--no-preprocessing</span></tt> disables using the C pre-processor
1874 to process <tt class="docutils literal"><span class="pre">#include</span></tt> directives for C/C++ source files. Use this
1875 option if you want to specify each source file on the command-line
1876 instead of using a 'master' header file. Also can be useful if you
1877 don't want to specify the CFLAGS environment variable.</li>
1878 </ul>
1879 <p>Example for the wxD library for the D programming language:</p>
1880 <pre class="literal-block">
1881 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1882 </pre>
1883 <p><em>Generating C/C++ tag files:</em></p>
1884 <p>For C/C++ tag files, gcc and grep are required, so that header files
1885 can be preprocessed to include any other headers they depend upon.</p>
1886 <p>For C/C++ files, the environment variable CFLAGS should be set with
1887 appropriate <tt class="docutils literal"><span class="pre">-I/path</span></tt> include paths. The following example works with
1888 the bash shell, generating tags for the GnomeUI library:</p>
1889 <pre class="literal-block">
1890 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1891 /usr/include/libgnomeui-2.0/gnome.h
1892 </pre>
1893 <p>You can adapt this command to use CFLAGS and header files appropriate
1894 for whichever libraries you want.</p>
1895 <p><em>Replacing the default C/C++ tags file:</em></p>
1896 <p>Geany currently uses a default global tags file c99.tags for
1897 C and C++, commonly installed in /usr/share/geany. This file can
1898 be replaced with one containing tags parsed from a different set
1899 of header files. When Geany is next started, your custom tags file
1900 will be loaded instead of the default c99.tags. You should keep a
1901 copy of the generated tags file because it will get overwritten when
1902 upgrading Geany.</p>
1903 </div>
1904 </div>
1905 <div class="section">
1906 <h3><a class="toc-backref" href="#id82" id="ignore-tags" name="ignore-tags">Ignore tags</a></h3>
1907 <p>You can also ignore certain tags if they would lead to wrong parsing of
1908 the code. Simply create a file called &quot;ignore.tags&quot; in your Geany
1909 configuration directory (usually <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>). Then list all tags
1910 you want to ignore in this file, separated by spaces and/or newlines.</p>
1911 <p>More detailed information about the usage from the Exuberant Ctags
1912 manual page:</p>
1913 <pre class="literal-block">
1914 Specifies a list of identifiers which are to be specially handled
1915 while  parsing C and C++ source files. This option is specifically
1916 provided to handle special cases arising through the use of
1917 pre-processor macros. When the identifiers listed are simple identifiers,
1918 these identifiers will be ignored during parsing of the source files.
1919 If an identifier is suffixed with a '+' character, ctags will also
1920 ignore any parenthesis-enclosed argument list which may immediately
1921 follow the identifier in the source files.
1922 If two identifiers are separated with the '=' character, the first
1923 identifiers is replaced by the second identifiers for parsing purposes.
1924 </pre>
1925 <p>For even more detailed information please read the manual page of
1926 Exuberant Ctags.</p>
1927 </div>
1928 </div>
1929 <div class="section">
1930 <h2><a class="toc-backref" href="#id83" id="preferences" name="preferences">Preferences</a></h2>
1931 <p>You may adjust Geany's settings using the Edit --&gt; Preferences
1932 dialog. Any changes you make there can be applied by hitting either
1933 the Apply or the OK button. These settings will persist between Geany
1934 sessions. Note that most settings here have descriptive popup bubble
1935 help -- just hover the mouse over the item in question to get help
1936 on it.</p>
1937 <p>You may also adjust some View settings (under the View menu) that
1938 persist between Geany sessions. The settings under the Document menu,
1939 however, are only for the current document and revert to defaults
1940 when restarting Geany.</p>
1941 <p>There are also some rarer <a class="reference" href="#hidden-preferences">Hidden preferences</a>.</p>
1942 <div class="note">
1943 <p class="first admonition-title">Note</p>
1944 <p class="last">In the paragraphs that follow, the text describing a dialog tab
1945 comes after the screenshot of that tab.</p>
1946 </div>
1947 <div class="section">
1948 <h3><a class="toc-backref" href="#id84" id="general-startup-preferences" name="general-startup-preferences">General Startup preferences</a></h3>
1949 <img alt="./images/pref_dialog_gen_startup.png" src="./images/pref_dialog_gen_startup.png" />
1950 <div class="section">
1951 <h4><a class="toc-backref" href="#id85" id="id1" name="id1">Startup</a></h4>
1952 <dl class="docutils">
1953 <dt>Load files from the last session</dt>
1954 <dd>On startup, load the same files you had open the last time you
1955 used Geany.</dd>
1956 <dt>Load virtual terminal support</dt>
1957 <dd>Load the library for running a terminal in the message window area.</dd>
1958 <dt>Enable plugin support</dt>
1959 <dd>Allow plugins to be used in Geany.</dd>
1960 </dl>
1961 </div>
1962 <div class="section">
1963 <h4><a class="toc-backref" href="#id86" id="shutdown" name="shutdown">Shutdown</a></h4>
1964 <dl class="docutils">
1965 <dt>Save window position and geometry</dt>
1966 <dd>Save the current position and size of the main window so next time
1967 you open Geany it's in the same location.</dd>
1968 <dt>Confirm Exit</dt>
1969 <dd>Have a dialog pop up to confirm that you really want to quit Geany.</dd>
1970 </dl>
1971 </div>
1972 <div class="section">
1973 <h4><a class="toc-backref" href="#id87" id="paths" name="paths">Paths</a></h4>
1974 <dl class="docutils">
1975 <dt>Startup path</dt>
1976 <dd>Path to start in when opening or saving files.
1977 It must be an absolute path.
1978 Leave it blank to use the current working directory.</dd>
1979 <dt>Project files</dt>
1980 <dd>Path to start in when opening project files.</dd>
1981 <dt>Extra plugin path</dt>
1982 <dd>By default Geany looks in the global installation path and in the
1983 configuration directory. In addition the path entered here will be searched
1984 for plugins. Usually you do not need to set an additional path to search for
1985 plugins. It might be useful when Geany is installed on a multi-user machine
1986 and additional plugins are available in a common location for all users.
1987 Leave blank to not set an additional lookup path.</dd>
1988 </dl>
1989 </div>
1990 </div>
1991 <div class="section">
1992 <h3><a class="toc-backref" href="#id88" id="general-miscellaneous-preferences" name="general-miscellaneous-preferences">General Miscellaneous preferences</a></h3>
1993 <img alt="./images/pref_dialog_gen_misc.png" src="./images/pref_dialog_gen_misc.png" />
1994 <div class="section">
1995 <h4><a class="toc-backref" href="#id89" id="miscellaneous" name="miscellaneous">Miscellaneous</a></h4>
1996 <dl class="docutils">
1997 <dt>Beep on errors when compilation has finished</dt>
1998 <dd>Have the computer make a beeping sound when compilation of your program
1999 has completed or any errors occurred.</dd>
2000 <dt>Switch status message list at new message</dt>
2001 <dd>Switch to the status message tab (in the notebook window at the bottom)
2002 once a new status message arrives.</dd>
2003 <dt>Suppress status messages in the status bar</dt>
2004 <dd><p class="first">Remove all messages from the status bar. The messages are still displayed
2005 in the status messages window.</p>
2006 <div class="last tip">
2007 <p class="first admonition-title">Tip</p>
2008 <p class="last">Another option is to use the <em>Switch to Editor</em> keybinding - it
2009 reshows the document statistics on the status bar. See <a class="reference" href="#focus-keybindings">Focus
2010 keybindings</a>.</p>
2011 </div>
2012 </dd>
2013 <dt>Auto-focus widgets (focus follows mouse)</dt>
2014 <dd>Give the focus automatically to widgets below the mouse cursor.
2015 This works for the main editor widget, the scribble, the toolbar search field
2016 goto line fields and the VTE.</dd>
2017 </dl>
2018 </div>
2019 <div class="section">
2020 <h4><a class="toc-backref" href="#id90" id="search" name="search">Search</a></h4>
2021 <dl class="docutils">
2022 <dt>Always wrap search and hide the Find dialog</dt>
2023 <dd>Always wrap search around the document and hide the Find dialog after clicking
2024 Find Next/Previous.</dd>
2025 <dt>Use the current word under the cursor for Find dialogs</dt>
2026 <dd>Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
2027 there is no selection. When this option is disabled, the search term last used in the
2028 appropriate Find dialog is used.</dd>
2029 <dt>Use the current file's directory for Find in Files</dt>
2030 <dd>When opening the Find in Files dialog, set the directory to search to the directory of the current
2031 active file. When this option is disabled, the directory of the last use of the Find in Files
2032 dialog is used.</dd>
2033 </dl>
2034 </div>
2035 <div class="section">
2036 <h4><a class="toc-backref" href="#id91" id="projects" name="projects">Projects</a></h4>
2037 <dl class="docutils">
2038 <dt>Use project-based session files</dt>
2039 <dd>Save your current session when closing projects. You will be able to
2040 resume different project sessions, automatically opening the files
2041 you had open previously.</dd>
2042 <dt>Store project file inside the project base directory</dt>
2043 <dd>When creating new projects, the default path for the project file contains
2044 the project base path. Without this option enabled, the default project file
2045 path is one level above the project base path.
2046 In either case, you can easily set the final project file path in the
2047 <em>New Project</em> dialog. This option provides the more common
2048 defaults automatically for convenience.</dd>
2049 </dl>
2050 </div>
2051 </div>
2052 <div class="section">
2053 <h3><a class="toc-backref" href="#id92" id="interface-preferences" name="interface-preferences">Interface preferences</a></h3>
2054 <img alt="./images/pref_dialog_interface.png" src="./images/pref_dialog_interface.png" />
2055 <div class="section">
2056 <h4><a class="toc-backref" href="#id93" id="sidebar" name="sidebar">Sidebar</a></h4>
2057 <dl class="docutils">
2058 <dt>Show sidebar</dt>
2059 <dd>Whether to show the sidebar at all.</dd>
2060 <dt>Show symbol list</dt>
2061 <dd>Show the list of functions, variables, and other information in the
2062 current document you are editing.</dd>
2063 <dt>Show documents list</dt>
2064 <dd>Show all the documents you have open currently. This can be used to
2065 change between documents (see <a class="reference" href="#switching-between-documents">Switching between documents</a>) and
2066 to perform some common operations such as saving, closing and reloading.</dd>
2067 <dt>Position</dt>
2068 <dd>Whether to place the sidebar on the left or right of the editor window.</dd>
2069 </dl>
2070 </div>
2071 <div class="section">
2072 <h4><a class="toc-backref" href="#id94" id="fonts" name="fonts">Fonts</a></h4>
2073 <dl class="docutils">
2074 <dt>Editor</dt>
2075 <dd>Change the font used to display documents.</dd>
2076 <dt>Symbol list</dt>
2077 <dd>Change the font used for the Symbols sidebar tab.</dd>
2078 <dt>Message window</dt>
2079 <dd>Change the font used for the message window area.</dd>
2080 </dl>
2081 </div>
2082 <div class="section">
2083 <h4><a class="toc-backref" href="#id95" id="editor-tabs" name="editor-tabs">Editor tabs</a></h4>
2084 <dl class="docutils">
2085 <dt>Show editor tabs</dt>
2086 <dd>Show a notebook tab for all documents so you can switch between them
2087 using the mouse (instead of using the Documents window).</dd>
2088 <dt>Show close buttons</dt>
2089 <dd>Make each tab show a close button so you can easily close open
2090 documents.</dd>
2091 <dt>Placement of new file tabs</dt>
2092 <dd>Whether to create a document with its notebook tab to the left or
2093 right of all existing tabs.</dd>
2094 <dt>Double-clicking hides all additional widgets</dt>
2095 <dd>Whether to call the View-&gt;Toggle All Additional Widgets command
2096 when double-clicking on a notebook tab.</dd>
2097 </dl>
2098 </div>
2099 <div class="section">
2100 <h4><a class="toc-backref" href="#id96" id="tab-positions" name="tab-positions">Tab positions</a></h4>
2101 <dl class="docutils">
2102 <dt>Editor</dt>
2103 <dd>Set the positioning of the editor's notebook tabs to the right,
2104 left, top, or bottom of the editing window.</dd>
2105 <dt>Sidebar</dt>
2106 <dd>Set the positioning of the sidebar's notebook tabs to the right,
2107 left, top, or bottom of the sidebar window.</dd>
2108 <dt>Message window</dt>
2109 <dd>Set the positioning of the message window's notebook tabs to the
2110 right, left, top, or bottom of the message window.</dd>
2111 </dl>
2112 </div>
2113 <div class="section">
2114 <h4><a class="toc-backref" href="#id97" id="id2" name="id2">Miscellaneous</a></h4>
2115 <dl class="docutils">
2116 <dt>Show status bar</dt>
2117 <dd>Show the status bar at the bottom of the main window. It gives information about
2118 the file you are editing like the line and column you are on, whether any
2119 modifications were done, the file encoding, the filetype and other information.</dd>
2120 </dl>
2121 </div>
2122 </div>
2123 <div class="section">
2124 <h3><a class="toc-backref" href="#id98" id="toolbar-preferences" name="toolbar-preferences">Toolbar preferences</a></h3>
2125 <p>Affects the main toolbar underneath the menu bar.</p>
2126 <img alt="./images/pref_dialog_toolbar.png" src="./images/pref_dialog_toolbar.png" />
2127 <div class="section">
2128 <h4><a class="toc-backref" href="#id99" id="toolbar" name="toolbar">Toolbar</a></h4>
2129 <dl class="docutils">
2130 <dt>Show Toolbar</dt>
2131 <dd>Whether to show the toolbar.</dd>
2132 <dt>Append Toolbar to the Menu</dt>
2133 <dd>Allows to append the toolbar to the main menu bar instead of placing it below.
2134 This is useful to save vertical space.</dd>
2135 <dt>Customize Toolbar</dt>
2136 <dd>See <a class="reference" href="#customizing-the-toolbar">Customizing the toolbar</a>.</dd>
2137 </dl>
2138 </div>
2139 <div class="section">
2140 <h4><a class="toc-backref" href="#id100" id="appearance" name="appearance">Appearance</a></h4>
2141 <dl class="docutils">
2142 <dt>Icon Style</dt>
2143 <dd>Select the toolbar icon style to use - either icons and text, just
2144 icons or just text.
2145 The choice System default uses whatever icon style is set by GTK.</dd>
2146 <dt>Icon size</dt>
2147 <dd>Select the size of the icons you see (large, small or very small).
2148 The choice System default uses whatever icon size is set by GTK.</dd>
2149 </dl>
2150 </div>
2151 </div>
2152 <div class="section">
2153 <h3><a class="toc-backref" href="#id101" id="editor-features-preferences" name="editor-features-preferences">Editor Features preferences</a></h3>
2154 <img alt="./images/pref_dialog_edit_features.png" src="./images/pref_dialog_edit_features.png" />
2155 <div class="section">
2156 <h4><a class="toc-backref" href="#id102" id="features" name="features">Features</a></h4>
2157 <dl class="docutils">
2158 <dt>Line wrapping</dt>
2159 <dd>Show long lines wrapped around to new display lines.</dd>
2160 <dt>Enable &quot;smart&quot; home key</dt>
2161 <dd>Whether to move the cursor to the first non-whitespace character
2162 on the line when you hit the home key on your keyboard. Pressing it
2163 again will go to the very start of the line.</dd>
2164 <dt>Disable Drag and Drop</dt>
2165 <dd>Do not allow the dragging and dropping of selected text in documents.</dd>
2166 <dt>Enable folding</dt>
2167 <dd>Allow groups of lines in a document to be collapsed for easier
2168 navigation/editing.</dd>
2169 <dt>Fold/Unfold all children of a fold point</dt>
2170 <dd>Whether to fold/unfold all child fold points when a parent line
2171 is folded.</dd>
2172 <dt>Use indicators to show compile errors</dt>
2173 <dd>Underline lines with compile errors using red squiggles to indicate
2174 them in the editor area.</dd>
2175 <dt>Newline strip trailing spaces</dt>
2176 <dd>Remove any white space at the end of the line when you hit the
2177 Enter/Return key.</dd>
2178 <dt>Line breaking column</dt>
2179 <dd>The editor column number to insert a newline at when Line Breaking
2180 is enabled for the current document.</dd>
2181 <dt>Comment toggle marker</dt>
2182 <dd>A string which is added when toggling a line comment in a source file.
2183 It is used to mark the comment as toggled.</dd>
2184 </dl>
2185 </div>
2186 </div>
2187 <div class="section">
2188 <h3><a class="toc-backref" href="#id103" id="editor-indentation-preferences" name="editor-indentation-preferences">Editor Indentation preferences</a></h3>
2189 <img alt="./images/pref_dialog_edit_indentation.png" src="./images/pref_dialog_edit_indentation.png" />
2190 <div class="section">
2191 <h4><a class="toc-backref" href="#id104" id="indentation-group" name="indentation-group">Indentation group</a></h4>
2192 <p>See <a class="reference" href="#indentation">Indentation</a> for more information.</p>
2193 <dl class="docutils">
2194 <dt>Type</dt>
2195 <dd><p class="first">When Geany inserts indentation, whether to use:</p>
2196 <ul class="simple">
2197 <li>Just Tabs</li>
2198 <li>Just Spaces</li>
2199 <li>Tabs and Spaces, depending on how much indentation is on a line</li>
2200 </ul>
2201 <p class="last">The <em>Tabs and Spaces</em> indent type is also known as <em>Soft tab
2202 support</em> in some other editors.</p>
2203 </dd>
2204 <dt>Width</dt>
2205 <dd>The width of a single indent size in spaces. By default the indent
2206 size is equivalent to 4 spaces.</dd>
2207 <dt>Detect from file</dt>
2208 <dd>Try to detect and set the indent type based on file content, when
2209 a file is opened.</dd>
2210 <dt>Auto-indent mode</dt>
2211 <dd><p class="first">The type of auto-indentation you wish to use after pressing Enter,
2212 if any.</p>
2213 <dl class="last docutils">
2214 <dt>Basic</dt>
2215 <dd>Just add the indentation of the previous line.</dd>
2216 <dt>Current chars</dt>
2217 <dd>Add indentation based on the current filetype and any characters at
2218 the end of the line such as <tt class="docutils literal"><span class="pre">{</span></tt>, <tt class="docutils literal"><span class="pre">}</span></tt> for C, <tt class="docutils literal"><span class="pre">:</span></tt> for Python.</dd>
2219 <dt>Match braces</dt>
2220 <dd>Like <em>Current chars</em> but for C-like languages, make a closing
2221 <tt class="docutils literal"><span class="pre">}</span></tt> brace line up with the matching opening brace.</dd>
2222 </dl>
2223 </dd>
2224 <dt>Tab key indents</dt>
2225 <dd><p class="first">If set, pressing tab will indent the current line or selection, and
2226 unindent when pressing Shift-tab. Otherwise, the tab key will
2227 insert a tab character into the document (which can be different
2228 from indentation, depending on the indent type).</p>
2229 <div class="last note">
2230 <p class="first admonition-title">Note</p>
2231 <p class="last">There are also separate configurable keybindings for indent &amp;
2232 unindent, but this preference allows the tab key to have different
2233 meanings in different contexts - e.g. for snippet completion.</p>
2234 </div>
2235 </dd>
2236 </dl>
2237 </div>
2238 </div>
2239 <div class="section">
2240 <h3><a class="toc-backref" href="#id105" id="editor-completions-preferences" name="editor-completions-preferences">Editor Completions preferences</a></h3>
2241 <img alt="./images/pref_dialog_edit_completions.png" src="./images/pref_dialog_edit_completions.png" />
2242 <div class="section">
2243 <h4><a class="toc-backref" href="#id106" id="completions" name="completions">Completions</a></h4>
2244 <dl class="docutils">
2245 <dt>Snippet Completion</dt>
2246 <dd>Whether to replace special keywords after typing Tab into a
2247 pre-defined text snippet.
2248 See <a class="reference" href="#user-definable-snippets">User-definable snippets</a>.</dd>
2249 <dt>XML tag autocompletion</dt>
2250 <dd>When you open an XML tag automatically generate its completion tag.</dd>
2251 <dt>Automatic continuation multi-line comments</dt>
2252 <dd><p class="first">Continue automatically multi-line comments in languages like C, C++
2253 and Java when a new line is entered inside such a comment.
2254 With this option enabled, Geany will insert a <tt class="docutils literal"><span class="pre">*</span></tt> on every new line
2255 inside a multi-line comment, for example when you press return in the
2256 following C code:</p>
2257 <pre class="literal-block">
2258 /*
2259  * This is a C multi-line comment, press &lt;Return&gt;
2260 </pre>
2261 <p>then Geany would insert:</p>
2262 <pre class="literal-block">
2263 *
2264 </pre>
2265 <p class="last">on the next line with the correct indentation based on the previous line,
2266 as long as the multi-line is not closed by <tt class="docutils literal"><span class="pre">*/</span></tt>.</p>
2267 </dd>
2268 <dt>Autocomplete symbols</dt>
2269 <dd>When you start to type a symbol name, look for the full string to
2270 allow it to be completed for you.</dd>
2271 <dt>Autocomplete all words in document</dt>
2272 <dd>When you start to type a word, Geany will search the whole document for
2273 words starting with the typed part to complete it, assuming there
2274 are no tag names to show.</dd>
2275 <dt>Drop rest of word on completion</dt>
2276 <dd>Remove any word part to the right of the cursor when choosing a
2277 completion list item.</dd>
2278 <dt>Characters to type for autocompletion</dt>
2279 <dd>Number of characters of a word to type before autocompletion is
2280 displayed.</dd>
2281 <dt>Completion list height</dt>
2282 <dd>The number of rows to display for the autocompletion window.</dd>
2283 <dt>Max. symbol name suggestions</dt>
2284 <dd>The maximum number of items in the autocompletion list.</dd>
2285 </dl>
2286 </div>
2287 <div class="section">
2288 <h4><a class="toc-backref" href="#id107" id="auto-close-quotes-and-brackets" name="auto-close-quotes-and-brackets">Auto-close quotes and brackets</a></h4>
2289 <p>Geany can automatically insert a closing bracket and quote characters when
2290 you open them. For instance, you type a <tt class="docutils literal"><span class="pre">(</span></tt> and Geany will automatically
2291 insert <tt class="docutils literal"><span class="pre">)</span></tt>. With the following options, you can define for which
2292 characters this should work.</p>
2293 <dl class="docutils">
2294 <dt>Parenthesis ( )</dt>
2295 <dd>Auto-close parenthesis when typing an opening one</dd>
2296 <dt>Curly brackets { }</dt>
2297 <dd>Auto-close curly brackets (braces) when typing an opening one</dd>
2298 <dt>Square brackets [ ]</dt>
2299 <dd>Auto-close square brackets when typing an opening one</dd>
2300 <dt>Single quotes ' '</dt>
2301 <dd>Auto-close single quotes when typing an opening one</dd>
2302 <dt>Double quotes &quot; &quot;</dt>
2303 <dd>Auto-close double quotes when typing an opening one</dd>
2304 </dl>
2305 </div>
2306 </div>
2307 <div class="section">
2308 <h3><a class="toc-backref" href="#id108" id="editor-display-preferences" name="editor-display-preferences">Editor Display preferences</a></h3>
2309 <p>This is for visual elements displayed in the editor window.</p>
2310 <img alt="./images/pref_dialog_edit_display.png" src="./images/pref_dialog_edit_display.png" />
2311 <div class="section">
2312 <h4><a class="toc-backref" href="#id109" id="display" name="display">Display</a></h4>
2313 <dl class="docutils">
2314 <dt>Invert syntax highlighting colors</dt>
2315 <dd>Invert all colors, by default this makes white text on a black
2316 background.</dd>
2317 <dt>Show indendation guides</dt>
2318 <dd>Show vertical lines to help show how much leading indentation there
2319 is on each line.</dd>
2320 <dt>Show whitespaces</dt>
2321 <dd>Mark all tabs with an arrow &quot;--&gt;&quot; symbol and spaces with dots to
2322 show which kinds of whitespace are used.</dd>
2323 <dt>Show line endings</dt>
2324 <dd>Display a symbol everywhere that a carriage return or line feed
2325 is present.</dd>
2326 <dt>Show line numbers</dt>
2327 <dd>Show or hide the Line Number margin.</dd>
2328 <dt>Show markers margin</dt>
2329 <dd>Show or hide the small margin right of the line numbers, which is used
2330 to mark lines.</dd>
2331 <dt>Stop scrolling at last line</dt>
2332 <dd>When enabled Geany stops scrolling when at the last line of the document.
2333 Otherwise you can scroll one more page even if there are no real lines.</dd>
2334 </dl>
2335 </div>
2336 <div class="section">
2337 <h4><a class="toc-backref" href="#id110" id="long-line-marker" name="long-line-marker">Long line marker</a></h4>
2338 <p>The long line marker helps to indicate overly-long lines, or as a hint
2339 to the user for when to break the line.</p>
2340 <dl class="docutils">
2341 <dt>Type</dt>
2342 <dd><dl class="first last docutils">
2343 <dt>Line</dt>
2344 <dd>Show a thin vertical line in the editor window at the given column
2345 position.</dd>
2346 <dt>Background</dt>
2347 <dd>Change the background color of characters after the given column
2348 position to the color set below. (This is recommended over the
2349 <em>Line</em> setting if you use proportional fonts).</dd>
2350 <dt>Disabled</dt>
2351 <dd>Don't mark long lines at all.</dd>
2352 </dl>
2353 </dd>
2354 <dt>Long line marker</dt>
2355 <dd>Set this value to a value greater than zero to specify the column
2356 where it should appear.</dd>
2357 <dt>Long line marker color</dt>
2358 <dd>Set the color of the long line marker.</dd>
2359 </dl>
2360 </div>
2361 <div class="section">
2362 <h4><a class="toc-backref" href="#id111" id="virtual-spaces" name="virtual-spaces">Virtual spaces</a></h4>
2363 <p>Virtual space is space beyond the end of each line.
2364 The cursor may be moved into virtual space but no real space will be
2365 added to the document until there is some text typed or some other
2366 text insertion command is used.</p>
2367 <dl class="docutils">
2368 <dt>Disabled</dt>
2369 <dd>Do not show virtual spaces</dd>
2370 <dt>Only for rectangular selections</dt>
2371 <dd>Only show virtual spaces beyond the end of lines when drawing a rectangular selection</dd>
2372 <dt>Always</dt>
2373 <dd>Always show virtual spaces beyond the end of lines</dd>
2374 </dl>
2375 </div>
2376 </div>
2377 <div class="section">
2378 <h3><a class="toc-backref" href="#id112" id="files-preferences" name="files-preferences">Files preferences</a></h3>
2379 <img alt="./images/pref_dialog_files.png" src="./images/pref_dialog_files.png" />
2380 <div class="section">
2381 <h4><a class="toc-backref" href="#id113" id="new-files" name="new-files">New files</a></h4>
2382 <dl class="docutils">
2383 <dt>Open new documents from the command-line</dt>
2384 <dd>Whether to create new documents when passing filenames that don't
2385 exist from the command-line.</dd>
2386 <dt>Default encoding (new files)</dt>
2387 <dd>The type of file encoding you wish to use when creating files.</dd>
2388 <dt>Used fixed encoding when opening files</dt>
2389 <dd>Assume all files you are opening are using the type of encoding specified below.</dd>
2390 <dt>Default encoding (existing files)</dt>
2391 <dd>Opens all files with the specified encoding instead of auto-detecting it.
2392 Use this option when it's not possible for Geany to detect the exact encoding.</dd>
2393 <dt>Default end of line characters</dt>
2394 <dd>The end of line characters to which should be used for new files.
2395 On Windows systems, you generally want to use CR/LF which are the common
2396 characters to mark line breaks.
2397 On Unix-like systems, LF is default and CR is used on MAC systems.</dd>
2398 </dl>
2399 </div>
2400 <div class="section">
2401 <h4><a class="toc-backref" href="#id114" id="saving-files" name="saving-files">Saving files</a></h4>
2402 <p>Perform formatting operations when a document is saved. These
2403 can each be undone with the Undo command.</p>
2404 <dl class="docutils">
2405 <dt>Ensure newline at file end</dt>
2406 <dd>Add a newline at the end of the document if one is missing.</dd>
2407 <dt>Strip trailing spaces</dt>
2408 <dd>Remove the trailing spaces on each line of the document.</dd>
2409 <dt>Replace tabs by space</dt>
2410 <dd><p class="first">Replace all tabs in the document with the equivalent number of spaces.</p>
2411 <div class="last note">
2412 <p class="first admonition-title">Note</p>
2413 <p class="last">It is better to use spaces to indent than use this preference - see
2414 <a class="reference" href="#indentation">Indentation</a>.</p>
2415 </div>
2416 </dd>
2417 </dl>
2418 </div>
2419 <div class="section">
2420 <h4><a class="toc-backref" href="#id115" id="id3" name="id3">Miscellaneous</a></h4>
2421 <dl class="docutils">
2422 <dt>Recent files list length</dt>
2423 <dd>The number of files to remember in the recently used files list.</dd>
2424 <dt>Disk check timeout</dt>
2425 <dd><p class="first">The number of seconds to periodically check the current document's
2426 file on disk in case it has changed. Setting it to 0 will disable
2427 this feature.</p>
2428 <div class="last note">
2429 <p class="first admonition-title">Note</p>
2430 <p class="last">These checks are only performed on local files. Remote files are
2431 not checked for changes due to performance issues
2432 (remote files are files in <tt class="docutils literal"><span class="pre">~/.gvfs/</span></tt>).</p>
2433 </div>
2434 </dd>
2435 </dl>
2436 </div>
2437 </div>
2438 <div class="section">
2439 <h3><a class="toc-backref" href="#id116" id="tools-preferences" name="tools-preferences">Tools preferences</a></h3>
2440 <img alt="./images/pref_dialog_tools.png" src="./images/pref_dialog_tools.png" />
2441 <div class="section">
2442 <h4><a class="toc-backref" href="#id117" id="tool-paths" name="tool-paths">Tool paths</a></h4>
2443 <dl class="docutils">
2444 <dt>Terminal</dt>
2445 <dd>The location of your terminal executable.</dd>
2446 <dt>Browser</dt>
2447 <dd>The location of your web browser executable.</dd>
2448 <dt>Grep</dt>
2449 <dd>The location of the grep executable.</dd>
2450 </dl>
2451 <div class="note">
2452 <p class="first admonition-title">Note</p>
2453 <p class="last">For Windows users: at the time of writing it is recommended to use
2454 the grep.exe from the UnxUtils project
2455 (<a class="reference" href="http://sourceforge.net/projects/unxutils">http://sourceforge.net/projects/unxutils</a>). The grep.exe from the
2456 Mingw project for instance might not work with Geany at the moment.</p>
2457 </div>
2458 </div>
2459 <div class="section">
2460 <h4><a class="toc-backref" href="#id118" id="commands" name="commands">Commands</a></h4>
2461 <dl class="docutils">
2462 <dt>Context action</dt>
2463 <dd>Set this to a command to execute on the current word.
2464 You can use the &quot;%s&quot; wildcard to pass the current word below the cursor
2465 to the specified command.</dd>
2466 </dl>
2467 </div>
2468 </div>
2469 <div class="section">
2470 <h3><a class="toc-backref" href="#id119" id="template-preferences" name="template-preferences">Template preferences</a></h3>
2471 <p>This data is used as meta data for various template text to insert into
2472 a document, such as the file header. You only need to set fields that
2473 you want to use in your template files.</p>
2474 <div class="note">
2475 <p class="first admonition-title">Note</p>
2476 <p class="last">For changes made here to take effect, either selecting
2477 <em>Tools-&gt;Reload Configuration</em> or restarting Geany is required.</p>
2478 </div>
2479 <img alt="./images/pref_dialog_templ.png" src="./images/pref_dialog_templ.png" />
2480 <div class="section">
2481 <h4><a class="toc-backref" href="#id120" id="template-data" name="template-data">Template data</a></h4>
2482 <dl class="docutils">
2483 <dt>Developer</dt>
2484 <dd>The name of the developer who will be creating files.</dd>
2485 <dt>Initials</dt>
2486 <dd>The initials of the developer.</dd>
2487 <dt>Mail address</dt>
2488 <dd><p class="first">The email address of the developer.</p>
2489 <div class="last note">
2490 <p class="first admonition-title">Note</p>
2491 <p class="last">You may wish to add anti-spam markup, e.g. <tt class="docutils literal"><span class="pre">name&lt;at&gt;site&lt;dot&gt;ext</span></tt>.</p>
2492 </div>
2493 </dd>
2494 <dt>Company</dt>
2495 <dd>The company the developer is working for.</dd>
2496 <dt>Initial version</dt>
2497 <dd>The initial version of files you will be creating.</dd>
2498 <dt>Year</dt>
2499 <dd>Specify a format for the the {year} wildcard. You can use any conversion specifiers
2500 which can be used with the ANSI C strftime function.  For details please see
2501 <a class="reference" href="http://man.cx/strftime">http://man.cx/strftime</a>.</dd>
2502 <dt>Date</dt>
2503 <dd>Specify a format for the the {date} wildcard. You can use any conversion specifiers
2504 which can be used with the ANSI C strftime function.  For details please see
2505 <a class="reference" href="http://man.cx/strftime">http://man.cx/strftime</a>.</dd>
2506 <dt>Date &amp; Time</dt>
2507 <dd>Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
2508 which can be used with the ANSI C strftime function.  For details please see
2509 <a class="reference" href="http://man.cx/strftime">http://man.cx/strftime</a>.</dd>
2510 </dl>
2511 </div>
2512 </div>
2513 <div class="section">
2514 <h3><a class="toc-backref" href="#id121" id="keybinding-preferences" name="keybinding-preferences">Keybinding preferences</a></h3>
2515 <img alt="./images/pref_dialog_keys.png" src="./images/pref_dialog_keys.png" />
2516 <p>There are some commands listed in the keybinding dialog that are not, by default,
2517 bound to a key combination, and may not be available as a menu item.</p>
2518 <div class="note">
2519 <p class="first admonition-title">Note</p>
2520 <p class="last">For more information see the section <a class="reference" href="#keybindings">Keybindings</a>.</p>
2521 </div>
2522 </div>
2523 <div class="section">
2524 <h3><a class="toc-backref" href="#id122" id="printing-preferences" name="printing-preferences">Printing preferences</a></h3>
2525 <img alt="./images/pref_dialog_printing.png" src="./images/pref_dialog_printing.png" />
2526 <dl class="docutils">
2527 <dt>Use external command for printing</dt>
2528 <dd>Use a system command to print your file out.</dd>
2529 <dt>Use native GTK printing</dt>
2530 <dd>Let the GTK GUI toolkit handle your print request.</dd>
2531 <dt>Print line numbers</dt>
2532 <dd>Print the line numbers on the left of your paper.</dd>
2533 <dt>Print page number</dt>
2534 <dd>Print the page number on the bottom right of your paper.</dd>
2535 <dt>Print page header</dt>
2536 <dd>Print a header on every page that is sent to the printer.</dd>
2537 <dt>Use base name of the printed file</dt>
2538 <dd>Don't use the entire path for the header, only the filename.</dd>
2539 <dt>Date format</dt>
2540 <dd>How the date should be printed. You can use the same format
2541 specifiers as in the ANSI C function strftime(). For details please
2542 see <a class="reference" href="http://man.cx/strftime">http://man.cx/strftime</a>.</dd>
2543 </dl>
2544 </div>
2545 <div class="section">
2546 <h3><a class="toc-backref" href="#id123" id="terminal-vte-preferences" name="terminal-vte-preferences">Terminal (VTE) preferences</a></h3>
2547 <p>See also: <a class="reference" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
2548 <img alt="./images/pref_dialog_vte.png" src="./images/pref_dialog_vte.png" />
2549 <div class="section">
2550 <h4><a class="toc-backref" href="#id124" id="terminal-widget" name="terminal-widget">Terminal widget</a></h4>
2551 <dl class="docutils">
2552 <dt>Terminal font</dt>
2553 <dd>Select the font that will be used in the terminal emulation control.</dd>
2554 <dt>Foreground color</dt>
2555 <dd>Select the font color.</dd>
2556 <dt>Background color</dt>
2557 <dd>Select the background color of the terminal.</dd>
2558 <dt>Scrollback lines</dt>
2559 <dd>The number of lines buffered so that you can scroll though the history.</dd>
2560 <dt>Shell</dt>
2561 <dd>The location of the shell on your system.</dd>
2562 <dt>Scroll on keystroke</dt>
2563 <dd>Scroll the terminal to the prompt line when pressing a key.</dd>
2564 <dt>Scroll on output</dt>
2565 <dd>Scroll the output down.</dd>
2566 <dt>Cursor blinks</dt>
2567 <dd>Let the terminal cursor blink.</dd>
2568 <dt>Override Geany keybindings</dt>
2569 <dd>Allow the VTE to receive keyboard shortcuts (apart from focus commands).</dd>
2570 <dt>Disable menu shortcut key (F10 by default)</dt>
2571 <dd>Disable the menu shortcut when you are in the virtual terminal.</dd>
2572 <dt>Follow path of the current file</dt>
2573 <dd>Make the path of the terminal change according to the path of the
2574 current file.</dd>
2575 <dt>Execute programs in VTE</dt>
2576 <dd>Execute programs in the virtual terminal instead of using the external
2577 terminal tool.  Note that if you run multiple execute commands at once
2578 the output may become mixed together in the VTE.</dd>
2579 <dt>Don't use run script</dt>
2580 <dd>Don't use the simple run script which is usually used to display
2581 the exit status of the executed program.
2582 This can be useful if you already have a program running in the VTE
2583 like a Python console (e.g. ipython). Use this with care.</dd>
2584 </dl>
2585 </div>
2586 </div>
2587 </div>
2588 <div class="section">
2589 <h2><a class="toc-backref" href="#id125" id="project-management" name="project-management">Project Management</a></h2>
2590 <p>Project Management is optional in Geany. Currently it can be used for:</p>
2591 <ul class="simple">
2592 <li>Storing and opening session files on a project basis.</li>
2593 <li>Configuring the Build menu on a project basis.</li>
2594 </ul>
2595 <p>A list of session files can be stored and opened with the project
2596 when the <em>Use project-based session files</em> preference is enabled,
2597 in the <em>Project</em> group of the <a class="reference" href="#preferences">Preferences</a> dialog.</p>
2598 <p>As long as a project is open, the Build menu will use
2599 the items defined in project's settings, instead of the defaults.
2600 See <a class="reference" href="#build-menu-configuration">Build Menu Configuration</a> for information on configuring the menu.</p>
2601 <p>The current project's settings are saved when it is closed, or when
2602 Geany is shutdown. When restarting Geany, the previously opened project
2603 file that was in use at the end of the last session will be reopened.</p>
2604 <p>The project menu items are detailed below.</p>
2605 <div class="section">
2606 <h3><a class="toc-backref" href="#id126" id="new-project" name="new-project">New Project</a></h3>
2607 <p>To create a new project, fill in the <em>Name</em> field. By default this
2608 will setup a new project file <tt class="docutils literal"><span class="pre">~/projects/name.geany</span></tt>. Usually it's
2609 best to store all your project files in the same directory (they are
2610 independent of any source directory trees).</p>
2611 <p>The Base path text field is setup to use <tt class="docutils literal"><span class="pre">~/projects/name</span></tt>. This
2612 can safely be set to any existing path -- it will not touch the file
2613 structure contained in it.</p>
2614 </div>
2615 <div class="section">
2616 <h3><a class="toc-backref" href="#id127" id="project-properties" name="project-properties">Project Properties</a></h3>
2617 <p>You can set an optional description for the project, but it is not
2618 used elsewhere by Geany.</p>
2619 <p>The <em>Base path</em> field is used as the directory to run the Build menu commands.
2620 The specified path can be an absolute path or it is considered to be
2621 relative to the project's file name.</p>
2622 <div class="section">
2623 <h4><a class="toc-backref" href="#id128" id="set-base-path-button" name="set-base-path-button">Set Base Path Button</a></h4>
2624 <p>This button is a convenience to set the working directory fields
2625 in the non-filetype Build menu items to %p to use the project base path.</p>
2626 <div class="note">
2627 <p class="first admonition-title">Note</p>
2628 <p class="last">Pressing the 'set' button will overright any working directories
2629 you have configured for the project.</p>
2630 </div>
2631 </div>
2632 </div>
2633 <div class="section">
2634 <h3><a class="toc-backref" href="#id129" id="open-project" name="open-project">Open Project</a></h3>
2635 <p>The Open command displays a standard file chooser, starting in
2636 <tt class="docutils literal"><span class="pre">~/projects</span></tt>. Choose a project file named with the <tt class="docutils literal"><span class="pre">.geany</span></tt>
2637 extension.</p>
2638 <p>When project session support is enabled, Geany will close the currently
2639 open files and open the session files associated with the project.</p>
2640 </div>
2641 <div class="section">
2642 <h3><a class="toc-backref" href="#id130" id="close-project" name="close-project">Close Project</a></h3>
2643 <p>Project file settings are saved when the project is closed.</p>
2644 <p>When project session support is enabled, Geany will close the project
2645 session files and open any previously closed default session files.</p>
2646 </div>
2647 </div>
2648 <div class="section">
2649 <h2><a class="toc-backref" href="#id131" id="build-menu" name="build-menu">Build Menu</a></h2>
2650 <p>After editing code with Geany, the next step is to compile, link, build,
2651 interpret, run etc.  As Geany supports many languages each with a different
2652 approach to such operations, and as there are also many language independant
2653 software building systems, Geany does not have a built in build system, nor
2654 does it limit which system you can use.  Instead the build menu provides
2655 a configurable and flexible means of running any external commands to
2656 execute your preferred build system.</p>
2657 <p>This section provides a description of the default configuration of the
2658 build menu and then covers how to configure it, and where the defaults fit in.</p>
2659 <p>Running the commands from within Geany has two benefits:</p>
2660 <ul class="simple">
2661 <li>the current file is automatically saved before the command is run</li>
2662 <li>the output is captured in the Compiler notebook tab and parsed for
2663 warnings or errors</li>
2664 </ul>
2665 <p>Warnings and errors that can be parsed for line numbers will be shown in
2666 red in the Compiler tab and you can click on them to switch to the relevant
2667 source file (or open it) and mark the line number.  Also lines with
2668 warnings or errors are marked in the source, see <a class="reference" href="#indicators">Indicators</a> below.</p>
2669 <div class="tip">
2670 <p class="first admonition-title">Tip</p>
2671 <p class="last">If Geany's default error message parsing does not parse errors for
2672 the tool you're using, you can set a custom regex in the Build Commands
2673 Dialog, see <a class="reference" href="#build-menu-configuration">Build Menu Configuration</a></p>
2674 </div>
2675 <div class="section">
2676 <h3><a class="toc-backref" href="#id132" id="indicators" name="indicators">Indicators</a></h3>
2677 <p>Indicators are red squiggly underlines which are used to highlight
2678 errors which occurred while compiling the current file. So you can
2679 easily see where your code failed to compile. To remove the indicators,
2680 just select &quot;Remove all indicators&quot; in the document file menu.</p>
2681 <p>If you do not like this feature, you can disable it in the preferences
2682 dialog.</p>
2683 </div>
2684 <div class="section">
2685 <h3><a class="toc-backref" href="#id133" id="default-build-menu-items" name="default-build-menu-items">Default Build Menu Items</a></h3>
2686 <p>Depending on the current file's filetype, the default Build menu will contain
2687 the following items:</p>
2688 <ul class="simple">
2689 <li>Compile</li>
2690 <li>Build</li>
2691 <li>Make All</li>
2692 <li>Make Custom Target</li>
2693 <li>Make Object</li>
2694 <li>Next Error</li>
2695 <li>Previous Error</li>
2696 <li>Execute</li>
2697 <li>Set Build Menu Commands</li>
2698 </ul>
2699 <div class="section">
2700 <h4><a class="toc-backref" href="#id134" id="compile" name="compile">Compile</a></h4>
2701 <p>The Compile command has different uses for different kinds of files.</p>
2702 <p>For compilable languages such as C and C++, the Compile command is
2703 set up to compile the current source file into a binary object file.</p>
2704 <p>Java source files will be compiled to class file bytecode.</p>
2705 <p>Interpreted languages such as Perl, Python, Ruby will compile to
2706 bytecode if the language supports it, or will run a syntax check,
2707 or if that is not available will run the file in its language interpreter.</p>
2708 </div>
2709 <div class="section">
2710 <h4><a class="toc-backref" href="#id135" id="build" name="build">Build</a></h4>
2711 <p>For compilable languages such as C and C++, the Build command will link
2712 the current source file's equivalent object file into an executable. If
2713 the object file does not exist, the source will be compiled and linked
2714 in one step, producing just the executable binary.</p>
2715 <p>Interpreted languages do not use the Build command.</p>
2716 </div>
2717 <div class="section">
2718 <h4><a class="toc-backref" href="#id136" id="make" name="make">Make</a></h4>
2719 <p>This runs &quot;make&quot; in the same directory as the
2720 current file.</p>
2721 </div>
2722 <div class="section">
2723 <h4><a class="toc-backref" href="#id137" id="make-custom-target" name="make-custom-target">Make custom target</a></h4>
2724 <p>This is similar to running 'Make' but you will be prompted for
2725 the make target name to be passed to the Make tool. For example,
2726 typing 'clean' in the dialog prompt will run &quot;make clean&quot;.</p>
2727 </div>
2728 <div class="section">
2729 <h4><a class="toc-backref" href="#id138" id="make-object" name="make-object">Make object</a></h4>
2730 <p>Make object will run &quot;make current_file.o&quot; in the same directory as
2731 the current file, using the filename for 'current_file'. It is useful
2732 for building just the current file without building the whole project.</p>
2733 </div>
2734 <div class="section">
2735 <h4><a class="toc-backref" href="#id139" id="next-error" name="next-error">Next Error</a></h4>
2736 <p>The next error item will move to the next detected error in the file.</p>
2737 </div>
2738 <div class="section">
2739 <h4><a class="toc-backref" href="#id140" id="previous-error" name="previous-error">Previous Error</a></h4>
2740 <p>The previous error item will move to the previous detected error in the file.</p>
2741 </div>
2742 <div class="section">
2743 <h4><a class="toc-backref" href="#id141" id="execute" name="execute">Execute</a></h4>
2744 <p>Execute will run the corresponding executable file, shell script or
2745 interpreted script in a terminal window. Note that the Terminal tool
2746 path must be correctly set in the Tools tab of the Preferences dialog -
2747 you can use any terminal program that runs a Bourne compatible shell
2748 and accept the &quot;-e&quot; command line argument to start a command or can be
2749 selected to us the build-in VTE if it is available, see
2750 <a class="reference" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
2751 <p>After your program or script has finished executing, you will be
2752 prompted to press the return key. This allows you to review any text
2753 output from the program before the terminal window is closed.</p>
2754 <p>The execute command output is not parsed for errors.</p>
2755 </div>
2756 <div class="section">
2757 <h4><a class="toc-backref" href="#id142" id="stopping-running-processes" name="stopping-running-processes">Stopping running processes</a></h4>
2758 <p>When there is a running program, the Execute menu item in the menu and
2759 the Run button in the toolbar
2760 becomes a stop button and you can stop the current running program. This
2761 works by sending a signal to the process (and its child process(es))
2762 to stop the process. The signal used is SIGQUIT.</p>
2763 <p>Depending on the process you started it is possible that the process
2764 cannot be stopped. For example this can happen when the process creates
2765 more than one child process.</p>
2766 <div class="section">
2767 <h5><a class="toc-backref" href="#id143" id="terminal-emulators" name="terminal-emulators">Terminal emulators</a></h5>
2768 <p>Xterm is known to work properly. If you are using &quot;Terminal&quot;
2769 (the terminal program of Xfce), you should add the command line
2770 option <tt class="docutils literal"><span class="pre">--disable-server</span></tt> otherwise the started process cannot be
2771 stopped. Just add this option in the preferences dialog on the Tools
2772 tab in the terminal field.</p>
2773 </div>
2774 </div>
2775 <div class="section">
2776 <h4><a class="toc-backref" href="#id144" id="set-build-commands" name="set-build-commands">Set Build Commands</a></h4>
2777 <p>By default the Compile and Build commands invoke the GCC compiler and
2778 linker with only the basic arguments needed by all programs. Using
2779 Set Build Commands you can add any include paths and compile
2780 flags for the compiler, any library names and paths for the linker,
2781 and any arguments you want to use when running Execute.</p>
2782 <p>For details of configuration see <a class="reference" href="#build-menu-configuration">Build Menu Configuration</a> below.</p>
2783 <div class="note">
2784 <p class="first admonition-title">Note</p>
2785 <p class="last">If you need complex settings for your build system, or several
2786 different settings, then writing a Makefile and using the Make
2787 commands is recommended; this will also make it easier for users to
2788 build your software.</p>
2789 </div>
2790 <p>These settings are saved automatically when Geany is shut down.</p>
2791 </div>
2792 </div>
2793 <div class="section">
2794 <h3><a class="toc-backref" href="#id145" id="build-menu-configuration" name="build-menu-configuration">Build Menu Configuration</a></h3>
2795 <p>The build menu has considerable flexibility and configurability, allowing
2796 both menu labels the commands they execute and the directory they execute
2797 in to be configured.</p>
2798 <p>For example, if you change one of the default make commands to run say 'waf'
2799 you can also change the label to match.</p>
2800 <p>Underlines in the labels set mnemonic characters.</p>
2801 <p>The build menu is divided into four groups of items each with different
2802 behaviors:</p>
2803 <ul class="simple">
2804 <li>file items - are configurable and depend on the filetype of the current
2805 document, put the output in the compiler tab and parse it for errors</li>
2806 <li>non-file items - are configurable and mostly don't depend on the filetype
2807 of the current document, put the output in the compiler tab and parse
2808 it for errors</li>
2809 <li>execute items - are configurable and intended for executing your
2810 program or other long running programs.  The output is not parsed for errors
2811 and is directed to the terminal selected in preferences.</li>
2812 <li>fixed items - are not configurable because they perform the Geany built in actions,
2813 go to the next error, go to the previous error and show the build menu
2814 commands dialog</li>
2815 </ul>
2816 <p>The maximum numbers of items in each of the configurable groups can be
2817 configured when Geany starts using hidden settings(see <a class="reference" href="#preferences-file-format">Preferences File Format</a>).
2818 Even though the maximum number of items may have been increased, only
2819 those menu items that have values configured are shown in the menu.</p>
2820 <p>The groups of menu items obtain their configuration from four potential
2821 sources.  The highest pririty source that has the menu item defined will
2822 be used. The sources in decreasing priority are:</p>
2823 <ul class="simple">
2824 <li>a project file if open</li>
2825 <li>the user preferences</li>
2826 <li>the system filetype definitions</li>
2827 <li>the defaults</li>
2828 </ul>
2829 <p>The detailed relationships between sources and the configurable menu item groups
2830 is shown in the following table.</p>
2831 <table border="1" class="docutils">
2832 <colgroup>
2833 <col width="13%" />
2834 <col width="19%" />
2835 <col width="23%" />
2836 <col width="17%" />
2837 <col width="28%" />
2838 </colgroup>
2839 <thead valign="bottom">
2840 <tr><th class="head">Group</th>
2841 <th class="head">Project File</th>
2842 <th class="head">Preferences</th>
2843 <th class="head">System Filetype</th>
2844 <th class="head">Defaults</th>
2845 </tr>
2846 </thead>
2847 <tbody valign="top">
2848 <tr><td>Filetype</td>
2849 <td><p class="first">Loads From: project
2850 file</p>
2851 <p class="last">Saves To: project
2852 file</p>
2853 </td>
2854 <td><p class="first">Loads From:
2855 filetype.xxx file in
2856 ~/.config/geany/filedefs</p>
2857 <p class="last">Saves to: as above,
2858 creating if needed.</p>
2859 </td>
2860 <td><p class="first">Loads From:
2861 filetype.xxx in
2862 Geany install</p>
2863 <p class="last">Saves to: as user
2864 preferences left.</p>
2865 </td>
2866 <td>None</td>
2867 </tr>
2868 <tr><td>Non-Filetype</td>
2869 <td><p class="first">Loads From: project
2870 file</p>
2871 <p class="last">Saves To: project
2872 file</p>
2873 </td>
2874 <td><p class="first">Loads From:
2875 geany.conf file in
2876 ~/.config/geany</p>
2877 <p class="last">Saves to: as above,
2878 creating if needed.</p>
2879 </td>
2880 <td><p class="first">Loads From:
2881 filetype.xxx in
2882 Geany install</p>
2883 <p class="last">Saves to: as user
2884 preferences left.</p>
2885 </td>
2886 <td><dl class="first last docutils">
2887 <dt>1:</dt>
2888 <dd>Label: _Make
2889 Command: make</dd>
2890 <dt>2:</dt>
2891 <dd>Label: Make Custom _Target
2892 Command: make</dd>
2893 <dt>3:</dt>
2894 <dd>Label: Make _Object
2895 Command: make %e.o</dd>
2896 </dl>
2897 </td>
2898 </tr>
2899 <tr><td>Execute</td>
2900 <td><p class="first">Loads From: project
2901 file or else
2902 filetype defined in
2903 project file</p>
2904 <p class="last">Saves To:
2905 project file</p>
2906 </td>
2907 <td><p class="first">Loads From:
2908 geany.conf file in
2909 ~/.config/geany or else
2910 filetype.xxx file in
2911 ~/.config/geany/filedefs</p>
2912 <p class="last">Saves To:
2913 filetype.xxx file in
2914 ~/.config/geany/filedefs</p>
2915 </td>
2916 <td><p class="first">Loads From:
2917 filetype.xxx in
2918 Geany install</p>
2919 <p class="last">Saves To: as user
2920 preferences left</p>
2921 </td>
2922 <td>Label: _Execute Command: ./%e</td>
2923 </tr>
2924 </tbody>
2925 </table>
2926 <p>The following notes on the table reference cells by coordinate as (group,source):</p>
2927 <ul class="simple">
2928 <li>General - for filetype.xxx substitute the filetype name of the
2929 current document for xxx.</li>
2930 <li>System Filetypes - Labels loaded from these sources are locale sensitive
2931 and can contain translations.</li>
2932 <li>(Filetype, Project File) and (Filetype, Preferences) - preferences use a full
2933 filetype file so that users can configure all other filetype preferences
2934 as well.  Projects can only configure menu items per filetype.  Saving
2935 in the project file means that there is only one file per project not
2936 a whole directory.</li>
2937 <li>(Non-Filetype, System Filetype) - although conceptually strange, defining
2938 non-filetype commands in a filetype file, this provides the ability to
2939 define filetype dependent default menu items.</li>
2940 <li>(Execute, Project File) and (Execute, Preferences) - the project filetype based execute
2941 configuration and preferences non-filetype based execute can only be set by hand editing the
2942 appropriate file, see <a class="reference" href="#preferences-file-format">Preferences File Format</a> and <a class="reference" href="#project-file-format">Project File Format</a>.</li>
2943 </ul>
2944 </div>
2945 <div class="section">
2946 <h3><a class="toc-backref" href="#id146" id="build-menu-commands-dialog" name="build-menu-commands-dialog">Build Menu Commands Dialog</a></h3>
2947 <p>Most of the configuration of the build menu is done through the Build Menu
2948 Commands Dialog.  You edit the configuration sourced from preferences in the
2949 dialog opened from the Build-&gt;Build Menu Commands item and you edit the
2950 configuration from the project in the build tab of the project preferences
2951 dialog.  Both use the same form shown below.</p>
2952 <img alt="./images/build_menu_commands_dialog.png" src="./images/build_menu_commands_dialog.png" />
2953 <p>The dialog is divided into three sections:</p>
2954 <ul class="simple">
2955 <li>Filetype menu items which will be selected based on the filetype of the
2956 currently open document,</li>
2957 <li>Non-filetype menu items, and</li>
2958 <li>Execute menu items.</li>
2959 </ul>
2960 <p>The filetype and non-filetype sections also contains a field for the regular
2961 expression used for parsing command output for error and warning messages.</p>
2962 <p>The columns in the first three sections allow setting of the label, command,
2963 and working directory to run the command in.</p>
2964 <p>An item with an empty label will not be shown in the menu.</p>
2965 <p>An empty working directory will default to the directory of the current document.
2966 If there is no current document then the command will not run.</p>
2967 <p>The dialog will always show the command selected by priority, not just the
2968 commands configured in this configuration source. This ensures that you always
2969 see what the menu item is going to do if activated.</p>
2970 <p>If the current source of the menu item is higher priority than the
2971 configuration source you are editing then the command will be shown
2972 in the dialog but will be insensitive (greyed out).  This can't happen
2973 with the project source but can with the preferences source dialog.</p>
2974 <p>The clear buttons remove the definition from the configuration source you are editing.
2975 When you do this the command from the next lower priority source will be shown.
2976 To hide lower priority menu items without having anything show in the menu
2977 configure with a nothing in the label but at least one character in the command.</p>
2978 <div class="section">
2979 <h4><a class="toc-backref" href="#id147" id="substitutions-in-commands-and-working-directories" name="substitutions-in-commands-and-working-directories">Substitutions in Commands and Working Directories</a></h4>
2980 <p>The first occurance of each of the following character sequences in each of the
2981 command and working directory fields is substituted by the items specified below
2982 before the command is run.</p>
2983 <ul class="simple">
2984 <li>%d - substituted by the absolute path to the directory of the current file.</li>
2985 <li>%e - substituted by the name of the current file without the extension or path.</li>
2986 <li>%f - substituted by the name of the current file without the path.</li>
2987 <li>%p - if a project is open, substituted by the base path from the project.</li>
2988 </ul>
2989 <div class="note">
2990 <p class="first admonition-title">Note</p>
2991 <p class="last">If the basepath set in the project preferences is not an absolute path , then it is
2992 taken as relative to the directory of the project file.  This allows a project file
2993 stored in the source tree to specify all commands and working directories relative
2994 to the tree itself, so that the whole tree including the project file, can be moved
2995 and even checked into and out of version control without having to re-configure the
2996 build menu.</p>
2997 </div>
2998 </div>
2999 <div class="section">
3000 <h4><a class="toc-backref" href="#id148" id="build-menu-keyboard-shortcuts" name="build-menu-keyboard-shortcuts">Build Menu Keyboard Shortcuts</a></h4>
3001 <p>Keyboard shortcuts can be defiend for the first two filetype menu items, the first three
3002 non-filetype menu items, the first two execute menu items and the fixed menu items.
3003 In the keybindings configuration dialog (see <a class="reference" href="#keybinding-preferences">Keybinding preferences</a>)
3004 these items are identified by the default labels shown in the <a class="reference" href="#build-menu">Build Menu</a> section above.</p>
3005 <p>It is currently not possible to bind keyboard shortcuts to more than these menu items.</p>
3006 </div>
3007 <div class="section">
3008 <h4><a class="toc-backref" href="#id149" id="configuration-files" name="configuration-files">Configuration Files</a></h4>
3009 <p>The configurable Build Menu capability was introduced in Geany V0.19 and
3010 required a new section to be added to the configuration files (See
3011 <a class="reference" href="#preferences-file-format">Preferences File Format</a>).  Geany will still load older format project,
3012 preferences and filetype file settings and will attempt to map them into the new
3013 configuration format.  There is not a simple clean mapping between the formats.
3014 The mapping used produces the most sensible results for the majority of cases.
3015 However, if they do not map the way you want, you may have to manually
3016 configure some settings using the Build Commands
3017 Dialog or the Build tab of the project preferences dialog.</p>
3018 <p>Any setting configured in either of these dialogs will override settings mapped from
3019 older format configuration files.</p>
3020 </div>
3021 </div>
3022 </div>
3023 <div class="section">
3024 <h2><a class="toc-backref" href="#id150" id="printing-support" name="printing-support">Printing support</a></h2>
3025 <p>Since Geany 0.13 there has been printing support using GTK's printing API.
3026 The printed page(s) will look nearly the same as on your screen in Geany.
3027 Additionally, there are some options to modify the printed page(s).</p>
3028 <p>You can define whether to print line numbers, page numbers at the bottom of
3029 each page and whether to print a page header on each page. This header
3030 contains the filename of the printed document, the current page number and
3031 the date and time of printing. By default, the file name of the document
3032 with full path information is added to the header. If you prefer to add
3033 only the basename of the file(without any path information) you can set it
3034 in the preferences dialog. You can also adjust the format of the date and
3035 time added to the page header. The available conversion specifiers are the
3036 same as the ones which can be used with the ANSI C strftime function.</p>
3037 <p>All of these settings can also be changed in the print dialog just before
3038 actual printing is done.
3039 On Unix-like systems the provided print dialog offers a print preview. The
3040 preview file is opened with a PDF viewer and by default GTK uses <tt class="docutils literal"><span class="pre">evince</span></tt>
3041 for print preview. If you have not installed evince or just want to use
3042 another PDF viewer, you can change the program to use in the file
3043 <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home directory). Simply add a line
3044 like:</p>
3045 <pre class="literal-block">
3046 gtk-print-preview-command = &quot;epdfview %f&quot;
3047 </pre>
3048 <p>at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3049 as the print preview command.</p>
3050 <p>Unfortunately, native GTK printing support is only available if Geany was
3051 built against GTK 2.10 (or above) <strong>and</strong> is running with GTK 2.10 (or above).
3052 If not, Geany provides basic printing support. This means you can print a
3053 file by passing the filename of the current file to a command which
3054 actually prints the file. However, the printed document contains no syntax
3055 highlighting. You can adjust the command to which the filename is
3056 passed in the preferences dialog. The default command is:</p>
3057 <pre class="literal-block">
3058 % lpr %f
3059 </pre>
3060 <p><tt class="docutils literal"><span class="pre">%f</span></tt> will be substituted by the filename of the current file. Geany
3061 will not show errors from the command itself, so you should make
3062 sure that it works before(e.g. by trying to execute it from the
3063 command line).</p>
3064 <p>A nicer example, which many prefer is:</p>
3065 <pre class="literal-block">
3066 % a2ps -1 --medium=A4 -o - %f | xfprint4
3067 </pre>
3068 <p>But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3069 gtklp or similar programs can be used.</p>
3070 </div>
3071 <div class="section">
3072 <h2><a class="toc-backref" href="#id151" id="plugins" name="plugins">Plugins</a></h2>
3073 <p>Plugins are loaded at startup, if the <em>Enable plugin support</em>
3074 general preference is set. There is also a command-line option,
3075 <tt class="docutils literal"><span class="pre">-p</span></tt>, which prevents plugins being loaded. Plugins are scanned in
3076 the following directories:</p>
3077 <ul class="simple">
3078 <li><tt class="docutils literal"><span class="pre">$prefix/lib/geany</span></tt> (see <a class="reference" href="#installation-prefix">Installation prefix</a>)</li>
3079 <li><tt class="docutils literal"><span class="pre">~/.config/geany/plugins</span></tt></li>
3080 </ul>
3081 <p>Most plugins add menu items to the <em>Tools</em> menu when they are loaded.</p>
3082 <p>Since Geany 0.13, there is a Plugin Manager to let you choose which plugins
3083 should be loaded at startup. You can also load and unload plugins on the
3084 fly using this dialog. Once you click the checkbox for a specific plugin
3085 in the dialog, it is loaded or unloaded according to its previous state.
3086 By default, no plugins are loaded at startup until you select some.
3087 You can also configure some plugin specific options when the plugin
3088 provides some.</p>
3089 <p>See also <a class="reference" href="#plugin-documentation">Plugin documentation</a> for information about single plugins
3090 which are included in Geany.</p>
3091 </div>
3092 <div class="section">
3093 <h2><a class="toc-backref" href="#id152" id="keybindings" name="keybindings">Keybindings</a></h2>
3094 <p>Geany supports the default keyboard shortcuts for the Scintilla
3095 editing widget. For a list of these commands, see <a class="reference" href="#scintilla-keyboard-commands">Scintilla
3096 keyboard commands</a>. The Scintilla keyboard shortcuts will be overridden
3097 by any custom keybindings with the same keyboard shortcut.</p>
3098 <div class="section">
3099 <h3><a class="toc-backref" href="#id153" id="switching-documents" name="switching-documents">Switching documents</a></h3>
3100 <p>There are a few non-configurable bindings to switch between documents,
3101 listed below. These can also be overridden by custom keybindings.</p>
3102 <table border="1" class="docutils">
3103 <colgroup>
3104 <col width="31%" />
3105 <col width="69%" />
3106 </colgroup>
3107 <thead valign="bottom">
3108 <tr><th class="head">Key</th>
3109 <th class="head">Action</th>
3110 </tr>
3111 </thead>
3112 <tbody valign="top">
3113 <tr><td>Alt-[1-9]</td>
3114 <td>Select left-most tab, from 1 to 9.</td>
3115 </tr>
3116 <tr><td>Alt-0</td>
3117 <td>Select right-most tab.</td>
3118 </tr>
3119 <tr><td>Ctrl-Shift-PgUp</td>
3120 <td>Select left-most tab.</td>
3121 </tr>
3122 <tr><td>Ctrl-Shift-PgDn</td>
3123 <td>Select right-most tab.</td>
3124 </tr>
3125 </tbody>
3126 </table>
3127 </div>
3128 <div class="section">
3129 <h3><a class="toc-backref" href="#id154" id="configurable-keybindings" name="configurable-keybindings">Configurable keybindings</a></h3>
3130 <p>For all actions listed below you can define your own keybindings. Open
3131 the Preferences dialog, select the desired action and click on
3132 change. In the resulting dialog you can press the key combination you
3133 want to assign to the action and it will be saved when you press OK.
3134 You can define only one key combination for each action and each key
3135 combination can only be defined for one action.</p>
3136 <p>Some of the default key combinations are common across many
3137 applications, for example <em>Ctrl-N</em> for New and <em>Ctrl-O</em> for Open.
3138 Because they are so common it is not advisable to change these, but
3139 you can add other key combinations for these actions. For example
3140 <em>Ctrl-O</em> is set to execute menu_open by default, but you can also
3141 define <em>Alt-O</em>, so that the file open dialog is shown by pressing
3142 either <em>Ctrl-O</em> or <em>Alt-O</em>.</p>
3143 <p>The following tables list all customizable keyboard shortcuts, those
3144 which are common to many applications are marked with (C) after the
3145 shortcut.</p>
3146 <div class="section">
3147 <h4><a class="toc-backref" href="#id155" id="file-keybindings" name="file-keybindings">File keybindings</a></h4>
3148 <table border="1" class="docutils">
3149 <colgroup>
3150 <col width="29%" />
3151 <col width="24%" />
3152 <col width="47%" />
3153 </colgroup>
3154 <thead valign="bottom">
3155 <tr><th class="head">Action</th>
3156 <th class="head">Default shortcut</th>
3157 <th class="head">Description</th>
3158 </tr>
3159 </thead>
3160 <tbody valign="top">
3161 <tr><td>New</td>
3162 <td>Ctrl-N  (C)</td>
3163 <td>Creates a new file.</td>
3164 </tr>
3165 <tr><td>Open</td>
3166 <td>Ctrl-O  (C)</td>
3167 <td>Opens a file.</td>
3168 </tr>
3169 <tr><td>Open selected file</td>
3170 <td>Ctrl-Shift-O</td>
3171 <td>Opens the selected filename.</td>
3172 </tr>
3173 <tr><td>Re-open last closed tab</td>
3174 <td>&nbsp;</td>
3175 <td>Re-opens the last closed document tab.</td>
3176 </tr>
3177 <tr><td>Save</td>
3178 <td>Ctrl-S  (C)</td>
3179 <td>Saves the current file.</td>
3180 </tr>
3181 <tr><td>Save As</td>
3182 <td>&nbsp;</td>
3183 <td>Saves the current file under a new name.</td>
3184 </tr>
3185 <tr><td>Save all</td>
3186 <td>Ctrl-Shift-S</td>
3187 <td>Saves all open files.</td>
3188 </tr>
3189 <tr><td>Close all</td>
3190 <td>Ctrl-Shift-W</td>
3191 <td>Closes all open files.</td>
3192 </tr>
3193 <tr><td>Close</td>
3194 <td>Ctrl-W  (C)</td>
3195 <td>Closes the current file.</td>
3196 </tr>
3197 <tr><td>Reload file</td>
3198 <td>Ctrl-R  (C)</td>
3199 <td>Reloads the current file. All unsaved changes
3200 will be lost.</td>
3201 </tr>
3202 <tr><td>Print</td>
3203 <td>Ctrl-P  (C)</td>
3204 <td>Prints the current file.</td>
3205 </tr>
3206 </tbody>
3207 </table>
3208 </div>
3209 <div class="section">
3210 <h4><a class="toc-backref" href="#id156" id="editor-keybindings" name="editor-keybindings">Editor keybindings</a></h4>
3211 <table border="1" class="docutils">
3212 <colgroup>
3213 <col width="29%" />
3214 <col width="24%" />
3215 <col width="47%" />
3216 </colgroup>
3217 <thead valign="bottom">
3218 <tr><th class="head">Action</th>
3219 <th class="head">Default shortcut</th>
3220 <th class="head">Description</th>
3221 </tr>
3222 </thead>
3223 <tbody valign="top">
3224 <tr><td>Undo</td>
3225 <td>Ctrl-Z  (C)</td>
3226 <td>Un-does the last action.</td>
3227 </tr>
3228 <tr><td>Redo</td>
3229 <td>Ctrl-Y</td>
3230 <td>Re-does the last action.</td>
3231 </tr>
3232 <tr><td>Delete current line(s)</td>
3233 <td>Ctrl-K</td>
3234 <td>Deletes the current line (and any lines with a
3235 selection).</td>
3236 </tr>
3237 <tr><td>Delete to line end</td>
3238 <td>Ctrl-Shift-Delete</td>
3239 <td>Deletes from the current caret position to the
3240 end of the current line.</td>
3241 </tr>
3242 <tr><td>Duplicate line or selection</td>
3243 <td>Ctrl-D</td>
3244 <td>Duplicates the current line or selection.</td>
3245 </tr>
3246 <tr><td>Transpose current line</td>
3247 <td>Ctrl-T</td>
3248 <td>Transposes the current line with the previous one.</td>
3249 </tr>
3250 <tr><td>Scroll to current line</td>
3251 <td>Ctrl-Shift-L</td>
3252 <td>Scrolls the current line into the centre of the
3253 view. The cursor position and or an existing
3254 selection will not be changed.</td>
3255 </tr>
3256 <tr><td>Scroll up by one line</td>
3257 <td>Alt-Up</td>
3258 <td>Scrolls the view.</td>
3259 </tr>
3260 <tr><td>Scroll down by one line</td>
3261 <td>Alt-Down</td>
3262 <td>Scrolls the view.</td>
3263 </tr>
3264 <tr><td>Complete word</td>
3265 <td>Ctrl-Space</td>
3266 <td>Shows the autocompletion list. If already showing
3267 tag completion, it shows document word completion
3268 instead, even if it is not enabled for automatic
3269 completion. Likewise if no tag suggestions are
3270 available, it shows document word completion.</td>
3271 </tr>
3272 <tr><td>Show calltip</td>
3273 <td>Ctrl-Shift-Space</td>
3274 <td>Shows a calltip for the current function or
3275 method.</td>
3276 </tr>
3277 <tr><td>Show macro list</td>
3278 <td>Ctrl-Return</td>
3279 <td>Shows a list of available macros and variables in
3280 the workspace.</td>
3281 </tr>
3282 <tr><td>Complete snippet</td>
3283 <td>Tab</td>
3284 <td>If you type a construct like if or for and press
3285 this key, it will be completed with a matching
3286 template.</td>
3287 </tr>
3288 <tr><td>Suppress snippet completion</td>
3289 <td>&nbsp;</td>
3290 <td>If you type a construct like if or for and press
3291 this key, it will not be completed, and a space or
3292 tab will be inserted, depending on what the
3293 construct completion keybinding is set to. For
3294 example, if you have set the construct completion
3295 keybinding to space, then setting this to
3296 Shift+space will prevent construct completion and
3297 insert a space.</td>
3298 </tr>
3299 <tr><td>Context Action</td>
3300 <td>&nbsp;</td>
3301 <td>Executes a command and passes the current word
3302 (near the cursor position) or selection as an
3303 argument. See the section called <a class="reference" href="#context-actions">Context
3304 actions</a>.</td>
3305 </tr>
3306 <tr><td>Move cursor in snippet</td>
3307 <td>&nbsp;</td>
3308 <td>Jumps to the next defined cursor positions in a
3309 completed snippets if multiple cursor positions
3310 where defined.</td>
3311 </tr>
3312 <tr><td>Word part completion</td>
3313 <td>Tab</td>
3314 <td>When the autocompletion list is visible, complete
3315 the currently selected item up to the next word
3316 part.</td>
3317 </tr>
3318 <tr><td>Move line(s) up</td>
3319 <td>&nbsp;</td>
3320 <td>Move the current line or selected lines up by
3321 one line.</td>
3322 </tr>
3323 <tr><td>Move line(s) down</td>
3324 <td>&nbsp;</td>
3325 <td>Move the current line or selected lines down by
3326 one line.</td>
3327 </tr>
3328 </tbody>
3329 </table>
3330 </div>
3331 <div class="section">
3332 <h4><a class="toc-backref" href="#id157" id="clipboard-keybindings" name="clipboard-keybindings">Clipboard keybindings</a></h4>
3333 <table border="1" class="docutils">
3334 <colgroup>
3335 <col width="29%" />
3336 <col width="23%" />
3337 <col width="48%" />
3338 </colgroup>
3339 <thead valign="bottom">
3340 <tr><th class="head">Action</th>
3341 <th class="head">Default shortcut</th>
3342 <th class="head">Description</th>
3343 </tr>
3344 </thead>
3345 <tbody valign="top">
3346 <tr><td>Cut</td>
3347 <td>Ctrl-X  (C)</td>
3348 <td>Cut the current selection to the clipboard.</td>
3349 </tr>
3350 <tr><td>Copy</td>
3351 <td>Ctrl-C  (C)</td>
3352 <td>Copy the current selection to the clipboard.</td>
3353 </tr>
3354 <tr><td>Paste</td>
3355 <td>Ctrl-V  (C)</td>
3356 <td>Paste the clipboard text into the current document.</td>
3357 </tr>
3358 <tr><td>Cut current line(s)</td>
3359 <td>Ctrl-Shift-X</td>
3360 <td>Cuts the current line (and any lines with a
3361 selection) to the clipboard.</td>
3362 </tr>
3363 <tr><td>Copy current line(s)</td>
3364 <td>Ctrl-Shift-C</td>
3365 <td>Copies the current line (and any lines with a
3366 selection) to the clipboard.</td>
3367 </tr>
3368 </tbody>
3369 </table>
3370 </div>
3371 <div class="section">
3372 <h4><a class="toc-backref" href="#id158" id="select-keybindings" name="select-keybindings">Select keybindings</a></h4>
3373 <table border="1" class="docutils">
3374 <colgroup>
3375 <col width="29%" />
3376 <col width="24%" />
3377 <col width="47%" />
3378 </colgroup>
3379 <thead valign="bottom">
3380 <tr><th class="head">Action</th>
3381 <th class="head">Default shortcut</th>
3382 <th class="head">Description</th>
3383 </tr>
3384 </thead>
3385 <tbody valign="top">
3386 <tr><td>Select all</td>
3387 <td>Ctrl-A  (C)</td>
3388 <td>Makes a selection of all text in the current
3389 document.</td>
3390 </tr>
3391 <tr><td>Select current word</td>
3392 <td>Alt-Shift-W</td>
3393 <td>Selects the current word under the cursor.</td>
3394 </tr>
3395 <tr><td>Select current paragraph</td>
3396 <td>Alt-Shift-P</td>
3397 <td>Selects the current paragraph under the cursor
3398 which is defined by two empty lines around it.</td>
3399 </tr>
3400 <tr><td>Select current line(s)</td>
3401 <td>Alt-Shift-L</td>
3402 <td>Selects the current line under the cursor (and any
3403 partially selected lines).</td>
3404 </tr>
3405 <tr><td>Select to previous word part</td>
3406 <td>&nbsp;</td>
3407 <td>(Extend) selection to previous word part boundary.</td>
3408 </tr>
3409 <tr><td>Select to next word part</td>
3410 <td>&nbsp;</td>
3411 <td>(Extend) selection to next word part boundary.</td>
3412 </tr>
3413 </tbody>
3414 </table>
3415 </div>
3416 <div class="section">
3417 <h4><a class="toc-backref" href="#id159" id="insert-keybindings" name="insert-keybindings">Insert keybindings</a></h4>
3418 <table border="1" class="docutils">
3419 <colgroup>
3420 <col width="29%" />
3421 <col width="24%" />
3422 <col width="47%" />
3423 </colgroup>
3424 <thead valign="bottom">
3425 <tr><th class="head">Action</th>
3426 <th class="head">Default shortcut</th>
3427 <th class="head">Description</th>
3428 </tr>
3429 </thead>
3430 <tbody valign="top">
3431 <tr><td>Insert date</td>
3432 <td>Shift-Alt-D</td>
3433 <td>Inserts a customisable date.</td>
3434 </tr>
3435 <tr><td>Insert alternative whitespace</td>
3436 <td>&nbsp;</td>
3437 <td>Inserts a tab character when spaces should
3438 be used for indentation and inserts space
3439 characters of the amount of a tab width when
3440 tabs should be used for indentation.</td>
3441 </tr>
3442 </tbody>
3443 </table>
3444 </div>
3445 <div class="section">
3446 <h4><a class="toc-backref" href="#id160" id="format-keybindings" name="format-keybindings">Format keybindings</a></h4>
3447 <table border="1" class="docutils">
3448 <colgroup>
3449 <col width="29%" />
3450 <col width="24%" />
3451 <col width="47%" />
3452 </colgroup>
3453 <thead valign="bottom">
3454 <tr><th class="head">Action</th>
3455 <th class="head">Default shortcut</th>
3456 <th class="head">Description</th>
3457 </tr>
3458 </thead>
3459 <tbody valign="top">
3460 <tr><td>Toggle case of selection</td>
3461 <td>Ctrl-Alt-U</td>
3462 <td>Changes the case of the selection. A lowercase
3463 selection will be changed into uppercase and vice
3464 versa. If the selection contains lower- and
3465 uppercase characters, all will be converted to
3466 lowercase.</td>
3467 </tr>
3468 <tr><td>Comment line</td>
3469 <td>&nbsp;</td>
3470 <td>Comments current line or selection.</td>
3471 </tr>
3472 <tr><td>Uncomment line</td>
3473 <td>&nbsp;</td>
3474 <td>Uncomments current line or selection.</td>
3475 </tr>
3476 <tr><td>Toggle line commentation</td>
3477 <td>Ctrl-E</td>
3478 <td>Comments a line if it is not commented or removes
3479 a comment if the line is commented.</td>
3480 </tr>
3481 <tr><td>Increase indent</td>
3482 <td>Ctrl-I</td>
3483 <td>Indents the current line or selection by one tab
3484 or by spaces in the amount of the tab width
3485 setting.</td>
3486 </tr>
3487 <tr><td>Decrease indent</td>
3488 <td>Ctrl-U</td>
3489 <td>Removes one tab or the amount of spaces of
3490 the tab width setting from the indentation of the
3491 current line or selection.</td>
3492 </tr>
3493 <tr><td>Increase indent by one space</td>
3494 <td>&nbsp;</td>
3495 <td>Indents the current line or selection by one
3496 space.</td>
3497 </tr>
3498 <tr><td>Decrease indent by one space</td>
3499 <td>&nbsp;</td>
3500 <td>Deindents the current line or selection by one
3501 space.</td>
3502 </tr>
3503 <tr><td>Smart line indent</td>
3504 <td>&nbsp;</td>
3505 <td>Indents the current line or all selected lines
3506 with the same indentation as the previous line.</td>
3507 </tr>
3508 <tr><td>Send to Custom Command 1 (2,3)</td>
3509 <td>Ctrl-1 (2,3)</td>
3510 <td>Passes the current selection to a configured
3511 external command (available for the first
3512 three configured commands, see
3513 <a class="reference" href="#sending-text-through-custom-commands">Sending text through custom commands</a> for
3514 details).</td>
3515 </tr>
3516 <tr><td>Send Selection to Terminal</td>
3517 <td>&nbsp;</td>
3518 <td>Sends the current selection or the current
3519 line (if there is no selection) to the
3520 embedded Terminal (VTE).</td>
3521 </tr>
3522 <tr><td>Reflow lines/block</td>
3523 <td>&nbsp;</td>
3524 <td>Reformat selected lines or current
3525 (indented) text block,
3526 breaking lines at the long line marker or the
3527 line breaking column if line breaking is
3528 enabled for the current document.</td>
3529 </tr>
3530 </tbody>
3531 </table>
3532 </div>
3533 <div class="section">
3534 <h4><a class="toc-backref" href="#id161" id="settings-keybindings" name="settings-keybindings">Settings keybindings</a></h4>
3535 <table border="1" class="docutils">
3536 <colgroup>
3537 <col width="29%" />
3538 <col width="24%" />
3539 <col width="47%" />
3540 </colgroup>
3541 <thead valign="bottom">
3542 <tr><th class="head">Action</th>
3543 <th class="head">Default shortcut</th>
3544 <th class="head">Description</th>
3545 </tr>
3546 </thead>
3547 <tbody valign="top">
3548 <tr><td>Preferences</td>
3549 <td>Ctrl-Alt-P</td>
3550 <td>Opens preferences dialog.</td>
3551 </tr>
3552 <tr><td>Plugin Preferences</td>
3553 <td>&nbsp;</td>
3554 <td>Opens plugin preferences dialog.</td>
3555 </tr>
3556 </tbody>
3557 </table>
3558 </div>
3559 <div class="section">
3560 <h4><a class="toc-backref" href="#id162" id="search-keybindings" name="search-keybindings">Search keybindings</a></h4>
3561 <table border="1" class="docutils">
3562 <colgroup>
3563 <col width="29%" />
3564 <col width="24%" />
3565 <col width="47%" />
3566 </colgroup>
3567 <thead valign="bottom">
3568 <tr><th class="head">Action</th>
3569 <th class="head">Default shortcut</th>
3570 <th class="head">Description</th>
3571 </tr>
3572 </thead>
3573 <tbody valign="top">
3574 <tr><td>Find</td>
3575 <td>Ctrl-F  (C)</td>
3576 <td>Opens the Find dialog.</td>
3577 </tr>
3578 <tr><td>Find Next</td>
3579 <td>Ctrl-G</td>
3580 <td>Finds next result.</td>
3581 </tr>
3582 <tr><td>Find Previous</td>
3583 <td>Ctrl-Shift-G</td>
3584 <td>Finds previous result.</td>
3585 </tr>
3586 <tr><td>Replace</td>
3587 <td>Ctrl-H  (C)</td>
3588 <td>Opens the Replace dialog.</td>
3589 </tr>
3590 <tr><td>Find in files</td>
3591 <td>Ctrl-Shift-F</td>
3592 <td>Opens the Find in files dialog.</td>
3593 </tr>
3594 <tr><td>Next message</td>
3595 <td>&nbsp;</td>
3596 <td>Jumps to the line with the next message in
3597 the Messages window.</td>
3598 </tr>
3599 <tr><td>Previous message</td>
3600 <td>&nbsp;</td>
3601 <td>Jumps to the line with the previous message
3602 in the Messages window.</td>
3603 </tr>
3604 <tr><td>Find Usage</td>
3605 <td>&nbsp;</td>
3606 <td>Finds all occurrences of the current word (near
3607 the keyboard cursor) or selection in all open
3608 documents and displays them in the messages
3609 window.</td>
3610 </tr>
3611 <tr><td>Find Document Usage</td>
3612 <td>&nbsp;</td>
3613 <td>Finds all occurrences of the current word (near
3614 the keyboard cursor) or selection in the current
3615 document and displays them in the messages
3616 window.</td>
3617 </tr>
3618 <tr><td>Mark All</td>
3619 <td>Ctrl-Shift-M</td>
3620 <td>Highlight all matches of the current
3621 word/selection in the current document
3622 with a colored box. If there's nothing to
3623 find, highlighted matches will be cleared.</td>
3624 </tr>
3625 </tbody>
3626 </table>
3627 </div>
3628 <div class="section">
3629 <h4><a class="toc-backref" href="#id163" id="go-to-keybindings" name="go-to-keybindings">Go to keybindings</a></h4>
3630 <table border="1" class="docutils">
3631 <colgroup>
3632 <col width="29%" />
3633 <col width="24%" />
3634 <col width="47%" />
3635 </colgroup>
3636 <thead valign="bottom">
3637 <tr><th class="head">Action</th>
3638 <th class="head">Default shortcut</th>
3639 <th class="head">Description</th>
3640 </tr>
3641 </thead>
3642 <tbody valign="top">
3643 <tr><td>Navigate forward a location</td>
3644 <td>&nbsp;</td>
3645 <td>Switches to the next location in the navigation
3646 history. See the section called <a class="reference" href="#code-navigation-history">Code Navigation
3647 History</a>.</td>
3648 </tr>
3649 <tr><td>Navigate back a location</td>
3650 <td>&nbsp;</td>
3651 <td>Switches to the previous location in the
3652 navigation history. See the section called
3653 <a class="reference" href="#code-navigation-history">Code navigation history</a>.</td>
3654 </tr>
3655 <tr><td>Go to line</td>
3656 <td>Ctrl-L</td>
3657 <td>Focuses the Go to Line entry (if visible) or
3658 shows the Go to line dialog.</td>
3659 </tr>
3660 <tr><td>Goto matching brace</td>
3661 <td>Ctrl-B</td>
3662 <td>If the cursor is ahead or behind a brace, then it
3663 is moved to the brace which belongs to the current
3664 one. If this keyboard shortcut is pressed again,
3665 the cursor is moved back to the first brace.</td>
3666 </tr>
3667 <tr><td>Toggle marker</td>
3668 <td>Ctrl-M</td>
3669 <td>Set a marker on the current line, or clear the
3670 marker if there already is one.</td>
3671 </tr>
3672 <tr><td>Goto next marker</td>
3673 <td>Ctrl-.</td>
3674 <td>Goto the next marker in the current document.</td>
3675 </tr>
3676 <tr><td>Goto previous marker</td>
3677 <td>Ctrl-,</td>
3678 <td>Goto the previous marker in the current document.</td>
3679 </tr>
3680 <tr><td>Go to tag definition</td>
3681 <td>&nbsp;</td>
3682 <td>Jump to the definition of the current word (near
3683 the keyboard cursor). If the definition cannot be
3684 found (e.g. the relevant file is not open) Geany
3685 will beep and do nothing. See the section called
3686 <a class="reference" href="#go-to-tag-definition">Go to tag definition</a>.</td>
3687 </tr>
3688 <tr><td>Go to tag declaration</td>
3689 <td>&nbsp;</td>
3690 <td>Jump to the declaration of the current word (near
3691 the keyboard cursor). If the declaration cannot be
3692 found (e.g. the relevant file is not open) Geany
3693 will beep and do nothing. See the section called
3694 <a class="reference" href="#go-to-tag-declaration">Go to tag declaration</a>.</td>
3695 </tr>
3696 <tr><td>Go to Start of Line</td>
3697 <td>Home</td>
3698 <td>Move the caret to the end of the line indentation
3699 unless it is already there, in which case it moves
3700 it to the start of the line.</td>
3701 </tr>
3702 <tr><td>Go to End of Line</td>
3703 <td>End</td>
3704 <td>Move the caret to the end of the line.</td>
3705 </tr>
3706 <tr><td>Go to End of Display Line</td>
3707 <td>Alt-End</td>
3708 <td>Move the caret to the end of the display line.
3709 This is useful when you use line wrapping and
3710 want to jump to the end of the wrapped, virtual
3711 line, not the real end of the whole line.
3712 If the line is not wrapped, it behaves like
3713 <cite>Go to End of Line</cite>, see above.</td>
3714 </tr>
3715 <tr><td>Go to Previous Word Part</td>
3716 <td>Ctrl-/</td>
3717 <td>Goto the previous part of the current word.</td>
3718 </tr>
3719 <tr><td>Go to Next Word Part</td>
3720 <td>Ctrl-</td>
3721 <td>Goto the next part of the current word.</td>
3722 </tr>
3723 </tbody>
3724 </table>
3725 </div>
3726 <div class="section">
3727 <h4><a class="toc-backref" href="#id164" id="view-keybindings" name="view-keybindings">View keybindings</a></h4>
3728 <table border="1" class="docutils">
3729 <colgroup>
3730 <col width="29%" />
3731 <col width="24%" />
3732 <col width="47%" />
3733 </colgroup>
3734 <thead valign="bottom">
3735 <tr><th class="head">Action</th>
3736 <th class="head">Default shortcut</th>
3737 <th class="head">Description</th>
3738 </tr>
3739 </thead>
3740 <tbody valign="top">
3741 <tr><td>Fullscreen</td>
3742 <td>F11  (C)</td>
3743 <td>Switches to fullscreen mode.</td>
3744 </tr>
3745 <tr><td>Toggle Messages Window</td>
3746 <td>&nbsp;</td>
3747 <td>Toggles the message window (status and compiler
3748 messages) on and off.</td>
3749 </tr>
3750 <tr><td>Toggle Sidebar</td>
3751 <td>&nbsp;</td>
3752 <td>Shows or hides the sidebar.</td>
3753 </tr>
3754 <tr><td>Toggle all additional widgets</td>
3755 <td>&nbsp;</td>
3756 <td>Hide and show all additional widgets like the
3757 notebook tabs, the toolbar, the messages window
3758 and the status bar.</td>
3759 </tr>
3760 <tr><td>Zoom In</td>
3761 <td>Ctrl-+  (C)</td>
3762 <td>Zooms in the text.</td>
3763 </tr>
3764 <tr><td>Zoom Out</td>
3765 <td>Ctrl--  (C)</td>
3766 <td>Zooms out the text.</td>
3767 </tr>
3768 <tr><td>Zoom Reset</td>
3769 <td>Ctrl-0</td>
3770 <td>Reset any previous zoom on the text.</td>
3771 </tr>
3772 </tbody>
3773 </table>
3774 </div>
3775 <div class="section">
3776 <h4><a class="toc-backref" href="#id165" id="focus-keybindings" name="focus-keybindings">Focus keybindings</a></h4>
3777 <table border="1" class="docutils">
3778 <colgroup>
3779 <col width="30%" />
3780 <col width="23%" />
3781 <col width="47%" />
3782 </colgroup>
3783 <thead valign="bottom">
3784 <tr><th class="head">Action</th>
3785 <th class="head">Default shortcut</th>
3786 <th class="head">Description</th>
3787 </tr>
3788 </thead>
3789 <tbody valign="top">
3790 <tr><td>Switch to Editor</td>
3791 <td>F2</td>
3792 <td>Switches to editor widget.
3793 Also reshows the document statistics line
3794 (after a short timeout).</td>
3795 </tr>
3796 <tr><td>Switch to Scribble</td>
3797 <td>F6</td>
3798 <td>Switches to scribble widget.</td>
3799 </tr>
3800 <tr><td>Switch to VTE</td>
3801 <td>F4</td>
3802 <td>Switches to VTE widget.</td>
3803 </tr>
3804 <tr><td>Switch to Search Bar</td>
3805 <td>F7</td>
3806 <td>Switches to the search bar in the toolbar (if
3807 visible).</td>
3808 </tr>
3809 <tr><td>Switch to Sidebar</td>
3810 <td>&nbsp;</td>
3811 <td>Focus the Sidebar.</td>
3812 </tr>
3813 <tr><td>Switch to Compiler</td>
3814 <td>&nbsp;</td>
3815 <td>Focus the Compiler message window tab.</td>
3816 </tr>
3817 <tr><td>Switch to Messages</td>
3818 <td>&nbsp;</td>
3819 <td>Focus the Messages message window tab.</td>
3820 </tr>
3821 <tr><td>Switch to Message Window</td>
3822 <td>&nbsp;</td>
3823 <td>Focus the Message Window's current tab.</td>
3824 </tr>
3825 <tr><td>Switch to Sidebar Document List</td>
3826 <td>&nbsp;</td>
3827 <td>Focus the Document list tab in the Sidebar
3828 (if visible).</td>
3829 </tr>
3830 <tr><td>Switch to Sidebar Symbol List</td>
3831 <td>&nbsp;</td>
3832 <td>Focus the Symbol list tab in the Sidebar
3833 (if visible).</td>
3834 </tr>
3835 </tbody>
3836 </table>
3837 </div>
3838 <div class="section">
3839 <h4><a class="toc-backref" href="#id166" id="notebook-tab-keybindings" name="notebook-tab-keybindings">Notebook tab keybindings</a></h4>
3840 <table border="1" class="docutils">
3841 <colgroup>
3842 <col width="28%" />
3843 <col width="23%" />
3844 <col width="49%" />
3845 </colgroup>
3846 <thead valign="bottom">
3847 <tr><th class="head">Action</th>
3848 <th class="head">Default shortcut</th>
3849 <th class="head">Description</th>
3850 </tr>
3851 </thead>
3852 <tbody valign="top">
3853 <tr><td>Switch to left document</td>
3854 <td>Ctrl-PageUp   (C)</td>
3855 <td>Switches to the previous open document.</td>
3856 </tr>
3857 <tr><td>Switch to right document</td>
3858 <td>Ctrl-PageDown (C)</td>
3859 <td>Switches to the next open document.</td>
3860 </tr>
3861 <tr><td>Switch to last used document</td>
3862 <td>Ctrl-Tab</td>
3863 <td>Switches to the previously shown document (if it's
3864 still open).
3865 Holding Ctrl (or another modifier if the keybinding
3866 has been changed) will show a dialog, then repeated
3867 presses of the keybinding will switch to the 2nd-last
3868 used document, 3rd-last, etc. Also known as
3869 Most-Recently-Used documents switching.</td>
3870 </tr>
3871 <tr><td>Move document left</td>
3872 <td>Alt-PageUp</td>
3873 <td>Changes the current document with the left hand
3874 one.</td>
3875 </tr>
3876 <tr><td>Move document right</td>
3877 <td>Alt-PageDown</td>
3878 <td>Changes the current document with the right hand
3879 one.</td>
3880 </tr>
3881 <tr><td>Move document first</td>
3882 <td>&nbsp;</td>
3883 <td>Moves the current document to the first position.</td>
3884 </tr>
3885 <tr><td>Move document last</td>
3886 <td>&nbsp;</td>
3887 <td>Moves the current document to the last position.</td>
3888 </tr>
3889 </tbody>
3890 </table>
3891 </div>
3892 <div class="section">
3893 <h4><a class="toc-backref" href="#id167" id="document-keybindings" name="document-keybindings">Document keybindings</a></h4>
3894 <table border="1" class="docutils">
3895 <colgroup>
3896 <col width="29%" />
3897 <col width="23%" />
3898 <col width="48%" />
3899 </colgroup>
3900 <thead valign="bottom">
3901 <tr><th class="head">Action</th>
3902 <th class="head">Default shortcut</th>
3903 <th class="head">Description</th>
3904 </tr>
3905 </thead>
3906 <tbody valign="top">
3907 <tr><td>Replace tabs by space</td>
3908 <td>&nbsp;</td>
3909 <td>Replaces all tabs with the right amount of spaces.</td>
3910 </tr>
3911 <tr><td>Replace spaces by tabs</td>
3912 <td>&nbsp;</td>
3913 <td>Replaces all spaces with tab characters.</td>
3914 </tr>
3915 <tr><td>Toggle current fold</td>
3916 <td>&nbsp;</td>
3917 <td>Toggles the folding state of the current code block.</td>
3918 </tr>
3919 <tr><td>Fold all</td>
3920 <td>&nbsp;</td>
3921 <td>Folds all contractible code blocks.</td>
3922 </tr>
3923 <tr><td>Unfold all</td>
3924 <td>&nbsp;</td>
3925 <td>Unfolds all contracted code blocks.</td>
3926 </tr>
3927 <tr><td>Reload symbol list</td>
3928 <td>Ctrl-Shift-R</td>
3929 <td>Reloads the tag/symbol list.</td>
3930 </tr>
3931 <tr><td>Toggle Line wrapping</td>
3932 <td>&nbsp;</td>
3933 <td>Enables or disables wrapping of long lines.</td>
3934 </tr>
3935 <tr><td>Toggle Line breaking</td>
3936 <td>&nbsp;</td>
3937 <td>Enables or disables automatic breaking of long
3938 lines at a configurable column.</td>
3939 </tr>
3940 <tr><td>Remove Markers</td>
3941 <td>&nbsp;</td>
3942 <td>Remove any markers on lines or words which
3943 were set by using 'Mark All' in the
3944 search dialog or by manually marking lines.</td>
3945 </tr>
3946 <tr><td>Remove Error Indicators</td>
3947 <td>&nbsp;</td>
3948 <td>Remove any error indicators in the
3949 current document.</td>
3950 </tr>
3951 </tbody>
3952 </table>
3953 </div>
3954 <div class="section">
3955 <h4><a class="toc-backref" href="#id168" id="build-keybindings" name="build-keybindings">Build keybindings</a></h4>
3956 <table border="1" class="docutils">
3957 <colgroup>
3958 <col width="29%" />
3959 <col width="24%" />
3960 <col width="47%" />
3961 </colgroup>
3962 <thead valign="bottom">
3963 <tr><th class="head">Action</th>
3964 <th class="head">Default shortcut</th>
3965 <th class="head">Description</th>
3966 </tr>
3967 </thead>
3968 <tbody valign="top">
3969 <tr><td>Compile</td>
3970 <td>F8</td>
3971 <td>Compiles the current file.</td>
3972 </tr>
3973 <tr><td>Build</td>
3974 <td>F9</td>
3975 <td>Builds (compiles if necessary and links) the
3976 current file.</td>
3977 </tr>
3978 <tr><td>Make all</td>
3979 <td>Shift-F9</td>
3980 <td>Builds the current file with the Make tool.</td>
3981 </tr>
3982 <tr><td>Make custom target</td>
3983 <td>Ctrl-Shift-F9</td>
3984 <td>Builds the current file with the Make tool and a
3985 given target.</td>
3986 </tr>
3987 <tr><td>Make object</td>
3988 <td>&nbsp;</td>
3989 <td>Compiles the current file with the Make tool.</td>
3990 </tr>
3991 <tr><td>Next error</td>
3992 <td>&nbsp;</td>
3993 <td>Jumps to the line with the next error from the
3994 last build process.</td>
3995 </tr>
3996 <tr><td>Previous error</td>
3997 <td>&nbsp;</td>
3998 <td>Jumps to the line with the previous error from
3999 the last build process.</td>
4000 </tr>
4001 <tr><td>Run</td>
4002 <td>F5</td>
4003 <td>Executes the current file in a terminal emulation.</td>
4004 </tr>
4005 <tr><td>Set Build Commands</td>
4006 <td>&nbsp;</td>
4007 <td>Opens the build commands dialog.</td>
4008 </tr>
4009 </tbody>
4010 </table>
4011 </div>
4012 <div class="section">
4013 <h4><a class="toc-backref" href="#id169" id="tools-keybindings" name="tools-keybindings">Tools keybindings</a></h4>
4014 <table border="1" class="docutils">
4015 <colgroup>
4016 <col width="29%" />
4017 <col width="24%" />
4018 <col width="47%" />
4019 </colgroup>
4020 <thead valign="bottom">
4021 <tr><th class="head">Action</th>
4022 <th class="head">Default shortcut</th>
4023 <th class="head">Description</th>
4024 </tr>
4025 </thead>
4026 <tbody valign="top">
4027 <tr><td>Show Color Chooser</td>
4028 <td>&nbsp;</td>
4029 <td>Opens the Color Chooser dialog.</td>
4030 </tr>
4031 </tbody>
4032 </table>
4033 </div>
4034 <div class="section">
4035 <h4><a class="toc-backref" href="#id170" id="help-keybindings" name="help-keybindings">Help keybindings</a></h4>
4036 <table border="1" class="docutils">
4037 <colgroup>
4038 <col width="29%" />
4039 <col width="24%" />
4040 <col width="47%" />
4041 </colgroup>
4042 <thead valign="bottom">
4043 <tr><th class="head">Action</th>
4044 <th class="head">Default shortcut</th>
4045 <th class="head">Description</th>
4046 </tr>
4047 </thead>
4048 <tbody valign="top">
4049 <tr><td>Help</td>
4050 <td>F1 (C)</td>
4051 <td>Opens the manual.</td>
4052 </tr>
4053 </tbody>
4054 </table>
4055 </div>
4056 </div>
4057 </div>
4058 </div>
4059 <div class="section">
4060 <h1><a class="toc-backref" href="#id171" id="id4" name="id4">Configuration files</a></h1>
4061 <div class="warning">
4062 <p class="first admonition-title">Warning</p>
4063 <p class="last">You must use UTF-8 encoding <em>without BOM</em> for configuration files.</p>
4064 </div>
4065 <div class="section">
4066 <h2><a class="toc-backref" href="#id172" id="tools-menu-items" name="tools-menu-items">Tools menu items</a></h2>
4067 <p>There's a <em>Configuration files</em> submenu in the <em>Tools</em> menu that
4068 contains items for some of the available user configuration files.
4069 Clicking on one opens it in the editor for you to update. Geany will
4070 reload the file after you have saved it.</p>
4071 <div class="note">
4072 <p class="first admonition-title">Note</p>
4073 <p class="last">Other configuration files not shown here will need to be opened
4074 manually, and will not be automatically reloaded when saved.
4075 (see <em>Reload Configuration</em> below).</p>
4076 </div>
4077 <p>There's also a <em>Reload Configuration</em> item which can be used if you
4078 updated one of the other configuration files, or modified or added
4079 template files.</p>
4080 <p><em>Reload Configuration</em> is also necessary to update syntax highlighting colors.</p>
4081 <div class="note">
4082 <p class="first admonition-title">Note</p>
4083 <p class="last">Syntax highlighting colors aren't updated in open documents after
4084 saving filetypes.common as this can possibly take a significant
4085 amount of time.</p>
4086 </div>
4087 </div>
4088 <div class="section">
4089 <h2><a class="toc-backref" href="#id173" id="global-configuration-file" name="global-configuration-file">Global configuration file</a></h2>
4090 <p>There is a global configuration file for Geany which will be used for
4091 any settings not defined in the users local configuration file.
4092 Settings present in the local configuration file override those in the global
4093 file.</p>
4094 <p>The global configuration file is read from
4095 <tt class="docutils literal"><span class="pre">$prefix/share/geany/geany.conf</span></tt> (where <tt class="docutils literal"><span class="pre">$prefix</span></tt> is the path where
4096 Geany is installed, see <a class="reference" href="#installation-prefix">Installation prefix</a>) when starting Geany and
4097 an user configuration file does not exist. It can contain any settings
4098 which are found in the usual configuration file created by Geany but
4099 does not have to contain all settings.</p>
4100 <div class="note">
4101 <p class="first admonition-title">Note</p>
4102 <p class="last">This feature is mainly intended for package maintainers or system
4103 admins who want to set up Geany in a multi user environment and
4104 set some sane default values for this environment. Usually users won't
4105 need to do that.</p>
4106 </div>
4107 </div>
4108 <div class="section">
4109 <h2><a class="toc-backref" href="#id174" id="filetype-definition-files" name="filetype-definition-files">Filetype definition files</a></h2>
4110 <p>All color definitions and other filetype specific settings are
4111 stored in the filetype definition files. Those settings are colors
4112 for syntax highlighting, general settings like comment characters or
4113 word delimiter characters as well as compiler and linker settings.</p>
4114 <div class="section">
4115 <h3><a class="toc-backref" href="#id175" id="custom-filetypes" name="custom-filetypes">Custom filetypes</a></h3>
4116 <p>At startup Geany looks for <tt class="docutils literal"><span class="pre">filetypes.*.conf</span></tt> files in the system and
4117 user filetype paths, adding any filetypes found with the name matching
4118 the '<tt class="docutils literal"><span class="pre">*</span></tt>' wildcard.</p>
4119 <p>Custom filetypes are not as powerful as built-in filetypes, but the following
4120 have been implemented:</p>
4121 <ul>
4122 <li><p class="first">Recognizing and setting the filetype (after the user has manually edited
4123 <tt class="docutils literal"><span class="pre">filetype_extensions.conf</span></tt>).</p>
4124 </li>
4125 <li><dl class="first docutils">
4126 <dt>Filetype settings in the [settings] section (see <a class="reference" href="#format">Format</a>).</dt>
4127 <dd><ul class="first last simple">
4128 <li>Using existing tag parsing (<tt class="docutils literal"><span class="pre">tag_parser</span></tt> key).</li>
4129 <li>Using existing syntax highlighting (<tt class="docutils literal"><span class="pre">lexer_filetype</span></tt> key).</li>
4130 </ul>
4131 </dd>
4132 </dl>
4133 </li>
4134 <li><p class="first">Build commands.</p>
4135 </li>
4136 <li><p class="first">Loading global tags files (namespace will be shared with tag_parser
4137 type).</p>
4138 </li>
4139 </ul>
4140 </div>
4141 <div class="section">
4142 <h3><a class="toc-backref" href="#id176" id="system-files" name="system-files">System files</a></h3>
4143 <p>The system-wide configuration files can be found in
4144 <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt> and are called <tt class="docutils literal"><span class="pre">filetypes.$ext</span></tt>,
4145 where <tt class="docutils literal"><span class="pre">$prefix</span></tt> is the path where Geany is installed (see
4146 <a class="reference" href="#installation-prefix">Installation prefix</a>) and $ext is the name of the filetype. For every
4147 filetype there is a corresponding definition file. There is one
4148 exception: <tt class="docutils literal"><span class="pre">filetypes.common</span></tt> -- this file is for general settings,
4149 which are not specific to a certain filetype.</p>
4150 <div class="warning">
4151 <p class="first admonition-title">Warning</p>
4152 <p class="last">It is not recommended that users edit the system-wide files,
4153 because they will be overridden when Geany is updated.</p>
4154 </div>
4155 </div>
4156 <div class="section">
4157 <h3><a class="toc-backref" href="#id177" id="user-files" name="user-files">User files</a></h3>
4158 <p>To change the settings, copy a file from <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt> to
4159 the subdirectory filedefs in your configuration directory (usually
4160 <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>).</p>
4161 <p>For example:</p>
4162 <pre class="literal-block">
4163 % cp /usr/local/share/geany/filetypes.c /home/username/.config/geany/filedefs/
4164 </pre>
4165 <p>Then you can edit the file and the changes are also
4166 available after an update of Geany because they reside in your
4167 configuration directory. Alternatively, you can create a file
4168 <tt class="docutils literal"><span class="pre">~/.config/geany/filedefs/filetypes.X</span></tt> and add only these settings you want
4169 to change. All missing settings will be read from the corresponding
4170 global definition file in <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt>.</p>
4171 <p>As well as the sections listed below, each filetype file can contain
4172 a [build-menu] section as described in <a class="reference" href="#build-menu-section">[build-menu] Section</a>.</p>
4173 </div>
4174 <div class="section">
4175 <h3><a class="toc-backref" href="#id178" id="format" name="format">Format</a></h3>
4176 <div class="section">
4177 <h4><a class="toc-backref" href="#id179" id="styling-section" name="styling-section">[styling] Section</a></h4>
4178 <p>In this section the colors for syntax highlighting are defined. The
4179 manual format is:</p>
4180 <ul class="simple">
4181 <li><tt class="docutils literal"><span class="pre">key=foreground_color;background_color;bold_flag;italic_flag</span></tt></li>
4182 </ul>
4183 <p>Colors have to be specified as RGB hex values prefixed by
4184 0x. For example red is 0xff0000, blue is 0x0000ff. The values are
4185 case-insensitive, but it is a good idea to use small letters. Bold
4186 and italic are flags and should only be &quot;true&quot; or &quot;false&quot;. If their
4187 value is something other than &quot;true&quot; or &quot;false&quot;, &quot;false&quot; is assumed.</p>
4188 <p>You can omit fields to use the values from the style named <tt class="docutils literal"><span class="pre">&quot;default&quot;</span></tt>.</p>
4189 <p>E.g. <tt class="docutils literal"><span class="pre">key=0xff0000;;true</span></tt></p>
4190 <p>This makes the key style have red foreground text, default background
4191 color text and bold emphasis.</p>
4192 <div class="section">
4193 <h5><a class="toc-backref" href="#id180" id="using-a-named-style" name="using-a-named-style">Using a named style</a></h5>
4194 <p>The second format uses a <em>named style</em> name to reference a style
4195 defined in filetypes.common.</p>
4196 <ul class="simple">
4197 <li><tt class="docutils literal"><span class="pre">key=named_style</span></tt></li>
4198 <li><tt class="docutils literal"><span class="pre">key2=named_style2,bold,italic</span></tt></li>
4199 </ul>
4200 <p>The bold and italic parts are optional, and if present are used to
4201 toggle the bold or italic flags to the opposite of the named style's
4202 flags. In contrast to style definition booleans, they are a literal
4203 &quot;,bold,italic&quot; and commas are used instead of semi-colons.</p>
4204 <p>E.g. <tt class="docutils literal"><span class="pre">key=comment,italic</span></tt></p>
4205 <p>This makes the key style match the <tt class="docutils literal"><span class="pre">&quot;comment&quot;</span></tt> named style, but with
4206 italic emphasis.</p>
4207 <p>To define named styles, see the filetypes.common <a class="reference" href="#named-styles-section">[named_styles]
4208 Section</a>.</p>
4209 </div>
4210 </div>
4211 <div class="section">
4212 <h4><a class="toc-backref" href="#id181" id="keywords-section" name="keywords-section">[keywords] Section</a></h4>
4213 <p>This section contains keys for different keyword lists specific to
4214 the filetype. Some filetypes do not support keywords, so adding a
4215 new key will not work. You can only add or remove keywords to/from
4216 an existing list.</p>
4217 <div class="important">
4218 <p class="first admonition-title">Important</p>
4219 <p class="last">The keywords list must be in one line without line ending characters.</p>
4220 </div>
4221 </div>
4222 <div class="section">
4223 <h4><a class="toc-backref" href="#id182" id="lexer-properties-section" name="lexer-properties-section">[lexer_properties] Section</a></h4>
4224 <p>Here any special properties for the Scintilla lexer can be set in the
4225 format <tt class="docutils literal"><span class="pre">key.name.field=some.value</span></tt>.</p>
4226 </div>
4227 <div class="section">
4228 <h4><a class="toc-backref" href="#id183" id="settings-section" name="settings-section">[settings] Section</a></h4>
4229 <dl class="docutils">
4230 <dt>extension</dt>
4231 <dd><p class="first">This is the default file extension used when saving files, not
4232 including the period character (<tt class="docutils literal"><span class="pre">.</span></tt>). The extension used should
4233 match one of the patterns associated with that filetype (see
4234 <a class="reference" href="#filetype-extensions">Filetype extensions</a>).</p>
4235 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">extension=cxx</span></tt></p>
4236 </dd>
4237 <dt>wordchars</dt>
4238 <dd><p class="first">These characters define word boundaries when making selections
4239 and searching using word matching options.</p>
4240 <p class="last"><em>Example:</em> (look at system filetypes.* files)</p>
4241 </dd>
4242 <dt>comment_open</dt>
4243 <dd><p class="first">A character or string which is used to comment code. If you want to
4244 use multiline comments, also set comment_close, otherwise leave it
4245 empty.</p>
4246 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_open=/*</span></tt></p>
4247 </dd>
4248 <dt>comment_close</dt>
4249 <dd><p class="first">If multiline comments are used, this is the character or string to
4250 close the comment.</p>
4251 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_close=*/</span></tt></p>
4252 </dd>
4253 <dt>comment_use_indent</dt>
4254 <dd><p class="first">Set this to false if a comment character or string should start at
4255 column 0 of a line. If set to true it uses any indentation of the
4256 line.</p>
4257 <p>Note: Comment indentation</p>
4258 <p><tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt> would generate this if a line is
4259 commented (e.g. with Ctrl-D):</p>
4260 <pre class="literal-block">
4261 #command_example();
4262 </pre>
4263 <p><tt class="docutils literal"><span class="pre">comment_use_indent=false</span></tt> would generate this if a line is
4264 commented (e.g. with Ctrl-D):</p>
4265 <pre class="literal-block">
4266 #   command_example();
4267 </pre>
4268 <p>Note: This setting only works for single line comments (like '//',
4269 '#' or ';').</p>
4270 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_use_indent=true</span></tt></p>
4271 </dd>
4272 <dt>context_action_cmd</dt>
4273 <dd><p class="first">A command which can be executed on the current word or the current
4274 selection.</p>
4275 <p>Example usage: Open the API documentation for the
4276 current function call at the cursor position.</p>
4277 <p>The command can
4278 be set for every filetype or if not set, a global command will
4279 be used. The command itself can be specified without the full
4280 path, then it is searched in $PATH. But for security reasons,
4281 it is recommended to specify the full path to the command. The
4282 wildcard %s will be replaced by the current word at the cursor
4283 position or by the current selection.</p>
4284 <p>Hint: for PHP files the following could be quite useful:
4285 context_action_cmd=firefox &quot;<a class="reference" href="http://www.php.net/%s">http://www.php.net/%s</a>&quot;</p>
4286 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">context_action_cmd=devhelp</span> <span class="pre">-s</span> <span class="pre">&quot;%s&quot;</span></tt></p>
4287 </dd>
4288 <dt>tag_parser</dt>
4289 <dd>The TagManager language name, e.g. &quot;C&quot;.</dd>
4290 <dt>lexer_filetype</dt>
4291 <dd>A filetype name to setup syntax highlighting from another filetype.
4292 This must not be recursive, i.e. it should be a filetype name that
4293 doesn't use the lexer_filetype key itself.</dd>
4294 </dl>
4295 </div>
4296 <div class="section">
4297 <h4><a class="toc-backref" href="#id184" id="build-settings-section" name="build-settings-section">[build_settings] Section</a></h4>
4298 <p>As of Geany v0.19 this section is supplemented by the <a class="reference" href="#build-menu-section">[build-menu] Section</a>.
4299 Values that are set in the [build-menu] section will override those in this section.</p>
4300 <dl class="docutils">
4301 <dt>error_regex</dt>
4302 <dd><p class="first">This is a GNU-style extended regular expression to parse a filename
4303 and line number from build output. If undefined, Geany will fall
4304 back to its default error message parsing.</p>
4305 <p>Only the first two matches will be read by Geany. Geany will look for
4306 a match that is purely digits, and use this for the line number. The
4307 remaining match will be used as the filename.</p>
4308 <p><em>Example:</em> <tt class="docutils literal"><span class="pre">error_regex=(.+):([0-9]+):[0-9]+</span></tt></p>
4309 <p class="last">This will parse a message such as:
4310 <tt class="docutils literal"><span class="pre">test.py:7:24:</span> <span class="pre">E202</span> <span class="pre">whitespace</span> <span class="pre">before</span> <span class="pre">']'</span></tt></p>
4311 </dd>
4312 </dl>
4313 <p><strong>Build commands</strong></p>
4314 <p>If any build menu item settings have been configured in the Build Menu Commands
4315 dialog or the Build tab of the project preferences dialog then these
4316 settings are stored in the [build-menu] section and override the settings in
4317 this section for that item.</p>
4318 <dl class="docutils">
4319 <dt>compiler</dt>
4320 <dd><p class="first">This item specifies the command to compile source code files. But
4321 it is also possible to use it with interpreted languages like Perl
4322 or Python. With these filetypes you can use this option as a kind of
4323 syntax parser, which sends output to the compiler message window.</p>
4324 <p>You should quote the filename to also support filenames with
4325 spaces. The following wildcards for filenames are available:</p>
4326 <ul class="simple">
4327 <li>%f -- complete filename without path</li>
4328 <li>%e -- filename without path and without extension</li>
4329 </ul>
4330 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">compiler=gcc</span> <span class="pre">-Wall</span> <span class="pre">-c</span> <span class="pre">&quot;%f&quot;</span></tt></p>
4331 </dd>
4332 <dt>linker</dt>
4333 <dd><p class="first">This item specifies the command to link the file. If the file is not
4334 already compiled, it will be compiled while linking. The -o option
4335 is automatically added by Geany. This item works well with GNU gcc,
4336 but may be problematic with other compilers (esp. with the linker).</p>
4337 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">linker=gcc</span> <span class="pre">-Wall</span> <span class="pre">&quot;%f&quot;</span></tt></p>
4338 </dd>
4339 <dt>run_cmd</dt>
4340 <dd><p class="first">Use this item to execute your file. It has to have been built
4341 already. Use the %e wildcard to have only the name of the executable
4342 (i.e. without extension) or use the %f wildcard if you need the
4343 complete filename, e.g. for shell scripts.</p>
4344 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">run_cmd=&quot;./%e&quot;</span></tt></p>
4345 </dd>
4346 </dl>
4347 </div>
4348 </div>
4349 <div class="section">
4350 <h3><a class="toc-backref" href="#id185" id="special-file-filetypes-common" name="special-file-filetypes-common">Special file filetypes.common</a></h3>
4351 <p>There is a special filetype definition file called
4352 filetypes.common. This file defines some general non-filetype-specific
4353 settings.</p>
4354 <p>See the <a class="reference" href="#format">Format</a> section for how to define styles.</p>
4355 <div class="section">
4356 <h4><a class="toc-backref" href="#id186" id="named-styles-section" name="named-styles-section">[named_styles] Section</a></h4>
4357 <p>Named styles declared here can be used in the [styling] section of any
4358 filetypes.* file.</p>
4359 <p>For example:</p>
4360 <p><em>In filetypes.common</em>:</p>
4361 <pre class="literal-block">
4362 [named_styles]
4363 foo=0xc00000;0xffffff;false;true
4364 bar=foo
4365 </pre>
4366 <p><em>In filetypes.c</em>:</p>
4367 <pre class="literal-block">
4368 [styling]
4369 comment=foo
4370 </pre>
4371 <p>This saves copying and pasting the whole style definition into several
4372 different files.</p>
4373 <div class="note">
4374 <p class="first admonition-title">Note</p>
4375 <p class="last">You can define aliases for named styles, as shown with the <tt class="docutils literal"><span class="pre">bar</span></tt>
4376 entry in the above example, but they must be declared after the
4377 original style.</p>
4378 </div>
4379 </div>
4380 <div class="section">
4381 <h4><a class="toc-backref" href="#id187" id="id5" name="id5">[styling] Section</a></h4>
4382 <dl class="docutils">
4383 <dt>default</dt>
4384 <dd><p class="first">This is the default style. It is used for styling files without a
4385 filetype set.</p>
4386 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">default=0x000000;0xffffff;false;false</span></tt></p>
4387 </dd>
4388 <dt>selection</dt>
4389 <dd><p class="first">The style for coloring selected text. The format is:</p>
4390 <ul class="simple">
4391 <li>Foreground color</li>
4392 <li>Background color</li>
4393 <li>Use foreground color</li>
4394 <li>Use background color</li>
4395 </ul>
4396 <p>The colors are only set if the 3rd or 4th argument is true. When
4397 the colors are not overridden, the default is a dark grey
4398 background with syntax highlighted foreground text.</p>
4399 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">selection=0xc0c0c0;0x00007F;true;true</span></tt></p>
4400 </dd>
4401 <dt>brace_good</dt>
4402 <dd><p class="first">The style for brace highlighting when a matching brace was found.</p>
4403 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">brace_good=0xff0000;0xFFFFFF;true;false</span></tt></p>
4404 </dd>
4405 <dt>brace_bad</dt>
4406 <dd><p class="first">The style for brace highlighting when no matching brace was found.</p>
4407 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">brace_bad=0x0000ff;0xFFFFFF;true;false</span></tt></p>
4408 </dd>
4409 <dt>caret</dt>
4410 <dd><p class="first">The style for coloring the caret(the blinking cursor). Only first
4411 and third argument is interpreted.
4412 Set the third argument to true to change the caret into a block caret.</p>
4413 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">caret=0x000000;0x0;false;false</span></tt></p>
4414 </dd>
4415 <dt>caret_width</dt>
4416 <dd><p class="first">The width for the caret(the blinking cursor). Only the first
4417 argument is interpreted. The width is specified in pixels with
4418 a maximum of three pixel. Use the width 0 to make the caret
4419 invisible.</p>
4420 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">caret=1;0;false;false</span></tt></p>
4421 </dd>
4422 <dt>current_line</dt>
4423 <dd><p class="first">The style for coloring the background of the current line. Only
4424 the second and third arguments are interpreted. The second argument
4425 is the background color. Use the third argument to enable or
4426 disable background highlighting for the current line (has to be
4427 true/false).</p>
4428 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">current_line=0x0;0xe5e5e5;true;false</span></tt></p>
4429 </dd>
4430 <dt>indent_guide</dt>
4431 <dd><p class="first">The style for coloring the indentation guides. Only the first and
4432 second arguments are interpreted.</p>
4433 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">indent_guide=0xc0c0c0;0xffffff;false;false</span></tt></p>
4434 </dd>
4435 <dt>white_space</dt>
4436 <dd><p class="first">The style for coloring the white space if it is shown. The first
4437 both arguments define the foreground and background colors, the
4438 third argument sets whether to use the defined foreground color
4439 or to use the color defined by each filetype for the white space.
4440 The fourth argument defines whether to use the background color.</p>
4441 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">white_space=0xc0c0c0;0xffffff;true;true</span></tt></p>
4442 </dd>
4443 </dl>
4444 <dl class="docutils" id="folding-settings">
4445 <dt>folding_style</dt>
4446 <dd><p class="first">The style of folding icons. Only first and second arguments are
4447 used.</p>
4448 <p>Valid values for the first argument are:</p>
4449 <ul class="simple">
4450 <li>1 -- for boxes</li>
4451 <li>2 -- for circles</li>
4452 <li>3 -- for arrows</li>
4453 <li>4 -- for +/-</li>
4454 </ul>
4455 <p>Valid values for the second argument are:</p>
4456 <ul class="simple">
4457 <li>0 -- for no lines</li>
4458 <li>1 -- for straight lines</li>
4459 <li>2 -- for curved lines</li>
4460 </ul>
4461 <p><em>Default:</em> <tt class="docutils literal"><span class="pre">folding_style=1;1;</span></tt></p>
4462 <p class="last"><em>Arrows:</em> <tt class="docutils literal"><span class="pre">folding_style=3;0;</span></tt></p>
4463 </dd>
4464 <dt>folding_horiz_line</dt>
4465 <dd><p class="first">Draw a thin horizontal line at the line where text is folded. Only
4466 first argument is used.</p>
4467 <p>Valid values for the first argument are:</p>
4468 <ul class="simple">
4469 <li>0 -- disable, do not draw a line</li>
4470 <li>1 -- draw the line above folded text</li>
4471 <li>2 -- draw the line below folded text</li>
4472 </ul>
4473 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">folding_horiz_line=0;0;false;false</span></tt></p>
4474 </dd>
4475 <dt>line_wrap_visuals</dt>
4476 <dd><p class="first">First argument: drawing of visual flags to indicate a line is wrapped.
4477 This is a bitmask of the values:</p>
4478 <ul class="simple">
4479 <li>0 -- No visual flags</li>
4480 <li>1 -- Visual flag at end of subline of a wrapped line</li>
4481 <li>2 -- Visual flag at begin of subline of a wrapped line. Subline is
4482 indented by at least 1 to make room for the flag.</li>
4483 </ul>
4484 <p>Second argument: wether the visual flags to indicate a line is wrapped
4485 are drawn near the border or near the text. This is a bitmask of the values:</p>
4486 <ul class="simple">
4487 <li>0 -- Visual flags drawn near border</li>
4488 <li>1 -- Visual flag at end of subline drawn near text</li>
4489 <li>2 -- Visual flag at begin of subline drawn near text</li>
4490 </ul>
4491 <p>Only first and second argument is interpreted.</p>
4492 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">line_wrap_visuals=3;0;false;false</span></tt></p>
4493 </dd>
4494 <dt>line_wrap_indent</dt>
4495 <dd><p class="first">First argument: sets the size of indentation of sublines for wrapped lines
4496 in terms of the width of a space, only used when the second argument is <tt class="docutils literal"><span class="pre">0</span></tt>.</p>
4497 <p>Second argument: wrapped sublines can be indented to the position of their
4498 first subline or one more indent level. Possible values:</p>
4499 <ul class="simple">
4500 <li>0 - Wrapped sublines aligned to left of window plus amount set by the first argument</li>
4501 <li>1 - Wrapped sublines are aligned to first subline indent (use the same indentation)</li>
4502 <li>2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation</li>
4503 </ul>
4504 <p>Only first and second argument is interpreted.</p>
4505 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">line_wrap_indent=0;1;false;false</span></tt></p>
4506 </dd>
4507 <dt>translucency</dt>
4508 <dd><p class="first">Translucency for the current line (first argument) and the selection
4509 (second argument). Values between 0 and 256 are accepted.</p>
4510 <p>Note for Windows 95, 98 and ME users:
4511 keep this value at 256 to disable translucency otherwise Geany might crash.</p>
4512 <p>Only the first and second argument is interpreted.</p>
4513 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">translucency=256;256;false;false</span></tt></p>
4514 </dd>
4515 <dt>marker_line</dt>
4516 <dd><p class="first">The style for a highlighted line (e.g when using Goto line or goto tag).
4517 The foreground color (first argument) is only used when the Markers margin
4518 is enabled (see View menu).</p>
4519 <p>Only the first and second argument is interpreted.</p>
4520 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">marker_line=0x000000;0xffff00;false;false</span></tt></p>
4521 </dd>
4522 <dt>marker_search</dt>
4523 <dd><p class="first">The style for a marked search results (when using &quot;Mark&quot; in Search dialogs).
4524 The second argument sets the background colour for the drawn rectangle.</p>
4525 <p>Only the second argument is interpreted.</p>
4526 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">marker_search=0x000000;0xb8f4b8;false;false</span></tt></p>
4527 </dd>
4528 <dt>marker_mark</dt>
4529 <dd><p class="first">The style for a marked line (e.g when using the &quot;Toggle Marker&quot; keybinding
4530 (Ctrl-M)). The foreground color (first argument) is only used
4531 when the Markers margin is enabled (see View menu).</p>
4532 <p>Only the first and second argument is interpreted.</p>
4533 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">marker_mark=0x000000;0xb8f4b8;false;false</span></tt></p>
4534 </dd>
4535 <dt>marker_translucency</dt>
4536 <dd><p class="first">Translucency for the line marker (first argument) and the search marker
4537 (second argument). Values between 0 and 256 are accepted.</p>
4538 <p>Note for Windows 95, 98 and ME users:
4539 keep this value at 256 to disable translucency otherwise Geany might crash.</p>
4540 <p>Only the first and second argument is interpreted.</p>
4541 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">marker_translucency=256;256;false;false</span></tt></p>
4542 </dd>
4543 <dt>line_height</dt>
4544 <dd><p class="first">Amount of space to be drawn above and below the line's baseline.
4545 The first argument defines the amount of space to be drawn above the line, the second
4546 argument defines the amount of space to be drawn below.</p>
4547 <p>Only the first and second argument is interpreted.</p>
4548 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">line_height=0;0;false;false</span></tt></p>
4549 </dd>
4550 <dt>calltips</dt>
4551 <dd><p class="first">The style for coloring the calltips. The first two arguments
4552 define the foreground and background colors, the third and fourth
4553 arguments set whether to use the defined colors.</p>
4554 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">calltips=0xc0c0c0;0xffffff;false;false</span></tt></p>
4555 </dd>
4556 </dl>
4557 </div>
4558 <div class="section">
4559 <h4><a class="toc-backref" href="#id188" id="id6" name="id6">[settings] Section</a></h4>
4560 <dl class="docutils">
4561 <dt>whitespace_chars</dt>
4562 <dd><p class="first">Characters to treat as whitespace. These characters are ignored
4563 when moving, selecting and deleting across word boundaries
4564 (see <a class="reference" href="#scintilla-keyboard-commands">Scintilla keyboard commands</a>).</p>
4565 <p>This should include space (\s) and tab (\t).</p>
4566 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">whitespace_chars=\s\t!\&quot;#$%&amp;'()*+,-./:;&lt;=&gt;?&#64;[\\]^`{|}~</span></tt></p>
4567 </dd>
4568 </dl>
4569 </div>
4570 </div>
4571 </div>
4572 <div class="section">
4573 <h2><a class="toc-backref" href="#id189" id="filetype-extensions" name="filetype-extensions">Filetype extensions</a></h2>
4574 <p>To change the default filetype extension used when saving a new file,
4575 see <a class="reference" href="#filetype-definition-files">Filetype definition files</a>.</p>
4576 <p>You can override the list of file extensions that Geany uses for each
4577 filetype using the <tt class="docutils literal"><span class="pre">filetype_extensions.conf</span></tt> file.</p>
4578 <p>To override the system-wide configuration file, copy it from
4579 <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt> to your configuration directory, usually
4580 <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>. <tt class="docutils literal"><span class="pre">$prefix</span></tt> is the path where Geany is installed
4581 (see <a class="reference" href="#installation-prefix">Installation prefix</a>).</p>
4582 <p>For example:</p>
4583 <pre class="literal-block">
4584 % cp /usr/local/share/geany/filetype_extensions.conf /home/username/.config/geany/
4585 </pre>
4586 <p>Then edit it and remove all the lines for filetype extensions that
4587 you do not want to override. The remaining lines can be edited after
4588 the <tt class="docutils literal"><span class="pre">=</span></tt> sign, using a semi-colon separated list of patterns which
4589 should be matched for that filetype.</p>
4590 <p>For example, to set the filetype extensions for Make, the
4591 <tt class="docutils literal"><span class="pre">/home/username/.config/geany/filetype_extensions.conf</span></tt> file should
4592 look like:</p>
4593 <pre class="literal-block">
4594 [Extensions]
4595 Make=Makefile*;*.mk;Buildfile;
4596 </pre>
4597 </div>
4598 <div class="section">
4599 <h2><a class="toc-backref" href="#id190" id="preferences-file-format" name="preferences-file-format">Preferences File Format</a></h2>
4600 <p>The preferences file <tt class="docutils literal"><span class="pre">~/.config/geany/geany.conf</span></tt> holds settings for all the items configured
4601 in the preferences dialog. This file should not be edited while Geany is running
4602 as the file will be overwritten when the preferences in Geany are changed or Geany
4603 is quitted.</p>
4604 <div class="section">
4605 <h3><a class="toc-backref" href="#id191" id="hidden-preferences" name="hidden-preferences">Hidden preferences</a></h3>
4606 <p>There are some rarely used preferences that are not shown in the Preferences
4607 dialog. These can be set by editing the preferences file, then
4608 selecting <em>Tools-&gt;Reload Configuration</em> or restarting Geany. Search for the
4609 key name, then edit the value. Example:</p>
4610 <blockquote>
4611 <tt class="docutils literal"><span class="pre">brace_match_ltgt=true</span></tt></blockquote>
4612 <p>The table below show the key names of hidden preferences in the
4613 configuration file.</p>
4614 <table border="1" class="docutils">
4615 <colgroup>
4616 <col width="34%" />
4617 <col width="46%" />
4618 <col width="19%" />
4619 </colgroup>
4620 <thead valign="bottom">
4621 <tr><th class="head">Key</th>
4622 <th class="head">Description</th>
4623 <th class="head">Default</th>
4624 </tr>
4625 </thead>
4626 <tbody valign="top">
4627 <tr><td><strong>Editor related</strong></td>
4628 <td>&nbsp;</td>
4629 <td>&nbsp;</td>
4630 </tr>
4631 <tr><td>brace_match_ltgt</td>
4632 <td>Whether to highlight &lt;, &gt; angle brackets.</td>
4633 <td>false</td>
4634 </tr>
4635 <tr><td>show_editor_scrollbars</td>
4636 <td>Whether to display scrollbars. If set to
4637 false, the horizontal and vertical
4638 scrollbars are hidden completely.</td>
4639 <td>true</td>
4640 </tr>
4641 <tr><td>use_gtk_word_boundaries</td>
4642 <td>Whether to look for the end of a word when
4643 using word-boundary related Scintilla
4644 commands (see <a class="reference" href="#scintilla-keyboard-commands">Scintilla keyboard
4645 commands</a>).</td>
4646 <td>true</td>
4647 </tr>
4648 <tr><td>complete_snippets_whilst_editing</td>
4649 <td>Whether to allow completion of snippets
4650 when editing an existing line (i.e. there
4651 is some text after the current cursor
4652 position on the line). Only used when the
4653 keybinding <tt class="docutils literal"><span class="pre">Complete</span> <span class="pre">snippet</span></tt> is set to
4654 <tt class="docutils literal"><span class="pre">Space</span></tt>.</td>
4655 <td>false</td>
4656 </tr>
4657 <tr><td><strong>Interface related</strong></td>
4658 <td>&nbsp;</td>
4659 <td>&nbsp;</td>
4660 </tr>
4661 <tr><td>show_symbol_list_expanders</td>
4662 <td>Whether to show or hide the small expander
4663 icons on the symbol list treeview (only
4664 available with GTK 2.12 or above).</td>
4665 <td>true</td>
4666 </tr>
4667 <tr><td>allow_always_save</td>
4668 <td>Whether files can be saved always, even if
4669 they don't have any changes. By default,
4670 the Save buttons and menu items are
4671 disabled when a file is unchanged. When
4672 setting this option to true, the Save
4673 buttons and menu items are always active
4674 and files can be saved.</td>
4675 <td>false</td>
4676 </tr>
4677 <tr><td><strong>VTE related</strong></td>
4678 <td>&nbsp;</td>
4679 <td>&nbsp;</td>
4680 </tr>
4681 <tr><td>emulation</td>
4682 <td>Terminal emulation mode. Only change this
4683 if you have VTE termcap files other than
4684 <tt class="docutils literal"><span class="pre">vte/termcap/xterm</span></tt>.</td>
4685 <td>xterm</td>
4686 </tr>
4687 <tr><td>send_selection_unsafe</td>
4688 <td>By default, Geany strips any trailing
4689 newline characters from the current
4690 selection before sending it to the terminal
4691 to not execute arbitrary code. This is
4692 mainly a security feature.
4693 If, for whatever reasons, you really want
4694 it to be executed directly, set this option
4695 to true.</td>
4696 <td>false</td>
4697 </tr>
4698 <tr><td><strong>File related</strong></td>
4699 <td>&nbsp;</td>
4700 <td>&nbsp;</td>
4701 </tr>
4702 <tr><td>use_safe_file_saving</td>
4703 <td>Defines the mode how Geany saves files to
4704 disk. If disabled, Geany directly writes
4705 the content of the document to disk. This
4706 might cause in loss of data when there is
4707 no more free space on disk to save the
4708 file. When set to true, Geany first saves
4709 the contents into a temporary file and if
4710 this succeeded, the temporary file is
4711 moved to the real file to save.
4712 This gives better error checking in case of
4713 no more free disk space. But it also
4714 destroys hard links of the original file
4715 and its permissions (e.g. executable flags
4716 are reset). Use this with care as it can
4717 break things seriously.
4718 The better approach would be to ensure your
4719 disk won't run out of free space.</td>
4720 <td>false</td>
4721 </tr>
4722 <tr><td><strong>Build Menu related</strong></td>
4723 <td>&nbsp;</td>
4724 <td>&nbsp;</td>
4725 </tr>
4726 <tr><td>number_ft_menu_items</td>
4727 <td>The maximum number of menu items in the
4728 filetype section of the Build menu.</td>
4729 <td>2</td>
4730 </tr>
4731 <tr><td>number_non_ft_menu_items</td>
4732 <td>The maximum number of menu items in the
4733 non-filetype section of the Build menu.</td>
4734 <td>3</td>
4735 </tr>
4736 <tr><td>number_exec_menu_items</td>
4737 <td>The maximum number of menu items in the
4738 execute section of the Build menu.</td>
4739 <td>2</td>
4740 </tr>
4741 </tbody>
4742 </table>
4743 </div>
4744 <div class="section">
4745 <h3><a class="toc-backref" href="#id192" id="build-menu-section" name="build-menu-section">[build-menu] Section</a></h3>
4746 <p>The [build-menu] section contains the configuration of the build menu.
4747 This section can occur in filetype, preferences and project files and
4748 always has the format described here.  Different menu items are loaded
4749 from different files, see the table in the <a class="reference" href="#build-menu-configuration">Build Menu Configuration</a>
4750 section for details.  All the settings can be configured from the dialogs
4751 except the execute command in filetype files and filetype definitions in
4752 the project file, so these are the only ones which need hand editing.</p>
4753 <p>The build-menu section stores one entry for each setting for each menu item that
4754 is configured.  The keys for these settings have the format:</p>
4755 <blockquote>
4756 <tt class="docutils literal"><span class="pre">GG_NN_FF</span></tt></blockquote>
4757 <p>where:</p>
4758 <ul class="simple">
4759 <li>GG - is the menu item group,<ul>
4760 <li>FT for filetype</li>
4761 <li>NF for non-filetype</li>
4762 <li>EX for execute</li>
4763 </ul>
4764 </li>
4765 <li>NN - is a two decimal digit number of the item within the group,
4766 starting at 00</li>
4767 <li>FF - is the field,<ul>
4768 <li>LB for label</li>
4769 <li>CM for command</li>
4770 <li>WD for working directory</li>
4771 </ul>
4772 </li>
4773 </ul>
4774 </div>
4775 </div>
4776 <div class="section">
4777 <h2><a class="toc-backref" href="#id193" id="project-file-format" name="project-file-format">Project File Format</a></h2>
4778 <p>The project file contains project related settings and possibly a
4779 record of the current session files.</p>
4780 <div class="section">
4781 <h3><a class="toc-backref" href="#id194" id="build-menu-additions" name="build-menu-additions">[build-menu] Additions</a></h3>
4782 <p>The project file also can have extra fields in the [build-menu] section
4783 in addition to those listed in <a class="reference" href="#build-menu-section">[build-menu] Section</a> above.</p>
4784 <p>When filetype menu items are configured for the project they are stored
4785 in the project file.</p>
4786 <p>The <tt class="docutils literal"><span class="pre">filetypes</span></tt> entry is a list of the filetypes which exist in the
4787 project file.</p>
4788 <p>For each filetype the entries for that filetype have the format defined in
4789 <a class="reference" href="#build-menu-section">[build-menu] Section</a> but the key is prefixed by the name of the filetype
4790 as it appears in the <tt class="docutils literal"><span class="pre">filetypes</span></tt> entry, eg the entry for the label of
4791 filetype menu item 0 for the C filetype would be</p>
4792 <blockquote>
4793 <tt class="docutils literal"><span class="pre">CFT_00_LB=Label</span></tt></blockquote>
4794 </div>
4795 </div>
4796 <div class="section">
4797 <h2><a class="toc-backref" href="#id195" id="templates" name="templates">Templates</a></h2>
4798 <p>Geany supports the following templates:</p>
4799 <ul class="simple">
4800 <li>ChangeLog entry</li>
4801 <li>File header</li>
4802 <li>Function description</li>
4803 <li>Short GPL notice</li>
4804 <li>Short BSD notice</li>
4805 <li>File templates</li>
4806 </ul>
4807 <p>To use these templates, just open the Edit menu or open the popup menu
4808 by right-clicking in the editor widget, and choose &quot;Insert Comments&quot;
4809 and insert templates as you want.</p>
4810 <p>Some templates (like File header or ChangeLog entry) will always be
4811 inserted at the top of the file.</p>
4812 <p>To insert a function description, the cursor must be inside
4813 of the function, so that the function name can be determined
4814 automatically. The description will be positioned correctly one line
4815 above the function, just check it out. If the cursor is not inside
4816 of a function or the function name cannot be determined, the inserted
4817 function description won't contain the correct function name but &quot;unknown&quot;
4818 instead.</p>
4819 <div class="section">
4820 <h3><a class="toc-backref" href="#id196" id="template-meta-data" name="template-meta-data">Template meta data</a></h3>
4821 <p>Meta data can be used with all templates, but by default user set
4822 meta data is only used for the ChangeLog and File header templates.</p>
4823 <p>In the configuration dialog you can find a tab &quot;Templates&quot; (see
4824 <a class="reference" href="#template-preferences">Template preferences</a>). You can define the default values
4825 which will be inserted in the templates. You should select
4826 <em>Tools-&gt;Reload Configuration</em> or restart Geany after making changes.</p>
4827 </div>
4828 <div class="section">
4829 <h3><a class="toc-backref" href="#id197" id="file-templates" name="file-templates">File templates</a></h3>
4830 <p>File templates are templates used as the basis of a new file. To
4831 use them, choose the <em>New (with Template)</em> menu item from the <em>File</em>
4832 menu.</p>
4833 <p>By default, file templates are installed for some filetypes. Custom
4834 file templates can be added by creating the appropriate template file
4835 and then selecting <em>Tools-&gt;Reload Configuration</em> or restarting Geany. You can
4836 also edit the default file templates.</p>
4837 <p>The file's contents are just the text to place in the document, with
4838 optional template wildcards like <tt class="docutils literal"><span class="pre">{fileheader}</span></tt>. The fileheader
4839 wildcard can be placed anywhere, but it's usually put on the first
4840 line of the file, followed by a blank line.</p>
4841 <div class="section">
4842 <h4><a class="toc-backref" href="#id198" id="custom-file-templates" name="custom-file-templates">Custom file templates</a></h4>
4843 <p>These are read from the following directories:</p>
4844 <ul class="simple">
4845 <li><tt class="docutils literal"><span class="pre">$prefix/share/geany/templates/files</span></tt> (see <a class="reference" href="#installation-prefix">Installation prefix</a>)</li>
4846 <li><tt class="docutils literal"><span class="pre">~/.config/geany/templates/files</span></tt> (created the first time
4847 Geany is started).</li>
4848 </ul>
4849 <p>The filetype to use is detected from the template file's extension, if
4850 any. For example, creating a file <tt class="docutils literal"><span class="pre">module.c</span></tt> would add a menu item
4851 which created a new document with the filetype set to 'C'.</p>
4852 <p>The template file is read from disk when the corresponding menu item is
4853 clicked, so you don't need to select <em>Tools-&gt;Reload Configuration</em> or restart
4854 Geany after editing a custom file template.</p>
4855 </div>
4856 <div class="section">
4857 <h4><a class="toc-backref" href="#id199" id="filetype-templates" name="filetype-templates">Filetype templates</a></h4>
4858 <div class="note">
4859 <p class="first admonition-title">Note</p>
4860 <p class="last">It's recommended to use custom file templates instead.</p>
4861 </div>
4862 <p>Filetype template files are read from the <tt class="docutils literal"><span class="pre">~/.config/geany/templates</span></tt>
4863 directory, and are named &quot;filetype.&quot; followed by the filetype
4864 name, e.g. &quot;filetype.python&quot;, &quot;filetype.sh&quot;, etc. If you are
4865 unsure about the filetype name extensions, they are the same as
4866 the filetype configuration file extensions, commonly installed in
4867 <tt class="docutils literal"><span class="pre">/usr/share/geany</span></tt>, with the prefix &quot;filetypes.&quot;.</p>
4868 <p>There is also a template file <tt class="docutils literal"><span class="pre">filetype.none</span></tt> which is used when
4869 the New command is used without a filetype. This is empty by default.</p>
4870 </div>
4871 </div>
4872 <div class="section">
4873 <h3><a class="toc-backref" href="#id200" id="customizing-templates" name="customizing-templates">Customizing templates</a></h3>
4874 <p>Each template can be customized to your needs. The templates are
4875 stored in the <tt class="docutils literal"><span class="pre">~/.config/geany/templates/</span></tt> directory (see the section called
4876 <a class="reference" href="#command-line-options">Command line options</a> for further information about the configuration
4877 directory). Just open the desired template with an editor (ideally,
4878 Geany ;-) ) and edit the template to your needs. There are some
4879 wildcards which will be automatically replaced by Geany at startup.</p>
4880 <div class="section">
4881 <h4><a class="toc-backref" href="#id201" id="template-wildcards" name="template-wildcards">Template wildcards</a></h4>
4882 <p>All wildcards must be enclosed by &quot;{&quot; and &quot;}&quot;, e.g. {date}.</p>
4883 <table border="1" class="docutils">
4884 <colgroup>
4885 <col width="14%" />
4886 <col width="46%" />
4887 <col width="40%" />
4888 </colgroup>
4889 <thead valign="bottom">
4890 <tr><th class="head">Wildcard</th>
4891 <th class="head">Description</th>
4892 <th class="head">Available in</th>
4893 </tr>
4894 </thead>
4895 <tbody valign="top">
4896 <tr><td>ob</td>
4897 <td>{ Opening Brace (used to prevent other
4898 wildcards being expanded).</td>
4899 <td>file templates, file header, snippets.</td>
4900 </tr>
4901 <tr><td>cb</td>
4902 <td>} Closing Brace.</td>
4903 <td>file templates, file header, snippets.</td>
4904 </tr>
4905 <tr><td>pc</td>
4906 <td>% Percent (used to escape e.g. %block% in
4907 snippets).</td>
4908 <td>snippets.</td>
4909 </tr>
4910 <tr><td>developer</td>
4911 <td>The name of the developer.</td>
4912 <td>file templates, file header,
4913 function description, ChangeLog entry,
4914 bsd, gpl, snippets.</td>
4915 </tr>
4916 <tr><td>initial</td>
4917 <td>The developer's initials, e.g. &quot;ET&quot; for
4918 Enrico Tröger or &quot;JFD&quot; for John Foobar Doe.</td>
4919 <td>file templates, file header,
4920 function description, ChangeLog entry,
4921 bsd, gpl, snippets.</td>
4922 </tr>
4923 <tr><td>mail</td>
4924 <td>The email address of the developer.</td>
4925 <td>file templates, file header,
4926 function description, ChangeLog entry,
4927 bsd, gpl, snippets.</td>
4928 </tr>
4929 <tr><td>company</td>
4930 <td>The company the developer is working for.</td>
4931 <td>file templates, file header,
4932 function description, ChangeLog entry,
4933 bsd, gpl, snippets.</td>
4934 </tr>
4935 <tr><td>year <a class="footnote-reference" href="#id10" id="id7" name="id7">[1]</a></td>
4936 <td>The current year. Default format is: YYYY.</td>
4937 <td>file templates, file header,
4938 function description, ChangeLog entry,
4939 bsd, gpl, snippets.</td>
4940 </tr>
4941 <tr><td>version</td>
4942 <td>The initial version of a new file.</td>
4943 <td>file templates, file header,
4944 function description, ChangeLog entry,
4945 bsd, gpl, snippets.</td>
4946 </tr>
4947 <tr><td>date <a class="footnote-reference" href="#id10" id="id8" name="id8">[1]</a></td>
4948 <td>The current date. Default format:
4949 YYYY-MM-DD.</td>
4950 <td>file templates, file header,
4951 function description, ChangeLog entry,
4952 bsd, gpl, snippets.</td>
4953 </tr>
4954 <tr><td>untitled</td>
4955 <td>The string &quot;untitled&quot; (this will be
4956 translated to your locale), used in
4957 file templates.</td>
4958 <td>file templates, file header,
4959 function description, ChangeLog entry,
4960 bsd, gpl, snippets.</td>
4961 </tr>
4962 <tr><td>geanyversion</td>
4963 <td>The actual Geany version, e.g.
4964 &quot;Geany 0.19&quot;.</td>
4965 <td>file templates, file header,
4966 function description, ChangeLog entry,
4967 bsd, gpl, snippets.</td>
4968 </tr>
4969 <tr><td>datetime <a class="footnote-reference" href="#id10" id="id9" name="id9">[1]</a></td>
4970 <td>The current date and time. Default format:
4971 DD.MM.YYYY HH:mm:ss ZZZZ.</td>
4972 <td>file templates, file header,
4973 function description, ChangeLog entry,
4974 bsd, gpl, snippets.</td>
4975 </tr>
4976 <tr><td>filename</td>
4977 <td>The filename of the current file.
4978 Only replaced when first saving if found on
4979 the first 3 lines of the file.</td>
4980 <td>file header, snippets, file
4981 templates.</td>
4982 </tr>
4983 <tr><td>project</td>
4984 <td>The current project's name, if any.</td>
4985 <td>file header, snippets, file templates.</td>
4986 </tr>
4987 <tr><td>description</td>
4988 <td>The current project's description, if any.</td>
4989 <td>file header, snippets, file templates.</td>
4990 </tr>
4991 <tr><td>gpl</td>
4992 <td>This wildcard inserts a short GPL notice.</td>
4993 <td>file header.</td>
4994 </tr>
4995 <tr><td>bsd</td>
4996 <td>This wildcard inserts a BSD licence notice.</td>
4997 <td>file header.</td>
4998 </tr>
4999 <tr><td>functionname</td>
5000 <td>The function name of the function at the
5001 cursor position. This wildcard will only be.
5002 replaced in the function description.
5003 template.</td>
5004 <td>function description.</td>
5005 </tr>
5006 <tr><td>fileheader</td>
5007 <td>The file header template. This wildcard
5008 will only be replaced in filetype
5009 templates.</td>
5010 <td>file header, snippets, file
5011 templates.</td>
5012 </tr>
5013 <tr><td>command:path</td>
5014 <td>Executes the specified command and replace
5015 the wildcard with the command's standard
5016 output. See <a class="reference" href="#special-command-wildcard">Special {command:} wildcard</a>
5017 for details.</td>
5018 <td>file templates, file header,
5019 function description, ChangeLog entry,
5020 bsd, gpl, snippets.</td>
5021 </tr>
5022 </tbody>
5023 </table>
5024 <table class="docutils footnote" frame="void" id="id10" rules="none">
5025 <colgroup><col class="label" /><col /></colgroup>
5026 <tbody valign="top">
5027 <tr><td class="label"><a name="id10">[1]</a></td><td><em>(<a class="fn-backref" href="#id7">1</a>, <a class="fn-backref" href="#id8">2</a>, <a class="fn-backref" href="#id9">3</a>)</em> The format for the <tt class="docutils literal"><span class="pre">year</span></tt>, <tt class="docutils literal"><span class="pre">date</span></tt> and <tt class="docutils literal"><span class="pre">datetime</span></tt> wildcards can be changed
5028 in the preferences dialog, see <a class="reference" href="#template-preferences">Template preferences</a>. You can
5029 use any conversion specifiers which can be used with the ANSI C strftime function.
5030 For details please see <a class="reference" href="http://man.cx/strftime">http://man.cx/strftime</a>.</td></tr>
5031 </tbody>
5032 </table>
5033 <div class="section">
5034 <h5><a class="toc-backref" href="#id202" id="special-command-wildcard" name="special-command-wildcard">Special {command:} wildcard</a></h5>
5035 <p>The {command:} wildcard is a special one because it can execute
5036 a specified command and put the command's output (stdout) into
5037 the template.</p>
5038 <p>Example:</p>
5039 <pre class="literal-block">
5040 {command:uname -a}
5041 </pre>
5042 <p>will result in:</p>
5043 <pre class="literal-block">
5044 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
5045 </pre>
5046 <p>Using this wildcard you can insert nearly any arbitrary text into the
5047 template.</p>
5048 <p>In the environment of the executed command the variables
5049 <tt class="docutils literal"><span class="pre">GEANY_FILENAME</span></tt>, <tt class="docutils literal"><span class="pre">GEANY_FILETYPE</span></tt> and <tt class="docutils literal"><span class="pre">GEANY_FUNCNAME</span></tt> are set.
5050 The value of these variables is filled in only if Geany knows about it.
5051 For example, <tt class="docutils literal"><span class="pre">GEANY_FUNCNAME</span></tt> is only filled within the function
5052 description template. However, these variables are <tt class="docutils literal"><span class="pre">always</span></tt> set,
5053 just maybe with an empty value.
5054 You can easily access them e.g. within an executed shell script using:</p>
5055 <pre class="literal-block">
5056 $GEANY_FILENAME
5057 </pre>
5058 <div class="note">
5059 <p class="first admonition-title">Note</p>
5060 <p class="last">If the specified command could not be found or not executed, the wildcard is substituted
5061 by an empty string. In such cases, you can find the occurred error message on Geany's
5062 standard error and in the Help-&gt;Debug Messages dialog.</p>
5063 </div>
5064 </div>
5065 </div>
5066 </div>
5067 </div>
5068 <div class="section">
5069 <h2><a class="toc-backref" href="#id203" id="customizing-the-toolbar" name="customizing-the-toolbar">Customizing the toolbar</a></h2>
5070 <p>You can add, remove and reorder the elements in the toolbar by using the toolbar editor
5071 by manually editing the file <tt class="docutils literal"><span class="pre">ui_toolbar.xml</span></tt>.</p>
5072 <p>The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5073 by right-clicking on the toolbar itself and choosing it from the menu.</p>
5074 <div class="section">
5075 <h3><a class="toc-backref" href="#id204" id="manually-editing-of-the-toolbar-layout" name="manually-editing-of-the-toolbar-layout">Manually editing of the toolbar layout</a></h3>
5076 <p>To override the system-wide configuration file, copy it from
5077 <tt class="docutils literal"><span class="pre">$prefix/share/geany</span></tt> to your configuration directory, usually
5078 <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>. <tt class="docutils literal"><span class="pre">$prefix</span></tt> is the path where Geany is installed
5079 (see <a class="reference" href="#installation-prefix">Installation prefix</a>).</p>
5080 <p>For example:</p>
5081 <pre class="literal-block">
5082 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5083 </pre>
5084 <p>Then edit it and add any of the available elements listed in the file or remove
5085 any of the existing elements. Of course, you can also reorder the elements as
5086 you wish and add or remove additional separators.
5087 This file must be valid XML, otherwise the global toolbar UI definition
5088 will be used instead.</p>
5089 <p>Your changes are applied once you save the file.</p>
5090 <div class="note">
5091 <p class="first admonition-title">Note</p>
5092 <ol class="last arabic simple">
5093 <li>You cannot add new actions which are not listed below.</li>
5094 <li>Everything you add or change must be inside the /ui/toolbar/ path.</li>
5095 </ol>
5096 </div>
5097 </div>
5098 <div class="section">
5099 <h3><a class="toc-backref" href="#id205" id="available-toolbar-elements" name="available-toolbar-elements">Available toolbar elements</a></h3>
5100 <table border="1" class="docutils">
5101 <colgroup>
5102 <col width="19%" />
5103 <col width="81%" />
5104 </colgroup>
5105 <thead valign="bottom">
5106 <tr><th class="head">Element name</th>
5107 <th class="head">Description</th>
5108 </tr>
5109 </thead>
5110 <tbody valign="top">
5111 <tr><td>New</td>
5112 <td>Create a new file</td>
5113 </tr>
5114 <tr><td>Open</td>
5115 <td>Open an existing file</td>
5116 </tr>
5117 <tr><td>Save</td>
5118 <td>Save the current file</td>
5119 </tr>
5120 <tr><td>SaveAll</td>
5121 <td>Save all open files</td>
5122 </tr>
5123 <tr><td>Reload</td>
5124 <td>Reload the current file from disk</td>
5125 </tr>
5126 <tr><td>Close</td>
5127 <td>Close the current file</td>
5128 </tr>
5129 <tr><td>CloseAll</td>
5130 <td>Close all open files</td>
5131 </tr>
5132 <tr><td>Print</td>
5133 <td>Print the current file</td>
5134 </tr>
5135 <tr><td>Cut</td>
5136 <td>Cut the current selection</td>
5137 </tr>
5138 <tr><td>Copy</td>
5139 <td>Copy the current selection</td>
5140 </tr>
5141 <tr><td>Paste</td>
5142 <td>Paste the contents of the clipboard</td>
5143 </tr>
5144 <tr><td>Delete</td>
5145 <td>Delete the current selection</td>
5146 </tr>
5147 <tr><td>Undo</td>
5148 <td>Undo the last modification</td>
5149 </tr>
5150 <tr><td>Redo</td>
5151 <td>Redo the last modification</td>
5152 </tr>
5153 <tr><td>NavBack</td>
5154 <td>Navigate back a location</td>
5155 </tr>
5156 <tr><td>NavFor</td>
5157 <td>Navigate forward a location</td>
5158 </tr>
5159 <tr><td>Compile</td>
5160 <td>Compile the current file</td>
5161 </tr>
5162 <tr><td>Build</td>
5163 <td>Build the current file, includes a submenu for Make commands. Geany
5164 remembers the last chosen action from the submenu and uses this as default
5165 action when the button itself is clicked.</td>
5166 </tr>
5167 <tr><td>Run</td>
5168 <td>Run or view the current file</td>
5169 </tr>
5170 <tr><td>Color</td>
5171 <td>Open a color chooser dialog, to interactively pick colors from a palette</td>
5172 </tr>
5173 <tr><td>ZoomIn</td>
5174 <td>Zoom in the text</td>
5175 </tr>
5176 <tr><td>ZoomOut</td>
5177 <td>Zoom out the text</td>
5178 </tr>
5179 <tr><td>UnIndent</td>
5180 <td>Decrease indentation</td>
5181 </tr>
5182 <tr><td>Indent</td>
5183 <td>Increase indentation</td>
5184 </tr>
5185 <tr><td>Replace</td>
5186 <td>Replace text in the current document</td>
5187 </tr>
5188 <tr><td>SearchEntry</td>
5189 <td>The search field belonging to the 'Search' element (can be used alone)</td>
5190 </tr>
5191 <tr><td>Search</td>
5192 <td>Find the entered text in the current file (only useful if you also
5193 use 'SearchEntry')</td>
5194 </tr>
5195 <tr><td>GotoEntry</td>
5196 <td>The goto field belonging to the 'Goto' element (can be used alone)</td>
5197 </tr>
5198 <tr><td>Goto</td>
5199 <td>Jump to the entered line number (only useful if you also use 'GotoEntry')</td>
5200 </tr>
5201 <tr><td>Preferences</td>
5202 <td>Show the preferences dialog</td>
5203 </tr>
5204 <tr><td>Quit</td>
5205 <td>Quit Geany</td>
5206 </tr>
5207 </tbody>
5208 </table>
5209 </div>
5210 </div>
5211 </div>
5212 <div class="section">
5213 <h1><a class="toc-backref" href="#id206" id="plugin-documentation" name="plugin-documentation">Plugin documentation</a></h1>
5214 <div class="section">
5215 <h2><a class="toc-backref" href="#id207" id="save-actions" name="save-actions">Save Actions</a></h2>
5216 <div class="section">
5217 <h3><a class="toc-backref" href="#id208" id="instant-save" name="instant-save">Instant Save</a></h3>
5218 <p>This plugin sets on every new file (File-&gt;New or File-&gt; New (with template))
5219 a randomly chosen filename and set its filetype appropriate to the used template
5220 or when no template was used, to a configurable default filetype.
5221 This enables you to quickly compile, build and/or run the new file without the
5222 need to give it an explicit filename using the Save As dialog. This might be
5223 useful when you often create new files just for testing some code or something
5224 similar.</p>
5225 </div>
5226 <div class="section">
5227 <h3><a class="toc-backref" href="#id209" id="backup-copy" name="backup-copy">Backup Copy</a></h3>
5228 <p>This plugin creates a backup copy of the current file in Geany when it is
5229 saved. You can specify the directory where the backup copy is saved and
5230 you can configure the automatically added extension in the configure dialog
5231 in Geany's plugin manager.</p>
5232 <p>After the plugin was loaded in Geany's plugin manager, every file is
5233 copied into the configured backup directory when the file is saved in Geany.</p>
5234 </div>
5235 </div>
5236 </div>
5237 <div class="section">
5238 <h1><a class="toc-backref" href="#id210" id="contributing-to-this-document" name="contributing-to-this-document">Contributing to this document</a></h1>
5239 <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>
5240 (or &quot;reST&quot;). The source file for it is located in Geany's <tt class="docutils literal"><span class="pre">doc</span></tt>
5241 subdirectory.  If you intend on making changes, you should grab the
5242 source right from SVN to make sure you've got the newest version. After
5243 editing the file, to build the HTML document to see how your changes
5244 look, run &quot;<tt class="docutils literal"><span class="pre">make</span> <span class="pre">doc</span></tt>&quot; in the subdirectory <tt class="docutils literal"><span class="pre">doc</span></tt> of Geany's source
5245 directory. This regenerates the <tt class="docutils literal"><span class="pre">geany.html</span></tt> file. To generate a PDF
5246 file, use the command &quot;<tt class="docutils literal"><span class="pre">make</span> <span class="pre">pdf</span></tt>&quot; which should generate a file called
5247 geany-0.19.pdf.</p>
5248 <p>After you are happy with your changes, create a patch:</p>
5249 <pre class="literal-block">
5250 % svn diff geany.txt &gt; foo.patch
5251 </pre>
5252 <p>and then submit that file to the mailing list for review.</p>
5253 <p>Note, you will need the Python docutils software package installed
5254 to build the docs. The package is named <tt class="docutils literal"><span class="pre">python-docutils</span></tt> on Debian
5255 and Fedora systems.</p>
5256 </div>
5257 <div class="section">
5258 <h1><a class="toc-backref" href="#id211" id="scintilla-keyboard-commands" name="scintilla-keyboard-commands">Scintilla keyboard commands</a></h1>
5259 <p>Copyright © 1998, 2006 Neil Hodgson &lt;neilh(at)scintilla(dot)org&gt;</p>
5260 <p>This appendix is distributed under the terms of the License for
5261 Scintilla and SciTE. A copy of this license can be found in the file
5262 <tt class="docutils literal"><span class="pre">scintilla/License.txt</span></tt> included with the source code of this
5263 program and in the appendix of this document. See <a class="reference" href="#license-for-scintilla-and-scite">License for
5264 Scintilla and SciTE</a>.</p>
5265 <p>20 June 2006</p>
5266 <div class="section">
5267 <h2><a class="toc-backref" href="#id212" id="keyboard-commands" name="keyboard-commands">Keyboard commands</a></h2>
5268 <p>Keyboard commands for Scintilla mostly follow common Windows and GTK+
5269 conventions. All move keys (arrows, page up/down, home and end)
5270 allows to extend or reduce the stream selection when holding the
5271 Shift key, and the rectangular selection when holding the Shift and
5272 Ctrl keys. Some keys may not be available with some national keyboards
5273 or because they are taken by the system such as by a window manager
5274 or GTK. Keyboard equivalents of menu commands are listed in the
5275 menus. Some less common commands with no menu equivalent are:</p>
5276 <table border="1" class="docutils">
5277 <colgroup>
5278 <col width="67%" />
5279 <col width="33%" />
5280 </colgroup>
5281 <thead valign="bottom">
5282 <tr><th class="head">Action</th>
5283 <th class="head">Shortcut key</th>
5284 </tr>
5285 </thead>
5286 <tbody valign="top">
5287 <tr><td>Magnify text size.</td>
5288 <td>Ctrl+Keypad+</td>
5289 </tr>
5290 <tr><td>Reduce text size.</td>
5291 <td>Ctrl+Keypad-</td>
5292 </tr>
5293 <tr><td>Restore text size to normal.</td>
5294 <td>Ctrl+Keypad/</td>
5295 </tr>
5296 <tr><td>Indent block.</td>
5297 <td>Tab</td>
5298 </tr>
5299 <tr><td>Dedent block.</td>
5300 <td>Shift+Tab</td>
5301 </tr>
5302 <tr><td>Delete to start of word.</td>
5303 <td>Ctrl+BackSpace</td>
5304 </tr>
5305 <tr><td>Delete to end of word.</td>
5306 <td>Ctrl+Delete</td>
5307 </tr>
5308 <tr><td>Delete to start of line.</td>
5309 <td>Ctrl+Shift+BackSpace</td>
5310 </tr>
5311 <tr><td>Go to start of document.</td>
5312 <td>Ctrl+Home</td>
5313 </tr>
5314 <tr><td>Extend selection to start of document.</td>
5315 <td>Ctrl+Shift+Home</td>
5316 </tr>
5317 <tr><td>Go to start of display line.</td>
5318 <td>Alt+Home</td>
5319 </tr>
5320 <tr><td>Extend selection to start of display line.</td>
5321 <td>Alt+Shift+Home</td>
5322 </tr>
5323 <tr><td>Go to end of document.</td>
5324 <td>Ctrl+End</td>
5325 </tr>
5326 <tr><td>Extend selection to end of document.</td>
5327 <td>Ctrl+Shift+End</td>
5328 </tr>
5329 <tr><td>Extend selection to end of display line.</td>
5330 <td>Alt+Shift+End</td>
5331 </tr>
5332 <tr><td>Previous paragraph. Shift extends selection.</td>
5333 <td>Ctrl+Up</td>
5334 </tr>
5335 <tr><td>Next paragraph. Shift extends selection.</td>
5336 <td>Ctrl+Down</td>
5337 </tr>
5338 <tr><td>Previous word. Shift extends selection.</td>
5339 <td>Ctrl+Left</td>
5340 </tr>
5341 <tr><td>Next word. Shift extends selection.</td>
5342 <td>Ctrl+Right</td>
5343 </tr>
5344 </tbody>
5345 </table>
5346 </div>
5347 </div>
5348 <div class="section">
5349 <h1><a class="toc-backref" href="#id213" id="tips-and-tricks" name="tips-and-tricks">Tips and tricks</a></h1>
5350 <div class="section">
5351 <h2><a class="toc-backref" href="#id214" id="document-notebook" name="document-notebook">Document notebook</a></h2>
5352 <ul class="simple">
5353 <li>Double-click on empty space in the notebook tab bar to open a
5354 new document.</li>
5355 <li>Middle-click on a document's notebook tab to close the document.</li>
5356 <li>Hold <cite>Ctrl</cite> and click on any notebook tab to switch to the last used
5357 document.</li>
5358 <li>Double-click on a document's notebook tab to toggle all additional
5359 widgets (to show them again use the View menu or the keyboard
5360 shortcut). The interface pref must be enabled for this to work.</li>
5361 </ul>
5362 </div>
5363 <div class="section">
5364 <h2><a class="toc-backref" href="#id215" id="editor" name="editor">Editor</a></h2>
5365 <ul class="simple">
5366 <li>Alt-scroll wheel moves up/down a page.</li>
5367 <li>Ctrl-scroll wheel zooms in/out.</li>
5368 <li>Shift-scroll wheel scrolls 8 characters right/left.</li>
5369 <li>Ctrl-click on a word in a document to perform <em>Go to Tag Definition</em>.</li>
5370 <li>Ctrl-click on a bracket/brace to perform <em>Go to Matching Brace</em>.</li>
5371 </ul>
5372 </div>
5373 <div class="section">
5374 <h2><a class="toc-backref" href="#id216" id="interface" name="interface">Interface</a></h2>
5375 <ul class="simple">
5376 <li>Double-click on a symbol-list group to expand or compact it.</li>
5377 </ul>
5378 </div>
5379 <div class="section">
5380 <h2><a class="toc-backref" href="#id217" id="gtk-related" name="gtk-related">GTK-related</a></h2>
5381 <ul class="simple">
5382 <li>Scrolling the mouse wheel over a notebook tab bar will switch
5383 notebook pages.</li>
5384 </ul>
5385 <p>The following are derived from X-Windows features (but GTK still supports
5386 them on Windows):</p>
5387 <ul class="simple">
5388 <li>Middle-click pastes the last selected text.</li>
5389 <li>Middle-click on a scrollbar moves the scrollbar to that
5390 position without having to drag it.</li>
5391 </ul>
5392 </div>
5393 </div>
5394 <div class="section">
5395 <h1><a class="toc-backref" href="#id218" id="compile-time-options" name="compile-time-options">Compile-time options</a></h1>
5396 <p>There are some options which can only be changed at compile time,
5397 and some options which are used as the default for configurable
5398 options. To change these options, edit the appropriate source file
5399 in the <tt class="docutils literal"><span class="pre">src</span></tt> subdirectory. Look for a block of lines starting with
5400 <tt class="docutils literal"><span class="pre">#define</span> <span class="pre">GEANY_*</span></tt>. Any definitions which are not listed here should
5401 not be changed.</p>
5402 <div class="note">
5403 <p class="first admonition-title">Note</p>
5404 <p class="last">Most users should not need to change these options.</p>
5405 </div>
5406 <div class="section">
5407 <h2><a class="toc-backref" href="#id219" id="src-geany-h" name="src-geany-h">src/geany.h</a></h2>
5408 <table border="1" class="docutils">
5409 <colgroup>
5410 <col width="33%" />
5411 <col width="48%" />
5412 <col width="20%" />
5413 </colgroup>
5414 <thead valign="bottom">
5415 <tr><th class="head">Option</th>
5416 <th class="head">Description</th>
5417 <th class="head">Default</th>
5418 </tr>
5419 </thead>
5420 <tbody valign="top">
5421 <tr><td>GEANY_STRING_UNTITLED</td>
5422 <td>A string used as the default name for new
5423 files. Be aware that the string can be
5424 translated, so change it only if you know
5425 what you are doing.</td>
5426 <td>untitled</td>
5427 </tr>
5428 <tr><td>GEANY_WINDOW_MINIMAL_WIDTH</td>
5429 <td>The minimal width of the main window.</td>
5430 <td>620</td>
5431 </tr>
5432 <tr><td>GEANY_WINDOW_MINIMAL_HEIGHT</td>
5433 <td>The minimal height of the main window.</td>
5434 <td>440</td>
5435 </tr>
5436 <tr><td>GEANY_WINDOW_DEFAULT_WIDTH</td>
5437 <td>The default width of the main window at the
5438 first start.</td>
5439 <td>900</td>
5440 </tr>
5441 <tr><td>GEANY_WINDOW_DEFAULT_HEIGHT</td>
5442 <td>The default height of the main window at the
5443 first start.</td>
5444 <td>600</td>
5445 </tr>
5446 <tr><td><strong>Windows specific</strong></td>
5447 <td>&nbsp;</td>
5448 <td>&nbsp;</td>
5449 </tr>
5450 <tr><td>GEANY_USE_WIN32_DIALOG</td>
5451 <td>Set this to 1 if you want to use the default
5452 Windows file open and save dialogs instead
5453 GTK's file open and save dialogs. The
5454 default Windows file dialogs are missing
5455 some nice features like choosing a filetype
5456 or an encoding. <em>Do not touch this setting
5457 when building on a non-Win32 system.</em></td>
5458 <td>0</td>
5459 </tr>
5460 </tbody>
5461 </table>
5462 </div>
5463 <div class="section">
5464 <h2><a class="toc-backref" href="#id220" id="project-h" name="project-h">project.h</a></h2>
5465 <table border="1" class="docutils">
5466 <colgroup>
5467 <col width="33%" />
5468 <col width="48%" />
5469 <col width="20%" />
5470 </colgroup>
5471 <thead valign="bottom">
5472 <tr><th class="head">Option</th>
5473 <th class="head">Description</th>
5474 <th class="head">Default</th>
5475 </tr>
5476 </thead>
5477 <tbody valign="top">
5478 <tr><td>GEANY_PROJECT_EXT</td>
5479 <td>The default filename extension for Geany
5480 project files. It is used when creating new
5481 projects and as filter mask for the project
5482 open dialog.</td>
5483 <td>geany</td>
5484 </tr>
5485 </tbody>
5486 </table>
5487 </div>
5488 <div class="section">
5489 <h2><a class="toc-backref" href="#id221" id="editor-h" name="editor-h">editor.h</a></h2>
5490 <table border="1" class="docutils">
5491 <colgroup>
5492 <col width="33%" />
5493 <col width="48%" />
5494 <col width="20%" />
5495 </colgroup>
5496 <thead valign="bottom">
5497 <tr><th class="head">Option</th>
5498 <th class="head">Description</th>
5499 <th class="head">Default</th>
5500 </tr>
5501 </thead>
5502 <tbody valign="top">
5503 <tr><td>GEANY_WORDCHARS</td>
5504 <td>These characters define word boundaries when
5505 making selections and searching using word
5506 matching options.</td>
5507 <td>a string with:
5508 a-z, A-Z, 0-9 and
5509 underscore.</td>
5510 </tr>
5511 </tbody>
5512 </table>
5513 </div>
5514 <div class="section">
5515 <h2><a class="toc-backref" href="#id222" id="keyfile-c" name="keyfile-c">keyfile.c</a></h2>
5516 <p>These are default settings that can be overridden in the <a class="reference" href="#preferences">Preferences</a> dialog.</p>
5517 <table border="1" class="docutils">
5518 <colgroup>
5519 <col width="33%" />
5520 <col width="48%" />
5521 <col width="20%" />
5522 </colgroup>
5523 <thead valign="bottom">
5524 <tr><th class="head">Option</th>
5525 <th class="head">Description</th>
5526 <th class="head">Default</th>
5527 </tr>
5528 </thead>
5529 <tbody valign="top">
5530 <tr><td>GEANY_MIN_SYMBOLLIST_CHARS</td>
5531 <td>How many characters you need to type to
5532 trigger the autocompletion list.</td>
5533 <td>4</td>
5534 </tr>
5535 <tr><td>GEANY_DISK_CHECK_TIMEOUT</td>
5536 <td>Time in seconds between checking a file for
5537 external changes.</td>
5538 <td>30</td>
5539 </tr>
5540 <tr><td>GEANY_DEFAULT_TOOLS_MAKE</td>
5541 <td>The make tool. This can also include a path.</td>
5542 <td>&quot;make&quot;</td>
5543 </tr>
5544 <tr><td>GEANY_DEFAULT_TOOLS_TERMINAL</td>
5545 <td>A terminal emulator. It has to accept the
5546 command line option &quot;-e&quot;. This can also
5547 include a path.</td>
5548 <td>&quot;xterm&quot;</td>
5549 </tr>
5550 <tr><td>GEANY_DEFAULT_TOOLS_BROWSER</td>
5551 <td>A web browser. This can also include a path.</td>
5552 <td>&quot;firefox&quot;</td>
5553 </tr>
5554 <tr><td>GEANY_DEFAULT_TOOLS_PRINTCMD</td>
5555 <td>A printing tool. It should be able to accept
5556 and process plain text files. This can also
5557 include a path.</td>
5558 <td>&quot;lpr&quot;</td>
5559 </tr>
5560 <tr><td>GEANY_DEFAULT_TOOLS_GREP</td>
5561 <td>A grep tool. It should be compatible with
5562 GNU grep. This can also include a path.</td>
5563 <td>&quot;grep&quot;</td>
5564 </tr>
5565 <tr><td>GEANY_DEFAULT_MRU_LENGTH</td>
5566 <td>The length of the &quot;Recent files&quot; list.</td>
5567 <td>10</td>
5568 </tr>
5569 <tr><td>GEANY_DEFAULT_FONT_SYMBOL_LIST</td>
5570 <td>The font used in sidebar to show symbols and
5571 open files.</td>
5572 <td>&quot;Sans 9&quot;</td>
5573 </tr>
5574 <tr><td>GEANY_DEFAULT_FONT_MSG_WINDOW</td>
5575 <td>The font used in the messages window.</td>
5576 <td>&quot;Sans 9&quot;</td>
5577 </tr>
5578 <tr><td>GEANY_DEFAULT_FONT_EDITOR</td>
5579 <td>The font used in the editor window.</td>
5580 <td>&quot;Monospace 10&quot;</td>
5581 </tr>
5582 <tr><td>GEANY_TOGGLE_MARK</td>
5583 <td>A string which is used to mark a toggled
5584 comment.</td>
5585 <td>&quot;~ &quot;</td>
5586 </tr>
5587 <tr><td>GEANY_MAX_AUTOCOMPLETE_WORDS</td>
5588 <td>How many autocompletion suggestions should
5589 Geany provide.</td>
5590 <td>30</td>
5591 </tr>
5592 </tbody>
5593 </table>
5594 </div>
5595 <div class="section">
5596 <h2><a class="toc-backref" href="#id223" id="build-h" name="build-h">build.h</a></h2>
5597 <table border="1" class="docutils">
5598 <colgroup>
5599 <col width="33%" />
5600 <col width="48%" />
5601 <col width="20%" />
5602 </colgroup>
5603 <thead valign="bottom">
5604 <tr><th class="head">Option</th>
5605 <th class="head">Description</th>
5606 <th class="head">Default</th>
5607 </tr>
5608 </thead>
5609 <tbody valign="top">
5610 <tr><td>GEANY_BUILD_ERR_HIGHLIGHT_MAX</td>
5611 <td>Amount of build error messages which should
5612 be highlighted in the Compiler message
5613 window. This affects the special coloring
5614 when Geany detects a compiler output line as
5615 an error message and then highlight the
5616 corresponding line in the source code.
5617 Usually only the first few messages are
5618 interesting because following errors are
5619 just aftereffects.</td>
5620 <td>100</td>
5621 </tr>
5622 </tbody>
5623 </table>
5624 </div>
5625 <div class="section">
5626 <h2><a class="toc-backref" href="#id224" id="build-c" name="build-c">build.c</a></h2>
5627 <table border="1" class="docutils">
5628 <colgroup>
5629 <col width="33%" />
5630 <col width="48%" />
5631 <col width="20%" />
5632 </colgroup>
5633 <thead valign="bottom">
5634 <tr><th class="head">Option</th>
5635 <th class="head">Description</th>
5636 <th class="head">Default</th>
5637 </tr>
5638 </thead>
5639 <tbody valign="top">
5640 <tr><td>PRINTBUILDCMDS</td>
5641 <td>Every time a build menu item priority
5642 calculation is run, print the state of the
5643 menu item table in the form of the table
5644 in <a class="reference" href="#build-menu-configuration">Build Menu Configuration</a>.  May be
5645 useful to debug configuration file
5646 overloading.  Warning produces a lot of
5647 output.  Can also be enabled/disabled by the
5648 debugger by setting printbuildcmds to 1/0
5649 overriding the compile setting.</td>
5650 <td>FALSE</td>
5651 </tr>
5652 </tbody>
5653 </table>
5654 </div>
5655 </div>
5656 <div class="section">
5657 <h1><a class="toc-backref" href="#id225" id="gnu-general-public-license" name="gnu-general-public-license">GNU General Public License</a></h1>
5658 <pre class="literal-block">
5659             GNU GENERAL PUBLIC LICENSE
5660                Version 2, June 1991
5661
5662  Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5663     51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
5664  Everyone is permitted to copy and distribute verbatim copies
5665  of this license document, but changing it is not allowed.
5666
5667                 Preamble
5668
5669   The licenses for most software are designed to take away your
5670 freedom to share and change it.  By contrast, the GNU General Public
5671 License is intended to guarantee your freedom to share and change free
5672 software--to make sure the software is free for all its users.  This
5673 General Public License applies to most of the Free Software
5674 Foundation's software and to any other program whose authors commit to
5675 using it.  (Some other Free Software Foundation software is covered by
5676 the GNU Library General Public License instead.)  You can apply it to
5677 your programs, too.
5678
5679   When we speak of free software, we are referring to freedom, not
5680 price.  Our General Public Licenses are designed to make sure that you
5681 have the freedom to distribute copies of free software (and charge for
5682 this service if you wish), that you receive source code or can get it
5683 if you want it, that you can change the software or use pieces of it
5684 in new free programs; and that you know you can do these things.
5685
5686   To protect your rights, we need to make restrictions that forbid
5687 anyone to deny you these rights or to ask you to surrender the rights.
5688 These restrictions translate to certain responsibilities for you if you
5689 distribute copies of the software, or if you modify it.
5690
5691   For example, if you distribute copies of such a program, whether
5692 gratis or for a fee, you must give the recipients all the rights that
5693 you have.  You must make sure that they, too, receive or can get the
5694 source code.  And you must show them these terms so they know their
5695 rights.
5696
5697   We protect your rights with two steps: (1) copyright the software, and
5698 (2) offer you this license which gives you legal permission to copy,
5699 distribute and/or modify the software.
5700
5701   Also, for each author's protection and ours, we want to make certain
5702 that everyone understands that there is no warranty for this free
5703 software.  If the software is modified by someone else and passed on, we
5704 want its recipients to know that what they have is not the original, so
5705 that any problems introduced by others will not reflect on the original
5706 authors' reputations.
5707
5708   Finally, any free program is threatened constantly by software
5709 patents.  We wish to avoid the danger that redistributors of a free
5710 program will individually obtain patent licenses, in effect making the
5711 program proprietary.  To prevent this, we have made it clear that any
5712 patent must be licensed for everyone's free use or not licensed at all.
5713
5714   The precise terms and conditions for copying, distribution and
5715 modification follow.
5716
5717             GNU GENERAL PUBLIC LICENSE
5718    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5719
5720   0. This License applies to any program or other work which contains
5721 a notice placed by the copyright holder saying it may be distributed
5722 under the terms of this General Public License.  The &quot;Program&quot;, below,
5723 refers to any such program or work, and a &quot;work based on the Program&quot;
5724 means either the Program or any derivative work under copyright law:
5725 that is to say, a work containing the Program or a portion of it,
5726 either verbatim or with modifications and/or translated into another
5727 language.  (Hereinafter, translation is included without limitation in
5728 the term &quot;modification&quot;.)  Each licensee is addressed as &quot;you&quot;.
5729
5730 Activities other than copying, distribution and modification are not
5731 covered by this License; they are outside its scope.  The act of
5732 running the Program is not restricted, and the output from the Program
5733 is covered only if its contents constitute a work based on the
5734 Program (independent of having been made by running the Program).
5735 Whether that is true depends on what the Program does.
5736
5737   1. You may copy and distribute verbatim copies of the Program's
5738 source code as you receive it, in any medium, provided that you
5739 conspicuously and appropriately publish on each copy an appropriate
5740 copyright notice and disclaimer of warranty; keep intact all the
5741 notices that refer to this License and to the absence of any warranty;
5742 and give any other recipients of the Program a copy of this License
5743 along with the Program.
5744
5745 You may charge a fee for the physical act of transferring a copy, and
5746 you may at your option offer warranty protection in exchange for a fee.
5747
5748   2. You may modify your copy or copies of the Program or any portion
5749 of it, thus forming a work based on the Program, and copy and
5750 distribute such modifications or work under the terms of Section 1
5751 above, provided that you also meet all of these conditions:
5752
5753     a) You must cause the modified files to carry prominent notices
5754     stating that you changed the files and the date of any change.
5755
5756     b) You must cause any work that you distribute or publish, that in
5757     whole or in part contains or is derived from the Program or any
5758     part thereof, to be licensed as a whole at no charge to all third
5759     parties under the terms of this License.
5760
5761     c) If the modified program normally reads commands interactively
5762     when run, you must cause it, when started running for such
5763     interactive use in the most ordinary way, to print or display an
5764     announcement including an appropriate copyright notice and a
5765     notice that there is no warranty (or else, saying that you provide
5766     a warranty) and that users may redistribute the program under
5767     these conditions, and telling the user how to view a copy of this
5768     License.  (Exception: if the Program itself is interactive but
5769     does not normally print such an announcement, your work based on
5770     the Program is not required to print an announcement.)
5771
5772 These requirements apply to the modified work as a whole.  If
5773 identifiable sections of that work are not derived from the Program,
5774 and can be reasonably considered independent and separate works in
5775 themselves, then this License, and its terms, do not apply to those
5776 sections when you distribute them as separate works.  But when you
5777 distribute the same sections as part of a whole which is a work based
5778 on the Program, the distribution of the whole must be on the terms of
5779 this License, whose permissions for other licensees extend to the
5780 entire whole, and thus to each and every part regardless of who wrote it.
5781
5782 Thus, it is not the intent of this section to claim rights or contest
5783 your rights to work written entirely by you; rather, the intent is to
5784 exercise the right to control the distribution of derivative or
5785 collective works based on the Program.
5786
5787 In addition, mere aggregation of another work not based on the Program
5788 with the Program (or with a work based on the Program) on a volume of
5789 a storage or distribution medium does not bring the other work under
5790 the scope of this License.
5791
5792   3. You may copy and distribute the Program (or a work based on it,
5793 under Section 2) in object code or executable form under the terms of
5794 Sections 1 and 2 above provided that you also do one of the following:
5795
5796     a) Accompany it with the complete corresponding machine-readable
5797     source code, which must be distributed under the terms of Sections
5798     1 and 2 above on a medium customarily used for software interchange; or,
5799
5800     b) Accompany it with a written offer, valid for at least three
5801     years, to give any third party, for a charge no more than your
5802     cost of physically performing source distribution, a complete
5803     machine-readable copy of the corresponding source code, to be
5804     distributed under the terms of Sections 1 and 2 above on a medium
5805     customarily used for software interchange; or,
5806
5807     c) Accompany it with the information you received as to the offer
5808     to distribute corresponding source code.  (This alternative is
5809     allowed only for noncommercial distribution and only if you
5810     received the program in object code or executable form with such
5811     an offer, in accord with Subsection b above.)
5812
5813 The source code for a work means the preferred form of the work for
5814 making modifications to it.  For an executable work, complete source
5815 code means all the source code for all modules it contains, plus any
5816 associated interface definition files, plus the scripts used to
5817 control compilation and installation of the executable.  However, as a
5818 special exception, the source code distributed need not include
5819 anything that is normally distributed (in either source or binary
5820 form) with the major components (compiler, kernel, and so on) of the
5821 operating system on which the executable runs, unless that component
5822 itself accompanies the executable.
5823
5824 If distribution of executable or object code is made by offering
5825 access to copy from a designated place, then offering equivalent
5826 access to copy the source code from the same place counts as
5827 distribution of the source code, even though third parties are not
5828 compelled to copy the source along with the object code.
5829
5830   4. You may not copy, modify, sublicense, or distribute the Program
5831 except as expressly provided under this License.  Any attempt
5832 otherwise to copy, modify, sublicense or distribute the Program is
5833 void, and will automatically terminate your rights under this License.
5834 However, parties who have received copies, or rights, from you under
5835 this License will not have their licenses terminated so long as such
5836 parties remain in full compliance.
5837
5838   5. You are not required to accept this License, since you have not
5839 signed it.  However, nothing else grants you permission to modify or
5840 distribute the Program or its derivative works.  These actions are
5841 prohibited by law if you do not accept this License.  Therefore, by
5842 modifying or distributing the Program (or any work based on the
5843 Program), you indicate your acceptance of this License to do so, and
5844 all its terms and conditions for copying, distributing or modifying
5845 the Program or works based on it.
5846
5847   6. Each time you redistribute the Program (or any work based on the
5848 Program), the recipient automatically receives a license from the
5849 original licensor to copy, distribute or modify the Program subject to
5850 these terms and conditions.  You may not impose any further
5851 restrictions on the recipients' exercise of the rights granted herein.
5852 You are not responsible for enforcing compliance by third parties to
5853 this License.
5854
5855   7. If, as a consequence of a court judgment or allegation of patent
5856 infringement or for any other reason (not limited to patent issues),
5857 conditions are imposed on you (whether by court order, agreement or
5858 otherwise) that contradict the conditions of this License, they do not
5859 excuse you from the conditions of this License.  If you cannot
5860 distribute so as to satisfy simultaneously your obligations under this
5861 License and any other pertinent obligations, then as a consequence you
5862 may not distribute the Program at all.  For example, if a patent
5863 license would not permit royalty-free redistribution of the Program by
5864 all those who receive copies directly or indirectly through you, then
5865 the only way you could satisfy both it and this License would be to
5866 refrain entirely from distribution of the Program.
5867
5868 If any portion of this section is held invalid or unenforceable under
5869 any particular circumstance, the balance of the section is intended to
5870 apply and the section as a whole is intended to apply in other
5871 circumstances.
5872
5873 It is not the purpose of this section to induce you to infringe any
5874 patents or other property right claims or to contest validity of any
5875 such claims; this section has the sole purpose of protecting the
5876 integrity of the free software distribution system, which is
5877 implemented by public license practices.  Many people have made
5878 generous contributions to the wide range of software distributed
5879 through that system in reliance on consistent application of that
5880 system; it is up to the author/donor to decide if he or she is willing
5881 to distribute software through any other system and a licensee cannot
5882 impose that choice.
5883
5884 This section is intended to make thoroughly clear what is believed to
5885 be a consequence of the rest of this License.
5886
5887   8. If the distribution and/or use of the Program is restricted in
5888 certain countries either by patents or by copyrighted interfaces, the
5889 original copyright holder who places the Program under this License
5890 may add an explicit geographical distribution limitation excluding
5891 those countries, so that distribution is permitted only in or among
5892 countries not thus excluded.  In such case, this License incorporates
5893 the limitation as if written in the body of this License.
5894
5895   9. The Free Software Foundation may publish revised and/or new versions
5896 of the General Public License from time to time.  Such new versions will
5897 be similar in spirit to the present version, but may differ in detail to
5898 address new problems or concerns.
5899
5900 Each version is given a distinguishing version number.  If the Program
5901 specifies a version number of this License which applies to it and &quot;any
5902 later version&quot;, you have the option of following the terms and conditions
5903 either of that version or of any later version published by the Free
5904 Software Foundation.  If the Program does not specify a version number of
5905 this License, you may choose any version ever published by the Free Software
5906 Foundation.
5907
5908   10. If you wish to incorporate parts of the Program into other free
5909 programs whose distribution conditions are different, write to the author
5910 to ask for permission.  For software which is copyrighted by the Free
5911 Software Foundation, write to the Free Software Foundation; we sometimes
5912 make exceptions for this.  Our decision will be guided by the two goals
5913 of preserving the free status of all derivatives of our free software and
5914 of promoting the sharing and reuse of software generally.
5915
5916                 NO WARRANTY
5917
5918   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5919 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
5920 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5921 PROVIDE THE PROGRAM &quot;AS IS&quot; WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5922 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5923 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
5924 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
5925 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5926 REPAIR OR CORRECTION.
5927
5928   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5929 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5930 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5931 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5932 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5933 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5934 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5935 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5936 POSSIBILITY OF SUCH DAMAGES.
5937
5938              END OF TERMS AND CONDITIONS
5939
5940         How to Apply These Terms to Your New Programs
5941
5942   If you develop a new program, and you want it to be of the greatest
5943 possible use to the public, the best way to achieve this is to make it
5944 free software which everyone can redistribute and change under these terms.
5945
5946   To do so, attach the following notices to the program.  It is safest
5947 to attach them to the start of each source file to most effectively
5948 convey the exclusion of warranty; and each file should have at least
5949 the &quot;copyright&quot; line and a pointer to where the full notice is found.
5950
5951     &lt;one line to give the program's name and a brief idea of what it does.&gt;
5952     Copyright (C) &lt;year&gt;  &lt;name of author&gt;
5953
5954     This program is free software; you can redistribute it and/or modify
5955     it under the terms of the GNU General Public License as published by
5956     the Free Software Foundation; either version 2 of the License, or
5957     (at your option) any later version.
5958
5959     This program is distributed in the hope that it will be useful,
5960     but WITHOUT ANY WARRANTY; without even the implied warranty of
5961     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
5962     GNU General Public License for more details.
5963
5964     You should have received a copy of the GNU General Public License
5965     along with this program; if not, write to the Free Software
5966     Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
5967
5968
5969 Also add information on how to contact you by electronic and paper mail.
5970
5971 If the program is interactive, make it output a short notice like this
5972 when it starts in an interactive mode:
5973
5974     Gnomovision version 69, Copyright (C) year  name of author
5975     Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5976     This is free software, and you are welcome to redistribute it
5977     under certain conditions; type `show c' for details.
5978
5979 The hypothetical commands `show w' and `show c' should show the appropriate
5980 parts of the General Public License.  Of course, the commands you use may
5981 be called something other than `show w' and `show c'; they could even be
5982 mouse-clicks or menu items--whatever suits your program.
5983
5984 You should also get your employer (if you work as a programmer) or your
5985 school, if any, to sign a &quot;copyright disclaimer&quot; for the program, if
5986 necessary.  Here is a sample; alter the names:
5987
5988   Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5989   `Gnomovision' (which makes passes at compilers) written by James Hacker.
5990
5991   &lt;signature of Ty Coon&gt;, 1 April 1989
5992   Ty Coon, President of Vice
5993
5994 This General Public License does not permit incorporating your program into
5995 proprietary programs.  If your program is a subroutine library, you may
5996 consider it more useful to permit linking proprietary applications with the
5997 library.  If this is what you want to do, use the GNU Library General
5998 Public License instead of this License.
5999 </pre>
6000 </div>
6001 <div class="section">
6002 <h1><a class="toc-backref" href="#id226" id="license-for-scintilla-and-scite" name="license-for-scintilla-and-scite">License for Scintilla and SciTE</a></h1>
6003 <p>Copyright 1998-2003 by Neil Hodgson &lt;neilh(at)scintilla(dot)org&gt;</p>
6004 <p>All Rights Reserved</p>
6005 <p>Permission to use, copy, modify, and distribute this software and
6006 its documentation for any purpose and without fee is hereby granted,
6007 provided that the above copyright notice appear in all copies and
6008 that both that copyright notice and this permission notice appear in
6009 supporting documentation.</p>
6010 <p>NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
6011 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
6012 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
6013 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
6014 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6015 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
6016 USE OR PERFORMANCE OF THIS SOFTWARE.</p>
6017 </div>
6018 </div>
6019 <div class="footer">
6020 <hr class="footer" />
6021 <a class="reference" href="geany.txt">View document source</a>.
6022 Generated on: 2010-05-05 13:02 UTC.
6023 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.
6024
6025 </div>
6026 </body>
6027 </html>