| blob | 8136bf9f86611a2023d6b3cff487817e8a2ecb75 |
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <head>
14 /*
15 :Author: Enrico Troeger
16 :Contact: enrico(dot)troeger(at)uvena(dot)de
17 :Copyright: This stylesheet has been placed in the public domain.
19 Stylesheet for Geany's documentation based on a version of John Gabriele.
20 */
22 @media screen {
24 body {
25 background-color: #f2f2f2;
26 color: #404040;
27 margin-left: 0.4em;
28 max-width: 60em;
29 font-size: 90%;
30 }
32 a {
33 color: #990000;
34 }
36 a:visited {
37 color: #7E558E;
38 }
40 a:hover {
41 text-decoration: none;
42 }
44 h1 {
45 border-top: 1px dotted;
46 margin-top: 2em;
47 }
49 h1, h2, h3 {
50 font-family: sans-serif;
51 color: #5D0606;
52 }
54 h1.title {
55 text-align: left }
57 h2 {
58 margin-top: 30px;
59 }
61 h2.subtitle {
62 text-align: left }
64 h3 {
65 padding-left: 3px;
66 }
68 blockquote, pre {
69 border: 1px solid;
70 padding: 0.4em;
71 }
73 blockquote {
74 font-family: sans-serif;
75 background-color: #DBEDD5;
76 border: 1px dotted;
77 border-left: 4px solid;
78 border-color: #9FD98C;
79 }
81 pre {
82 background-color: #ECDFCE;
83 border: 1px dotted;
84 border-left: 4px solid;
85 border-color: #D9BE9A;
86 }
88 tt, pre, code {
89 color: #6D4212;
90 }
92 table {
93 border: 1px solid #D9BE9A;
94 }
96 th {
97 background-color: #ECDFCE;
98 border: 1px dotted #D9BE9A;
99 }
101 td {
102 border: 1px dotted #D9BE9A;
103 }
105 .docinfo-name {
106 color: #5D0606;
107 }
109 p.admonition-title {
110 color: #990000;
111 font-weight: bold;
112 }
114 div.note {
116 padding: 0em;
117 }
119 dt {
120 font-style: italic;
121 }
123 }
125 @media print {
127 }
129 </style>
131 </head>
132 <body>
143 <td>Enrico Tröger
144 <br />Nick Treleaven
145 <br />Frank Lanitz
151 </tbody>
152 </table>
155 <p>This document is distributed under the terms of the GNU General Public
156 License as published by the Free Software Foundation; either version 2
157 of the License, or (at your option) any later version. A copy of this
158 license can be found in the file COPYING included with the source code
159 of this program, and also in the chapter <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
167 <li><a class="reference internal" href="#about-this-document" id="id11">About this document</a></li>
168 </ul>
169 </li>
173 <li><a class="reference internal" href="#source-compilation" id="id15">Source compilation</a><ul>
174 <li><a class="reference internal" href="#autotools-based-build-system" id="id16">Autotools based build system</a></li>
175 <li><a class="reference internal" href="#waf-based-build-system" id="id17">Waf based build system</a><ul>
177 <li><a class="reference internal" href="#cleaning-the-cache" id="id19">Cleaning the cache</a></li>
178 </ul>
179 </li>
180 </ul>
181 </li>
182 <li><a class="reference internal" href="#custom-installation" id="id20">Custom installation</a></li>
183 <li><a class="reference internal" href="#dynamic-linking-loader-support-and-vte" id="id21">Dynamic linking loader support and VTE</a></li>
185 </ul>
186 </li>
187 <li><a class="reference internal" href="#installation-prefix" id="id23">Installation prefix</a></li>
188 </ul>
189 </li>
192 <li><a class="reference internal" href="#the-geany-workspace" id="id26">The Geany workspace</a></li>
193 <li><a class="reference internal" href="#command-line-options" id="id27">Command line options</a></li>
196 <li><a class="reference internal" href="#opening-files-from-the-command-line-in-a-running-instance" id="id30">Opening files from the command-line in a running instance</a></li>
197 <li><a class="reference internal" href="#virtual-terminal-emulator-widget-vte" id="id31">Virtual terminal emulator widget (VTE)</a></li>
198 <li><a class="reference internal" href="#defining-own-widget-styles-using-gtkrc-2-0" id="id32">Defining own widget styles using .gtkrc-2.0</a></li>
199 </ul>
200 </li>
202 <li><a class="reference internal" href="#switching-between-documents" id="id34">Switching between documents</a></li>
203 </ul>
204 </li>
205 <li><a class="reference internal" href="#character-sets-and-unicode-byte-order-mark-bom" id="id35">Character sets and Unicode Byte-Order-Mark (BOM)</a><ul>
206 <li><a class="reference internal" href="#using-character-sets" id="id36">Using character sets</a></li>
207 <li><a class="reference internal" href="#in-file-encoding-specification" id="id37">In-file encoding specification</a></li>
208 <li><a class="reference internal" href="#special-encoding-none" id="id38">Special encoding "None"</a></li>
209 <li><a class="reference internal" href="#unicode-byte-order-mark-bom" id="id39">Unicode Byte-Order-Mark (BOM)</a></li>
210 </ul>
211 </li>
214 <li><a class="reference internal" href="#column-mode-editing-rectangular-selections" id="id42">Column mode editing (rectangular selections)</a></li>
215 <li><a class="reference internal" href="#drag-and-drop-of-text" id="id43">Drag and drop of text</a></li>
217 <li><a class="reference internal" href="#applying-new-indentation-settings" id="id45">Applying new indentation settings</a></li>
218 <li><a class="reference internal" href="#detecting-indent-type" id="id46">Detecting indent type</a></li>
219 </ul>
220 </li>
223 <li><a class="reference internal" href="#code-navigation-history" id="id49">Code navigation history</a></li>
224 <li><a class="reference internal" href="#sending-text-through-custom-commands" id="id50">Sending text through custom commands</a></li>
227 <li><a class="reference internal" href="#word-part-completion" id="id53">Word part completion</a></li>
228 <li><a class="reference internal" href="#scope-autocompletion" id="id54">Scope autocompletion</a></li>
229 </ul>
230 </li>
231 <li><a class="reference internal" href="#user-definable-snippets" id="id55">User-definable snippets</a><ul>
232 <li><a class="reference internal" href="#snippet-keybindings" id="id56">Snippet keybindings</a></li>
233 </ul>
234 </li>
235 <li><a class="reference internal" href="#inserting-unicode-characters" id="id57">Inserting Unicode characters</a></li>
236 </ul>
237 </li>
238 <li><a class="reference internal" href="#search-replace-and-go-to" id="id58">Search, replace and go to</a><ul>
241 </ul>
242 </li>
246 <li><a class="reference internal" href="#change-font-in-search-dialog-text-fields" id="id64">Change font in search dialog text fields</a></li>
247 </ul>
248 </li>
252 <li><a class="reference internal" href="#filtering-out-version-control-files" id="id68">Filtering out version control files</a></li>
253 </ul>
254 </li>
257 </ul>
258 </li>
259 <li><a class="reference internal" href="#go-to-tag-definition" id="id71">Go to tag definition</a></li>
260 <li><a class="reference internal" href="#go-to-tag-declaration" id="id72">Go to tag declaration</a></li>
262 <li><a class="reference internal" href="#regular-expressions" id="id74">Regular expressions</a></li>
263 </ul>
264 </li>
266 <li><a class="reference internal" href="#color-schemes-menu" id="id76">Color schemes menu</a></li>
267 </ul>
268 </li>
272 <li><a class="reference internal" href="#default-global-tags-files" id="id80">Default global tags files</a></li>
273 <li><a class="reference internal" href="#global-tags-file-format" id="id81">Global tags file format</a></li>
274 <li><a class="reference internal" href="#generating-a-global-tags-file" id="id82">Generating a global tags file</a></li>
275 </ul>
276 </li>
278 </ul>
279 </li>
281 <li><a class="reference internal" href="#general-startup-preferences" id="id85">General Startup preferences</a><ul>
285 </ul>
286 </li>
287 <li><a class="reference internal" href="#general-miscellaneous-preferences" id="id89">General Miscellaneous preferences</a><ul>
291 </ul>
292 </li>
293 <li><a class="reference internal" href="#interface-preferences" id="id93">Interface preferences</a><ul>
297 </ul>
298 </li>
299 <li><a class="reference internal" href="#interface-notebook-tab-preferences" id="id97">Interface Notebook tab preferences</a><ul>
302 </ul>
303 </li>
304 <li><a class="reference internal" href="#interface-toolbar-preferences" id="id100">Interface Toolbar preferences</a><ul>
307 </ul>
308 </li>
309 <li><a class="reference internal" href="#editor-features-preferences" id="id103">Editor Features preferences</a><ul>
311 </ul>
312 </li>
313 <li><a class="reference internal" href="#editor-indentation-preferences" id="id105">Editor Indentation preferences</a><ul>
314 <li><a class="reference internal" href="#indentation-group" id="id106">Indentation group</a></li>
315 </ul>
316 </li>
317 <li><a class="reference internal" href="#editor-completions-preferences" id="id107">Editor Completions preferences</a><ul>
319 <li><a class="reference internal" href="#auto-close-quotes-and-brackets" id="id109">Auto-close quotes and brackets</a></li>
320 </ul>
321 </li>
322 <li><a class="reference internal" href="#editor-display-preferences" id="id110">Editor Display preferences</a><ul>
326 </ul>
327 </li>
328 <li><a class="reference internal" href="#files-preferences" id="id114">Files preferences</a><ul>
332 </ul>
333 </li>
334 <li><a class="reference internal" href="#tools-preferences" id="id118">Tools preferences</a><ul>
337 </ul>
338 </li>
339 <li><a class="reference internal" href="#template-preferences" id="id121">Template preferences</a><ul>
341 </ul>
342 </li>
343 <li><a class="reference internal" href="#keybinding-preferences" id="id123">Keybinding preferences</a></li>
344 <li><a class="reference internal" href="#printing-preferences" id="id124">Printing preferences</a></li>
345 <li><a class="reference internal" href="#various-preferences" id="id125">Various preferences</a></li>
346 <li><a class="reference internal" href="#terminal-vte-preferences" id="id126">Terminal (VTE) preferences</a><ul>
348 </ul>
349 </li>
350 </ul>
351 </li>
352 <li><a class="reference internal" href="#project-management" id="id128">Project management</a><ul>
354 <li><a class="reference internal" href="#project-properties" id="id130">Project properties</a></li>
357 </ul>
358 </li>
361 <li><a class="reference internal" href="#default-build-menu-items" id="id135">Default build menu items</a><ul>
365 <li><a class="reference internal" href="#make-custom-target" id="id139">Make custom target</a></li>
370 <li><a class="reference internal" href="#stopping-running-processes" id="id144">Stopping running processes</a><ul>
371 <li><a class="reference internal" href="#terminal-emulators" id="id145">Terminal emulators</a></li>
372 </ul>
373 </li>
374 <li><a class="reference internal" href="#set-build-commands" id="id146">Set build commands</a></li>
375 </ul>
376 </li>
377 <li><a class="reference internal" href="#build-menu-configuration" id="id147">Build menu configuration</a></li>
378 <li><a class="reference internal" href="#build-menu-commands-dialog" id="id148">Build menu commands dialog</a><ul>
379 <li><a class="reference internal" href="#substitutions-in-commands-and-working-directories" id="id149">Substitutions in commands and working directories</a></li>
380 <li><a class="reference internal" href="#build-menu-keyboard-shortcuts" id="id150">Build menu keyboard shortcuts</a></li>
382 </ul>
383 </li>
384 </ul>
385 </li>
389 </ul>
390 </li>
392 <li><a class="reference internal" href="#switching-documents" id="id156">Switching documents</a></li>
393 <li><a class="reference internal" href="#configurable-keybindings" id="id157">Configurable keybindings</a><ul>
395 <li><a class="reference internal" href="#editor-keybindings" id="id159">Editor keybindings</a></li>
396 <li><a class="reference internal" href="#clipboard-keybindings" id="id160">Clipboard keybindings</a></li>
397 <li><a class="reference internal" href="#select-keybindings" id="id161">Select keybindings</a></li>
398 <li><a class="reference internal" href="#insert-keybindings" id="id162">Insert keybindings</a></li>
399 <li><a class="reference internal" href="#format-keybindings" id="id163">Format keybindings</a></li>
400 <li><a class="reference internal" href="#settings-keybindings" id="id164">Settings keybindings</a></li>
401 <li><a class="reference internal" href="#search-keybindings" id="id165">Search keybindings</a></li>
402 <li><a class="reference internal" href="#go-to-keybindings" id="id166">Go to keybindings</a></li>
404 <li><a class="reference internal" href="#focus-keybindings" id="id168">Focus keybindings</a></li>
405 <li><a class="reference internal" href="#notebook-tab-keybindings" id="id169">Notebook tab keybindings</a></li>
406 <li><a class="reference internal" href="#document-keybindings" id="id170">Document keybindings</a></li>
407 <li><a class="reference internal" href="#build-keybindings" id="id171">Build keybindings</a></li>
408 <li><a class="reference internal" href="#tools-keybindings" id="id172">Tools keybindings</a></li>
410 </ul>
411 </li>
412 </ul>
413 </li>
414 </ul>
415 </li>
416 <li><a class="reference internal" href="#configuration-files" id="id174">Configuration files</a><ul>
417 <li><a class="reference internal" href="#configuration-file-paths" id="id175">Configuration file paths</a><ul>
418 <li><a class="reference internal" href="#paths-on-unix-like-systems" id="id176">Paths on Unix-like systems</a></li>
419 </ul>
420 </li>
422 <li><a class="reference internal" href="#global-configuration-file" id="id178">Global configuration file</a></li>
423 <li><a class="reference internal" href="#filetype-definition-files" id="id179">Filetype definition files</a><ul>
428 <li><a class="reference internal" href="#creating-a-custom-filetype-from-an-existing-filetype" id="id184">Creating a custom filetype from an existing filetype</a></li>
429 </ul>
430 </li>
431 <li><a class="reference internal" href="#filetype-configuration" id="id185">Filetype configuration</a><ul>
433 <li><a class="reference internal" href="#using-a-named-style" id="id187">Using a named style</a></li>
434 <li><a class="reference internal" href="#reading-styles-from-another-filetype" id="id188">Reading styles from another filetype</a></li>
435 </ul>
436 </li>
437 <li><a class="reference internal" href="#keywords-section" id="id189">[keywords] section</a></li>
438 <li><a class="reference internal" href="#lexer-properties-section" id="id190">[lexer_properties] section</a></li>
439 <li><a class="reference internal" href="#settings-section" id="id191">[settings] section</a></li>
440 <li><a class="reference internal" href="#indentation-section" id="id192">[indentation] section</a></li>
441 <li><a class="reference internal" href="#build-settings-section" id="id193">[build_settings] section</a></li>
442 </ul>
443 </li>
444 <li><a class="reference internal" href="#special-file-filetypes-common" id="id194">Special file filetypes.common</a><ul>
445 <li><a class="reference internal" href="#named-styles-section" id="id195">[named_styles] section</a></li>
448 </ul>
449 </li>
450 </ul>
451 </li>
452 <li><a class="reference internal" href="#filetype-extensions" id="id198">Filetype extensions</a></li>
453 <li><a class="reference internal" href="#filetype-group-membership" id="id199">Filetype group membership</a></li>
454 <li><a class="reference internal" href="#preferences-file-format" id="id200">Preferences file format</a><ul>
455 <li><a class="reference internal" href="#build-menu-section" id="id201">[build-menu] section</a></li>
456 </ul>
457 </li>
458 <li><a class="reference internal" href="#project-file-format" id="id202">Project file format</a><ul>
459 <li><a class="reference internal" href="#build-menu-additions" id="id203">[build-menu] additions</a></li>
460 </ul>
461 </li>
463 <li><a class="reference internal" href="#template-meta-data" id="id205">Template meta data</a></li>
465 <li><a class="reference internal" href="#adding-file-templates" id="id207">Adding file templates</a></li>
466 </ul>
467 </li>
468 <li><a class="reference internal" href="#customizing-templates" id="id208">Customizing templates</a><ul>
469 <li><a class="reference internal" href="#template-wildcards" id="id209">Template wildcards</a><ul>
470 <li><a class="reference internal" href="#special-command-wildcard" id="id210">Special {command:} wildcard</a></li>
471 </ul>
472 </li>
473 </ul>
474 </li>
475 </ul>
476 </li>
477 <li><a class="reference internal" href="#customizing-the-toolbar" id="id211">Customizing the toolbar</a><ul>
478 <li><a class="reference internal" href="#manually-editing-the-toolbar-layout" id="id212">Manually editing the toolbar layout</a></li>
479 <li><a class="reference internal" href="#available-toolbar-elements" id="id213">Available toolbar elements</a></li>
480 </ul>
481 </li>
482 </ul>
483 </li>
484 <li><a class="reference internal" href="#plugin-documentation" id="id214">Plugin documentation</a><ul>
486 <li><a class="reference internal" href="#insert-entity-dialog" id="id216">Insert entity dialog</a></li>
487 <li><a class="reference internal" href="#replace-special-chars-by-its-entity" id="id217">Replace special chars by its entity</a><ul>
490 </ul>
491 </li>
492 </ul>
493 </li>
497 </ul>
498 </li>
499 </ul>
500 </li>
501 <li><a class="reference internal" href="#contributing-to-this-document" id="id223">Contributing to this document</a></li>
502 <li><a class="reference internal" href="#scintilla-keyboard-commands" id="id224">Scintilla keyboard commands</a><ul>
503 <li><a class="reference internal" href="#keyboard-commands" id="id225">Keyboard commands</a></li>
504 </ul>
505 </li>
507 <li><a class="reference internal" href="#document-notebook" id="id227">Document notebook</a></li>
511 </ul>
512 </li>
513 <li><a class="reference internal" href="#compile-time-options" id="id231">Compile-time options</a><ul>
520 </ul>
521 </li>
522 <li><a class="reference internal" href="#gnu-general-public-license" id="id238">GNU General Public License</a></li>
523 <li><a class="reference internal" href="#license-for-scintilla-and-scite" id="id239">License for Scintilla and SciTE</a></li>
524 </ul>
525 </div>
530 <p>Geany is a small and lightweight Integrated Development Environment. It
531 was developed to provide a small and fast IDE, which has only a few
532 dependencies on other packages. Another goal was to be as independent
533 as possible from a particular Desktop Environment like KDE or GNOME -
534 Geany only requires the GTK2 runtime libraries.</p>
543 <li>Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
544 Pascal, and others</li>
550 </ul>
551 </div>
554 <p>You can obtain Geany from <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a> or perhaps also from
555 your distribution. For a list of available packages, please see
556 <a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
557 </div>
560 <p>Geany is distributed under the terms of the GNU General Public License
561 as published by the Free Software Foundation; either version 2 of
562 the License, or (at your option) any later version. A copy of this
563 license can be found in the file COPYING included with the source
564 code of this program and in the chapter, <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
565 <p>The included Scintilla library (found in the subdirectory
566 <tt class="docutils literal">scintilla/</tt>) has its own license, which can be found in the chapter,
567 <a class="reference internal" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
568 </div>
571 <p>This documentation is available in HTML and text formats.
572 The latest version can always be found at <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a>.</p>
573 <p>If you want to contribute to it, see <a class="reference internal" href="#contributing-to-this-document">Contributing to this document</a>.</p>
574 </div>
575 </div>
581 (Pango, GLib and ATK). Your distro should provide packages for these,
582 usually installed by default. For Windows, you can download an installer
583 from the website which bundles these libraries.</p>
584 </div>
587 <p>There are many binary packages available. For an up-to-date but maybe
588 incomplete list see <a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
589 </div>
592 <p>Compiling Geany is quite easy.
594 You also need the Pango, GLib and ATK libraries and header files.
595 All these files are available at <a class="reference external" href="http://www.gtk.org">http://www.gtk.org</a>, but very often
596 your distro will provide development packages to save the trouble of
597 building these yourself.</p>
598 <p>Furthermore you need, of course, a C and C++ compiler. The GNU versions
599 of these tools are recommended.</p>
602 <p>The Autotools based build system is very mature and has been well tested.
603 To use it, you just need the Make tool, preferably GNU Make.</p>
606 $ ./configure
607 $ make
608 </pre>
611 % make install
612 </pre>
613 </div>
616 <p>The Waf build system is still quite young and under heavy development but already in a
617 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
618 to install Python on your system.
619 The advantage of the Waf build system over the Autotools based build system is that the whole
620 build process might be a bit faster. Especially when you use the Waf
621 cache feature for repetitive builds (e.g. when changing only a few source files
622 to test something) will become much faster since Waf will cache and re-use the
623 unchanged built files and only compile the changed code again. See <a class="reference internal" href="#waf-cache">Waf Cache</a> for details.
624 To build Geany with Waf as run:</p>
626 $ ./waf configure
627 $ ./waf build
628 </pre>
631 % ./waf install
632 </pre>
635 <p>The Waf build system has a nice and interesting feature which can help to avoid
636 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
637 or trying to debug something in Geany.
638 Waf is able to store and retrieve the object files from a cache. This cache is declared
640 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
641 this, you first need to create this directory:</p>
643 $ mkdir -p ~/.cache/waf
644 </pre>
645 <p>then add the environment variable to your shell configuration (the following example is for
646 Bash and should be adjusted to your used shell):</p>
648 export WAFCACHE=/home/username/.cache/waf
649 </pre>
650 <p>Remember to replace <tt class="docutils literal">username</tt> with your actual username.</p>
651 <p>More information about the Waf cache feature are available at
652 <a class="reference external" href="http://code.google.com/p/waf/wiki/CacheObjectFiles">http://code.google.com/p/waf/wiki/CacheObjectFiles</a>.</p>
655 <p>You should be careful about the size of the cache directory as it may
656 grow rapidly over time.
657 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
658 clean by yourself.
659 An easy way to keep it clean is to run the following command regularly to remove old
660 cached files:</p>
662 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
663 </pre>
665 <p>For details about the <tt class="docutils literal">find</tt> command and its options, check its manual page.</p>
666 </div>
667 </div>
668 </div>
671 <p>The configure script supports several common options, for a detailed
672 list, type:</p>
674 $ ./configure --help
675 </pre>
679 </dl>
681 <p>You may also want to read the INSTALL file for advanced installation
682 options.</p>
684 <li>See also <a class="reference internal" href="#compile-time-options">Compile-time options</a>.</li>
685 </ul>
686 </div>
689 <p>In the case that your system lacks dynamic linking loader support, you
690 probably want to pass the option <tt class="docutils literal"><span class="pre">--disable-vte</span></tt> to the <tt class="docutils literal">configure</tt>
691 script. This prevents compiling Geany with dynamic linking loader
692 support for automatically loading <tt class="docutils literal">libvte.so.4</tt> if available.</p>
693 </div>
696 <p>If there are any errors during compilation, check your build
697 environment and try to find the error, otherwise contact the mailing
698 list or one the authors. Sometimes you might need to ask for specific
699 help from your distribution.</p>
700 </div>
701 </div>
704 <p>If you want to find Geany's system files after installation you may
705 want to know the installation prefix.</p>
706 <p>Pass the <tt class="docutils literal"><span class="pre">--print-prefix</span></tt> option to Geany to check this - see
707 <a class="reference internal" href="#command-line-options">Command line options</a>. The first path is the prefix.</p>
708 <p>On Unix-like systems this is commonly <tt class="docutils literal">/usr</tt> if you installed from
713 per-user configuration files instead, which don't need root
714 permissions. See <a class="reference internal" href="#configuration-files">Configuration files</a>.</p>
715 </div>
716 </div>
717 </div>
723 <ul>
725 <p>Choose in your application menu of your used Desktop Environment:
727 </li>
729 <p>To start Geany from a command line, type the following and press
730 Return:</p>
732 % geany
733 </pre>
734 </li>
735 </ul>
736 </div>
748 </ul>
749 </li>
757 </ul>
758 </li>
760 </ul>
761 <p>Most of these can be configured in the <a class="reference internal" href="#interface-preferences">Interface preferences</a>, the
762 <a class="reference internal" href="#view-menu">View menu</a>, or the popup menu for the relevant area.</p>
765 <p>The sizes of the sidebar and message window can be adjusted by
766 dragging the dividers.</p>
767 </div>
771 <colgroup>
775 </colgroup>
780 </tr>
781 </thead>
785 <td>Set initial line number for the first opened file
786 (same as --line, do not put a space between the + sign
789 </tr>
793 </tr>
796 <td>Use an alternate configuration directory. The default
797 configuration directory is <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt> and that
799 reside.</td>
800 </tr>
803 <td>Print a list of Geany's internal filetype names (useful
804 for snippets configuration).</td>
805 </tr>
808 <td>Generate a global tags file (see
809 <a class="reference internal" href="#generating-a-global-tags-file">Generating a global tags file</a>).</td>
810 </tr>
814 </tr>
817 <td>Do not open files in a running instance, force opening
818 a new instance. Only available if Geany was compiled
819 with support for Sockets.</td>
820 </tr>
824 </tr>
827 <td>Return a list of open documents in a running Geany
828 instance.
829 This can be used to read the currently opened documents in
830 Geany from an external script or tool. The returned list
831 is separated by newlines (LF) and consists of the full,
832 UTF-8 encoded filenames of the documents.
833 Only available if Geany was compiled with support for
834 Sockets.</td>
835 </tr>
838 <td>Do not show the message window. Use this option if you
839 do not need compiler messages or VTE support.</td>
840 </tr>
843 <td>Do not load symbol completion and call tip data. Use this
844 option if you do not want to use them.</td>
845 </tr>
849 </tr>
852 <td>Print installation prefix, the data directory, the lib
853 directory and the locale directory (in that order) to
854 stdout, one line each. This is mainly intended for plugin
855 authors to detect installation paths.</td>
856 </tr>
860 </tr>
863 <td>Do not load terminal support. Use this option if you do
864 not want to load the virtual terminal emulator widget
866 then terminal-support is automatically disabled. Only
867 available if Geany was compiled with support for VTE.</td>
868 </tr>
872 running Geany instance. This can be used with the following
873 command to execute Geany on the current workspace:</p>
875 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
876 </pre>
877 </td>
878 </tr>
881 <td>Specify explicitly the path including filename or only
882 the filename to the VTE library, e.g.
883 <tt class="docutils literal">/usr/lib/libvte.so</tt> or <tt class="docutils literal">libvte.so</tt>. This option is
884 only needed when the auto-detection does not work. Only
885 available if Geany was compiled with support for VTE.</td>
886 </tr>
890 </tr>
894 </tr>
898 </tr>
902 Geany to ignore loading stored files from the last
903 session (if enabled).
904 Geany also recognizes line and column information when
905 appended to the filename with colons, e.g.
909 must be the first non-option argument. All additionally
910 given files are ignored.</p>
911 </td>
912 </tr>
913 </tbody>
914 </table>
918 </pre>
919 <p>Geany supports all generic GTK options, a list is available on the
920 help screen.</p>
921 </div>
926 <p>At startup, Geany loads all files from the last time Geany was
927 launched. You can disable this feature in the preferences dialog
928 (see <a class="reference internal" href="#general-startup-preferences">General Startup preferences</a>). If you specify some
929 files on the command line, only these files will be opened, but you
930 can find the files from the last session in the file menu under the
932 opened files. You can change the number of recently opened files in
933 the preferences dialog.</p>
934 <p>You can start several instances of Geany, but only the first will
935 load files from the last session. To run a second instance of Geany,
936 do not specify any filenames on the command-line, or disable opening
937 files in a running instance using the appropriate command line option.</p>
938 </div>
940 <h3><a class="toc-backref" href="#id30">Opening files from the command-line in a running instance</a></h3>
941 <p>Geany detects if there is an an instance of itself already running and opens files
942 from the command-line in that instance. So, Geany can
943 be used to view and edit files by opening them from other programs
944 such as a file manager.</p>
948 </pre>
949 <p>This would open the file <tt class="docutils literal">some_file.foo</tt> with the cursor on line 55,
951 <p>If you do not like this for some reason, you can disable using the first
952 instance by using the appropriate command line option -- see the section
954 </div>
957 <p>If you have installed <tt class="docutils literal">libvte.so</tt> on your system, it is loaded
958 automatically by Geany, and you will have a terminal widget in the
959 notebook at the bottom.</p>
960 <p>If Geany cannot find any <tt class="docutils literal">libvte.so</tt> at startup, the terminal widget
961 will not be loaded. So there is no need to install the package containing
962 this file in order to run Geany. Additionally, you can disable the use
963 of the terminal widget by command line option, for more information
964 see the section called <a class="reference internal" href="#command-line-options">Command line options</a>.</p>
965 <p>You can use this terminal (from now on called VTE) much as you would
966 a terminal program like xterm. There is basic clipboard support. You
967 can paste the contents of the clipboard by pressing the right mouse
968 button to open the popup menu, and choosing Paste. To copy text from
969 the VTE, just select the desired text and then press the right mouse
970 button and choose Copy from the popup menu. On systems running the
971 X Window System you can paste the last selected text by pressing the
972 middle mouse button in the VTE (on 2-button mice, the middle button
973 can often be simulated by pressing both mouse buttons together).</p>
974 <p>In the preferences dialog you can specify a shell which should be
975 started in the VTE. To make the specified shell a login shell just
976 use the appropriate command line options for the shell. These options
977 should be found in the manual page of the shell. For zsh and bash
978 you can use the argument <tt class="docutils literal"><span class="pre">--login</span></tt>.</p>
981 <p class="last">Geany tries to load <tt class="docutils literal">libvte.so</tt>. If this fails, it tries to load
982 some other filenames. If this fails too, you should check whether you
983 installed libvte correctly. Again note, Geany will run without this
984 library.</p>
985 </div>
986 <p>It could be, that the library is called something else than
987 <tt class="docutils literal">libvte.so</tt> (e.g. on FreeBSD 6.0 it is called <tt class="docutils literal">libvte.so.8</tt>). If so
988 please set a link to the correct file (as root):</p>
990 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
991 </pre>
992 <p>Obviously, you have to adjust the paths and set X to the number of your
994 <p>You can also specify the filename of the VTE library to use on the command
995 line (see the section called <a class="reference internal" href="#command-line-options">Command line options</a>) or at compile time
996 by specifying the command line option <tt class="docutils literal"><span class="pre">--with-vte-module-path</span></tt> to
997 ./configure.</p>
998 </div>
1001 <p>You can define your widget style for many of Geany's GUI parts. To
1002 do this, just edit your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home
1003 directory on UNIX-like systems and in the etc subdirectory of your
1004 Geany installation on Windows).</p>
1005 <p>To have a defined style used by Geany you must assign it to
1006 at least one of Geany's widgets. For example use the following line:</p>
1009 </pre>
1011 widgets. You can also assign styles only to specific widgets. At the
1012 moment you can use the following widgets:</p>
1023 </ul>
1024 <p>An example of a simple <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>:</p>
1027 {
1029 }
1033 {
1035 }
1037 </pre>
1038 </div>
1039 </div>
1044 <p>The documents list and the editor tabs are two different ways
1045 to switch between documents using the mouse. When you hit the key
1046 combination to move between tabs, the order is determined by the tab
1047 order. It is not alphabetical as shown in the documents list
1048 (regardless of whether or not editor tabs are visible).</p>
1049 <p>See the <a class="reference internal" href="#notebook-tab-keybindings">Notebook tab keybindings</a> section for useful
1050 shortcuts including for Most-Recently-Used document switching.</p>
1051 </div>
1052 </div>
1054 <h2><a class="toc-backref" href="#id35">Character sets and Unicode Byte-Order-Mark (BOM)</a></h2>
1057 <p>Geany provides support for detecting and converting character sets. So
1058 you can open and save files in different character sets, and even
1059 convert a file from one character set to another. To do this,
1060 Geany uses the character conversion capabilities of the GLib library.</p>
1061 <p>Only text files are supported, i.e. opening files which contain
1062 NULL-bytes may fail. Geany will try to open the file anyway but it is
1063 likely that the file will be truncated because it can only be read up
1064 to the first occurrence of a NULL-byte. All characters after this
1065 position are lost and are not written when you save the file.</p>
1066 <p>Geany tries to detect the encoding of a file while opening it, but
1067 auto-detecting the encoding of a file is not easy and sometimes an
1068 encoding might not be detected correctly. In this case you have to
1069 set the encoding of the file manually in order to display it
1070 correctly. You can this in the file open dialog by selecting an
1071 encoding in the drop down box or by reloading the file with the
1073 encodings but there are also some encodings where it is known that
1074 auto-detection has problems.</p>
1076 <ul>
1078 <p>This opens the file with the encoding specified in the encoding drop
1081 file will be opened without any character conversion and Geany will
1082 not try to auto-detect the encoding (see below for more information).</p>
1083 </li>
1085 <p>This item reloads the current file with the specified encoding. It can
1086 help if you opened a file and found out that the wrong encoding was used.</p>
1087 </li>
1089 <p>Contrary to the above two options, this will not change or reload
1090 the current file unless you save it. It is useful when you want to
1091 change the encoding of the file.</p>
1092 </li>
1094 <p>As mentioned above, auto-detecting the encoding of a file may fail on
1095 some encodings. If you know that Geany doesn't open a certain file,
1096 you can add the specification line, described in the next section,
1097 to the beginning of the file to force Geany to use a specific
1098 encoding when opening the file.</p>
1099 </li>
1100 </ul>
1101 </div>
1104 <p>Geany detects meta tags of HTML files which contain charset information
1105 like:</p>
1107 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
1108 </pre>
1109 <p>and the specified charset is used when opening the file. This is useful if the
1110 encoding of the file cannot be detected properly.
1111 For non-HTML files you can also define a line like:</p>
1114 </pre>
1118 </pre>
1119 <p>to force an encoding to be used. The #, /* and */ are examples
1120 of filetype-specific comment characters. It doesn't matter which
1122 as there is at least one whitespace character before and after this
1123 string. Whitespace characters are in this case a space or tab character.
1126 Then you simply add such a line to the file and Geany will open it
1127 correctly the next time.</p>
1129 regular expression used to find the encoding string:
1130 <tt class="docutils literal"><span class="pre">coding[\t</span> <span class="pre">]*[:=][\t</span> <span class="pre">]*([a-z0-9-]+)[\t</span> ]*</tt></p>
1135 </div>
1139 </pre>
1143 </pre>
1144 </div>
1148 encoding. It is useful when you know that Geany cannot auto-detect
1149 the encoding of a file and it is not displayed correctly. Especially
1150 when the file contains NULL-bytes this can be useful to skip auto
1151 detection and open the file properly at least until the occurrence
1152 of the first NULL-byte. Using this encoding opens the file as it is
1153 without any character conversion.</p>
1154 </div>
1157 <p>Furthermore, Geany detects a Unicode Byte Order Mark (see
1158 <a class="reference external" href="http://en.wikipedia.org/wiki/Byte_Order_Mark">http://en.wikipedia.org/wiki/Byte_Order_Mark</a> for details). Of course,
1159 this feature is only available if the opened file is in a Unicode
1160 encoding. The Byte Order Mark helps to detect the encoding of a file,
1162 using a Byte Order Mark could cause some problems for programs not
1163 expecting it, e.g. the compiler gcc stops
1164 with stray errors, PHP does not parse a script containing a BOM and
1165 script files starting with a she-bang maybe cannot be started. In the
1166 status bar you can easily see whether the file starts with a BOM or
1167 not.</p>
1168 <p>If you want to set a BOM for a file or if you want to remove it
1169 from a file, just use the document menu and toggle the checkbox.</p>
1173 to use it, then it is probably not important for you and you can
1174 safely ignore it.</p>
1175 </div>
1176 </div>
1177 </div>
1182 <p>Geany provides basic code folding support. Folding means the ability to
1183 show and hide parts of the text in the current file. You can hide
1184 unimportant code sections and concentrate on the parts you are working on
1185 and later you can show hidden sections again. In the editor window there is
1186 a small grey margin on the left side with [+] and [-] symbols which
1187 show hidden parts and hide parts of the file respectively. By
1188 clicking on these icons you can simply show and hide sections which are
1189 marked by vertical lines within this margin. For many filetypes nested
1190 folding is supported, so there may be several fold points within other
1191 fold points.</p>
1195 filetypes.common <a class="reference internal" href="#folding-settings">Folding Settings</a>.</p>
1196 </div>
1197 <p>If you don't like it or don't need it at all, you can simply disable
1198 folding support completely in the preferences dialog.</p>
1200 a fold point" option in the preference dialog. If activated, Geany will
1201 unfold all nested fold points below the current one if they are already
1202 folded (when clicking on a [+] symbol).
1203 When clicking on a [-] symbol, Geany will fold all nested fold points
1204 below the current one if they are unfolded.</p>
1205 <p>This option can be inverted by pressing the Shift
1206 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
1207 children of a fold point" option is enabled, pressing Shift will disable
1208 it for this click and vice versa.</p>
1209 </div>
1212 <p>There is basic support for column mode editing. To use it, create a
1213 rectangular selection by holding down the Control and Shift keys
1214 (or Control and Alt if it doesn't work) while
1215 selecting some text. It is also possible to create a zero-column selection.
1216 Once a rectangular selection exists you can start editing the text within
1217 this selection and the modifications will be done for every line in the
1218 selection.</p>
1219 </div>
1222 <p>If you drag selected text in the editor widget of Geany the text is
1223 moved to the position where the mouse pointer is when releasing the
1224 mouse button. Holding Control when releasing the mouse button will
1225 copy the text instead. This behaviour was changed in Geany 0.11 -
1226 before the selected text was copied to the new position.</p>
1227 </div>
1230 <p>Geany allows each document to indent either with a tab character,
1231 multiple spaces or a combination of both. The default indent
1232 settings are set in <a class="reference internal" href="#editor-indentation-preferences">Editor Indentation preferences</a> (see the link
1233 for more information).</p>
1234 <p>The default settings can be overridden per-document using the
1235 Document menu. They can also be overridden by projects - see
1237 <p>The indent mode for the current document is shown on the status bar
1238 as follows:</p>
1245 <dd>Indent with tabs and spaces, depending on how much indentation is
1246 on a line.</dd>
1247 </dl>
1250 <p>After changing the default settings you may wish to apply the new
1251 settings to every document in the current session. To do this use the
1253 </div>
1257 scan each file as it's opened and set the indent type based on
1259 </div>
1260 </div>
1264 Editor. It adds a certain amount of indentation to the new line so the
1265 user doesn't always have to indent each line manually.</p>
1274 brace '{', and de-indents when typing a closing brace '}'. For Python,
1275 a new line will be indented after typing ':' at the end of the
1276 previous line.</dd>
1279 match the indentation of the line with the opening brace.</dd>
1280 </dl>
1281 <p>There is also XML-tag auto-indentation. This is enabled when the
1282 mode is more than just Basic, and is also controlled by a filetype
1284 </div>
1287 <p>Geany provides a handy bookmarking feature that lets you mark one
1288 or more lines in a document, and return the cursor to them using a
1289 key combination.</p>
1290 <p>To place a mark on a line, either left-mouse-click in the left margin
1291 of the editor window, or else use Ctrl-m. This will
1292 produce a small green plus symbol in the margin. You can have as many
1293 marks in a document as you like. Click again (or use Ctrl-m again)
1294 to remove the bookmark. To remove all the marks in a given document,
1296 <p>To navigate down your document, jumping from one mark to the next,
1297 use Ctrl-. (control period). To go in the opposite direction on
1298 the page, use Ctrl-, (control comma). Using the bookmarking feature
1299 together with the commands to switch from one editor tab to another
1300 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
1301 navigate around multiple files.</p>
1302 </div>
1305 <p>To ease navigation in source files and especially between
1306 different files, Geany lets you jump between different navigation
1307 points. Currently, this works for the following:</p>
1314 </ul>
1315 <p>When using one of these actions, Geany remembers your current position
1316 and jumps to the new one. If you decide to go back to your previous
1318 get back to the new position again, just use "Navigate forward a
1319 location". This makes it easier to navigate in e.g. foreign code
1320 and between different files.</p>
1321 </div>
1324 <p>You can define several custom commands in Geany and send the current
1326 Selection to</em> menu or keybindings. The output of the command will be
1327 used to replace the current selection. This makes it possible to use
1328 text formatting tools with Geany in a general way.</p>
1329 <p>The selected text will be sent to the standard input of the executed
1330 command, so the command should be able to read from it and it should
1331 print all results to its standard output which will be read by
1332 Geany. To help finding errors in executing the command, the output
1333 of the program's standard error will be printed on Geany's standard
1334 output.</p>
1338 command. You can also specify some command line options. Empty
1339 commands are not saved.</p>
1343 </ul>
1344 <p>The above example would normally be done with the <a class="reference internal" href="#replace-all">Replace all</a>
1345 function, but it can be handy to have common commands already set up.</p>
1346 </div>
1349 <p>You can execute the context action command on the current word at the
1350 cursor position or the available selection. This word or selection
1351 can be used as an argument to the command.
1352 The context action is invoked by a menu entry in the popup menu of the
1353 editor and also a keyboard shortcut (see the section called
1355 <p>The command can be specified in the preferences dialog and also for
1357 <a class="reference internal" href="#filetype-configuration">Filetype configuration</a>). When the context action is invoked, the filetype
1358 specific command is used if available, otherwise the command
1359 specified in the preferences dialog is executed.</p>
1361 in the command, it will be replaced by the current word or
1362 selection before the command is executed.</p>
1363 <p>For example a context action can be used to open API documentation
1364 in a browser window, the command to open the PHP API documentation
1365 would be:</p>
1368 </pre>
1369 <p>when executing the command, the %s is substituted by the word near
1370 the cursor position or by the current selection. If the cursor is at
1372 called firefox) and it will open the address: <a class="reference external" href="http://www.php.net/echo">http://www.php.net/echo</a>.</p>
1373 </div>
1376 <p>Geany can offer a list of possible completions for symbols defined in the
1377 tags and for all words in a document.</p>
1378 <p>The autocompletion list for symbols is presented when the first few
1379 characters of the symbol are typed (configurable, see <a class="reference internal" href="#editor-completions-preferences">Editor Completions
1381 keybinding is pressed (configurable, see <a class="reference internal" href="#editor-keybindings">Editor keybindings</a>,
1382 default Ctrl-Space).</p>
1384 document</em> preference (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions preferences</a>)
1385 is selected then the autocompletion list will show all matching words
1386 in the document, if there are no matching symbols.</p>
1387 <p>If you don't want to use autocompletion it can be dismissed until
1388 the next symbol by pressing Escape. The autocompletion list is updated
1389 as more characters are typed so that it only shows completions that start
1390 with the characters typed so far. If no symbols begin with the sequence,
1391 the autocompletion window is closed.</p>
1392 <p>The up and down arrows will move the selected item. The highlighted
1393 item on the autocompletion list can be chosen from the list by pressing
1394 Enter/Return. You can also double-click to select an item. The sequence
1395 will be completed to match the chosen item, and if the <em>Drop rest of
1396 word on completion</em> preference is set (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions
1397 preferences</a>) then any characters after the cursor that match
1398 a symbol or word are deleted.</p>
1401 <p>By default, pressing Tab will complete the selected item by word part;
1402 useful e.g. for adding the prefix <tt class="docutils literal">gtk_combo_box_entry_</tt> without typing it
1403 manually:</p>
1410 </ul>
1411 <p>The key combination can be changed from Tab - See <a class="reference internal" href="#editor-keybindings">Editor keybindings</a>.
1412 If you clear/change the key combination for word part completion, Tab
1413 will complete the whole word instead, like Enter.</p>
1414 </div>
1419 struct
1420 {
1421 int i;
1422 char c;
1423 } foo;
1424 </pre>
1425 <p>When you type <tt class="docutils literal">foo.</tt> it will show an autocompletion list with 'i' and
1426 'c' symbols.</p>
1427 <p>It only works for languages that set parent scope names for e.g. struct
1428 members. Currently this means C-like languages. The C tag parser only
1429 parses global scopes, so this won't work for structs or objects declared
1430 in local scope.</p>
1431 </div>
1432 </div>
1435 <p>Snippets are small strings or code constructs which can be replaced or
1436 completed to a more complex string. So you can save a lot of time when
1437 typing common strings and letting Geany do the work for you.
1438 To know what to complete or replace Geany reads a configuration file
1442 [Default]
1443 myname=Enrico Tröger
1444 </pre>
1445 <p>Every time you write <tt class="docutils literal">myname</tt> <TAB> in Geany, it will replace "myname"
1447 in the preferences dialog, by default it is TAB. The corresponding keybinding
1450 <p>You can override the default snippets using the user
1452 Files->snippets.conf</em> menu item. See also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
1453 <p>This adds the default settings to the user file if the file doesn't
1454 exist. Alternatively the file can be created manually, adding only
1455 the settings you want to change. All missing settings will be read
1456 from the system snippets file.</p>
1458 <p>The file <tt class="docutils literal">snippets.conf</tt> contains sections defining snippets that
1459 are available for particular filetypes and in general.</p>
1463 other snippets. So you can define often used parts of snippets and
1464 just use the special snippet as a placeholder (see the
1467 snippets in that section are only available for use in files with that
1468 filetype. Snippets in filetype sections will hide snippets with the
1470 filetype.</p>
1472 <p>To define snippets you can use several special character sequences which
1473 will be replaced when using the snippet:</p>
1475 <colgroup>
1478 </colgroup>
1481 <td>Insert a new line (it will be replaced by the used EOL
1482 char(s): LF, CR/LF, or CR).</td>
1483 </tr>
1485 <td>Insert an indentation step, it will be replaced according
1486 to the current document's indent mode.</td>
1487 </tr>
1489 <td>\s to force whitespace at beginning or end of a value
1490 ('key= value' won't work, use 'key=\svalue')</td>
1491 </tr>
1493 <td>Place the cursor at this position after completion has
1494 been done. You can define multiple %cursor% wildcards
1496 to the next defined cursor position in the completed
1497 snippet.</td>
1498 </tr>
1502 section you can use %brace_open% in any other snippet.</td>
1503 </tr>
1504 </tbody>
1505 </table>
1506 <p>Snippet names must not contain spaces otherwise they won't
1507 work correctly. But beside that you can define almost any
1508 string as a snippet and use it later in Geany. It is not limited
1509 to existing contructs of certain programming languages(like <tt class="docutils literal">if</tt>,
1510 <tt class="docutils literal">for</tt>, <tt class="docutils literal">switch</tt>). Define whatever you need.</p>
1513 listed in <a class="reference internal" href="#template-wildcards">Template wildcards</a>. All wildcards which are listed as
1516 [Default]
1517 myname=My name is {developer}
1518 mysystem=My system: {command:uname -a}
1519 </pre>
1520 <p>this will replace <tt class="docutils literal">myname</tt> with "My name is " and the value of the template
1523 <p>You can change the way Geany recognizes the word to complete,
1524 that is how the start and end of a word is recognised when the
1527 to be recognized as a word for completion. Leave it commented to use
1528 default characters or define it to add or remove characters to fit your
1529 needs.</p>
1532 <p>Normally you would type the snippet name and press Tab. However, you
1536 [Keybindings]
1539 </pre>
1543 keybindings.</p>
1544 </div>
1545 </div>
1546 </div>
1549 <p>You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1550 Ctrl-Shift, type some hex digits representing the code point for the character
1551 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1552 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1553 insertion is completed, but the typed character is also entered. In the case
1554 of Enter/Return, it is a newline, as you might expect.</p>
1555 <p>In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1556 in the <a class="reference internal" href="#keybinding-preferences">keybinding preferences</a>, then select <em>Tools->Reload Configuration</em>
1557 or restart Geany. Note that it works slightly differently from other GTK
1558 applications, in that you'll need to continue to hold down the Ctrl and Shift
1559 keys while typing the code point hex digits (and the Enter or Return to finish the code point).</p>
1560 </div>
1561 </div>
1564 <p>This section describes search-related commands from the Search menu
1565 and the editor window's popup menu:</p>
1575 </ul>
1582 </ul>
1583 <p>There are keybindings to focus each of these - see <a class="reference internal" href="#focus-keybindings">Focus
1587 <p>The quickest way to find some text is to use the search bar entry in
1588 the toolbar. This performs a case-insensitive search in the current
1589 document whilst you type. Pressing Enter will search again, and pressing
1590 Shift-Enter will search backwards.</p>
1591 </div>
1592 </div>
1604 </div>
1606 into their UTF-8 equivalent. For example, \t will be transformed into
1607 a tab character. Other recognized symbols are: \\, \n, \r, \uXXXX
1608 (Unicode characters).</p>
1609 </div>
1612 <p>To find all matches, click on the Find All expander. This will reveal
1613 several options:</p>
1618 </ul>
1619 <p>Find All In Document will show a list of matching lines in the
1620 current document in the Messages tab of the Message Window. <em>Find All
1622 <p>Mark will highlight all matches in the current document with a
1623 colored box. These markers can be removed by selecting the
1624 Remove Markers command from the Document menu.</p>
1625 </div>
1628 <p>All search related dialogs use a Monospace for the text input fields to
1629 increase the readability of input text. This is useful when you are
1630 typing input such as regular expressions with spaces, periods and commas which
1631 might it hard to read with a proportional font.</p>
1632 <p>If you want to change the font, you can do this easily
1633 by inserting the following style into your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>
1634 (usually found in your home directory on UNIX-like systems and in the
1635 etc subdirectory of your Geany installation on Windows):</p>
1638 {
1640 }
1642 </pre>
1644 of this style to the highest available. Otherwise, the style is ignored
1645 for the search dialogs.</p>
1646 </div>
1647 </div>
1651 current selected text. If nothing is selected, by default the current
1652 word is used instead. This can be customized by the
1653 <em>find_selection_type</em> preference - see <a class="reference internal" href="#various-preferences">Various preferences</a>.</p>
1655 <colgroup>
1658 </colgroup>
1662 </tr>
1663 </thead>
1667 </tr>
1670 </tr>
1673 </tr>
1674 </tbody>
1675 </table>
1676 </div>
1679 <p>Find usage searches all open files. It is similar to the Find All In
1680 Session option in the Find dialog.</p>
1681 <p>If there is a selection, then it is used as the search text; otherwise
1682 the current word is used. The current word is either taken from the
1683 word nearest the edit cursor, or the word underneath the popup menu
1684 click position when the popup menu is used. The search results are
1685 shown in the Messages tab of the Message Window.</p>
1686 </div>
1689 <p>Find in files is a more powerful version of Find usage that searches
1690 all files in a certain directory using the Grep tool. The Grep tool
1691 must be correctly set in Preferences to the path of the system's Grep
1692 utility. GNU Grep is recommended (see note below).</p>
1695 search, depending on the mode:</p>
1700 <dd>Use the current project's patterns, see <a class="reference internal" href="#project-properties">Project properties</a>;</dd>
1703 </dl>
1704 <p>Both project and custom patterns use a glob-style syntax, each
1705 pattern separated by a space. To search all <tt class="docutils literal">.c</tt> and <tt class="docutils literal">.h</tt> files,
1707 Note that an empty pattern list searches in all files rather
1708 than none.</p>
1710 to be searched. The entered search text is converted to the chosen encoding
1713 the grep tool.</p>
1716 <p class="last">The <em>Files</em> setting uses <tt class="docutils literal"><span class="pre">--include=</span></tt> when searching recursively,
1717 <em>Recurse in subfolders</em> uses <tt class="docutils literal"><span class="pre">-r</span></tt>; both are GNU Grep options and may
1718 not work with other Grep implementations.</p>
1719 </div>
1724 out version control files.</p>
1725 <p>If you have GNU Grep >= 2.5.2 you can use the <tt class="docutils literal"><span class="pre">--exclude-dir</span></tt>
1726 argument to filter out CVS and hidden directories like <tt class="docutils literal">.svn</tt>.</p>
1727 <p>Example: <tt class="docutils literal"><span class="pre">--exclude-dir=.svn</span> <span class="pre">--exclude-dir=CVS</span></tt></p>
1728 <p>If you have an older Grep, you can try using the <tt class="docutils literal"><span class="pre">--exclude</span></tt> flag
1729 to filter out filenames.</p>
1730 <p>SVN Example: <tt class="docutils literal"><span class="pre">--exclude=*.svn-base</span></tt></p>
1732 </div>
1733 </div>
1736 <p>The Replace dialog is used for replacing text in one or more open
1737 documents.</p>
1739 <p>The Replace dialog has the same options for matching text as the Find
1740 dialog. See the section <a class="reference internal" href="#matching-options">Matching options</a>.</p>
1742 be used in the search string and back references in the replacement
1743 text -- see the entry for '\n' in <a class="reference internal" href="#regular-expressions">Regular expressions</a>.</p>
1747 will reveal several options:</p>
1752 </ul>
1756 in the current selection of the current document.</p>
1757 </div>
1758 </div>
1761 <p>If the current word is the name of a tag definition (like a function
1762 body) and the file containing the tag definition is open, this command
1763 will switch to that file and go to the corresponding line number. The
1764 current word is either the word nearest the edit cursor,
1765 or the word underneath the popup menu click position when the popup
1766 menu is used.</p>
1770 to look for a tag declaration instead, as this is more useful.
1771 Likewise 'Go to tag declaration' will search for a tag definition
1772 in this case also.</p>
1773 </div>
1774 </div>
1777 <p>Like Go to tag definition, but for a forward declaration such as a
1778 C function prototype or <tt class="docutils literal">extern</tt> declaration instead of a function
1779 body.</p>
1780 </div>
1784 </div>
1787 <p>You can use regular expressions in the Find and Replace dialogs
1788 by selecting the <em>Use regular expressions</em> check box (see <a class="reference internal" href="#matching-options">Matching
1789 options</a>). The syntax is POSIX compatible, as described in the table
1790 below.</p>
1795 expressions.</li>
1797 <li>\b, \d, \s, \w are GNU extensions and may not be available
1798 on non-GNU POSIX systems unless you built Geany with the
1799 <tt class="docutils literal"><span class="pre">--enable-gnu-regex</span></tt> option (this is always used on Windows).</li>
1800 </ol>
1801 </div>
1804 <colgroup>
1807 </colgroup>
1811 </tr>
1814 </tr>
1817 </tr>
1820 region when searching or replacing.</p>
1823 replace string was Sam\1YYY, when applied to Fred2XXX this
1824 would generate Sam2YYY.</p>
1825 </td>
1826 </tr>
1829 </tr>
1832 </tr>
1835 character class (both inside and outside sets []).</p>
1843 </ul>
1844 </td>
1845 </tr>
1847 <td>This allows you to use a character x that would otherwise have
1848 a special meaning. For example, \[ would be interpreted as [
1849 and not as the start of a character set. Use \\ for a literal
1850 backslash.</td>
1851 </tr>
1854 character in the set is ^, it matches the characters NOT in
1855 the set, i.e. complements the set. A shorthand S-E (start
1856 dash end) is used to specify a set of characters S up to E,
1857 inclusive.</p>
1858 <p>The special characters ] and - have no special
1859 meaning if they appear first in the set. - can also be last
1860 in the set. To include both, put ] first: []A-Z-].</p>
1863 []|-] matches these 3 chars
1864 []-|] matches from ] to | chars
1865 [a-z] any lowercase alpha
1866 [^]-] any char except - and ]
1867 [^A-Z] any char except uppercase alpha
1868 [a-zA-Z] any alpha
1869 </pre>
1870 </td>
1871 </tr>
1873 <td>This matches the start of a line (unless used inside a set, see
1874 above).</td>
1875 </tr>
1878 </tr>
1881 Saam, Saaam and so on.</td>
1882 </tr>
1885 Saam, Saaam and so on.</td>
1886 </tr>
1889 </tr>
1890 </tbody>
1891 </table>
1895 distributed under the <a class="reference internal" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
1896 </div>
1897 </div>
1898 </div>
1901 <p>The View menu allows various elements of the main window to be shown
1902 or hidden, and also provides various display-related editor options.</p>
1906 It lists various color schemes for editor highlighting styles,
1907 including the default scheme first. Other items are available based
1908 on what color scheme files Geany found at startup.</p>
1909 <p>Color scheme files are read from the <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a> under
1910 the <tt class="docutils literal">colorschemes</tt> subdirectory. They should have the extension
1913 <p>The <a class="reference internal" href="#named-styles-section">[named_styles] section</a> is the same as for <tt class="docutils literal">filetypes.common</tt>.</p>
1917 any chosen color scheme.</p>
1918 </div>
1919 <p>The <tt class="docutils literal">[theme_info]</tt> section can contain information about the
1920 theme. The <tt class="docutils literal">name</tt> and <tt class="docutils literal">description</tt> keys are read to set the
1921 menu item text and tooltip, respectively. These keys can have
1922 translations, e.g.:</p>
1924 key=Hello
1925 key[de]=Hallo
1926 key[fr_FR]=Bonjour
1927 </pre>
1928 </div>
1929 </div>
1932 <p>Tags are information that relates symbols in a program with the
1933 source file location of the declaration and definition.</p>
1934 <p>Geany has built-in functionality for generating tag information (aka
1936 can also have Geany automatically load external tag files (aka "global
1938 <p>Geany uses its own tag file format, similar to what <tt class="docutils literal">ctags</tt> uses
1939 (but is incompatible with ctags). You use Geany to generate global
1940 tags files, as described below.</p>
1943 <p>Tags for each document are parsed whenever a file is loaded, saved or
1944 modified (see <em>Symbol list update frequency</em> preference in the <a class="reference internal" href="#editor-completions-preferences">Editor
1945 Completions preferences</a>). These are shown in the Symbol list in the
1946 Sidebar. These tags are also used for autocompletion of symbols and calltips
1947 for all documents open in the current session that have the same filetype.</p>
1950 </div>
1953 <p>Global tags are used to provide autocompletion of symbols and calltips
1954 without having to open the corresponding source files. This is intended
1955 for library APIs, as the tags file only has to be updated when you upgrade
1956 the library.</p>
1960 <li>By moving or symlinking tags files to the <tt class="docutils literal">tags</tt> subdirectory of
1961 one of the <a class="reference internal" href="#configuration-file-paths">configuration file paths</a> before starting Geany.</li>
1962 </ul>
1963 <p>You can either download these files or generate your own. They have
1964 the format:</p>
1966 name.lang_ext.tags
1967 </pre>
1969 with the tags. See the section called <a class="reference internal" href="#filetype-extensions">Filetype extensions</a> for
1970 more information.</p>
1973 <p>For some languages, a list of global tags is loaded when the
1974 corresponding filetype is first used. Currently these are for:</p>
1982 </ul>
1983 </div>
1990 </ul>
1991 <p>The first line of global tags files should be a comment, introduced
1992 by <tt class="docutils literal">#</tt> followed by a space and a string like <tt class="docutils literal">format=pipe</tt>
1994 This helps Geany to read the file properly. If this line
1995 is missing, Geany tries to auto-detect the used format but this
1996 might fail.</p>
1997 <p>The Tagmanager format is a bit more complex and is used for files
1998 created by the <tt class="docutils literal">geany <span class="pre">-g</span></tt> command. There is one tag per line.
1999 Different tag attributes like the return value or the argument list
2000 are separated with different characters indicating the type of the
2001 following argument.</p>
2002 <p>The Pipe-separated format is easier to read and write.
2003 There is one tag per line and different tag attributes are separated
2006 basename|string|(string path [, string suffix])|
2007 </pre>
2013 currently unused and should be left empty.</div>
2014 </div>
2015 <p>Except for the first field (tag name), all other field can be left
2016 empty but the pipe separator must appear for them.</p>
2017 <p>You can easily write your own global tag files using this format.
2018 Just save them in your tags directory, as described earlier in the
2020 </div>
2023 <p>You can generate your own global tags files by parsing a list of
2024 source files. The command is:</p>
2027 </pre>
2029 <li>Tag File filename should be in the format described earlier --
2031 <li>File list is a list of filenames, each with a full path (unless
2032 you are generating C/C++ tags and have set the CFLAGS environment
2033 variable appropriately).</li>
2034 <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
2035 to process <tt class="docutils literal">#include</tt> directives for C/C++ source files. Use this
2036 option if you want to specify each source file on the command-line
2037 instead of using a 'master' header file. Also can be useful if you
2038 don't want to specify the CFLAGS environment variable.</li>
2039 </ul>
2042 geany -g wxd.d.tags /home/username/wxd/wx/*.d
2043 </pre>
2045 <p>For C/C++ tag files, gcc and grep are required, so that header files
2046 can be preprocessed to include any other headers they depend upon.</p>
2047 <p>For C/C++ files, the environment variable CFLAGS should be set with
2048 appropriate <tt class="docutils literal"><span class="pre">-I/path</span></tt> include paths. The following example works with
2049 the bash shell, generating tags for the GnomeUI library:</p>
2051 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
2052 /usr/include/libgnomeui-2.0/gnome.h
2053 </pre>
2054 <p>You can adapt this command to use CFLAGS and header files appropriate
2055 for whichever libraries you want.</p>
2057 <p>Geany currently uses a default global tags file c99.tags for
2058 C and C++, commonly installed in /usr/share/geany. This file can
2059 be replaced with one containing tags parsed from a different set
2060 of header files. When Geany is next started, your custom tags file
2061 will be loaded instead of the default c99.tags. You should keep a
2062 copy of the generated tags file because it will get overwritten when
2063 upgrading Geany.</p>
2065 <p>This works basically the same as on other platforms but you need to make
2066 sure you have grep installed and Geany can find it, i.e. it must be
2067 in the PATH environment variable. To test this, open a console window
2069 If it is, then you can create a tags file like the following:</p>
2072 </pre>
2073 </div>
2074 </div>
2077 <p>You can ignore certain tags for C-based languages if they would lead
2079 Files->ignore.tags</em> menu item to open the user <tt class="docutils literal">ignore.tags</tt> file.
2080 See also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
2081 <p>List all tag names you want to ignore in this file, separated by spaces
2082 and/or newlines.</p>
2085 G_GNUC_NULL_TERMINATED
2086 G_GNUC_PRINTF
2087 G_GNUC_WARN_UNUSED_RESULT
2088 </pre>
2090 <p><tt class="docutils literal">gchar **utils_strv_new(const gchar *first, <span class="pre">...)</span>
2091 G_GNUC_NULL_TERMINATED;</tt></p>
2092 <p>More detailed information about ignore tags usage from the Exuberant Ctags
2093 manual page:</p>
2094 <blockquote>
2095 Specifies a list of identifiers which are to be specially handled
2096 while parsing C and C++ source files. This option is specifically
2097 provided to handle special cases arising through the use of
2098 pre-processor macros. When the identifiers listed are simple identifiers,
2099 these identifiers will be ignored during parsing of the source files.
2100 If an identifier is suffixed with a '+' character, ctags will also
2101 ignore any parenthesis-enclosed argument list which may immediately
2102 follow the identifier in the source files.
2103 If two identifiers are separated with the '=' character, the first
2104 identifiers is replaced by the second identifiers for parsing purposes.</blockquote>
2105 <p>For even more detailed information please read the manual page of
2106 Exuberant Ctags.</p>
2107 </div>
2108 </div>
2112 dialog. Any changes you make there can be applied by hitting either
2113 the Apply or the OK button. These settings will persist between Geany
2114 sessions. Note that most settings here have descriptive popup bubble
2115 help -- just hover the mouse over the item in question to get help
2116 on it.</p>
2117 <p>You may also adjust some View settings (under the View menu) that
2118 persist between Geany sessions. The settings under the Document menu,
2119 however, are only for the current document and revert to defaults
2120 when restarting Geany.</p>
2124 comes after the screenshot of that tab.</p>
2125 </div>
2133 <dd>On startup, load the same files you had open the last time you
2134 used Geany.</dd>
2139 </dl>
2140 </div>
2145 <dd>Save the current position and size of the main window so next time
2146 you open Geany it's in the same location.</dd>
2149 </dl>
2150 </div>
2155 <dd>Path to start in when opening or saving files.
2156 It must be an absolute path.
2157 Leave it blank to use the current working directory.</dd>
2161 <dd>By default Geany looks in the global installation path and in the
2162 configuration directory. In addition the path entered here will be searched
2163 for plugins. Usually you do not need to set an additional path to search for
2164 plugins. It might be useful when Geany is installed on a multi-user machine
2165 and additional plugins are available in a common location for all users.
2166 Leave blank to not set an additional lookup path.</dd>
2167 </dl>
2168 </div>
2169 </div>
2177 <dd>Have the computer make a beeping sound when compilation of your program
2178 has completed or any errors occurred.</dd>
2180 <dd>Switch to the status message tab (in the notebook window at the bottom)
2181 once a new status message arrives.</dd>
2184 in the status messages window.</p>
2188 reshows the document statistics on the status bar. See <a class="reference internal" href="#focus-keybindings">Focus
2190 </div>
2191 </dd>
2193 <dd>Defines whether to use the native Windows File Open/Save dialogs or
2194 whether to use the GTK default dialogs.</dd>
2196 <dd>Give the focus automatically to widgets below the mouse cursor.
2197 This works for the main editor widget, the scribble, the toolbar search field
2198 goto line fields and the VTE.</dd>
2199 </dl>
2200 </div>
2205 <dd>Always wrap search around the document and hide the Find dialog after clicking
2206 Find Next/Previous.</dd>
2208 <dd>Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
2209 there is no selection. When this option is disabled, the search term last used in the
2210 appropriate Find dialog is used.</dd>
2212 <dd>When opening the Find in Files dialog, set the directory to search to the directory of the current
2213 active file. When this option is disabled, the directory of the last use of the Find in Files
2214 dialog is used.</dd>
2215 </dl>
2216 </div>
2221 <dd>Save your current session when closing projects. You will be able to
2222 resume different project sessions, automatically opening the files
2223 you had open previously.</dd>
2225 <dd>When creating new projects, the default path for the project file contains
2226 the project base path. Without this option enabled, the default project file
2227 path is one level above the project base path.
2228 In either case, you can easily set the final project file path in the
2230 defaults automatically for convenience.</dd>
2231 </dl>
2232 </div>
2233 </div>
2236 <img alt="./images/pref_dialog_interface_interface.png" src="./images/pref_dialog_interface_interface.png" />
2243 <dd>Show the list of functions, variables, and other information in the
2244 current document you are editing.</dd>
2246 <dd>Show all the documents you have open currently. This can be used to
2247 change between documents (see <a class="reference internal" href="#switching-between-documents">Switching between documents</a>) and
2248 to perform some common operations such as saving, closing and reloading.</dd>
2251 </dl>
2252 </div>
2262 </dl>
2263 </div>
2268 <dd>Show the status bar at the bottom of the main window. It gives information about
2269 the file you are editing like the line and column you are on, whether any
2270 modifications were done, the file encoding, the filetype and other information.</dd>
2271 </dl>
2272 </div>
2273 </div>
2276 <img alt="./images/pref_dialog_interface_notebook.png" src="./images/pref_dialog_interface_notebook.png" />
2281 <dd>Show a notebook tab for all documents so you can switch between them
2282 using the mouse (instead of using the Documents window).</dd>
2284 <dd>Make each tab show a close button so you can easily close open
2285 documents.</dd>
2287 <dd>Whether to create a document with its notebook tab to the left or
2288 right of all existing tabs.</dd>
2290 <dd>Whether to place file tabs next to the current tab
2291 rather than at the edges of the notebook.</dd>
2294 when double-clicking on a notebook tab.</dd>
2295 </dl>
2296 </div>
2301 <dd>Set the positioning of the editor's notebook tabs to the right,
2302 left, top, or bottom of the editing window.</dd>
2304 <dd>Set the positioning of the sidebar's notebook tabs to the right,
2305 left, top, or bottom of the sidebar window.</dd>
2307 <dd>Set the positioning of the message window's notebook tabs to the
2308 right, left, top, or bottom of the message window.</dd>
2309 </dl>
2310 </div>
2311 </div>
2315 <img alt="./images/pref_dialog_interface_toolbar.png" src="./images/pref_dialog_interface_toolbar.png" />
2322 <dd>Allows to append the toolbar to the main menu bar instead of placing it below.
2323 This is useful to save vertical space.</dd>
2325 <dd>See <a class="reference internal" href="#customizing-the-toolbar">Customizing the toolbar</a>.</dd>
2326 </dl>
2327 </div>
2332 <dd>Select the toolbar icon style to use - either icons and text, just
2333 icons or just text.
2334 The choice System default uses whatever icon style is set by GTK.</dd>
2336 <dd>Select the size of the icons you see (large, small or very small).
2337 The choice System default uses whatever icon size is set by GTK.</dd>
2338 </dl>
2339 </div>
2340 </div>
2343 <img alt="./images/pref_dialog_edit_features.png" src="./images/pref_dialog_edit_features.png" />
2350 <dd>Whether to move the cursor to the first non-whitespace character
2351 on the line when you hit the home key on your keyboard. Pressing it
2352 again will go to the very start of the line.</dd>
2356 <dd>Allow groups of lines in a document to be collapsed for easier
2357 navigation/editing.</dd>
2359 <dd>Whether to fold/unfold all child fold points when a parent line
2360 is folded.</dd>
2362 <dd>Underline lines with compile errors using red squiggles to indicate
2363 them in the editor area.</dd>
2365 <dd>Remove any white space at the end of the line when you hit the
2366 Enter/Return key.</dd>
2368 <dd>The editor column number to insert a newline at when Line Breaking
2369 is enabled for the current document.</dd>
2371 <dd>A string which is added when toggling a line comment in a source file.
2372 It is used to mark the comment as toggled.</dd>
2373 </dl>
2374 </div>
2375 </div>
2378 <img alt="./images/pref_dialog_edit_indentation.png" src="./images/pref_dialog_edit_indentation.png" />
2381 <p>See <a class="reference internal" href="#indentation">Indentation</a> for more information.</p>
2384 <dd>The width of a single indent size in spaces. By default the indent
2387 <dd>Try to detect and set the indent width based on file content, when
2388 a file is opened.</dd>
2395 </ul>
2398 </dd>
2400 <dd>Try to detect and set the indent type based on file content, when
2401 a file is opened.</dd>
2404 if any.</p>
2409 <dd>Add indentation based on the current filetype and any characters at
2410 the end of the line such as <tt class="docutils literal">{</tt>, <tt class="docutils literal">}</tt> for C, <tt class="docutils literal">:</tt> for Python.</dd>
2414 </dl>
2415 </dd>
2418 unindent when pressing Shift-tab. Otherwise, the tab key will
2419 insert a tab character into the document (which can be different
2420 from indentation, depending on the indent type).</p>
2424 unindent, but this preference allows the tab key to have different
2425 meanings in different contexts - e.g. for snippet completion.</p>
2426 </div>
2427 </dd>
2428 </dl>
2429 </div>
2430 </div>
2433 <img alt="./images/pref_dialog_edit_completions.png" src="./images/pref_dialog_edit_completions.png" />
2438 <dd>Whether to replace special keywords after typing Tab into a
2439 pre-defined text snippet.
2440 See <a class="reference internal" href="#user-definable-snippets">User-definable snippets</a>.</dd>
2442 <dd>When you open an XML/HTML tag automatically generate its
2443 completion tag.</dd>
2446 and Java when a new line is entered inside such a comment.
2447 With this option enabled, Geany will insert a <tt class="docutils literal">*</tt> on every new line
2448 inside a multi-line comment, for example when you press return in the
2449 following C code:</p>
2451 /*
2453 </pre>
2456 *
2457 </pre>
2460 </dd>
2462 <dd>When you start to type a symbol name, look for the full string to
2463 allow it to be completed for you.</dd>
2465 <dd>When you start to type a word, Geany will search the whole document for
2466 words starting with the typed part to complete it, assuming there
2467 are no tag names to show.</dd>
2469 <dd>Remove any word part to the right of the cursor when choosing a
2470 completion list item.</dd>
2472 <dd>Number of characters of a word to type before autocompletion is
2473 displayed.</dd>
2480 <p>This option determines how frequently the tag list is updated for the
2481 current document. The smaller the delay, the more up-to-date the symbol
2482 list (and then the completions); but rebuilding the symbol list has a
2483 cost in performance, especially with large files.</p>
2485 at most four times per second, even if the document changes continuously.</p>
2487 updated upon document saving.</p>
2488 </dd>
2489 </dl>
2490 </div>
2493 <p>Geany can automatically insert a closing bracket and quote characters when
2494 you open them. For instance, you type a <tt class="docutils literal">(</tt> and Geany will automatically
2495 insert <tt class="docutils literal">)</tt>. With the following options, you can define for which
2496 characters this should work.</p>
2508 </dl>
2509 </div>
2510 </div>
2514 <img alt="./images/pref_dialog_edit_display.png" src="./images/pref_dialog_edit_display.png" />
2519 <dd>Invert all colors, by default this makes white text on a black
2520 background.</dd>
2522 <dd>Show vertical lines to help show how much leading indentation there
2523 is on each line.</dd>
2526 show which kinds of whitespace are used.</dd>
2528 <dd>Display a symbol everywhere that a carriage return or line feed
2529 is present.</dd>
2533 <dd>Show or hide the small margin right of the line numbers, which is used
2534 to mark lines.</dd>
2536 <dd>When enabled Geany stops scrolling when at the last line of the document.
2537 Otherwise you can scroll one more page even if there are no real lines.</dd>
2538 </dl>
2539 </div>
2542 <p>The long line marker helps to indicate overly-long lines, or as a hint
2543 to the user for when to break the line.</p>
2548 <dd>Show a thin vertical line in the editor window at the given column
2549 position.</dd>
2551 <dd>Change the background color of characters after the given column
2552 position to the color set below. (This is recommended over the
2556 </dl>
2557 </dd>
2559 <dd>Set this value to a value greater than zero to specify the column
2560 where it should appear.</dd>
2563 </dl>
2564 </div>
2567 <p>Virtual space is space beyond the end of each line.
2568 The cursor may be moved into virtual space but no real space will be
2569 added to the document until there is some text typed or some other
2570 text insertion command is used.</p>
2578 </dl>
2579 </div>
2580 </div>
2588 <dd>Whether to create new documents when passing filenames that don't
2589 exist from the command-line.</dd>
2595 <dd>Opens all files with the specified encoding instead of auto-detecting it.
2596 Use this option when it's not possible for Geany to detect the exact encoding.</dd>
2598 <dd>The end of line characters to which should be used for new files.
2599 On Windows systems, you generally want to use CR/LF which are the common
2600 characters to mark line breaks.
2601 On Unix-like systems, LF is default and CR is used on MAC systems.</dd>
2602 </dl>
2603 </div>
2606 <p>Perform formatting operations when a document is saved. These
2607 can each be undone with the Undo command.</p>
2612 <dd>Ensures that newline characters always get converted before
2613 saving, avoiding mixed line endings in the same file.</dd>
2617 <dd><p class="first">Replace all tabs in the document with the equivalent number of spaces.</p>
2622 </div>
2623 </dd>
2624 </dl>
2625 </div>
2633 file on disk in case it has changed. Setting it to 0 will disable
2634 this feature.</p>
2638 not checked for changes due to performance issues
2639 (remote files are files in <tt class="docutils literal"><span class="pre">~/.gvfs/</span></tt>).</p>
2640 </div>
2641 </dd>
2642 </dl>
2643 </div>
2644 </div>
2657 </dl>
2661 the grep.exe from the UnxUtils project
2662 (<a class="reference external" href="http://sourceforge.net/projects/unxutils">http://sourceforge.net/projects/unxutils</a>). The grep.exe from the
2663 Mingw project for instance might not work with Geany at the moment.</p>
2664 </div>
2665 </div>
2670 <dd>Set this to a command to execute on the current word.
2672 to the specified command.</dd>
2673 </dl>
2674 </div>
2675 </div>
2678 <p>This data is used as meta data for various template text to insert into
2679 a document, such as the file header. You only need to set fields that
2680 you want to use in your template files.</p>
2693 <p class="last">You may wish to add anti-spam markup, e.g. <tt class="docutils literal">name<at>site<dot>ext</tt>.</p>
2694 </div>
2695 </dd>
2701 <dd>Specify a format for the the {year} wildcard. You can use any conversion specifiers
2702 which can be used with the ANSI C strftime function. For details please see
2705 <dd>Specify a format for the the {date} wildcard. You can use any conversion specifiers
2706 which can be used with the ANSI C strftime function. For details please see
2709 <dd>Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
2710 which can be used with the ANSI C strftime function. For details please see
2712 </dl>
2713 </div>
2714 </div>
2718 <p>There are some commands listed in the keybinding dialog that are not, by default,
2719 bound to a key combination, and may not be available as a menu item.</p>
2722 <p class="last">For more information see the section <a class="reference internal" href="#keybindings">Keybindings</a>.</p>
2723 </div>
2724 </div>
2742 <dd>How the date should be printed. You can use the same format
2743 specifiers as in the ANSI C function strftime(). For details please
2744 see <a class="reference external" href="http://man.cx/strftime">http://man.cx/strftime</a>.</dd>
2745 </dl>
2746 </div>
2750 <p>Rarely used preferences, explained in the table below. A few of them require
2751 restart to take effect, and a few other will only affect newly opened or created
2752 documents before restart.</p>
2754 <colgroup>
2759 </colgroup>
2765 </tr>
2766 </thead>
2772 </tr>
2774 <td>Whether to look for the end of a word
2775 when using word-boundary related
2776 Scintilla commands (see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla
2779 <td>to new
2780 documents</td>
2781 </tr>
2786 </tr>
2788 <td>Whether to allow completion of snippets
2789 when editing an existing line (i.e. there
2790 is some text after the current cursor
2791 position on the line). Only used when the
2796 </tr>
2798 <td>Whether to display scrollbars. If set to
2799 false, the horizontal and vertical
2800 scrollbars are hidden completely.</td>
2803 </tr>
2805 <td>The size of a tab character. Don't change
2806 it unless you really need to; use the
2807 indentation settings instead.</td>
2810 </tr>
2815 </tr>
2817 <td>Whether to show or hide the small
2818 expander icons on the symbol list</td>
2820 <td>to new
2821 documents</td>
2822 </tr>
2824 <td>treeview. Whether files can be saved
2825 always, even if they don't have any
2826 changes. By default, the Save button and
2827 menu item are disabled when a file is
2828 unchanged. When setting this option to
2829 true, the Save button and menu item are
2830 always active and files can be saved.</td>
2833 </tr>
2835 <td>Whether to automatically scroll to the
2836 last line of the output in the Compiler
2837 tab.</td>
2840 </tr>
2842 <td>The status bar statistics line format.
2843 (Search in src/ui_utils.c for details).</td>
2846 </tr>
2848 <td>Whether to open a new document after all
2849 documents have been closed.</td>
2852 </tr>
2854 <td>Whether to show the Status tab in the
2855 Messages Window</td>
2858 </tr>
2860 <td>Whether to show the Compiler tab in the
2861 Messages Window</td>
2864 </tr>
2866 <td>Whether to show the Messages tab in the
2867 Messages Window</td>
2870 </tr>
2872 <td>Whether to show the Scribble tab in the
2873 Messages Window</td>
2876 </tr>
2877 </tbody>
2878 </table>
2879 <p>By default, statusbar_template is empty. This tells Geany to use its
2880 internal default, which is currently:</p>
2881 <p><tt class="docutils literal">line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S</tt></p>
2884 <colgroup>
2889 </colgroup>
2895 </tr>
2896 </thead>
2902 </tr>
2904 <td>Terminal emulation mode. Only change this
2905 if you have VTE termcap files other than
2909 </tr>
2911 <td>By default, Geany strips any trailing
2912 newline characters from the current
2913 selection before sending it to the terminal
2914 to not execute arbitrary code. This is
2915 mainly a security feature.
2916 If, for whatever reasons, you really want
2917 it to be executed directly, set this option
2918 to true.</td>
2921 </tr>
2926 </tr>
2928 <td>Defines the mode how Geany saves files to
2929 disk. If disabled, Geany directly writes
2930 the content of the document to disk. This
2931 might cause loss of data when there is
2932 no more free space on disk to save the
2933 file. When set to true, Geany first saves
2934 the contents into a temporary file and if
2935 this succeeded, the temporary file is
2936 moved to the real file to save.
2937 This gives better error checking in case of
2938 no more free disk space. But it also
2939 destroys hard links of the original file
2940 and its permissions (e.g. executable flags
2941 are reset). Use this with care as it can
2942 break things seriously.
2943 The better approach would be to ensure your
2944 disk won't run out of free space.</td>
2947 </tr>
2949 <td>Whether to use GIO as the unsafe file
2950 saving backend. It is better on most
2951 situations but is known not to work
2952 correctly on some complex setups.</td>
2955 </tr>
2957 <td>Make a backup when using GIO unsafe file
2961 </tr>
2966 </tr>
2968 <td>Regex to extract filetype name from file
2969 via capture group one.</td>
2972 </tr>
2977 </tr>
2982 </tr>
2987 </tr>
2989 <td>The maximum number of menu items in the
2990 filetype section of the Build menu.</td>
2993 </tr>
2995 <td>The maximum number of menu items in the
2996 independent section of the Build menu.</td>
2999 </tr>
3001 <td>The maximum number of menu items in the
3002 execute section of the Build menu.</td>
3005 </tr>
3006 </tbody>
3007 </table>
3009 </div>
3012 <p>See also: <a class="reference internal" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
3038 <dd>Make the path of the terminal change according to the path of the
3039 current file.</dd>
3041 <dd>Execute programs in the virtual terminal instead of using the external
3042 terminal tool. Note that if you run multiple execute commands at once
3043 the output may become mixed together in the VTE.</dd>
3045 <dd>Don't use the simple run script which is usually used to display
3046 the exit status of the executed program.
3047 This can be useful if you already have a program running in the VTE
3048 like a Python console (e.g. ipython). Use this with care.</dd>
3049 </dl>
3050 </div>
3051 </div>
3052 </div>
3060 </ul>
3061 <p>A list of session files can be stored and opened with the project
3063 in the <em>Project</em> group of the <a class="reference internal" href="#preferences">Preferences</a> dialog.</p>
3064 <p>As long as a project is open, the Build menu will use
3065 the items defined in project's settings, instead of the defaults.
3066 See <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a> for information on configuring the menu.</p>
3067 <p>The current project's settings are saved when it is closed, or when
3068 Geany is shutdown. When restarting Geany, the previously opened project
3069 file that was in use at the end of the last session will be reopened.</p>
3074 will setup a new project file <tt class="docutils literal">~/projects/name.geany</tt>. Usually it's
3075 best to store all your project files in the same directory (they are
3076 independent of any source directory trees).</p>
3077 <p>The Base path text field is setup to use <tt class="docutils literal">~/projects/name</tt>. This
3078 can safely be set to any existing path -- it will not touch the file
3079 structure contained in it.</p>
3080 </div>
3083 <p>You can set an optional description for the project. Currently it's
3084 only used for a template wildcard - see <a class="reference internal" href="#template-wildcards">Template wildcards</a>.</p>
3086 The specified path can be an absolute path or it is considered to be
3087 relative to the project's file name.</p>
3089 project, which can be used in the <a class="reference internal" href="#find-in-files">Find in files</a> dialog.</p>
3092 </div>
3095 <p>The Open command displays a standard file chooser, starting in
3096 <tt class="docutils literal">~/projects</tt>. Choose a project file named with the <tt class="docutils literal">.geany</tt>
3097 extension.</p>
3098 <p>When project session support is enabled, Geany will close the currently
3099 open files and open the session files associated with the project.</p>
3100 </div>
3104 <p>When project session support is enabled, Geany will close the project
3105 session files and open any previously closed default session files.</p>
3106 </div>
3107 </div>
3110 <p>After editing code with Geany, the next step is to compile, link, build,
3111 interpret, run etc. As Geany supports many languages each with a different
3112 approach to such operations, and as there are also many language independent
3113 software building systems, Geany does not have a built-in build system, nor
3114 does it limit which system you can use. Instead the build menu provides
3115 a configurable and flexible means of running any external commands to
3116 execute your preferred build system.</p>
3117 <p>This section provides a description of the default configuration of the
3118 build menu and then covers how to configure it, and where the defaults fit in.</p>
3122 <li>The output is captured in the Compiler notebook tab and parsed for
3123 warnings or errors.</li>
3124 </ul>
3125 <p>Warnings and errors that can be parsed for line numbers will be shown in
3126 red in the Compiler tab and you can click on them to switch to the relevant
3127 source file (or open it) and mark the line number. Also lines with
3128 warnings or errors are marked in the source, see <a class="reference internal" href="#indicators">Indicators</a> below.</p>
3132 the tool you're using, you can set a custom regex in the Build Commands
3133 Dialog, see <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>.</p>
3134 </div>
3137 <p>Indicators are red squiggly underlines which are used to highlight
3138 errors which occurred while compiling the current file. So you can
3139 easily see where your code failed to compile. You can remove them by
3141 <p>If you do not like this feature, you can disable it - see <a class="reference internal" href="#editor-features-preferences">Editor Features
3143 </div>
3146 <p>Depending on the current file's filetype, the default Build menu will contain
3147 the following items:</p>
3158 </ul>
3162 <p>For compilable languages such as C and C++, the Compile command is
3163 set up to compile the current source file into a binary object file.</p>
3165 <p>Interpreted languages such as Perl, Python, Ruby will compile to
3166 bytecode if the language supports it, or will run a syntax check,
3167 or if that is not available will run the file in its language interpreter.</p>
3168 </div>
3171 <p>For compilable languages such as C and C++, the Build command will link
3172 the current source file's equivalent object file into an executable. If
3173 the object file does not exist, the source will be compiled and linked
3174 in one step, producing just the executable binary.</p>
3179 different settings, then writing a Makefile and using the Make
3180 commands is recommended; this will also make it easier for users to
3181 build your software.</p>
3182 </div>
3183 </div>
3187 current file.</p>
3188 </div>
3191 <p>This is similar to running 'Make' but you will be prompted for
3192 the make target name to be passed to the Make tool. For example,
3194 </div>
3198 the current file, using the filename for 'current_file'. It is useful
3199 for building just the current file without building the whole project.</p>
3200 </div>
3204 </div>
3208 </div>
3211 <p>Execute will run the corresponding executable file, shell script or
3212 interpreted script in a terminal window. Note that the Terminal tool
3213 path must be correctly set in the Tools tab of the Preferences dialog -
3214 you can use any terminal program that runs a Bourne compatible shell
3216 selected to use the built-in VTE if it is available - see
3217 <a class="reference internal" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
3218 <p>After your program or script has finished executing, you will be
3219 prompted to press the return key. This allows you to review any text
3220 output from the program before the terminal window is closed.</p>
3224 </div>
3225 </div>
3228 <p>When there is a running program, the Execute menu item in the menu and
3229 the Run button in the toolbar
3230 each become a stop button so you can stop the current running program (and
3231 any child processes). This works by sending the SIGQUIT signal to the process.</p>
3232 <p>Depending on the process you started it is possible that the process
3233 cannot be stopped. For example this can happen when the process creates
3234 more than one child process.</p>
3238 (the terminal program of Xfce), you should add the command line
3239 option <tt class="docutils literal"><span class="pre">--disable-server</span></tt> otherwise the started process cannot be
3240 stopped. Just add this option in the preferences dialog on the Tools
3241 tab in the terminal field.</p>
3242 </div>
3243 </div>
3246 <p>By default Compile, Build and Execute are fairly basic commands. You
3248 <p>E.g. for C you can add any include paths and compile flags for the
3249 compiler, any library names and paths for the linker, and any
3250 arguments you want to use when running Execute.</p>
3251 </div>
3252 </div>
3255 <p>The build menu has considerable flexibility and configurability, allowing
3256 both menu labels the commands they execute and the directory they execute
3257 in to be configured.</p>
3258 <p>For example, if you change one of the default make commands to run say 'waf'
3259 you can also change the label to match.</p>
3261 <p>The build menu is divided into four groups of items each with different
3262 behaviors:</p>
3264 <li>Filetype build commands - are configurable and depend on the filetype of the
3265 current document; they capture output in the compiler tab and parse it for
3266 errors.</li>
3267 <li>Independent build commands - are configurable and mostly don't depend on the
3268 filetype of the current document; they also capture output in the
3269 compiler tab and parse it for errors.</li>
3270 <li>Execute commands - are configurable and intended for executing your
3271 program or other long running programs. The output is not parsed for errors
3272 and is directed to the terminal selected in preferences.</li>
3277 </ul>
3278 </li>
3279 </ul>
3280 <p>The maximum numbers of items in each of the configurable groups can be
3281 configured in the <a class="reference internal" href="#various-preferences">Various preferences</a>. Even though the maximum number of
3282 items may have been increased, only those menu items that have values
3283 configured are shown in the menu.</p>
3284 <p>The groups of menu items obtain their configuration from four potential
3285 sources. The highest priority source that has the menu item defined will
3286 be used. The sources in decreasing priority are:</p>
3292 </ul>
3293 <p>The detailed relationships between sources and the configurable menu item groups
3294 is shown in the following table.</p>
3296 <colgroup>
3302 </colgroup>
3309 </tr>
3310 </thead>
3314 file</p>
3316 file</p>
3317 </td>
3319 filetypes.xxx file in
3320 ~/.config/geany/filedefs</p>
3322 creating if needed.</p>
3323 </td>
3325 filetypes.xxx in
3326 Geany install</p>
3328 preferences left.</p>
3329 </td>
3331 </tr>
3332 <tr><td>Filetype
3333 Independent</td>
3335 file</p>
3337 file</p>
3338 </td>
3340 geany.conf file in
3341 ~/.config/geany</p>
3343 creating if needed.</p>
3344 </td>
3346 filetypes.xxx in
3347 Geany install</p>
3349 preferences left.</p>
3350 </td>
3353 <dd>Label: _Make
3354 Command: make</dd>
3356 <dd>Label: Make Custom _Target
3357 Command: make</dd>
3359 <dd>Label: Make _Object
3360 Command: make %e.o</dd>
3361 </dl>
3362 </td>
3363 </tr>
3366 file or else
3367 filetype defined in
3368 project file</p>
3370 project file</p>
3371 </td>
3373 geany.conf file in
3374 ~/.config/geany or else
3375 filetypes.xxx file in
3376 ~/.config/geany/filedefs</p>
3378 filetypes.xxx file in
3379 ~/.config/geany/filedefs</p>
3380 </td>
3382 filetypes.xxx in
3383 Geany install</p>
3385 preferences left.</p>
3386 </td>
3387 <td>Label: _Execute
3388 Command: ./%e</td>
3389 </tr>
3390 </tbody>
3391 </table>
3394 <li>General - for filetypes.xxx substitute the appropriate extension for
3395 the filetype of the current document for xxx - see <a class="reference internal" href="#filenames">filenames</a>.</li>
3396 <li>System Filetypes - Labels loaded from these sources are locale sensitive
3397 and can contain translations.</li>
3398 <li>(Filetype, Project File) and (Filetype, Preferences) - preferences use a full
3399 filetype file so that users can configure all other filetype preferences
3400 as well. Projects can only configure menu items per filetype. Saving
3401 in the project file means that there is only one file per project not
3402 a whole directory.</li>
3403 <li>(Filetype-Independent, System Filetype) - although conceptually strange, defining
3404 filetype-independent commands in a filetype file, this provides the ability to
3405 define filetype dependent default menu items.</li>
3406 <li>(Execute, Project File) and (Execute, Preferences) - the project independent
3407 execute and preferences independent execute commands can only be set by hand
3408 editing the appropriate file, see <a class="reference internal" href="#preferences-file-format">Preferences file format</a> and <a class="reference internal" href="#project-file-format">Project file
3410 </ul>
3411 </div>
3414 <p>Most of the configuration of the build menu is done through the Build Menu
3415 Commands Dialog. You edit the configuration sourced from preferences in the
3416 dialog opened from the Build->Build Menu Commands item and you edit the
3417 configuration from the project in the build tab of the project preferences
3418 dialog. Both use the same form shown below.</p>
3419 <img alt="./images/build_menu_commands_dialog.png" src="./images/build_menu_commands_dialog.png" />
3425 </ul>
3426 <p>The filetype and independent sections also each contain a field for the regular
3427 expression used for parsing command output for error and warning messages.</p>
3428 <p>The columns in the first three sections allow setting of the label, command,
3429 and working directory to run the command in.</p>
3431 <p>An empty working directory will default to the directory of the current document.
3432 If there is no current document then the command will not run.</p>
3433 <p>The dialog will always show the command selected by priority, not just the
3434 commands configured in this configuration source. This ensures that you always
3435 see what the menu item is going to do if activated.</p>
3436 <p>If the current source of the menu item is higher priority than the
3437 configuration source you are editing then the command will be shown
3438 in the dialog but will be insensitive (greyed out). This can't happen
3439 with the project source but can with the preferences source dialog.</p>
3440 <p>The clear buttons remove the definition from the configuration source you are editing.
3441 When you do this the command from the next lower priority source will be shown.
3442 To hide lower priority menu items without having anything show in the menu
3443 configure with a nothing in the label but at least one character in the command.</p>
3445 <h4><a class="toc-backref" href="#id149">Substitutions in commands and working directories</a></h4>
3446 <p>The first occurence of each of the following character sequences in each of the
3447 command and working directory fields is substituted by the items specified below
3448 before the command is run.</p>
3454 </ul>
3457 <p class="last">If the basepath set in the project preferences is not an absolute path , then it is
3458 taken as relative to the directory of the project file. This allows a project file
3459 stored in the source tree to specify all commands and working directories relative
3460 to the tree itself, so that the whole tree including the project file, can be moved
3461 and even checked into and out of version control without having to re-configure the
3462 build menu.</p>
3463 </div>
3464 </div>
3467 <p>Keyboard shortcuts can be defined for the first two filetype menu items, the first three
3468 independent menu items, the first two execute menu items and the fixed menu items.
3469 In the keybindings configuration dialog (see <a class="reference internal" href="#keybinding-preferences">Keybinding preferences</a>)
3470 these items are identified by the default labels shown in the <a class="reference internal" href="#build-menu">Build Menu</a> section above.</p>
3473 </div>
3477 required a new section to be added to the configuration files (See
3478 <a class="reference internal" href="#preferences-file-format">Preferences file format</a>). Geany will still load older format project,
3479 preferences and filetype file settings and will attempt to map them into the new
3480 configuration format. There is not a simple clean mapping between the formats.
3481 The mapping used produces the most sensible results for the majority of cases.
3482 However, if they do not map the way you want, you may have to manually
3483 configure some settings using the Build Commands
3484 Dialog or the Build tab of the project preferences dialog.</p>
3485 <p>Any setting configured in either of these dialogs will override settings mapped from
3486 older format configuration files.</p>
3487 </div>
3488 </div>
3489 </div>
3493 The printed page(s) will look nearly the same as on your screen in Geany.
3494 Additionally, there are some options to modify the printed page(s).</p>
3498 a white foreground. This allows dark color schemes to save ink
3499 when printing.</p>
3500 </div>
3501 <p>You can define whether to print line numbers, page numbers at the bottom of
3502 each page and whether to print a page header on each page. This header
3503 contains the filename of the printed document, the current page number and
3504 the date and time of printing. By default, the file name of the document
3505 with full path information is added to the header. If you prefer to add
3506 only the basename of the file(without any path information) you can set it
3507 in the preferences dialog. You can also adjust the format of the date and
3508 time added to the page header. The available conversion specifiers are the
3509 same as the ones which can be used with the ANSI C strftime function.</p>
3510 <p>All of these settings can also be changed in the print dialog just before
3511 actual printing is done.
3512 On Unix-like systems the provided print dialog offers a print preview. The
3513 preview file is opened with a PDF viewer and by default GTK uses <tt class="docutils literal">evince</tt>
3514 for print preview. If you have not installed evince or just want to use
3515 another PDF viewer, you can change the program to use in the file
3516 <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home directory). Simply add a line
3517 like:</p>
3520 </pre>
3521 <p>at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3522 as the print preview command.</p>
3523 <p>Geany also provides an alternative basic printing support using a custom
3524 print command. However, the printed document contains no syntax highlighting.
3525 You can adjust the command to which the filename is passed in the preferences
3526 dialog. The default command is:</p>
3528 % lpr %f
3529 </pre>
3530 <p><tt class="docutils literal">%f</tt> will be substituted by the filename of the current file. Geany
3531 will not show errors from the command itself, so you should make
3532 sure that it works before(e.g. by trying to execute it from the
3533 command line).</p>
3536 % a2ps -1 --medium=A4 -o - %f | xfprint4
3537 </pre>
3538 <p>But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3539 gtklp or similar programs can be used.</p>
3540 </div>
3544 general preference is set. There is also a command-line option,
3545 <tt class="docutils literal"><span class="pre">-p</span></tt>, which prevents plugins being loaded. Plugins are scanned in
3546 the following directories:</p>
3548 <li><tt class="docutils literal">$prefix/lib/geany</tt> (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>)</li>
3549 <li>The <tt class="docutils literal">plugins</tt> subfolder of the user configuration directory - see
3550 <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</li>
3551 <li>The <cite>Extra plugin path</cite> preference (usually blank) - see <a class="reference internal" href="#paths">Paths</a>.</li>
3552 </ul>
3554 <p>See also <a class="reference internal" href="#plugin-documentation">Plugin documentation</a> for information about single plugins
3555 which are included in Geany.</p>
3558 <p>The Plugin Manager dialog lets you choose which plugins
3559 should be loaded at startup. You can also load and unload plugins on the
3560 fly using this dialog. Once you click the checkbox for a specific plugin
3561 in the dialog, it is loaded or unloaded according to its previous state.
3562 By default, no plugins are loaded at startup until you select some.
3563 You can also configure some plugin specific options if the plugin
3564 provides any.</p>
3565 </div>
3566 </div>
3569 <p>Geany supports the default keyboard shortcuts for the Scintilla
3570 editing widget. For a list of these commands, see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla
3571 keyboard commands</a>. The Scintilla keyboard shortcuts will be overridden
3572 by any custom keybindings with the same keyboard shortcut.</p>
3575 <p>There are a few non-configurable bindings to switch between documents,
3576 listed below. These can also be overridden by custom keybindings.</p>
3578 <colgroup>
3581 </colgroup>
3585 </tr>
3586 </thead>
3590 </tr>
3593 </tr>
3596 </tr>
3599 </tr>
3600 </tbody>
3601 </table>
3602 </div>
3605 <p>For all actions listed below you can define your own keybindings. Open
3606 the Preferences dialog, select the desired action and click on
3607 change. In the resulting dialog you can press the key combination you
3608 want to assign to the action and it will be saved when you press OK.
3609 You can define only one key combination for each action and each key
3610 combination can only be defined for one action.</p>
3611 <p>Some of the default key combinations are common across many
3613 Because they are so common it is not advisable to change these, but
3614 you can add other key combinations for these actions. For example
3618 <p>The following tables list all customizable keyboard shortcuts, those
3619 which are common to many applications are marked with (C) after the
3620 shortcut.</p>
3624 <colgroup>
3628 </colgroup>
3633 </tr>
3634 </thead>
3639 </tr>
3643 </tr>
3647 </tr>
3651 </tr>
3655 </tr>
3659 </tr>
3663 </tr>
3667 </tr>
3671 </tr>
3674 <td>Reloads the current file. All unsaved changes
3675 will be lost.</td>
3676 </tr>
3680 </tr>
3681 </tbody>
3682 </table>
3683 </div>
3687 <colgroup>
3691 </colgroup>
3696 </tr>
3697 </thead>
3702 </tr>
3706 </tr>
3709 <td>Deletes the current line (and any lines with a
3710 selection).</td>
3711 </tr>
3714 <td>Deletes from the current caret position to the
3715 end of the current line.</td>
3716 </tr>
3720 </tr>
3724 </tr>
3727 <td>Scrolls the current line into the centre of the
3728 view. The cursor position and or an existing
3729 selection will not be changed.</td>
3730 </tr>
3734 </tr>
3738 </tr>
3741 <td>Shows the autocompletion list. If already showing
3742 tag completion, it shows document word completion
3743 instead, even if it is not enabled for automatic
3744 completion. Likewise if no tag suggestions are
3745 available, it shows document word completion.</td>
3746 </tr>
3749 <td>Shows a calltip for the current function or
3750 method.</td>
3751 </tr>
3754 <td>Shows a list of available macros and variables in
3755 the workspace.</td>
3756 </tr>
3759 <td>If you type a construct like if or for and press
3760 this key, it will be completed with a matching
3761 template.</td>
3762 </tr>
3765 <td>If you type a construct like if or for and press
3766 this key, it will not be completed, and a space or
3767 tab will be inserted, depending on what the
3768 construct completion keybinding is set to. For
3769 example, if you have set the construct completion
3770 keybinding to space, then setting this to
3771 Shift+space will prevent construct completion and
3772 insert a space.</td>
3773 </tr>
3776 <td>Executes a command and passes the current word
3777 (near the cursor position) or selection as an
3780 </tr>
3783 <td>Jumps to the next defined cursor positions in a
3784 completed snippets if multiple cursor positions
3785 where defined.</td>
3786 </tr>
3789 <td>When the autocompletion list is visible, complete
3790 the currently selected item up to the next word
3791 part.</td>
3792 </tr>
3795 <td>Move the current line or selected lines up by
3796 one line.</td>
3797 </tr>
3800 <td>Move the current line or selected lines down by
3801 one line.</td>
3802 </tr>
3803 </tbody>
3804 </table>
3805 </div>
3809 <colgroup>
3813 </colgroup>
3818 </tr>
3819 </thead>
3824 </tr>
3828 </tr>
3832 </tr>
3835 <td>Cuts the current line (and any lines with a
3836 selection) to the clipboard.</td>
3837 </tr>
3840 <td>Copies the current line (and any lines with a
3841 selection) to the clipboard.</td>
3842 </tr>
3843 </tbody>
3844 </table>
3845 </div>
3849 <colgroup>
3853 </colgroup>
3858 </tr>
3859 </thead>
3863 <td>Makes a selection of all text in the current
3864 document.</td>
3865 </tr>
3869 </tr>
3872 <td>Selects the current paragraph under the cursor
3873 which is defined by two empty lines around it.</td>
3874 </tr>
3877 <td>Selects the current line under the cursor (and any
3878 partially selected lines).</td>
3879 </tr>
3883 </tr>
3887 </tr>
3888 </tbody>
3889 </table>
3890 </div>
3894 <colgroup>
3898 </colgroup>
3903 </tr>
3904 </thead>
3909 </tr>
3912 <td>Inserts a tab character when spaces should
3913 be used for indentation and inserts space
3914 characters of the amount of a tab width when
3915 tabs should be used for indentation.</td>
3916 </tr>
3920 </tr>
3924 </tr>
3925 </tbody>
3926 </table>
3927 </div>
3931 <colgroup>
3935 </colgroup>
3940 </tr>
3941 </thead>
3945 <td>Changes the case of the selection. A lowercase
3946 selection will be changed into uppercase and vice
3947 versa. If the selection contains lower- and
3948 uppercase characters, all will be converted to
3949 lowercase.</td>
3950 </tr>
3954 </tr>
3958 </tr>
3961 <td>Comments a line if it is not commented or removes
3962 a comment if the line is commented.</td>
3963 </tr>
3966 <td>Indents the current line or selection by one tab
3967 or by spaces in the amount of the tab width
3968 setting.</td>
3969 </tr>
3972 <td>Removes one tab or the amount of spaces of
3973 the tab width setting from the indentation of the
3974 current line or selection.</td>
3975 </tr>
3978 <td>Indents the current line or selection by one
3979 space.</td>
3980 </tr>
3983 <td>Deindents the current line or selection by one
3984 space.</td>
3985 </tr>
3988 <td>Indents the current line or all selected lines
3989 with the same indentation as the previous line.</td>
3990 </tr>
3993 <td>Passes the current selection to a configured
3994 external command (available for the first
3995 three configured commands, see
3996 <a class="reference internal" href="#sending-text-through-custom-commands">Sending text through custom commands</a> for
3997 details).</td>
3998 </tr>
4001 <td>Sends the current selection or the current
4002 line (if there is no selection) to the
4003 embedded Terminal (VTE).</td>
4004 </tr>
4007 <td>Reformat selected lines or current
4008 (indented) text block,
4009 breaking lines at the long line marker or the
4010 line breaking column if line breaking is
4011 enabled for the current document.</td>
4012 </tr>
4013 </tbody>
4014 </table>
4015 </div>
4019 <colgroup>
4023 </colgroup>
4028 </tr>
4029 </thead>
4034 </tr>
4038 </tr>
4039 </tbody>
4040 </table>
4041 </div>
4045 <colgroup>
4049 </colgroup>
4054 </tr>
4055 </thead>
4060 </tr>
4064 </tr>
4068 </tr>
4072 </tr>
4076 </tr>
4080 </tr>
4084 </tr>
4087 <td>Jumps to the line with the next message in
4088 the Messages window.</td>
4089 </tr>
4092 <td>Jumps to the line with the previous message
4093 in the Messages window.</td>
4094 </tr>
4097 <td>Finds all occurrences of the current word (near
4098 the keyboard cursor) or selection in all open
4099 documents and displays them in the messages
4100 window.</td>
4101 </tr>
4104 <td>Finds all occurrences of the current word (near
4105 the keyboard cursor) or selection in the current
4106 document and displays them in the messages
4107 window.</td>
4108 </tr>
4111 <td>Highlight all matches of the current
4112 word/selection in the current document
4113 with a colored box. If there's nothing to
4114 find, highlighted matches will be cleared.</td>
4115 </tr>
4116 </tbody>
4117 </table>
4118 </div>
4122 <colgroup>
4126 </colgroup>
4131 </tr>
4132 </thead>
4136 <td>Switches to the next location in the navigation
4137 history. See the section called <a class="reference internal" href="#code-navigation-history">Code Navigation
4139 </tr>
4142 <td>Switches to the previous location in the
4143 navigation history. See the section called
4144 <a class="reference internal" href="#code-navigation-history">Code navigation history</a>.</td>
4145 </tr>
4148 <td>Focuses the Go to Line entry (if visible) or
4149 shows the Go to line dialog.</td>
4150 </tr>
4153 <td>If the cursor is ahead or behind a brace, then it
4154 is moved to the brace which belongs to the current
4155 one. If this keyboard shortcut is pressed again,
4156 the cursor is moved back to the first brace.</td>
4157 </tr>
4160 <td>Set a marker on the current line, or clear the
4161 marker if there already is one.</td>
4162 </tr>
4166 </tr>
4170 </tr>
4173 <td>Jump to the definition of the current word (near
4174 the keyboard cursor). If the definition cannot be
4175 found (e.g. the relevant file is not open) Geany
4176 will beep and do nothing. See the section called
4178 </tr>
4181 <td>Jump to the declaration of the current word (near
4182 the keyboard cursor). If the declaration cannot be
4183 found (e.g. the relevant file is not open) Geany
4184 will beep and do nothing. See the section called
4186 </tr>
4189 <td>Move the caret to the end of the line indentation
4190 unless it is already there, in which case it moves
4191 it to the start of the line.</td>
4192 </tr>
4196 </tr>
4199 <td>Move the caret to the end of the display line.
4200 This is useful when you use line wrapping and
4201 want to jump to the end of the wrapped, virtual
4202 line, not the real end of the whole line.
4203 If the line is not wrapped, it behaves like
4205 </tr>
4209 </tr>
4213 </tr>
4214 </tbody>
4215 </table>
4216 </div>
4220 <colgroup>
4224 </colgroup>
4229 </tr>
4230 </thead>
4235 </tr>
4238 <td>Toggles the message window (status and compiler
4239 messages) on and off.</td>
4240 </tr>
4244 </tr>
4247 <td>Hide and show all additional widgets like the
4248 notebook tabs, the toolbar, the messages window
4249 and the status bar.</td>
4250 </tr>
4254 </tr>
4258 </tr>
4262 </tr>
4263 </tbody>
4264 </table>
4265 </div>
4269 <colgroup>
4273 </colgroup>
4278 </tr>
4279 </thead>
4283 <td>Switches to editor widget.
4284 Also reshows the document statistics line
4285 (after a short timeout).</td>
4286 </tr>
4289 <td>Switches to the search bar in the toolbar (if
4290 visible).</td>
4291 </tr>
4295 </tr>
4299 </tr>
4303 </tr>
4307 </tr>
4311 </tr>
4315 </tr>
4318 <td>Focus the Symbol list tab in the Sidebar
4319 (if visible).</td>
4320 </tr>
4323 <td>Focus the Document list tab in the Sidebar
4324 (if visible).</td>
4325 </tr>
4326 </tbody>
4327 </table>
4328 </div>
4332 <colgroup>
4336 </colgroup>
4341 </tr>
4342 </thead>
4347 </tr>
4351 </tr>
4354 <td>Switches to the previously shown document (if it's
4355 still open).
4356 Holding Ctrl (or another modifier if the keybinding
4357 has been changed) will show a dialog, then repeated
4358 presses of the keybinding will switch to the 2nd-last
4359 used document, 3rd-last, etc. Also known as
4360 Most-Recently-Used documents switching.</td>
4361 </tr>
4364 <td>Changes the current document with the left hand
4365 one.</td>
4366 </tr>
4369 <td>Changes the current document with the right hand
4370 one.</td>
4371 </tr>
4375 </tr>
4379 </tr>
4380 </tbody>
4381 </table>
4382 </div>
4386 <colgroup>
4390 </colgroup>
4395 </tr>
4396 </thead>
4401 </tr>
4405 </tr>
4409 </tr>
4413 </tr>
4417 </tr>
4421 </tr>
4425 </tr>
4428 <td>Enables or disables automatic breaking of long
4429 lines at a configurable column.</td>
4430 </tr>
4433 <td>Remove any markers on lines or words which
4434 were set by using 'Mark All' in the
4435 search dialog or by manually marking lines.</td>
4436 </tr>
4439 <td>Remove any error indicators in the
4440 current document.</td>
4441 </tr>
4446 </tr>
4447 </tbody>
4448 </table>
4449 </div>
4453 <colgroup>
4457 </colgroup>
4462 </tr>
4463 </thead>
4468 </tr>
4471 <td>Builds (compiles if necessary and links) the
4472 current file.</td>
4473 </tr>
4477 </tr>
4480 <td>Builds the current file with the Make tool and a
4481 given target.</td>
4482 </tr>
4486 </tr>
4489 <td>Jumps to the line with the next error from the
4490 last build process.</td>
4491 </tr>
4494 <td>Jumps to the line with the previous error from
4495 the last build process.</td>
4496 </tr>
4500 </tr>
4504 </tr>
4505 </tbody>
4506 </table>
4507 </div>
4511 <colgroup>
4515 </colgroup>
4520 </tr>
4521 </thead>
4526 </tr>
4527 </tbody>
4528 </table>
4529 </div>
4533 <colgroup>
4537 </colgroup>
4542 </tr>
4543 </thead>
4548 </tr>
4549 </tbody>
4550 </table>
4551 </div>
4552 </div>
4553 </div>
4554 </div>
4560 </div>
4563 <p>Geany has default configuration files installed for the system and
4564 also per-user configuration files.</p>
4565 <p>The system files should not normally be edited because they will be
4566 overwritten when upgrading Geany.</p>
4567 <p>The user configuration directory can be overridden with the <tt class="docutils literal"><span class="pre">-c</span></tt>
4568 switch, but this is not normally done. See <a class="reference internal" href="#command-line-options">Command line options</a>.</p>
4572 will be created when Geany starts.</p>
4573 </div>
4577 Geany-INFO: System data dir: /usr/share/geany
4578 Geany-INFO: User config dir: /home/username/.config/geany
4579 </pre>
4582 <p>The system path is <tt class="docutils literal">$prefix/share/geany</tt>, where <tt class="docutils literal">$prefix</tt> is the
4583 path where Geany is installed (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>).</p>
4584 <p>The user configuration directory is normally
4586 </div>
4587 </div>
4591 contains items for some of the available user configuration files.
4592 Clicking on one opens it in the editor for you to update. Geany will
4593 reload the file after you have saved it.</p>
4597 manually, and will not be automatically reloaded when saved.
4599 </div>
4601 updated one of the other configuration files, or modified or added
4602 template files.</p>
4607 saving filetypes.common as this may take a significant
4608 amount of time.</p>
4609 </div>
4610 </div>
4613 <p>System administrators can add a global configuration file for Geany
4614 which will be used when starting Geany and a user configuration file
4615 does not exist.</p>
4616 <p>The global configuration file is read from <tt class="docutils literal">geany.conf</tt> in the
4617 system configuration path - see <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>. It can
4618 contain any settings which are found in the usual configuration file
4619 created by Geany, but does not have to contain all settings.</p>
4623 admins who want to set up Geany in a multi user environment and
4624 set some sane default values for this environment. Usually users won't
4625 need to do that.</p>
4626 </div>
4627 </div>
4630 <p>All color definitions and other filetype specific settings are
4631 stored in the filetype definition files. Those settings are colors
4632 for syntax highlighting, general settings like comment characters or
4633 word delimiter characters as well as compiler and linker settings.</p>
4634 <p>See also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
4637 <p>Each filetype has a corresponding filetype definition file. The format
4640 filetypes.foo
4641 </pre>
4645 <colgroup>
4648 </colgroup>
4652 </tr>
4653 </thead>
4657 </tr>
4660 </tr>
4663 </tr>
4666 </tr>
4667 </tbody>
4668 </table>
4669 <p>There is also the <a class="reference internal" href="#special-file-filetypes-common">special file filetypes.common</a>.</p>
4670 <p>For <a class="reference internal" href="#custom-filetypes">custom filetypes</a>, the filename for <cite>Foo</cite> is different:</p>
4672 filetypes.Foo.conf
4673 </pre>
4675 </div>
4678 <p>The system-wide filetype configuration files can be found in the
4679 system configuration path and are called <tt class="docutils literal"><span class="pre">filetypes.$ext</span></tt>,
4680 where $ext is the name of the filetype. For every
4681 filetype there is a corresponding definition file. There is one
4682 exception: <tt class="docutils literal">filetypes.common</tt> -- this file is for general settings,
4683 which are not specific to a certain filetype.</p>
4687 because they will be overridden when Geany is updated.</p>
4688 </div>
4689 </div>
4692 <p>To change the settings, copy a file from the system configuration
4694 directory. Then you can edit the file and the changes will still be
4695 available after an update of Geany.</p>
4696 <p>Alternatively, you can create the file yourself and add only the
4697 settings you want to change. All missing settings will be read from
4698 the corresponding system configuration file.</p>
4699 </div>
4702 <p>At startup Geany looks for <tt class="docutils literal"><span class="pre">filetypes.*.conf</span></tt> files in the system and
4703 user filetype paths, adding any filetypes found with the name matching
4704 the '<tt class="docutils literal">*</tt>' wildcard - e.g. <tt class="docutils literal">filetypes.Bar.conf</tt>.</p>
4705 <p>Custom filetypes are not as powerful as built-in filetypes, but
4706 support for the following has been implemented:</p>
4707 <ul>
4710 </li>
4712 <dt>Reading filetype settings in the <tt class="docutils literal">[settings]</tt> section, including:</dt>
4714 <li>Using an existing syntax highlighting lexer (<a class="reference internal" href="#lexer-filetype">lexer_filetype</a> key).</li>
4716 </ul>
4717 </dd>
4718 </dl>
4719 </li>
4720 <li><p class="first">Build commands (<tt class="docutils literal"><span class="pre">[build-menu]</span></tt> section).</p>
4721 </li>
4722 <li><p class="first">Loading global tags files (sharing the <tt class="docutils literal">tag_parser</tt> namespace).</p>
4723 </li>
4724 </ul>
4725 <p>See <a class="reference internal" href="#filetype-configuration">Filetype configuration</a> for details on each setting.</p>
4727 <h4><a class="toc-backref" href="#id184">Creating a custom filetype from an existing filetype</a></h4>
4728 <p>Because most filetype settings will relate to the syntax
4730 sections), it is best to copy an existing filetype file that uses
4731 the lexer you wish to use as the basis of a custom filetype, using
4732 the correct filename extension format shown above, e.g.:</p>
4734 cp filetypes.foo filetypes.Bar.conf
4735 </pre>
4736 <p>Then add the <tt class="docutils literal">lexer_filetype=Foo</tt> setting (if not already present)
4737 and add/adjust other settings.</p>
4740 <p class="last">The <tt class="docutils literal">[styling]</tt> and <tt class="docutils literal">[keywords]</tt> sections have key names
4741 specific to each filetype/lexer. You must follow the same
4742 names - in particular, some lexers only support one keyword
4743 list, or none.</p>
4744 </div>
4745 </div>
4746 </div>
4749 <p>As well as the sections listed below, each filetype file can contain
4750 a [build-menu] section as described in <a class="reference internal" href="#build-menu-section">[build-menu] section</a>.</p>
4753 <p>In this section the colors for syntax highlighting are defined. The
4754 manual format is:</p>
4756 <li><tt class="docutils literal">key=foreground_color;background_color;bold_flag;italic_flag</tt></li>
4757 </ul>
4758 <p>Colors have to be specified as RGB hex values prefixed by
4760 case-insensitive, but it is a good idea to use small letters. Bold
4762 value is something other than "true" or "false", "false" is assumed.</p>
4763 <p>You can omit fields to use the values from the style named <tt class="docutils literal">"default"</tt>.</p>
4765 <p>This makes the key style have red foreground text, default background
4766 color text and bold emphasis.</p>
4770 defined in filetypes.common.</p>
4774 </ul>
4775 <p>The bold and italic parts are optional, and if present are used to
4776 toggle the bold or italic flags to the opposite of the named style's
4777 flags. In contrast to style definition booleans, they are a literal
4780 <p>This makes the key style match the <tt class="docutils literal">"comment"</tt> named style, but with
4781 italic emphasis.</p>
4782 <p>To define named styles, see the filetypes.common <a class="reference internal" href="#named-styles-section">[named_styles]
4784 </div>
4787 <p>You can automatically copy all of the styles from another filetype
4788 definition file by using the following syntax for the <tt class="docutils literal">[styling]</tt>
4789 group:</p>
4791 [styling=Foo]
4792 </pre>
4795 <p>This is useful when the same lexer is being used for multiple
4796 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4797 styling the same as the C styling, you would put the following in
4800 [styling=C]
4801 </pre>
4802 </div>
4803 </div>
4806 <p>This section contains keys for different keyword lists specific to
4807 the filetype. Some filetypes do not support keywords, so adding a
4808 new key will not work. You can only add or remove keywords to/from
4809 an existing list.</p>
4813 </div>
4814 </div>
4817 <p>Here any special properties for the Scintilla lexer can be set in the
4819 <p>Properties Geany uses are listed in the system filetype files. To find
4820 other properties you need Geany's source code:</p>
4823 </pre>
4824 </div>
4830 including the period character (<tt class="docutils literal">.</tt>). The extension used should
4831 match one of the patterns associated with that filetype (see
4834 </dd>
4837 and searching using word matching options.</p>
4842 filetypes.common setting.</p>
4843 </div>
4844 </dd>
4847 multiline comments only, don't set this but rather comment_open and
4848 comment_close.</p>
4849 <p>Single-line comments are used in priority over multiline comments to
4851 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_single=//</span></tt></p>
4852 </dd>
4855 set comment_close to really use multiline comments. If you want to use
4856 single-line comments, prefer setting comment_single.</p>
4857 <p>Multiline comments are used in priority over single-line comments to
4858 comment a block, e.g. template comments.</p>
4859 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_open=/*</span></tt></p>
4860 </dd>
4863 close the comment.</p>
4864 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_close=*/</span></tt></p>
4865 </dd>
4868 column 0 of a line. If set to true it uses any indentation of the
4869 line.</p>
4872 commented (e.g. with Ctrl-D):</p>
4874 #command_example();
4875 </pre>
4877 commented (e.g. with Ctrl-D):</p>
4879 # command_example();
4880 </pre>
4881 <p>Note: This setting only works for single line comments (like '//',
4882 '#' or ';').</p>
4883 <p class="last"><em>Example:</em> <tt class="docutils literal">comment_use_indent=true</tt></p>
4884 </dd>
4887 selection.</p>
4888 <p>Example usage: Open the API documentation for the
4889 current function call at the cursor position.</p>
4890 <p>The command can
4891 be set for every filetype or if not set, a global command will
4892 be used. The command itself can be specified without the full
4893 path, then it is searched in $PATH. But for security reasons,
4894 it is recommended to specify the full path to the command. The
4895 wildcard %s will be replaced by the current word at the cursor
4896 position or by the current selection.</p>
4897 <p>Hint: for PHP files the following could be quite useful:
4898 context_action_cmd=firefox "<a class="reference external" href="http://www.php.net/%s">http://www.php.net/%s</a>"</p>
4899 <p class="last"><em>Example:</em> <tt class="docutils literal">context_action_cmd=devhelp <span class="pre">-s</span> "%s"</tt></p>
4900 </dd>
4903 filetype name.</dd>
4904 </dl>
4908 This must not be recursive, i.e. it should be a filetype name that
4911 lexer_filetype=C
4912 #lexer_filetype=C++
4913 </pre>
4914 <p class="last">The second line is wrong, because <tt class="docutils literal">filetypes.cpp</tt> itself uses
4916 </dd>
4920 <colgroup>
4923 </colgroup>
4927 </tr>
4928 </thead>
4932 </tr>
4935 </tr>
4936 </tbody>
4937 </table>
4938 </dd>
4939 </dl>
4943 unclosed XML/HTML tag will be automatically indented. This only applies
4944 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4945 this setting in their system configuration files.</dd>
4946 </dl>
4947 </div>
4950 <p>This section allows definition of default indentation settings specific to
4951 the file type, overriding the ones configured in the preferences. This can
4952 be useful for file types requiring specific indentation settings (e.g. tabs
4953 only for Makefile). These settings don't override auto-detection if activated.</p>
4960 <colgroup>
4963 </colgroup>
4967 </tr>
4968 </thead>
4972 </tr>
4975 </tr>
4978 </tr>
4979 </tbody>
4980 </table>
4981 </dd>
4982 </dl>
4983 </div>
4986 <p>As of Geany 0.19 this section is supplemented by the <a class="reference internal" href="#build-menu-section">[build-menu] section</a>.
4987 Values that are set in the [build-menu] section will override those in this section.</p>
4991 and line number from build output. If undefined, Geany will fall
4992 back to its default error message parsing.</p>
4993 <p>Only the first two matches will be read by Geany. Geany will look for
4994 a match that is purely digits, and use this for the line number. The
4995 remaining match will be used as the filename.</p>
4996 <p><em>Example:</em> <tt class="docutils literal"><span class="pre">error_regex=(.+):([0-9]+):[0-9]+</span></tt></p>
4999 </dd>
5000 </dl>
5002 <p>If any build menu item settings have been configured in the Build Menu Commands
5003 dialog or the Build tab of the project preferences dialog then these
5004 settings are stored in the [build-menu] section and override the settings in
5005 this section for that item.</p>
5009 it is also possible to use it with interpreted languages like Perl
5010 or Python. With these filetypes you can use this option as a kind of
5011 syntax parser, which sends output to the compiler message window.</p>
5012 <p>You should quote the filename to also support filenames with
5013 spaces. The following wildcards for filenames are available:</p>
5017 </ul>
5018 <p class="last"><em>Example:</em> <tt class="docutils literal">compiler=gcc <span class="pre">-Wall</span> <span class="pre">-c</span> "%f"</tt></p>
5019 </dd>
5022 already compiled, it will be compiled while linking. The -o option
5023 is automatically added by Geany. This item works well with GNU gcc,
5024 but may be problematic with other compilers (esp. with the linker).</p>
5025 <p class="last"><em>Example:</em> <tt class="docutils literal">linker=gcc <span class="pre">-Wall</span> "%f"</tt></p>
5026 </dd>
5029 already. Use the %e wildcard to have only the name of the executable
5030 (i.e. without extension) or use the %f wildcard if you need the
5031 complete filename, e.g. for shell scripts.</p>
5032 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">run_cmd="./%e"</span></tt></p>
5033 </dd>
5034 </dl>
5035 </div>
5036 </div>
5039 <p>There is a special filetype definition file called
5040 filetypes.common. This file defines some general non-filetype-specific
5041 settings.</p>
5042 <p>You can open the user filetypes.common with the
5044 the default settings to the user file if the file doesn't exist.
5045 Alternatively the file can be created manually, adding only the
5046 settings you want to change. All missing settings will be read from
5047 the system file.</p>
5050 <p class="last">See the <a class="reference internal" href="#filetype-configuration">Filetype configuration</a> section for how to define styles.</p>
5051 </div>
5054 <p>Named styles declared here can be used in the [styling] section of any
5055 filetypes.* file.</p>
5059 [named_styles]
5061 bar=foo
5062 </pre>
5065 [styling]
5066 comment=foo
5067 </pre>
5068 <p>This saves copying and pasting the whole style definition into several
5069 different files.</p>
5072 <p class="last">You can define aliases for named styles, as shown with the <tt class="docutils literal">bar</tt>
5073 entry in the above example, but they must be declared after the
5074 original style.</p>
5075 </div>
5076 <p>This section can be overridden with color scheme files - see the <a class="reference internal" href="#color-schemes-menu">Color
5078 </div>
5084 filetype set.</p>
5085 <p class="last"><em>Example:</em> <tt class="docutils literal">default=0x000000;0xffffff;false;false</tt></p>
5086 </dd>
5094 </ul>
5096 the colors are not overridden, the default is a dark grey
5097 background with syntax highlighted foreground text.</p>
5098 <p class="last"><em>Example:</em> <tt class="docutils literal">selection=0xc0c0c0;0x00007F;true;true</tt></p>
5099 </dd>
5102 <p class="last"><em>Example:</em> <tt class="docutils literal">brace_good=0xff0000;0xFFFFFF;true;false</tt></p>
5103 </dd>
5106 <p class="last"><em>Example:</em> <tt class="docutils literal">brace_bad=0x0000ff;0xFFFFFF;true;false</tt></p>
5107 </dd>
5110 and third argument is interpreted.
5111 Set the third argument to true to change the caret into a block caret.</p>
5112 <p class="last"><em>Example:</em> <tt class="docutils literal">caret=0x000000;0x0;false;false</tt></p>
5113 </dd>
5116 argument is interpreted. The width is specified in pixels with
5117 a maximum of three pixel. Use the width 0 to make the caret
5118 invisible.</p>
5120 </dd>
5123 the second and third arguments are interpreted. The second argument
5124 is the background color. Use the third argument to enable or
5125 disable background highlighting for the current line (has to be
5126 true/false).</p>
5127 <p class="last"><em>Example:</em> <tt class="docutils literal">current_line=0x0;0xe5e5e5;true;false</tt></p>
5128 </dd>
5131 second arguments are interpreted.</p>
5132 <p class="last"><em>Example:</em> <tt class="docutils literal">indent_guide=0xc0c0c0;0xffffff;false;false</tt></p>
5133 </dd>
5136 both arguments define the foreground and background colors, the
5137 third argument sets whether to use the defined foreground color
5138 or to use the color defined by each filetype for the white space.
5139 The fourth argument defines whether to use the background color.</p>
5140 <p class="last"><em>Example:</em> <tt class="docutils literal">white_space=0xc0c0c0;0xffffff;true;true</tt></p>
5141 </dd>
5144 </dl>
5152 used.</p>
5159 </ul>
5165 </ul>
5168 </dd>
5171 first argument is used.</p>
5177 </ul>
5178 <p class="last"><em>Example:</em> <tt class="docutils literal">folding_horiz_line=0;0;false;false</tt></p>
5179 </dd>
5182 This is a bitmask of the values:</p>
5188 </ul>
5189 <p>Second argument: wether the visual flags to indicate a line is wrapped
5190 are drawn near the border or near the text. This is a bitmask of the values:</p>
5195 </ul>
5197 <p class="last"><em>Example:</em> <tt class="docutils literal">line_wrap_visuals=3;0;false;false</tt></p>
5198 </dd>
5200 <dd><p class="first">First argument: sets the size of indentation of sublines for wrapped lines
5201 in terms of the width of a space, only used when the second argument is <tt class="docutils literal">0</tt>.</p>
5202 <p>Second argument: wrapped sublines can be indented to the position of their
5203 first subline or one more indent level. Possible values:</p>
5207 <li>2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation</li>
5208 </ul>
5210 <p class="last"><em>Example:</em> <tt class="docutils literal">line_wrap_indent=0;1;false;false</tt></p>
5211 </dd>
5218 <p class="last"><em>Example:</em> <tt class="docutils literal">translucency=256;256;false;false</tt></p>
5219 </dd>
5222 The foreground color (first argument) is only used when the Markers margin
5223 is enabled (see View menu).</p>
5225 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_line=0x000000;0xffff00;false;false</tt></p>
5226 </dd>
5228 <dd><p class="first">The style for a marked search results (when using "Mark" in Search dialogs).
5229 The second argument sets the background color for the drawn rectangle.</p>
5231 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_search=0x000000;0xb8f4b8;false;false</tt></p>
5232 </dd>
5234 <dd><p class="first">The style for a marked line (e.g when using the "Toggle Marker" keybinding
5235 (Ctrl-M)). The foreground color (first argument) is only used
5236 when the Markers margin is enabled (see View menu).</p>
5238 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_mark=0x000000;0xb8f4b8;false;false</tt></p>
5239 </dd>
5246 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_translucency=256;256;false;false</tt></p>
5247 </dd>
5250 The first argument defines the amount of space to be drawn above the line, the second
5251 argument defines the amount of space to be drawn below.</p>
5253 <p class="last"><em>Example:</em> <tt class="docutils literal">line_height=0;0;false;false</tt></p>
5254 </dd>
5257 define the foreground and background colors, the third and fourth
5258 arguments set whether to use the defined colors.</p>
5259 <p class="last"><em>Example:</em> <tt class="docutils literal">calltips=0xc0c0c0;0xffffff;false;false</tt></p>
5260 </dd>
5261 </dl>
5262 </div>
5268 when moving, selecting and deleting across word boundaries
5269 (see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla keyboard commands</a>).</p>
5271 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~</span></tt></p>
5272 </dd>
5273 </dl>
5274 </div>
5275 </div>
5276 </div>
5279 <p>To change the default filetype extension used when saving a new file,
5280 see <a class="reference internal" href="#filetype-definition-files">Filetype definition files</a>.</p>
5281 <p>You can override the list of file extensions that Geany uses to detect
5282 filetypes using the user <tt class="docutils literal">filetype_extensions.conf</tt> file. Use the
5284 also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
5285 <p>You should only list lines for filetype extensions that you want to
5286 override in the user configuration file and remove or comment out
5288 semi-colon separated list of patterns which should be matched for
5289 that filetype.</p>
5290 <p>For example, to override the filetype extensions for Make, the file
5291 should look like:</p>
5293 [Extensions]
5294 Make=Makefile*;*.mk;Buildfile;
5295 </pre>
5296 </div>
5299 <p>Group membership is also stored in <tt class="docutils literal">filetype_extensions.conf</tt>. This
5300 file is used to store information Geany needs at startup, whereas the
5301 separate filetype definition files hold information only needed when
5302 a document with their filetype is used.</p>
5305 [Groups]
5306 Programming=C;C++;
5307 Script=Perl;Python;
5308 Markup=HTML;XML;
5309 Misc=Diff;Conf;
5310 None=None;
5311 </pre>
5316 </div>
5317 </div>
5320 <p>The user preferences file <tt class="docutils literal">geany.conf</tt> holds settings for all the items configured
5321 in the preferences dialog. This file should not be edited while Geany is running
5322 as the file will be overwritten when the preferences in Geany are changed or Geany
5323 is quit.</p>
5326 <p>The [build-menu] section contains the configuration of the build menu.
5327 This section can occur in filetype, preferences and project files and
5328 always has the format described here. Different menu items are loaded
5329 from different files, see the table in the <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>
5330 section for details. All the settings can be configured from the dialogs
5331 except the execute command in filetype files and filetype definitions in
5332 the project file, so these are the only ones which need hand editing.</p>
5333 <p>The build-menu section stores one entry for each setting for each menu item that
5334 is configured. The keys for these settings have the format:</p>
5335 <blockquote>
5343 </ul>
5344 </li>
5345 <li>NN - is a two decimal digit number of the item within the group,
5351 </ul>
5352 </li>
5353 </ul>
5354 </div>
5355 </div>
5358 <p>The project file contains project related settings and possibly a
5359 record of the current session files.</p>
5362 <p>The project file also can have extra fields in the [build-menu] section
5363 in addition to those listed in <a class="reference internal" href="#build-menu-section">[build-menu] section</a> above.</p>
5364 <p>When filetype menu items are configured for the project they are stored
5365 in the project file.</p>
5366 <p>The <tt class="docutils literal">filetypes</tt> entry is a list of the filetypes which exist in the
5367 project file.</p>
5368 <p>For each filetype the entries for that filetype have the format defined in
5369 <a class="reference internal" href="#build-menu-section">[build-menu] section</a> but the key is prefixed by the name of the filetype
5370 as it appears in the <tt class="docutils literal">filetypes</tt> entry, eg the entry for the label of
5372 <blockquote>
5374 </div>
5375 </div>
5386 </ul>
5387 <p>To use these templates, just open the Edit menu or open the popup menu
5389 and insert templates as you want.</p>
5390 <p>Some templates (like File header or ChangeLog entry) will always be
5391 inserted at the top of the file.</p>
5392 <p>To insert a function description, the cursor must be inside
5393 of the function, so that the function name can be determined
5394 automatically. The description will be positioned correctly one line
5395 above the function, just check it out. If the cursor is not inside
5396 of a function or the function name cannot be determined, the inserted
5398 instead.</p>
5402 save a file in the user's template configuration directory. You can
5404 </div>
5407 <p>Meta data can be used with all templates, but by default user set
5408 meta data is only used for the ChangeLog and File header templates.</p>
5410 <a class="reference internal" href="#template-preferences">Template preferences</a>). You can define the default values
5411 which will be inserted in the templates.</p>
5412 </div>
5415 <p>File templates are templates used as the basis of a new file. To
5417 menu.</p>
5418 <p>By default, file templates are installed for some filetypes. Custom
5419 file templates can be added by creating the appropriate template file. You can
5420 also edit the default file templates.</p>
5421 <p>The file's contents are just the text to place in the document, with
5422 optional template wildcards like <tt class="docutils literal">{fileheader}</tt>. The fileheader
5423 wildcard can be placed anywhere, but it's usually put on the first
5424 line of the file, followed by a blank line.</p>
5428 <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
5429 <p>The filetype to use is detected from the template file's extension, if
5430 any. For example, creating a file <tt class="docutils literal">module.c</tt> would add a menu item
5431 which created a new document with the filetype set to 'C'.</p>
5432 <p>The template file is read from disk when the corresponding menu item is
5433 clicked.</p>
5434 </div>
5435 </div>
5438 <p>Each template can be customized to your needs. The templates are
5439 stored in the <tt class="docutils literal"><span class="pre">~/.config/geany/templates/</span></tt> directory (see the section called
5440 <a class="reference internal" href="#command-line-options">Command line options</a> for further information about the configuration
5441 directory). Just open the desired template with an editor (ideally,
5442 Geany ;-) ) and edit the template to your needs. There are some
5443 wildcards which will be automatically replaced by Geany at startup.</p>
5449 <colgroup>
5453 </colgroup>
5458 </tr>
5459 </thead>
5462 <td>{ Opening Brace (used to prevent other
5463 wildcards being expanded).</td>
5465 </tr>
5469 </tr>
5471 <td>% Percent (used to escape e.g. %block% in
5472 snippets).</td>
5474 </tr>
5475 </tbody>
5476 </table>
5478 <p>These are configurable, see <a class="reference internal" href="#template-preferences">Template preferences</a>.</p>
5480 <colgroup>
5484 </colgroup>
5489 </tr>
5490 </thead>
5494 <td>file templates, file header,
5495 function description, ChangeLog entry,
5496 bsd, gpl, snippets.</td>
5497 </tr>
5501 <td>file templates, file header,
5502 function description, ChangeLog entry,
5503 bsd, gpl, snippets.</td>
5504 </tr>
5507 <td>file templates, file header,
5508 function description, ChangeLog entry,
5509 bsd, gpl, snippets.</td>
5510 </tr>
5513 <td>file templates, file header,
5514 function description, ChangeLog entry,
5515 bsd, gpl, snippets.</td>
5516 </tr>
5519 <td>file templates, file header,
5520 function description, ChangeLog entry,
5521 bsd, gpl, snippets.</td>
5522 </tr>
5523 </tbody>
5524 </table>
5526 <p>The format for these wildcards can be changed in the preferences
5527 dialog, see <a class="reference internal" href="#template-preferences">Template preferences</a>. You can use any conversion
5528 specifiers which can be used with the ANSI C strftime function.
5529 For details please see <a class="reference external" href="http://man.cx/strftime">http://man.cx/strftime</a>.</p>
5531 <colgroup>
5535 </colgroup>
5540 </tr>
5541 </thead>
5545 <td>file templates, file header,
5546 function description, ChangeLog entry,
5547 bsd, gpl, snippets.</td>
5548 </tr>
5550 <td>The current date. Default format:
5551 YYYY-MM-DD.</td>
5552 <td>file templates, file header,
5553 function description, ChangeLog entry,
5554 bsd, gpl, snippets.</td>
5555 </tr>
5557 <td>The current date and time. Default format:
5558 DD.MM.YYYY HH:mm:ss ZZZZ.</td>
5559 <td>file templates, file header,
5560 function description, ChangeLog entry,
5561 bsd, gpl, snippets.</td>
5562 </tr>
5563 </tbody>
5564 </table>
5567 <colgroup>
5571 </colgroup>
5576 </tr>
5577 </thead>
5581 translated to your locale), used in
5582 file templates.</td>
5583 <td>file templates, file header,
5584 function description, ChangeLog entry,
5585 bsd, gpl, snippets.</td>
5586 </tr>
5588 <td>The actual Geany version, e.g.
5590 <td>file templates, file header,
5591 function description, ChangeLog entry,
5592 bsd, gpl, snippets.</td>
5593 </tr>
5595 <td>The filename of the current file.
5596 For new files, it's only replaced when
5597 first saving if found on the first 3 lines
5598 of the file.</td>
5599 <td>file header, snippets, file
5600 templates.</td>
5601 </tr>
5605 </tr>
5609 </tr>
5611 <td>The function name of the function at the
5612 cursor position. This wildcard will only be
5613 replaced in the function description
5614 template.</td>
5616 </tr>
5618 <td>Executes the specified command and replace
5619 the wildcard with the command's standard
5620 output. See <a class="reference internal" href="#special-command-wildcard">Special {command:} wildcard</a>
5621 for details.</td>
5622 <td>file templates, file header,
5623 function description, ChangeLog entry,
5624 bsd, gpl, snippets.</td>
5625 </tr>
5626 </tbody>
5627 </table>
5630 <colgroup>
5634 </colgroup>
5639 </tr>
5640 </thead>
5645 </tr>
5649 </tr>
5651 <td>The file header template. This wildcard
5652 will only be replaced in file templates.</td>
5654 </tr>
5655 </tbody>
5656 </table>
5659 <p>The {command:} wildcard is a special one because it can execute
5660 a specified command and put the command's output (stdout) into
5661 the template.</p>
5664 {command:uname -a}
5665 </pre>
5669 </pre>
5670 <p>Using this wildcard you can insert nearly any arbitrary text into the
5671 template.</p>
5672 <p>In the environment of the executed command the variables
5673 <tt class="docutils literal">GEANY_FILENAME</tt>, <tt class="docutils literal">GEANY_FILETYPE</tt> and <tt class="docutils literal">GEANY_FUNCNAME</tt> are set.
5674 The value of these variables is filled in only if Geany knows about it.
5675 For example, <tt class="docutils literal">GEANY_FUNCNAME</tt> is only filled within the function
5676 description template. However, these variables are <tt class="docutils literal">always</tt> set,
5677 just maybe with an empty value.
5678 You can easily access them e.g. within an executed shell script using:</p>
5680 $GEANY_FILENAME
5681 </pre>
5684 <p class="last">If the specified command could not be found or not executed, the wildcard is substituted
5685 by an empty string. In such cases, you can find the occurred error message on Geany's
5687 </div>
5688 </div>
5689 </div>
5690 </div>
5691 </div>
5694 <p>You can add, remove and reorder the elements in the toolbar by using
5695 the toolbar editor, or by manually editing the configuration file
5697 <p>The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5698 by right-clicking on the toolbar itself and choosing it from the menu.</p>
5701 <p>To override the system-wide configuration file, copy it to your user
5702 configuration directory (see <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>).</p>
5705 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5706 </pre>
5707 <p>Then edit it and add any of the available elements listed in the file or remove
5708 any of the existing elements. Of course, you can also reorder the elements as
5709 you wish and add or remove additional separators.
5710 This file must be valid XML, otherwise the global toolbar UI definition
5711 will be used instead.</p>
5718 </ol>
5719 </div>
5720 </div>
5724 <colgroup>
5727 </colgroup>
5731 </tr>
5732 </thead>
5736 </tr>
5739 </tr>
5742 </tr>
5745 </tr>
5748 </tr>
5751 </tr>
5754 </tr>
5757 </tr>
5760 </tr>
5763 </tr>
5766 </tr>
5769 </tr>
5772 </tr>
5775 </tr>
5778 </tr>
5781 </tr>
5784 </tr>
5786 <td>Build the current file, includes a submenu for Make commands. Geany
5787 remembers the last chosen action from the submenu and uses this as default
5788 action when the button itself is clicked.</td>
5789 </tr>
5792 </tr>
5795 </tr>
5798 </tr>
5801 </tr>
5804 </tr>
5807 </tr>
5810 </tr>
5813 </tr>
5815 <td>Find the entered text in the current file (only useful if you also
5816 use 'SearchEntry')</td>
5817 </tr>
5820 </tr>
5823 </tr>
5826 </tr>
5829 </tr>
5830 </tbody>
5831 </table>
5832 </div>
5833 </div>
5834 </div>
5839 <p>The HTML Characters plugin helps when working with special
5840 characters in XML/HTML, e.g. German Umlauts ü and ä.</p>
5843 <p>When the plugin is enabled, you can insert special character
5845 <p>This opens up a dialog where you can find a huge amount of special
5846 characters sorted by category that you might like to use inside your
5847 document. You can expand and collapse the categories by clicking on
5848 the little arrow on the left hand side. Once you have found the
5850 the entity for the character at the current cursor position. You
5851 might also like to double click the chosen entity instead.</p>
5852 </div>
5855 <p>To help make a XML/HTML document valid the plugin supports
5856 replacement of special chars known by the plugin. Both bulk
5857 replacement and immediate replacement during typing are supported.</p>
5866 </ul>
5867 </dd>
5868 </dl>
5873 activated, all special characters (beside the given exceptions from
5874 above) known by the plugin will be replaced by their entities.</p>
5875 <p>You could also set a keybinding for the plugin to toggle the status
5876 of this feature.</p>
5877 </div>
5881 plugin allows bulk replacement of all known characters (beside the
5882 mentioned exceptions). You can find the function under the same
5884 configure a keybinding for the plugin.</p>
5885 </div>
5886 </div>
5887 </div>
5892 <p>This plugin sets on every new file (<em>File->New</em> or <em>File->New (with template)</em>)
5893 a randomly chosen filename and set its filetype appropriate to the used template
5894 or when no template was used, to a configurable default filetype.
5895 This enables you to quickly compile, build and/or run the new file without the
5896 need to give it an explicit filename using the Save As dialog. This might be
5897 useful when you often create new files just for testing some code or something
5898 similar.</p>
5899 </div>
5902 <p>This plugin creates a backup copy of the current file in Geany when it is
5903 saved. You can specify the directory where the backup copy is saved and
5904 you can configure the automatically added extension in the configure dialog
5905 in Geany's plugin manager.</p>
5906 <p>After the plugin was loaded in Geany's plugin manager, every file is
5907 copied into the configured backup directory when the file is saved in Geany.</p>
5908 </div>
5909 </div>
5910 </div>
5913 <p>This document (<tt class="docutils literal">geany.txt</tt>) is written in <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>
5914 (or "reST"). The source file for it is located in Geany's <tt class="docutils literal">doc</tt>
5915 subdirectory. If you intend on making changes, you should grab the
5916 source right from SVN to make sure you've got the newest version. After
5917 editing the file, to build the HTML document to see how your changes
5918 look, run "<tt class="docutils literal">make doc</tt>" in the subdirectory <tt class="docutils literal">doc</tt> of Geany's source
5919 directory. This regenerates the <tt class="docutils literal">geany.html</tt> file. To generate a PDF
5920 file, use the command "<tt class="docutils literal">make pdf</tt>" which should generate a file called
5924 % svn diff geany.txt > foo.patch
5925 </pre>
5927 <p>Note, you will need the Python docutils software package installed
5928 to build the docs. The package is named <tt class="docutils literal"><span class="pre">python-docutils</span></tt> on Debian
5929 and Fedora systems.</p>
5930 </div>
5934 <p>This appendix is distributed under the terms of the License for
5935 Scintilla and SciTE. A copy of this license can be found in the file
5937 program and in the appendix of this document. See <a class="reference internal" href="#license-for-scintilla-and-scite">License for
5942 <p>Keyboard commands for Scintilla mostly follow common Windows and GTK+
5943 conventions. All move keys (arrows, page up/down, home and end)
5944 allows to extend or reduce the stream selection when holding the
5945 Shift key, and the rectangular selection when holding the Shift and
5946 Ctrl keys. Some keys may not be available with some national keyboards
5947 or because they are taken by the system such as by a window manager
5948 or GTK. Keyboard equivalents of menu commands are listed in the
5949 menus. Some less common commands with no menu equivalent are:</p>
5951 <colgroup>
5954 </colgroup>
5958 </tr>
5959 </thead>
5963 </tr>
5966 </tr>
5969 </tr>
5972 </tr>
5975 </tr>
5978 </tr>
5981 </tr>
5984 </tr>
5987 </tr>
5990 </tr>
5993 </tr>
5996 </tr>
5999 </tr>
6002 </tr>
6005 </tr>
6008 </tr>
6011 </tr>
6014 </tr>
6017 </tr>
6018 </tbody>
6019 </table>
6020 </div>
6021 </div>
6027 <li>Double-click on empty space in the notebook tab bar to open a
6028 new document.</li>
6031 document.</li>
6032 <li>Double-click on a document's notebook tab to toggle all additional
6033 widgets (to show them again use the View menu or the keyboard
6034 shortcut). The interface pref must be enabled for this to work.</li>
6035 </ul>
6036 </div>
6045 </ul>
6046 </div>
6051 </ul>
6052 </div>
6056 <li>Scrolling the mouse wheel over a notebook tab bar will switch
6057 notebook pages.</li>
6058 </ul>
6059 <p>The following are derived from X-Windows features (but GTK still supports
6060 them on Windows):</p>
6063 <li>Middle-click on a scrollbar moves the scrollbar to that
6064 position without having to drag it.</li>
6065 </ul>
6066 </div>
6067 </div>
6070 <p>There are some options which can only be changed at compile time,
6071 and some options which are used as the default for configurable
6072 options. To change these options, edit the appropriate source file
6073 in the <tt class="docutils literal">src</tt> subdirectory. Look for a block of lines starting with
6074 <tt class="docutils literal">#define GEANY_*</tt>. Any definitions which are not listed here should
6075 not be changed.</p>
6079 </div>
6083 <colgroup>
6087 </colgroup>
6092 </tr>
6093 </thead>
6096 <td>A string used as the default name for new
6097 files. Be aware that the string can be
6098 translated, so change it only if you know
6099 what you are doing.</td>
6101 </tr>
6105 </tr>
6109 </tr>
6111 <td>The default width of the main window at the
6112 first start.</td>
6114 </tr>
6116 <td>The default height of the main window at the
6117 first start.</td>
6119 </tr>
6123 </tr>
6126 Windows file open and save dialogs instead
6127 GTK's file open and save dialogs. The
6128 default Windows file dialogs are missing
6129 some nice features like choosing a filetype
6130 or an encoding. <em>Do not touch this setting
6131 when building on a non-Win32 system.</em></td>
6133 </tr>
6134 </tbody>
6135 </table>
6136 </div>
6140 <colgroup>
6144 </colgroup>
6149 </tr>
6150 </thead>
6153 <td>The default filename extension for Geany
6154 project files. It is used when creating new
6155 projects and as filter mask for the project
6156 open dialog.</td>
6158 </tr>
6159 </tbody>
6160 </table>
6161 </div>
6165 <colgroup>
6169 </colgroup>
6174 </tr>
6175 </thead>
6178 <td>The number of lines to search for the
6179 filetype with the extract filetype regex.</td>
6181 </tr>
6182 </tbody>
6183 </table>
6184 </div>
6188 <colgroup>
6192 </colgroup>
6197 </tr>
6198 </thead>
6201 <td>These characters define word boundaries when
6202 making selections and searching using word
6203 matching options.</td>
6204 <td>a string with:
6206 underscore.</td>
6207 </tr>
6208 </tbody>
6209 </table>
6210 </div>
6213 <p>These are default settings that can be overridden in the <a class="reference internal" href="#preferences">Preferences</a> dialog.</p>
6215 <colgroup>
6219 </colgroup>
6224 </tr>
6225 </thead>
6228 <td>How many characters you need to type to
6229 trigger the autocompletion list.</td>
6231 </tr>
6233 <td>Time in seconds between checking a file for
6234 external changes.</td>
6236 </tr>
6240 </tr>
6242 <td>A terminal emulator. It has to accept the
6244 include a path.</td>
6246 </tr>
6250 </tr>
6252 <td>A printing tool. It should be able to accept
6253 and process plain text files. This can also
6254 include a path.</td>
6256 </tr>
6258 <td>A grep tool. It should be compatible with
6259 GNU grep. This can also include a path.</td>
6261 </tr>
6265 </tr>
6267 <td>The font used in sidebar to show symbols and
6268 open files.</td>
6270 </tr>
6274 </tr>
6278 </tr>
6280 <td>A string which is used to mark a toggled
6281 comment.</td>
6283 </tr>
6285 <td>How many autocompletion suggestions should
6286 Geany provide.</td>
6288 </tr>
6290 <td>The default regex to extract filetypes from
6291 files.</td>
6293 </tr>
6294 </tbody>
6295 </table>
6296 <p>The GEANY_DEFAULT_FILETYPE_REGEX default value is -\*-\s*([^\s]+)\s*-\*- which finds Emacs filetypes.</p>
6297 </div>
6301 <colgroup>
6305 </colgroup>
6310 </tr>
6311 </thead>
6314 <td>Amount of build error indicators to
6315 be shown in the editor window.
6316 This affects the special coloring
6317 when Geany detects a compiler output line as
6318 an error message and then highlights the
6319 corresponding line in the source code.
6320 Usually only the first few messages are
6321 interesting because following errors are
6322 just after-effects.
6323 All errors in the Compiler window are parsed
6324 and unaffected by this value.</td>
6326 </tr>
6328 <td>Every time a build menu item priority
6329 calculation is run, print the state of the
6330 menu item table in the form of the table
6331 in <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>. May be
6332 useful to debug configuration file
6333 overloading. Warning produces a lot of
6334 output. Can also be enabled/disabled by the
6336 overriding the compile setting.</td>
6338 </tr>
6339 </tbody>
6340 </table>
6341 </div>
6342 </div>
6346 GNU GENERAL PUBLIC LICENSE
6351 Everyone is permitted to copy and distribute verbatim copies
6352 of this license document, but changing it is not allowed.
6354 Preamble
6356 The licenses for most software are designed to take away your
6357 freedom to share and change it. By contrast, the GNU General Public
6358 License is intended to guarantee your freedom to share and change free
6359 software--to make sure the software is free for all its users. This
6360 General Public License applies to most of the Free Software
6361 Foundation's software and to any other program whose authors commit to
6362 using it. (Some other Free Software Foundation software is covered by
6363 the GNU Library General Public License instead.) You can apply it to
6364 your programs, too.
6366 When we speak of free software, we are referring to freedom, not
6367 price. Our General Public Licenses are designed to make sure that you
6368 have the freedom to distribute copies of free software (and charge for
6369 this service if you wish), that you receive source code or can get it
6370 if you want it, that you can change the software or use pieces of it
6371 in new free programs; and that you know you can do these things.
6373 To protect your rights, we need to make restrictions that forbid
6374 anyone to deny you these rights or to ask you to surrender the rights.
6375 These restrictions translate to certain responsibilities for you if you
6376 distribute copies of the software, or if you modify it.
6378 For example, if you distribute copies of such a program, whether
6379 gratis or for a fee, you must give the recipients all the rights that
6380 you have. You must make sure that they, too, receive or can get the
6381 source code. And you must show them these terms so they know their
6382 rights.
6384 We protect your rights with two steps: (1) copyright the software, and
6385 (2) offer you this license which gives you legal permission to copy,
6386 distribute and/or modify the software.
6388 Also, for each author's protection and ours, we want to make certain
6389 that everyone understands that there is no warranty for this free
6390 software. If the software is modified by someone else and passed on, we
6391 want its recipients to know that what they have is not the original, so
6392 that any problems introduced by others will not reflect on the original
6393 authors' reputations.
6395 Finally, any free program is threatened constantly by software
6396 patents. We wish to avoid the danger that redistributors of a free
6397 program will individually obtain patent licenses, in effect making the
6398 program proprietary. To prevent this, we have made it clear that any
6399 patent must be licensed for everyone's free use or not licensed at all.
6401 The precise terms and conditions for copying, distribution and
6402 modification follow.
6404 GNU GENERAL PUBLIC LICENSE
6405 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
6407 0. This License applies to any program or other work which contains
6408 a notice placed by the copyright holder saying it may be distributed
6411 means either the Program or any derivative work under copyright law:
6412 that is to say, a work containing the Program or a portion of it,
6413 either verbatim or with modifications and/or translated into another
6414 language. (Hereinafter, translation is included without limitation in
6417 Activities other than copying, distribution and modification are not
6418 covered by this License; they are outside its scope. The act of
6419 running the Program is not restricted, and the output from the Program
6420 is covered only if its contents constitute a work based on the
6421 Program (independent of having been made by running the Program).
6422 Whether that is true depends on what the Program does.
6424 1. You may copy and distribute verbatim copies of the Program's
6425 source code as you receive it, in any medium, provided that you
6426 conspicuously and appropriately publish on each copy an appropriate
6427 copyright notice and disclaimer of warranty; keep intact all the
6428 notices that refer to this License and to the absence of any warranty;
6429 and give any other recipients of the Program a copy of this License
6430 along with the Program.
6432 You may charge a fee for the physical act of transferring a copy, and
6433 you may at your option offer warranty protection in exchange for a fee.
6435 2. You may modify your copy or copies of the Program or any portion
6436 of it, thus forming a work based on the Program, and copy and
6437 distribute such modifications or work under the terms of Section 1
6438 above, provided that you also meet all of these conditions:
6440 a) You must cause the modified files to carry prominent notices
6441 stating that you changed the files and the date of any change.
6443 b) You must cause any work that you distribute or publish, that in
6444 whole or in part contains or is derived from the Program or any
6445 part thereof, to be licensed as a whole at no charge to all third
6446 parties under the terms of this License.
6448 c) If the modified program normally reads commands interactively
6449 when run, you must cause it, when started running for such
6450 interactive use in the most ordinary way, to print or display an
6451 announcement including an appropriate copyright notice and a
6452 notice that there is no warranty (or else, saying that you provide
6453 a warranty) and that users may redistribute the program under
6454 these conditions, and telling the user how to view a copy of this
6455 License. (Exception: if the Program itself is interactive but
6456 does not normally print such an announcement, your work based on
6457 the Program is not required to print an announcement.)
6459 These requirements apply to the modified work as a whole. If
6460 identifiable sections of that work are not derived from the Program,
6461 and can be reasonably considered independent and separate works in
6462 themselves, then this License, and its terms, do not apply to those
6463 sections when you distribute them as separate works. But when you
6464 distribute the same sections as part of a whole which is a work based
6465 on the Program, the distribution of the whole must be on the terms of
6466 this License, whose permissions for other licensees extend to the
6467 entire whole, and thus to each and every part regardless of who wrote it.
6469 Thus, it is not the intent of this section to claim rights or contest
6470 your rights to work written entirely by you; rather, the intent is to
6471 exercise the right to control the distribution of derivative or
6472 collective works based on the Program.
6474 In addition, mere aggregation of another work not based on the Program
6475 with the Program (or with a work based on the Program) on a volume of
6476 a storage or distribution medium does not bring the other work under
6477 the scope of this License.
6479 3. You may copy and distribute the Program (or a work based on it,
6480 under Section 2) in object code or executable form under the terms of
6483 a) Accompany it with the complete corresponding machine-readable
6484 source code, which must be distributed under the terms of Sections
6487 b) Accompany it with a written offer, valid for at least three
6488 years, to give any third party, for a charge no more than your
6489 cost of physically performing source distribution, a complete
6490 machine-readable copy of the corresponding source code, to be
6492 customarily used for software interchange; or,
6494 c) Accompany it with the information you received as to the offer
6495 to distribute corresponding source code. (This alternative is
6496 allowed only for noncommercial distribution and only if you
6497 received the program in object code or executable form with such
6498 an offer, in accord with Subsection b above.)
6500 The source code for a work means the preferred form of the work for
6501 making modifications to it. For an executable work, complete source
6502 code means all the source code for all modules it contains, plus any
6503 associated interface definition files, plus the scripts used to
6504 control compilation and installation of the executable. However, as a
6505 special exception, the source code distributed need not include
6506 anything that is normally distributed (in either source or binary
6507 form) with the major components (compiler, kernel, and so on) of the
6508 operating system on which the executable runs, unless that component
6509 itself accompanies the executable.
6511 If distribution of executable or object code is made by offering
6512 access to copy from a designated place, then offering equivalent
6513 access to copy the source code from the same place counts as
6514 distribution of the source code, even though third parties are not
6515 compelled to copy the source along with the object code.
6517 4. You may not copy, modify, sublicense, or distribute the Program
6518 except as expressly provided under this License. Any attempt
6519 otherwise to copy, modify, sublicense or distribute the Program is
6520 void, and will automatically terminate your rights under this License.
6521 However, parties who have received copies, or rights, from you under
6522 this License will not have their licenses terminated so long as such
6523 parties remain in full compliance.
6525 5. You are not required to accept this License, since you have not
6526 signed it. However, nothing else grants you permission to modify or
6527 distribute the Program or its derivative works. These actions are
6528 prohibited by law if you do not accept this License. Therefore, by
6529 modifying or distributing the Program (or any work based on the
6530 Program), you indicate your acceptance of this License to do so, and
6531 all its terms and conditions for copying, distributing or modifying
6532 the Program or works based on it.
6534 6. Each time you redistribute the Program (or any work based on the
6535 Program), the recipient automatically receives a license from the
6536 original licensor to copy, distribute or modify the Program subject to
6537 these terms and conditions. You may not impose any further
6538 restrictions on the recipients' exercise of the rights granted herein.
6539 You are not responsible for enforcing compliance by third parties to
6540 this License.
6542 7. If, as a consequence of a court judgment or allegation of patent
6543 infringement or for any other reason (not limited to patent issues),
6544 conditions are imposed on you (whether by court order, agreement or
6545 otherwise) that contradict the conditions of this License, they do not
6546 excuse you from the conditions of this License. If you cannot
6547 distribute so as to satisfy simultaneously your obligations under this
6548 License and any other pertinent obligations, then as a consequence you
6549 may not distribute the Program at all. For example, if a patent
6550 license would not permit royalty-free redistribution of the Program by
6551 all those who receive copies directly or indirectly through you, then
6552 the only way you could satisfy both it and this License would be to
6553 refrain entirely from distribution of the Program.
6555 If any portion of this section is held invalid or unenforceable under
6556 any particular circumstance, the balance of the section is intended to
6557 apply and the section as a whole is intended to apply in other
6558 circumstances.
6560 It is not the purpose of this section to induce you to infringe any
6561 patents or other property right claims or to contest validity of any
6562 such claims; this section has the sole purpose of protecting the
6563 integrity of the free software distribution system, which is
6564 implemented by public license practices. Many people have made
6565 generous contributions to the wide range of software distributed
6566 through that system in reliance on consistent application of that
6567 system; it is up to the author/donor to decide if he or she is willing
6568 to distribute software through any other system and a licensee cannot
6569 impose that choice.
6571 This section is intended to make thoroughly clear what is believed to
6572 be a consequence of the rest of this License.
6574 8. If the distribution and/or use of the Program is restricted in
6575 certain countries either by patents or by copyrighted interfaces, the
6576 original copyright holder who places the Program under this License
6577 may add an explicit geographical distribution limitation excluding
6578 those countries, so that distribution is permitted only in or among
6579 countries not thus excluded. In such case, this License incorporates
6580 the limitation as if written in the body of this License.
6582 9. The Free Software Foundation may publish revised and/or new versions
6583 of the General Public License from time to time. Such new versions will
6584 be similar in spirit to the present version, but may differ in detail to
6585 address new problems or concerns.
6587 Each version is given a distinguishing version number. If the Program
6588 specifies a version number of this License which applies to it and "any
6589 later version", you have the option of following the terms and conditions
6590 either of that version or of any later version published by the Free
6591 Software Foundation. If the Program does not specify a version number of
6592 this License, you may choose any version ever published by the Free Software
6593 Foundation.
6595 10. If you wish to incorporate parts of the Program into other free
6596 programs whose distribution conditions are different, write to the author
6597 to ask for permission. For software which is copyrighted by the Free
6598 Software Foundation, write to the Free Software Foundation; we sometimes
6599 make exceptions for this. Our decision will be guided by the two goals
6600 of preserving the free status of all derivatives of our free software and
6601 of promoting the sharing and reuse of software generally.
6603 NO WARRANTY
6605 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
6606 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
6607 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
6609 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
6610 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
6611 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
6612 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
6613 REPAIR OR CORRECTION.
6615 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
6616 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
6617 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
6618 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
6619 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
6620 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
6621 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
6622 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
6623 POSSIBILITY OF SUCH DAMAGES.
6625 END OF TERMS AND CONDITIONS
6627 How to Apply These Terms to Your New Programs
6629 If you develop a new program, and you want it to be of the greatest
6630 possible use to the public, the best way to achieve this is to make it
6631 free software which everyone can redistribute and change under these terms.
6633 To do so, attach the following notices to the program. It is safest
6634 to attach them to the start of each source file to most effectively
6635 convey the exclusion of warranty; and each file should have at least
6641 This program is free software; you can redistribute it and/or modify
6642 it under the terms of the GNU General Public License as published by
6643 the Free Software Foundation; either version 2 of the License, or
6644 (at your option) any later version.
6646 This program is distributed in the hope that it will be useful,
6647 but WITHOUT ANY WARRANTY; without even the implied warranty of
6648 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6649 GNU General Public License for more details.
6651 You should have received a copy of the GNU General Public License
6652 along with this program; if not, write to the Free Software
6656 Also add information on how to contact you by electronic and paper mail.
6658 If the program is interactive, make it output a short notice like this
6659 when it starts in an interactive mode:
6661 Gnomovision version 69, Copyright (C) year name of author
6662 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
6663 This is free software, and you are welcome to redistribute it
6664 under certain conditions; type `show c' for details.
6666 The hypothetical commands `show w' and `show c' should show the appropriate
6667 parts of the General Public License. Of course, the commands you use may
6668 be called something other than `show w' and `show c'; they could even be
6669 mouse-clicks or menu items--whatever suits your program.
6671 You should also get your employer (if you work as a programmer) or your
6673 necessary. Here is a sample; alter the names:
6675 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
6676 `Gnomovision' (which makes passes at compilers) written by James Hacker.
6679 Ty Coon, President of Vice
6681 This General Public License does not permit incorporating your program into
6682 proprietary programs. If your program is a subroutine library, you may
6683 consider it more useful to permit linking proprietary applications with the
6684 library. If this is what you want to do, use the GNU Library General
6685 Public License instead of this License.
6686 </pre>
6687 </div>
6692 <p>Permission to use, copy, modify, and distribute this software and
6693 its documentation for any purpose and without fee is hereby granted,
6694 provided that the above copyright notice appear in all copies and
6695 that both that copyright notice and this permission notice appear in
6696 supporting documentation.</p>
6697 <p>NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
6698 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
6699 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
6700 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
6701 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6702 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
6703 USE OR PERFORMANCE OF THIS SOFTWARE.</p>
6704 </div>
6706 </div>
6711 Generated by <a class="reference external" href="http://docutils.sourceforge.net/">Docutils</a> from <a class="reference external" href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> source.
6713 </div>
6714 </body>
6715 </html>