| blob | 4c1f56587756a895d1352f012650b88c8149bce8 |
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <head>
12 /*
13 :Author: Enrico Troeger
14 :Contact: enrico(dot)troeger(at)uvena(dot)de
15 :Copyright: This stylesheet has been placed in the public domain.
17 Stylesheet for Geany's documentation based on a version of John Gabriele.
18 */
20 @media screen {
22 body {
23 background-color: #f2f2f2;
24 color: #404040;
25 margin-left: 0.4em;
26 max-width: 60em;
27 font-size: 90%;
28 }
30 a {
31 color: #990000;
32 }
34 a:visited {
35 color: #7E558E;
36 }
38 a:hover {
39 text-decoration: none;
40 }
42 h1 {
43 border-top: 1px dotted;
44 margin-top: 2em;
45 }
47 h1, h2, h3 {
48 font-family: sans-serif;
49 color: #5D0606;
50 }
52 h1.title {
53 text-align: left }
55 h2 {
56 margin-top: 30px;
57 }
59 h2.subtitle {
60 text-align: left }
62 h3 {
63 padding-left: 3px;
64 }
66 blockquote, pre {
67 border: 1px solid;
68 padding: 0.4em;
69 }
71 blockquote {
72 font-family: sans-serif;
73 background-color: #DBEDD5;
74 border: 1px dotted;
75 border-left: 4px solid;
76 border-color: #9FD98C;
77 }
79 pre {
80 background-color: #ECDFCE;
81 border: 1px dotted;
82 border-left: 4px solid;
83 border-color: #D9BE9A;
84 }
86 tt, pre, code {
87 color: #6D4212;
88 }
90 table {
91 border: 1px solid #D9BE9A;
92 }
94 th {
95 background-color: #ECDFCE;
96 border: 1px dotted #D9BE9A;
97 }
99 td {
100 border: 1px dotted #D9BE9A;
101 }
103 .docinfo-name {
104 color: #5D0606;
105 }
107 p.admonition-title {
108 color: #990000;
109 font-weight: bold;
110 }
112 div.note {
114 padding: 0em;
115 }
117 dt {
118 font-style: italic;
119 }
121 }
123 @media print {
125 }
127 </style>
128 </head>
129 <body>
138 <td>Enrico Tröger
139 <br />Nick Treleaven
145 </tbody>
146 </table>
148 <p>This document is distributed under the terms of the GNU General Public
149 License as published by the Free Software Foundation; either version 2
150 of the License, or (at your option) any later version. A copy of this
151 license can be found in the file COPYING included with the source code
152 of this program, and also in the chapter <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
160 <li><a class="reference internal" href="#about-this-document" id="id16">About this document</a></li>
161 </ul>
162 </li>
166 <li><a class="reference internal" href="#source-compilation" id="id20">Source compilation</a><ul>
167 <li><a class="reference internal" href="#autotools-based-build-system" id="id21">Autotools based build system</a></li>
168 <li><a class="reference internal" href="#waf-based-build-system" id="id22">Waf based build system</a><ul>
170 <li><a class="reference internal" href="#cleaning-the-cache" id="id24">Cleaning the Cache</a></li>
171 </ul>
172 </li>
173 </ul>
174 </li>
175 <li><a class="reference internal" href="#custom-installation" id="id25">Custom installation</a></li>
176 <li><a class="reference internal" href="#dynamic-linking-loader-support-and-vte" id="id26">Dynamic linking loader support and VTE</a></li>
178 </ul>
179 </li>
180 <li><a class="reference internal" href="#installation-prefix" id="id28">Installation prefix</a></li>
181 </ul>
182 </li>
185 <li><a class="reference internal" href="#the-geany-workspace" id="id31">The Geany workspace</a></li>
186 <li><a class="reference internal" href="#command-line-options" id="id32">Command line options</a></li>
189 <li><a class="reference internal" href="#opening-files-from-the-command-line-in-a-running-instance" id="id35">Opening files from the command-line in a running instance</a></li>
190 <li><a class="reference internal" href="#virtual-terminal-emulator-widget-vte" id="id36">Virtual terminal emulator widget (VTE)</a></li>
191 <li><a class="reference internal" href="#defining-own-widget-styles-using-gtkrc-2-0" id="id37">Defining own widget styles using .gtkrc-2.0</a></li>
192 </ul>
193 </li>
195 <li><a class="reference internal" href="#switching-between-documents" id="id39">Switching between documents</a></li>
196 </ul>
197 </li>
198 <li><a class="reference internal" href="#character-sets-and-unicode-byte-order-mark-bom" id="id40">Character sets and Unicode Byte-Order-Mark (BOM)</a><ul>
199 <li><a class="reference internal" href="#using-character-sets" id="id41">Using character sets</a></li>
200 <li><a class="reference internal" href="#in-file-encoding-specification" id="id42">In-file encoding specification</a></li>
201 <li><a class="reference internal" href="#special-encoding-none" id="id43">Special encoding "None"</a></li>
202 <li><a class="reference internal" href="#unicode-byte-order-mark-bom" id="id44">Unicode Byte-Order-Mark (BOM)</a></li>
203 </ul>
204 </li>
207 <li><a class="reference internal" href="#column-mode-editing-rectangular-selections" id="id47">Column mode editing (rectangular selections)</a></li>
208 <li><a class="reference internal" href="#drag-and-drop-of-text" id="id48">Drag and drop of text</a></li>
212 <li><a class="reference internal" href="#code-navigation-history" id="id52">Code navigation history</a></li>
213 <li><a class="reference internal" href="#sending-text-through-custom-commands" id="id53">Sending text through custom commands</a></li>
216 <li><a class="reference internal" href="#word-part-completion" id="id56">Word part completion</a></li>
217 <li><a class="reference internal" href="#scope-autocompletion" id="id57">Scope autocompletion</a></li>
218 </ul>
219 </li>
220 <li><a class="reference internal" href="#user-definable-snippets" id="id58">User-definable snippets</a></li>
221 <li><a class="reference internal" href="#inserting-unicode-characters" id="id59">Inserting Unicode characters</a></li>
222 </ul>
223 </li>
224 <li><a class="reference internal" href="#search-replace-and-go-to" id="id60">Search, replace and go to</a><ul>
227 </ul>
228 </li>
232 <li><a class="reference internal" href="#change-font-in-search-dialog-text-fields" id="id66">Change font in search dialog text fields</a></li>
233 </ul>
234 </li>
237 <li><a class="reference internal" href="#filtering-out-version-control-files" id="id69">Filtering out version control files</a></li>
238 </ul>
239 </li>
242 </ul>
243 </li>
244 <li><a class="reference internal" href="#go-to-tag-definition" id="id72">Go to tag definition</a></li>
245 <li><a class="reference internal" href="#go-to-tag-declaration" id="id73">Go to tag declaration</a></li>
247 <li><a class="reference internal" href="#regular-expressions" id="id75">Regular expressions</a></li>
248 </ul>
249 </li>
253 <li><a class="reference internal" href="#default-global-tags-files" id="id79">Default global tags files</a></li>
254 <li><a class="reference internal" href="#global-tags-file-format" id="id80">Global tags file format</a></li>
255 <li><a class="reference internal" href="#generating-a-global-tags-file" id="id81">Generating a global tags file</a></li>
256 </ul>
257 </li>
259 </ul>
260 </li>
262 <li><a class="reference internal" href="#general-startup-preferences" id="id84">General Startup preferences</a><ul>
266 </ul>
267 </li>
268 <li><a class="reference internal" href="#general-miscellaneous-preferences" id="id88">General Miscellaneous preferences</a><ul>
272 </ul>
273 </li>
274 <li><a class="reference internal" href="#interface-preferences" id="id92">Interface preferences</a><ul>
280 </ul>
281 </li>
282 <li><a class="reference internal" href="#toolbar-preferences" id="id98">Toolbar preferences</a><ul>
285 </ul>
286 </li>
287 <li><a class="reference internal" href="#editor-features-preferences" id="id101">Editor Features preferences</a><ul>
289 </ul>
290 </li>
291 <li><a class="reference internal" href="#editor-indentation-preferences" id="id103">Editor Indentation preferences</a><ul>
292 <li><a class="reference internal" href="#indentation-group" id="id104">Indentation group</a></li>
293 </ul>
294 </li>
295 <li><a class="reference internal" href="#editor-completions-preferences" id="id105">Editor Completions preferences</a><ul>
297 <li><a class="reference internal" href="#auto-close-quotes-and-brackets" id="id107">Auto-close quotes and brackets</a></li>
298 </ul>
299 </li>
300 <li><a class="reference internal" href="#editor-display-preferences" id="id108">Editor Display preferences</a><ul>
303 </ul>
304 </li>
305 <li><a class="reference internal" href="#files-preferences" id="id111">Files preferences</a><ul>
309 </ul>
310 </li>
311 <li><a class="reference internal" href="#tools-preferences" id="id115">Tools preferences</a><ul>
314 </ul>
315 </li>
316 <li><a class="reference internal" href="#template-preferences" id="id118">Template preferences</a><ul>
318 </ul>
319 </li>
320 <li><a class="reference internal" href="#keybinding-preferences" id="id120">Keybinding preferences</a></li>
321 <li><a class="reference internal" href="#printing-preferences" id="id121">Printing preferences</a></li>
322 <li><a class="reference internal" href="#terminal-vte-preferences" id="id122">Terminal (VTE) preferences</a><ul>
324 </ul>
325 </li>
326 </ul>
327 </li>
328 <li><a class="reference internal" href="#project-management" id="id124">Project Management</a><ul>
330 <li><a class="reference internal" href="#project-properties" id="id126">Project Properties</a><ul>
331 <li><a class="reference internal" href="#set-base-path-button" id="id127">Set Base Path Button</a></li>
332 </ul>
333 </li>
336 </ul>
337 </li>
340 <li><a class="reference internal" href="#default-build-menu-items" id="id132">Default Build Menu Items</a><ul>
344 <li><a class="reference internal" href="#make-custom-target" id="id136">Make custom target</a></li>
349 <li><a class="reference internal" href="#stopping-running-processes" id="id141">Stopping running processes</a><ul>
350 <li><a class="reference internal" href="#terminal-emulators" id="id142">Terminal emulators</a></li>
351 </ul>
352 </li>
353 <li><a class="reference internal" href="#set-build-commands" id="id143">Set Build Commands</a></li>
354 </ul>
355 </li>
356 <li><a class="reference internal" href="#build-menu-configuration" id="id144">Build Menu Configuration</a></li>
357 <li><a class="reference internal" href="#build-menu-commands-dialog" id="id145">Build Menu Commands Dialog</a><ul>
358 <li><a class="reference internal" href="#substitutions-in-commands-and-working-directories" id="id146">Substitutions in Commands and Working Directories</a></li>
359 <li><a class="reference internal" href="#build-menu-keyboard-shortcuts" id="id147">Build Menu Keyboard Shortcuts</a></li>
360 <li><a class="reference internal" href="#configuration-files" id="id148">Configuration Files</a></li>
361 </ul>
362 </li>
363 </ul>
364 </li>
368 <li><a class="reference internal" href="#switching-documents" id="id152">Switching documents</a></li>
369 <li><a class="reference internal" href="#configurable-keybindings" id="id153">Configurable keybindings</a><ul>
371 <li><a class="reference internal" href="#editor-keybindings" id="id155">Editor keybindings</a></li>
372 <li><a class="reference internal" href="#clipboard-keybindings" id="id156">Clipboard keybindings</a></li>
373 <li><a class="reference internal" href="#select-keybindings" id="id157">Select keybindings</a></li>
374 <li><a class="reference internal" href="#insert-keybindings" id="id158">Insert keybindings</a></li>
375 <li><a class="reference internal" href="#format-keybindings" id="id159">Format keybindings</a></li>
376 <li><a class="reference internal" href="#settings-keybindings" id="id160">Settings keybindings</a></li>
377 <li><a class="reference internal" href="#search-keybindings" id="id161">Search keybindings</a></li>
378 <li><a class="reference internal" href="#go-to-keybindings" id="id162">Go to keybindings</a></li>
380 <li><a class="reference internal" href="#focus-keybindings" id="id164">Focus keybindings</a></li>
381 <li><a class="reference internal" href="#notebook-tab-keybindings" id="id165">Notebook tab keybindings</a></li>
382 <li><a class="reference internal" href="#document-keybindings" id="id166">Document keybindings</a></li>
383 <li><a class="reference internal" href="#build-keybindings" id="id167">Build keybindings</a></li>
384 <li><a class="reference internal" href="#tools-keybindings" id="id168">Tools keybindings</a></li>
386 </ul>
387 </li>
388 </ul>
389 </li>
390 </ul>
391 </li>
394 <li><a class="reference internal" href="#global-configuration-file" id="id172">Global configuration file</a></li>
395 <li><a class="reference internal" href="#filetype-definition-files" id="id173">Filetype definition files</a><ul>
401 <li><a class="reference internal" href="#using-a-named-style" id="id179">Using a named style</a></li>
402 </ul>
403 </li>
404 <li><a class="reference internal" href="#keywords-section" id="id180">[keywords] Section</a></li>
405 <li><a class="reference internal" href="#lexer-properties-section" id="id181">[lexer_properties] Section</a></li>
406 <li><a class="reference internal" href="#settings-section" id="id182">[settings] Section</a></li>
407 <li><a class="reference internal" href="#build-settings-section" id="id183">[build_settings] Section</a></li>
408 </ul>
409 </li>
410 <li><a class="reference internal" href="#special-file-filetypes-common" id="id184">Special file filetypes.common</a><ul>
411 <li><a class="reference internal" href="#named-styles-section" id="id185">[named_styles] Section</a></li>
414 </ul>
415 </li>
416 </ul>
417 </li>
418 <li><a class="reference internal" href="#filetype-extensions" id="id188">Filetype extensions</a></li>
419 <li><a class="reference internal" href="#preferences-file-format" id="id189">Preferences File Format</a><ul>
420 <li><a class="reference internal" href="#hidden-preferences" id="id190">Hidden preferences</a></li>
421 <li><a class="reference internal" href="#build-menu-section" id="id191">[build-menu] Section</a></li>
422 </ul>
423 </li>
424 <li><a class="reference internal" href="#project-file-format" id="id192">Project File Format</a><ul>
425 <li><a class="reference internal" href="#build-menu-additions" id="id193">[build-menu] Additions</a></li>
426 </ul>
427 </li>
429 <li><a class="reference internal" href="#template-meta-data" id="id195">Template meta data</a></li>
431 <li><a class="reference internal" href="#custom-file-templates" id="id197">Custom file templates</a></li>
432 <li><a class="reference internal" href="#filetype-templates" id="id198">Filetype templates</a></li>
433 </ul>
434 </li>
435 <li><a class="reference internal" href="#customizing-templates" id="id199">Customizing templates</a><ul>
436 <li><a class="reference internal" href="#template-wildcards" id="id200">Template wildcards</a></li>
437 </ul>
438 </li>
439 </ul>
440 </li>
441 <li><a class="reference internal" href="#customizing-the-toolbar" id="id201">Customizing the toolbar</a><ul>
442 <li><a class="reference internal" href="#manually-editing-of-the-toolbar-layout" id="id202">Manually editing of the toolbar layout</a></li>
443 <li><a class="reference internal" href="#available-toolbar-elements" id="id203">Available toolbar elements</a></li>
444 </ul>
445 </li>
446 </ul>
447 </li>
448 <li><a class="reference internal" href="#plugin-documentation" id="id204">Plugin documentation</a><ul>
452 </ul>
453 </li>
454 </ul>
455 </li>
456 <li><a class="reference internal" href="#contributing-to-this-document" id="id208">Contributing to this document</a></li>
457 <li><a class="reference internal" href="#scintilla-keyboard-commands" id="id209">Scintilla keyboard commands</a><ul>
458 <li><a class="reference internal" href="#keyboard-commands" id="id210">Keyboard commands</a></li>
459 </ul>
460 </li>
462 <li><a class="reference internal" href="#document-notebook" id="id212">Document notebook</a></li>
466 </ul>
467 </li>
468 <li><a class="reference internal" href="#compile-time-options" id="id216">Compile-time options</a><ul>
475 </ul>
476 </li>
477 <li><a class="reference internal" href="#gnu-general-public-license" id="id223">GNU General Public License</a></li>
478 <li><a class="reference internal" href="#license-for-scintilla-and-scite" id="id224">License for Scintilla and SciTE</a></li>
479 </ul>
480 </div>
485 <p>Geany is a small and lightweight Integrated Development Environment. It
486 was developed to provide a small and fast IDE, which has only a few
487 dependencies on other packages. Another goal was to be as independent
488 as possible from a particular Desktop Environment like KDE or GNOME -
489 Geany only requires the GTK2 runtime libraries.</p>
498 <li>Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
499 Pascal, and others</li>
505 </ul>
506 </div>
509 <p>You can obtain Geany from <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a> or perhaps also from
510 your distribution. For a list of available packages, please see
511 <a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
512 </div>
515 <p>Geany is distributed under the terms of the GNU General Public License
516 as published by the Free Software Foundation; either version 2 of
517 the License, or (at your option) any later version. A copy of this
518 license can be found in the file COPYING included with the source
519 code of this program and in the chapter, <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
520 <p>The included Scintilla library (found in the subdirectory
521 <tt class="docutils literal">scintilla/</tt>) has its own license, which can be found in the chapter,
522 <a class="reference internal" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
523 </div>
526 <p>This documentation is available in HTML and text formats.
527 The latest version can always be found at <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a>.</p>
528 <p>If you want to contribute to it, see <a class="reference internal" href="#contributing-to-this-document">Contributing to this document</a>.</p>
529 </div>
530 </div>
536 (Pango, GLib and ATK). Your distro should provide packages for these,
537 usually installed by default. For Windows, you can download an installer
538 from the website which bundles these libraries.</p>
539 </div>
542 <p>There are many binary packages available. For an up-to-date but maybe
543 incomplete list see <a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
544 </div>
547 <p>Compiling Geany is quite easy.
549 You also need the Pango, GLib and ATK libraries and header files.
550 All these files are available at <a class="reference external" href="http://www.gtk.org">http://www.gtk.org</a>, but very often
551 your distro will provide development packages to save the trouble of
552 building these yourself.</p>
553 <p>Furthermore you need, of course, a C and C++ compiler. The GNU versions
554 of these tools are recommended.</p>
557 <p>The Autotools based build system is very mature and has been well tested.
558 To use it, you just need the Make tool, preferably GNU Make.</p>
561 $ ./configure
562 $ make
563 </pre>
566 % make install
567 </pre>
568 </div>
571 <p>The Waf build system is still quite young and under heavy development but already in a
572 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
573 to install Python on your system.
574 The advantage of the Waf build system over the Autotools based build system is that the whole
575 build process might be a bit faster. Especially when you use the Waf
576 cache feature for repetitive builds (e.g. when changing only a few source files
577 to test something) will become much faster since Waf will cache and re-use the
578 unchanged built files and only compile the changed code again. See <a class="reference internal" href="#waf-cache">Waf Cache</a> for details.
579 To build Geany with Waf as run:</p>
581 $ ./waf configure
582 $ ./waf build
583 </pre>
586 % ./waf install
587 </pre>
590 <p>The Waf build system has a nice and interesting feature which can help to avoid
591 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
592 or trying to debug something in Geany.
593 Waf is able to store and retrieve the object files from a cache. This cache is declared
595 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
596 this, you first need to create this directory:</p>
598 $ mkdir -p ~/.cache/waf
599 </pre>
600 <p>then add the environment variable to your shell configuration (the following example is for
601 Bash and should be adjusted to your used shell):</p>
603 export WAFCACHE=/home/username/.cache/waf
604 </pre>
605 <p>Remember to replace <tt class="docutils literal">username</tt> with your actual username.</p>
606 <p>More information about the Waf cache feature are available at
607 <a class="reference external" href="http://code.google.com/p/waf/wiki/CacheObjectFiles">http://code.google.com/p/waf/wiki/CacheObjectFiles</a>.</p>
610 <p>You should be careful about the size of the cache directory as it may
611 grow rapidly over time.
612 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
613 clean by yourself.
614 An easy way to keep it clean is to run the following command regularly to remove old
615 cached files:</p>
617 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
618 </pre>
620 <p>For details about the <tt class="docutils literal">find</tt> command and its options, check its manual page.</p>
621 </div>
622 </div>
623 </div>
626 <p>The configure script supports several common options, for a detailed
627 list, type:</p>
629 $ ./configure --help
630 </pre>
634 </dl>
636 <p>You may also want to read the INSTALL file for advanced installation
637 options.</p>
639 <li>See also <a class="reference internal" href="#compile-time-options">Compile-time options</a>.</li>
640 </ul>
641 </div>
644 <p>In the case that your system lacks dynamic linking loader support, you
645 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>
646 script. This prevents compiling Geany with dynamic linking loader
647 support for automatically loading <tt class="docutils literal">libvte.so.4</tt> if available.</p>
648 </div>
651 <p>If there are any errors during compilation, check your build
652 environment and try to find the error, otherwise contact the mailing
653 list or one the authors. Sometimes you might need to ask for specific
654 help from your distribution.</p>
655 </div>
656 </div>
659 <p>If you want to edit any of Geany's system configuration files after
660 installation you will need to know the installation prefix. Usually this
661 is not necessary as you can just use per user configuration files and
662 you will not need root permissions.</p>
663 <p>Use the <tt class="docutils literal"><span class="pre">--print-prefix</span></tt> option to Geany to check - see <a class="reference internal" href="#command-line-options">Command line
665 <p>This is commonly <tt class="docutils literal">/usr</tt> if you installed from a binary package, or
667 </div>
668 </div>
674 <ul>
676 <p>Choose in your application menu of your used Desktop Environment:
678 </li>
680 <p>To start Geany from a command line, type the following and press
681 Return:</p>
683 % geany
684 </pre>
685 </li>
686 </ul>
687 </div>
699 </ul>
700 </li>
708 </ul>
709 </li>
711 </ul>
714 <p>The sizes of the sidebar and message window can be adjusted by
715 dragging the dividers.</p>
716 </div>
720 <colgroup>
724 </colgroup>
729 </tr>
730 </thead>
734 <td>Set initial line number for the first opened file
735 (same as --line, do not put a space between the + sign
738 </tr>
742 </tr>
745 <td>Use an alternate configuration directory. The default
746 configuration directory is <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt> and that
748 reside.</td>
749 </tr>
752 <td>Print a list of Geany's internal filetype names (useful
753 for snippets configuration).</td>
754 </tr>
757 <td>Generate a global tags file (see
758 <a class="reference internal" href="#generating-a-global-tags-file">Generating a global tags file</a>).</td>
759 </tr>
763 </tr>
766 <td>Do not open files in a running instance, force opening
767 a new instance. Only available if Geany was compiled
768 with support for Sockets.</td>
769 </tr>
773 </tr>
776 <td>Do not show the message window. Use this option if you
777 do not need compiler messages or VTE support.</td>
778 </tr>
781 <td>Do not load symbol completion and call tip data. Use this
782 option if you do not want to use them.</td>
783 </tr>
787 </tr>
790 <td>Print installation prefix, the data directory, the lib
791 directory and the locale directory (in this order) to
792 stdout, one line each. This is mainly intended for plugin
793 authors to detect installation paths.</td>
794 </tr>
798 </tr>
801 <td>Do not load terminal support. Use this option if you do
802 not want to load the virtual terminal emulator widget
804 then terminal-support is automatically disabled. Only
805 available if Geany was compiled with support for VTE.</td>
806 </tr>
810 running Geany instance. This can be used with the following
811 command to execute Geany on the current workspace:</p>
813 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
814 </pre>
815 </td>
816 </tr>
819 <td>Specify explicitly the path including filename or only
820 the filename to the VTE library, e.g.
821 <tt class="docutils literal">/usr/lib/libvte.so</tt> or <tt class="docutils literal">libvte.so</tt>. This option is
822 only needed when the auto-detection does not work. Only
823 available if Geany was compiled with support for VTE.</td>
824 </tr>
828 </tr>
832 </tr>
836 </tr>
840 Geany to ignore loading stored files from the last
841 session (if enabled).
842 Geany also recognizes line and column information when
843 appended to the filename with colons, e.g.
847 must be the first non-option argument. All additionally
848 given files are ignored.</p>
849 </td>
850 </tr>
851 </tbody>
852 </table>
856 </pre>
857 <p>Geany supports all generic GTK options, a list is available on the
858 help screen.</p>
859 </div>
864 <p>At startup, Geany loads all files from the last time Geany was
865 launched. You can disable this feature in the preferences dialog
866 (see <a class="reference internal" href="#general-startup-preferences">General Startup preferences</a>). If you specify some
867 files on the command line, only these files will be opened, but you
868 can find the files from the last session in the file menu under the
870 opened files. You can change the number of recently opened files in
871 the preferences dialog.</p>
872 <p>You can start several instances of Geany, but only the first will
873 load files from the last session. To run a second instance of Geany,
874 do not specify any filenames on the command-line, or disable opening
875 files in a running instance using the appropriate command line option.</p>
876 </div>
878 <h3><a class="toc-backref" href="#id35">Opening files from the command-line in a running instance</a></h3>
879 <p>Geany detects if there is an an instance of itself already running and opens files
880 from the command-line in that instance. So, Geany can
881 be used to view and edit files by opening them from other programs
882 such as a file manager.</p>
886 </pre>
887 <p>This would open the file <tt class="docutils literal">some_file.foo</tt> with the cursor on line 55,
889 <p>If you do not like this for some reason, you can disable using the first
890 instance by using the appropriate command line option -- see the section
892 </div>
895 <p>If you have installed <tt class="docutils literal">libvte.so</tt> on your system, it is loaded
896 automatically by Geany, and you will have a terminal widget in the
897 notebook at the bottom.</p>
898 <p>If Geany cannot find any <tt class="docutils literal">libvte.so</tt> at startup, the terminal widget
899 will not be loaded. So there is no need to install the package containing
900 this file in order to run Geany. Additionally, you can disable the use
901 of the terminal widget by command line option, for more information
902 see the section called <a class="reference internal" href="#command-line-options">Command line options</a>.</p>
903 <p>You can use this terminal (from now on called VTE) much as you would
904 a terminal program like xterm. There is basic clipboard support. You
905 can paste the contents of the clipboard by pressing the right mouse
906 button to open the popup menu, and choosing Paste. To copy text from
907 the VTE, just select the desired text and then press the right mouse
908 button and choose Copy from the popup menu. On systems running the
909 X Window System you can paste the last selected text by pressing the
910 middle mouse button in the VTE (on 2-button mice, the middle button
911 can often be simulated by pressing both mouse buttons together).</p>
912 <p>In the preferences dialog you can specify a shell which should be
913 started in the VTE. To make the specified shell a login shell just
914 use the appropriate command line options for the shell. These options
915 should be found in the manual page of the shell. For zsh and bash
916 you can use the argument <tt class="docutils literal"><span class="pre">--login</span></tt>.</p>
919 <p class="last">Geany tries to load <tt class="docutils literal">libvte.so</tt>. If this fails, it tries to load
920 some other filenames. If this fails too, you should check whether you
921 installed libvte correctly. Again note, Geany will run without this
922 library.</p>
923 </div>
924 <p>It could be, that the library is called something else than
925 <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
926 please set a link to the correct file (as root):</p>
928 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
929 </pre>
930 <p>Obviously, you have to adjust the paths and set X to the number of your
932 <p>You can also specify the filename of the VTE library to use on the command
933 line (see the section called <a class="reference internal" href="#command-line-options">Command line options</a>) or at compile time
934 by specifying the command line option <tt class="docutils literal"><span class="pre">--with-vte-module-path</span></tt> to
935 ./configure.</p>
936 </div>
939 <p>You can define your widget style for many of Geany's GUI parts. To
940 do this, just edit your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home
941 directory on UNIX-like systems and in the etc subdirectory of your
942 Geany installation on Windows).</p>
943 <p>To have a defined style used by Geany you must assign it to
944 at least one of Geany's widgets. For example use the following line:</p>
947 </pre>
949 widgets. You can also assign styles only to specific widgets. At the
950 moment you can use the following widgets:</p>
961 </ul>
962 <p>An example of a simple <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>:</p>
965 {
967 }
971 {
973 }
975 </pre>
976 </div>
977 </div>
982 <p>The documents list and the editor tabs are two different ways
983 to switch between documents using the mouse. When you hit the key
984 combination to move between tabs, the order is determined by the tab
985 order. Its is not alphabetical as shown in the documents list
986 (regardless of whether or not editor tabs are visible).</p>
987 <p>The tabs can be positioned at the top, bottom, left, or right of the
988 main editing window, by a selection in the interface preferences.</p>
989 <p>See the <a class="reference internal" href="#notebook-tab-keybindings">Notebook tab keybindings</a> section for useful
990 shortcuts including for Most-Recently-Used document switching.</p>
991 </div>
992 </div>
994 <h2><a class="toc-backref" href="#id40">Character sets and Unicode Byte-Order-Mark (BOM)</a></h2>
997 <p>Geany provides support for detecting and converting character sets. So
998 you can open and save files in different character sets, and even
999 convert a file from one character set to another. To do this,
1000 Geany uses the character conversion capabilities of the GLib library.</p>
1001 <p>Only text files are supported, i.e. opening files which contain
1002 NULL-bytes may fail. Geany will try to open the file anyway but it is
1003 likely that the file will be truncated because it can only be read up
1004 to the first occurrence of a NULL-byte. All characters after this
1005 position are lost and are not written when you save the file.</p>
1006 <p>Geany tries to detect the encoding of a file while opening it, but
1007 auto-detecting the encoding of a file is not easy and sometimes an
1008 encoding might not be detected correctly. In this case you have to
1009 set the encoding of the file manually in order to display it
1010 correctly. You can this in the file open dialog by selecting an
1011 encoding in the drop down box or by reloading the file with the
1013 encodings but there are also some encodings where it is known that
1014 auto-detection has problems.</p>
1016 <ul>
1018 <p>This opens the file with the encoding specified in the encoding drop
1021 file will be opened without any character conversion and Geany will
1022 not try to auto-detect the encoding (see below for more information).</p>
1023 </li>
1025 <p>This item reloads the current file with the specified encoding. It can
1026 help if you opened a file and found out that the wrong encoding was used.</p>
1027 </li>
1029 <p>Contrary to the above two options, this will not change or reload
1030 the current file unless you save it. It is useful when you want to
1031 change the encoding of the file.</p>
1032 </li>
1034 <p>As mentioned above, auto-detecting the encoding of a file may fail on
1035 some encodings. If you know that Geany doesn't open a certain file,
1036 you can add the specification line, described in the next section,
1037 to the beginning of the file to force Geany to use a specific
1038 encoding when opening the file.</p>
1039 </li>
1040 </ul>
1041 </div>
1044 <p>Geany detects meta tags of HTML files which contain charset information
1045 like:</p>
1047 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
1048 </pre>
1049 <p>and the specified charset is used when opening the file. This is useful if the
1050 encoding of the file cannot be detected properly.
1051 For non-HTML files you can also define a line like:</p>
1054 </pre>
1058 </pre>
1059 <p>to force an encoding to be used. The #, /* and */ are examples
1060 of filetype-specific comment characters. It doesn't matter which
1062 as there is at least one whitespace character before and after this
1063 string. Whitespace characters are in this case a space or tab character.
1066 Then you simply add such a line to the file and Geany will open it
1067 correctly the next time.</p>
1069 regular expression used to find the encoding string:
1070 <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>
1075 </div>
1079 </pre>
1083 </pre>
1084 </div>
1088 encoding. It is useful when you know that Geany cannot auto-detect
1089 the encoding of a file and it is not displayed correctly. Especially
1090 when the file contains NULL-bytes this can be useful to skip auto
1091 detection and open the file properly at least until the occurrence
1092 of the first NULL-byte. Using this encoding opens the file as it is
1093 without any character conversion.</p>
1094 </div>
1097 <p>Furthermore, Geany detects a Unicode Byte Order Mark (see
1098 <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,
1099 this feature is only available if the opened file is in a Unicode
1100 encoding. The Byte Order Mark helps to detect the encoding of a file,
1102 using a Byte Order Mark could cause some problems for programs not
1103 expecting it, e.g. the compiler gcc stops
1104 with stray errors, PHP does not parse a script containing a BOM and
1105 script files starting with a she-bang maybe cannot be started. In the
1106 status bar you can easily see whether the file starts with a BOM or
1107 not.</p>
1108 <p>If you want to set a BOM for a file or if you want to remove it
1109 from a file, just use the document menu and toggle the checkbox.</p>
1113 to use it, then it is probably not important for you and you can
1114 safely ignore it.</p>
1115 </div>
1116 </div>
1117 </div>
1122 <p>Geany provides basic code folding support. Folding means the ability to
1123 show and hide parts of the text in the current file. You can hide
1124 unimportant code sections and concentrate on the parts you are working on
1125 and later you can show hidden sections again. In the editor window there is
1126 a small grey margin on the left side with [+] and [-] symbols which
1127 show hidden parts and hide parts of the file respectively. By
1128 clicking on these icons you can simply show and hide sections which are
1129 marked by vertical lines within this margin. For many filetypes nested
1130 folding is supported, so there may be several fold points within other
1131 fold points.</p>
1132 <p>If you don't like it or don't need it at all, you can simply disable
1133 folding support completely in the preferences dialog.</p>
1135 a fold point" option in the preference dialog. If activated, Geany will
1136 unfold all nested fold points below the current one if they are already
1137 folded (when clicking on a [+] symbol).
1138 When clicking on a [-] symbol, Geany will fold all nested fold points
1139 below the current one if they are unfolded.</p>
1140 <p>This option can be inverted by pressing the Shift
1141 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
1142 children of a fold point" option is enabled, pressing Shift will disable
1143 it for this click and vice versa.</p>
1144 </div>
1147 <p>There is basic support for column mode editing. To use it, create a
1148 rectangular selection by holding down the Control and Shift keys
1149 (or Control and Alt if it doesn't work) while
1150 selecting some text. It is also possible to create a zero-column selection
1151 but be careful because there is no visual indication of this selection.
1152 Once a rectangular selection exists you can start editing the text within
1153 this selection and the modifications will be done for every line in the
1154 selection.</p>
1155 </div>
1158 <p>If you drag selected text in the editor widget of Geany the text is
1159 moved to the position where the mouse pointer is when releasing the
1160 mouse button. Holding Control when releasing the mouse button will
1161 copy the text instead. This behaviour was changed in Geany 0.11 -
1162 before the selected text was copied to the new position.</p>
1163 </div>
1166 <p>Geany allows each document to indent either with a tab character or
1167 multiple spaces. The default indent mode is set in the <a class="reference internal" href="#editor-features-preferences">Editor Features
1168 preferences</a> (see the link for more information). But
1171 this scans each file that is opened and sets the indent mode based on
1173 <p>The indent mode for the current document is shown on the status bar
1174 as follows:</p>
1181 <dd>Indent with tabs and spaces, depending on how much indentation is
1182 on a line.</dd>
1183 </dl>
1184 </div>
1188 Editor. It adds a certain amount of indentation to the new line so the
1189 user doesn't always have to indent each line manually.</p>
1198 brace '{', and de-indents when typing a closing brace '}'. For Python,
1199 a new line will be indented after typing ':' at the end of the
1200 previous line.</dd>
1203 match the indentation of the line with the opening brace.</dd>
1204 </dl>
1205 </div>
1208 <p>Geany provides a handy bookmarking feature that lets you mark one
1209 or more lines in a document, and return the cursor to them using a
1210 key combination.</p>
1211 <p>To place a mark on a line, either left-mouse-click in the left margin
1212 of the editor window, or else use Ctrl-m. This will
1213 produce a small green plus symbol in the margin. You can have as many
1214 marks in a document as you like. Click again (or use Ctrl-m again)
1215 to remove the bookmark. To remove all the marks in a given document,
1217 <p>To navigate down your document, jumping from one mark to the next,
1218 use Ctrl-. (control period). To go in the opposite direction on
1219 the page, use Ctrl-, (control comma). Using the bookmarking feature
1220 together with the commands to switch from one editor tab to another
1221 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
1222 navigate around multiple files.</p>
1223 </div>
1226 <p>To ease navigation in source files and especially between
1227 different files, Geany lets you jump between different navigation
1228 points. Currently, this works for the following:</p>
1235 </ul>
1236 <p>When using one of these actions, Geany remembers your current position
1237 and jumps to the new one. If you decide to go back to your previous
1239 get back to the new position again, just use "Navigate forward a
1240 location". This makes it easier to navigate in e.g. foreign code
1241 and between different files.</p>
1242 </div>
1245 <p>You can define several custom commands in Geany and send the current
1247 Selection to" menu or keybindings.
1248 The output of the command will be
1249 used to replace the current selection. This makes it possible to use text
1250 formatting tools with Geany in a general way. The selected text will
1251 be sent to the standard input of the executed command, so the command
1252 should be able to read from it and it should print all results to its
1253 standard output which will be read by Geany. To help finding errors
1254 in executing the command, the output of the program's standard error
1255 will be printed on Geany's standard output.</p>
1256 <p>To add a custom command, just go to the Set Custom Commands dialog
1257 in the Format sub menu of the Edit and Popup menu. Then click on Add
1258 to get a new text entry and type the command. You can also specify
1259 some command line options. To delete a command, just clear the text
1260 entry and press OK. It will be deleted automatically.</p>
1261 </div>
1264 <p>You can execute the context action command on the current word at the
1265 cursor position or the available selection. This word or selection
1266 can be used as an argument to the command.
1267 The context action is invoked by a menu entry in the popup menu of the
1268 editor and also a keyboard shortcut (see the section called
1270 <p>The command can be specified in the preferences dialog and also for
1272 <a class="reference internal" href="#format">Format</a>). When the context action is invoked, the filetype
1273 specific command is used if available, otherwise the command
1274 specified in the preferences dialog is executed.</p>
1276 in the command, it will be replaced by the current word or
1277 selection before the command is executed.</p>
1278 <p>For example a context action can be used to open API documentation
1279 in a browser window, the command to open the PHP API documentation
1280 would be:</p>
1283 </pre>
1284 <p>when executing the command, the %s is substituted by the word near
1285 the cursor position or by the current selection. If the cursor is at
1287 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>
1288 </div>
1291 <p>Geany can offer a list of possible completions for symbols defined in the
1292 tags and for all words in a document.</p>
1293 <p>The autocompletion list for symbols is presented when the first few
1294 characters of the symbol are typed (configurable, see <a class="reference internal" href="#editor-completions-preferences">Editor Completions
1296 keybinding is pressed (configurable, see <a class="reference internal" href="#editor-keybindings">Editor keybindings</a>,
1297 default Ctrl-Space).</p>
1299 document</em> preference (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions preferences</a>)
1300 is selected then the autocompletion list will show all matching words
1301 in the document, if there are no matching symbols.</p>
1302 <p>If you don't want to use autocompletion it can be dismissed until
1303 the next symbol by pressing Escape. The autocompletion list is updated
1304 as more characters are typed so that it only shows completions that start
1305 with the characters typed so far. If no symbols begin with the sequence,
1306 the autocompletion window is closed.</p>
1307 <p>The up and down arrows will move the selected item. The highlighted
1308 item on the autocompletion list can be chosen from the list by pressing
1309 Enter/Return. You can also double-click to select an item. The sequence
1310 will be completed to match the chosen item, and if the <em>Drop rest of
1311 word on completion</em> preference is set (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions
1312 preferences</a>) then any characters after the cursor that match
1313 a symbol or word are deleted.</p>
1316 <p>By default, pressing Tab will complete the selected item by word part;
1317 useful e.g. for adding the prefix <tt class="docutils literal">gtk_combo_box_entry_</tt> without typing it
1318 manually:</p>
1325 </ul>
1326 <p>The key combination can be changed from Tab - See <a class="reference internal" href="#editor-keybindings">Editor keybindings</a>.
1327 If you clear/change the key combination for word part completion, Tab
1328 will complete the whole word instead, like Enter.</p>
1329 </div>
1334 struct
1335 {
1336 int i;
1337 char c;
1338 } foo;
1339 </pre>
1340 <p>When you type <tt class="docutils literal">foo.</tt> it will show an autocompletion list with 'i' and
1341 'c' symbols.</p>
1342 <p>It only works for languages that set parent scope names for e.g. struct
1343 members. Currently this means C-like languages. The C tag parser only
1344 parses global scopes, so this won't work for structs or objects declared
1345 in local scope.</p>
1346 </div>
1347 </div>
1350 <p>Snippets are small strings or code constructs which can be replaced or
1351 completed to a more complex string. So you can save a lot of time when
1352 typing common strings and letting Geany do the work for you.
1353 To know what to complete or replace Geany reads a configuration file
1357 [Default]
1358 myname=Enrico Tröger
1359 </pre>
1360 <p>Every time you write <tt class="docutils literal">myname</tt> <TAB> in Geany, it will replace "myname"
1362 in the preferences dialog, by default it is TAB. The corresponding keybinding
1364 <p>The system-wide configuration file can be found in
1365 <tt class="docutils literal">$prefix/share/geany</tt>, where <tt class="docutils literal">$prefix</tt> is the path where Geany is
1366 installed (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>). It is not recommended to edit the
1367 system-wide file, because it will be overridden when Geany is updated.</p>
1368 <p>To change the settings, copy the file from <tt class="docutils literal">$prefix/share/geany</tt>
1369 in your configuration directory (usually <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>).</p>
1372 % cp /usr/local/share/geany/snippets.conf /home/username/.config/geany/
1373 </pre>
1374 <p>Then you can edit the file and the changes will remain available
1375 after an update of Geany because the file resides in your
1376 configuration directory. Alternatively, you can create a file
1377 <tt class="docutils literal"><span class="pre">~/.config/geany/snippets.conf</span></tt> and add only these settings you want
1378 to change. All missing settings will be read from the global snippets
1380 <p>The file <tt class="docutils literal">snippets.conf</tt> contains sections defining snippets that
1381 are available for particular filetypes and in general.</p>
1385 other snippets. So you can define often used parts of snippets and
1386 just use the special snippet as a placeholder (see the
1389 snippets in that section are only available for use in files with that
1390 filetype. Snippets in filetype sections will hide snippets with the
1392 filetype.</p>
1393 <p>To define snippets you can use several special character sequences which
1394 will be replaced when using the snippet:</p>
1397 <colgroup>
1400 </colgroup>
1403 <td>Insert a new line (it will be replaced by the used EOL
1404 char(s): LF, CR/LF, or CR).</td>
1405 </tr>
1407 <td>Insert an indentation step, it will be replaced according
1408 to the current document's indent mode.</td>
1409 </tr>
1411 <td>\s to force whitespace at beginning or end of a value
1412 ('key= value' won't work, use 'key=\svalue')</td>
1413 </tr>
1415 <td>Place the cursor at this position after completion has
1416 been done. You can define multiple %cursor% wildcards
1418 to the next defined cursor position in the completed
1419 snippet.</td>
1420 </tr>
1424 section you can use %brace_open% in any other snippet.</td>
1425 </tr>
1426 </tbody>
1427 </table>
1428 <p>Snippet names must not contain spaces otherwise they won't
1429 work correctly. But beside that you can define almost any
1430 string as a snippet and use it later in Geany. It is not limited
1431 to existing contructs of certain programming languages(like <tt class="docutils literal">if</tt>,
1432 <tt class="docutils literal">for</tt>, <tt class="docutils literal">switch</tt>). Define whatever you need.</p>
1434 listed in <a class="reference internal" href="#template-wildcards">Template wildcards</a>. All wildcards which are listed as
1437 [Default]
1438 myname=My name is {developer}
1439 </pre>
1440 <p>this will replace <tt class="docutils literal">myname</tt> with "My name is " and the value of the template
1442 <p>You can change the way Geany recognizes the word to complete,
1443 that is how the start and end of a word is recognised when the
1446 to be recognized as a word for completion. Leave it commented to use
1447 default characters or define it to add or remove characters to fit your
1448 needs.</p>
1449 </div>
1453 Ctrl-Shift-u, then still holding Ctrl-Shift, type some hex digits representing
1454 the code point for the character you want, then let go of Ctrl-Shift and
1455 hit Enter or Return.</p>
1456 <p>For this to work in Geany, you'll need to first unbind Ctrl-Shift-u
1457 in the <a class="reference internal" href="#keybinding-preferences">keybinding preferences</a>, then restart Geany.
1458 Note that it works slightly differently from other GTK applications,
1459 in that you'll need to continue to hold down the Ctrl and Shift keys
1460 while typing the code point hex digits.</p>
1462 is not necessary. One problem is that you may find the alphabetic
1463 keys conflict with other Geany keybindings.</p>
1464 </div>
1465 </div>
1468 <p>This section describes search-related commands from the Search menu
1469 and the editor window's popup menu:</p>
1478 </ul>
1479 <p>* These items are available from the editor window's popup menu, or by
1480 using a keyboard shortcut (see <a class="reference internal" href="#search-keybindings">Search keybindings</a>).</p>
1487 </ul>
1488 <p>There are keybindings to focus each of these - see <a class="reference internal" href="#focus-keybindings">Focus
1492 <p>The quickest way to find some text is to use the search bar entry in
1493 the toolbar. This performs a case-insensitive search in the current
1494 document whilst you type. Pressing Enter will search again.</p>
1495 </div>
1496 </div>
1503 <p>The syntax for the Use regular expressions option is shown in
1505 <p>The Use escape sequences option will transform any escaped characters
1506 into their UTF-8 equivalent. For example, \t will be transformed into
1507 a tab character. Other recognized symbols are: \\, \n, \r, \uXXXX
1508 (Unicode characters).</p>
1509 </div>
1512 <p>To find all matches, click on the Find All expander. This will reveal
1513 several options:</p>
1518 </ul>
1519 <p>Find All In Document will show a list of matching lines in the
1520 current document in the Messages tab of the Message Window. <em>Find All
1522 <p>Mark will highlight all matches in the current document with a
1523 colored box. These markers can be removed by selecting the
1524 Remove Markers command from the Document menu.</p>
1525 </div>
1528 <p>All search related dialogs use a Monospace for the text input fields to
1529 increase the readability of input text. This is useful when you are
1530 typing input such as regular expressions with spaces, periods and commas which
1531 might it hard to read with a proportional font.</p>
1532 <p>If you want to change the font, you can do this easily
1533 by inserting the following style into your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>
1534 (usually found in your home directory on UNIX-like systems and in the
1535 etc subdirectory of your Geany installation on Windows):</p>
1538 {
1540 }
1542 </pre>
1544 of this style to the highest available. Otherwise, the style is ignored
1545 for the search dialogs.</p>
1546 </div>
1547 </div>
1550 <p>Find usage searches all open files. It is similar to the Find All In
1551 Session option in the Find dialog.</p>
1552 <p>If there is a selection, then it is used as the search text; otherwise
1553 the current word is used. The current word is either taken from the
1554 word nearest the edit cursor, or the word underneath the popup menu
1555 click position when the popup menu is used. The search results are
1556 shown in the Messages tab of the Message Window.</p>
1557 </div>
1560 <p>Find in files is a more powerful version of Find usage that searches
1561 all files in a certain directory using the Grep tool. The Grep tool
1562 must be correctly set in Preferences to the path of the system's Grep
1563 utility. GNU Grep is recommended.</p>
1565 <p>The Encoding combo box can be used to define the encoding of the files
1566 to be searched. The entered search text is converted to the chosen encoding
1567 and the search results are converted back to UTF-8.
1568 The Extra options field is used to pass any additional arguments to
1569 the grep tool.</p>
1574 grep's <tt class="docutils literal"><span class="pre">--exclude</span></tt> flag to filter out filenames.</p>
1575 <p>SVN Example: <tt class="docutils literal"><span class="pre">--exclude=*.svn-base</span></tt></p>
1576 <p>The --exclude argument only matches the file name part, not the path. If
1577 you have GNU Grep >= 2.5.2 you can use the <tt class="docutils literal"><span class="pre">--exclude-dir</span></tt> argument to
1579 <p>Example: <tt class="docutils literal"><span class="pre">--exclude-dir=.*</span> <span class="pre">--exclude-dir=CVS</span></tt></p>
1580 </div>
1581 </div>
1584 <p>The Replace dialog is used for replacing text in one or more open
1585 documents.</p>
1587 <p>The Replace dialog has the same options for matching text as the Find
1588 dialog. See the section <a class="reference internal" href="#matching-options">Matching options</a>.</p>
1590 be used in the search string and back references in the replacement
1591 text -- see the entry for '\n' in <a class="reference internal" href="#regular-expressions">Regular expressions</a>.</p>
1595 will reveal several options:</p>
1600 </ul>
1604 in the current selection of the current document.</p>
1605 </div>
1606 </div>
1609 <p>If the current word is the name of a tag definition (like a function
1610 body) and the file containing the tag definition is open, this command
1611 will switch to that file and go to the corresponding line number. The
1612 current word is either the word nearest the edit cursor,
1613 or the word underneath the popup menu click position when the popup
1614 menu is used.</p>
1615 </div>
1618 <p>Like Go to tag definition, but for a forward declaration such as a
1619 function prototype or <tt class="docutils literal">extern</tt> declaration instead of a function
1620 body.</p>
1621 </div>
1625 </div>
1628 <p>You can use regular expressions in the Find and Replace dialogs
1629 by selecting the Use regular expressions check box. The syntax is
1630 POSIX-like, as described in the table below.</p>
1635 <li>\r and \n are never matched because regular expression
1636 searches are made line per line (stripped of end-of-line chars).</li>
1637 <li>The POSIX '?' regular expression character for optional
1638 matching is not supported.</li>
1639 </ol>
1640 </div>
1643 <colgroup>
1646 </colgroup>
1650 </tr>
1653 </tr>
1656 </tr>
1659 region when replacing. For example, if the search string was
1661 to Fred2XXX this would generate Sam2YYY.</td>
1662 </tr>
1665 </tr>
1668 </tr>
1671 character class (both inside and outside sets []).</p>
1679 </ul>
1680 </td>
1681 </tr>
1683 <td>This allows you to use a character x that would otherwise have
1684 a special meaning. For example, \[ would be interpreted as [
1685 and not as the start of a character set. Use \\ for a literal
1686 backslash.</td>
1687 </tr>
1689 <td>A backslash followed by x and two hexa digits, becomes the
1690 character whose Ascii code is equal to these digits. If not
1691 followed by two digits, it is 'x' char itself.</td>
1692 </tr>
1695 character in the set is ^, it matches the characters NOT in
1696 the set, i.e. complements the set. A shorthand S-E (start
1697 dash end) is used to specify a set of characters S up to E,
1698 inclusive. The special characters ] and - have no special
1699 meaning if they appear as the first chars in the set. To
1700 include both, put - first: [-]A-Z] (or just backslash them).</p>
1703 [-]|] matches these 3 chars
1704 []-|] matches from ] to | chars
1705 [a-z] any lowercase alpha
1706 [^-]] any char except - and ]
1707 [^A-Z] any char except uppercase alpha
1708 [a-zA-Z] any alpha
1709 </pre>
1710 </td>
1711 </tr>
1713 <td>This matches the start of a line (unless used inside a set, see
1714 above).</td>
1715 </tr>
1718 </tr>
1721 Saam, Saaam and so on.</td>
1722 </tr>
1725 Saam, Saaam and so on.</td>
1726 </tr>
1727 </tbody>
1728 </table>
1732 distributed under the <a class="reference internal" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
1733 </div>
1734 </div>
1735 </div>
1738 <p>Tags are information that relates symbols in a program with the
1739 source file location of the declaration and definition.</p>
1740 <p>Geany has built-in functionality for generating tag information (aka
1742 can also have Geany automatically load external tag files (aka "global
1744 <p>Geany uses its own tag file format, similar to what <tt class="docutils literal">ctags</tt> uses
1745 (but is incompatible with ctags). You use Geany to generate global
1746 tags files, as described below.</p>
1749 <p>Tags for each document are parsed whenever a file is loaded or
1750 saved. These are shown in the Symbol list in the Sidebar. These tags
1751 are also used for autocompletion of symbols and calltips for all documents
1752 open in the current session that have the same filetype.</p>
1755 </div>
1758 <p>Global tags are used to provide autocompletion of symbols and calltips
1759 without having to open the corresponding source files. This is intended
1760 for library APIs, as the tags file only has to be updated when you upgrade
1761 the library.</p>
1765 <li>By creating a directory <tt class="docutils literal"><span class="pre">~/.config/geany/tags</span></tt>, and moving or symlinking
1766 the tags files there before starting Geany.</li>
1767 <li>By creating a directory <tt class="docutils literal">$prefix/share/geany/tags</tt>, and moving
1768 or symlinking the tags files there before starting Geany.
1769 <tt class="docutils literal">$prefix</tt> is the installation prefix (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>).</li>
1770 </ul>
1771 <p>You can either download these files or generate your own. They have
1772 the format:</p>
1774 name.lang_ext.tags
1775 </pre>
1777 with the tags. See the section called <a class="reference internal" href="#filetype-extensions">Filetype extensions</a> for
1778 more information.</p>
1781 <p>For some languages, a list of global tags is loaded when the
1782 corresponding filetype is first used. Currently these are for:</p>
1790 </ul>
1791 </div>
1798 </ul>
1799 <p>The first line of global tags files should be a comment, introduced
1800 by <tt class="docutils literal">#</tt> followed by a space and a string like <tt class="docutils literal">format=pipe</tt>
1802 This helps Geany to read the file properly. If this line
1803 is missing, Geany tries to auto-detect the used format but this
1804 might fail.</p>
1805 <p>The Tagmanager format is a bit more complex and is used for files
1806 created by the <tt class="docutils literal">geany <span class="pre">-g</span></tt> command. There is one tag per line.
1807 Different tag attributes like the return value or the argument list
1808 are separated with different characters indicating the type of the
1809 following argument.</p>
1810 <p>The Pipe-separated format is easier to read and write.
1811 There is one tag per line and different tag attributes are separated
1814 basename|string|(string path [, string suffix])|
1815 </pre>
1821 currently unused and should be left empty.</div>
1822 </div>
1823 <p>Except for the first field (tag name), all other field can be left
1824 empty but the pipe separator must appear for them.</p>
1825 <p>You can easily write your own global tag files using this format.
1826 Just save them in your tags directory, as described earlier in the
1828 </div>
1831 <p>You can generate your own global tags files by parsing a list of
1832 source files. The command is:</p>
1835 </pre>
1837 <li>Tag File filename should be in the format described earlier --
1839 <li>File list is a list of filenames, each with a full path (unless
1840 you are generating C/C++ tags and have set the CFLAGS environment
1841 variable appropriately).</li>
1842 <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
1843 to process <tt class="docutils literal">#include</tt> directives for C/C++ source files. Use this
1844 option if you want to specify each source file on the command-line
1845 instead of using a 'master' header file. Also can be useful if you
1846 don't want to specify the CFLAGS environment variable.</li>
1847 </ul>
1850 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1851 </pre>
1853 <p>For C/C++ tag files, gcc and grep are required, so that header files
1854 can be preprocessed to include any other headers they depend upon.</p>
1855 <p>For C/C++ files, the environment variable CFLAGS should be set with
1856 appropriate <tt class="docutils literal"><span class="pre">-I/path</span></tt> include paths. The following example works with
1857 the bash shell, generating tags for the GnomeUI library:</p>
1859 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1860 /usr/include/libgnomeui-2.0/gnome.h
1861 </pre>
1862 <p>You can adapt this command to use CFLAGS and header files appropriate
1863 for whichever libraries you want.</p>
1865 <p>Geany currently uses a default global tags file c99.tags for
1866 C and C++, commonly installed in /usr/share/geany. This file can
1867 be replaced with one containing tags parsed from a different set
1868 of header files. When Geany is next started, your custom tags file
1869 will be loaded instead of the default c99.tags. You should keep a
1870 copy of the generated tags file because it will get overwritten when
1871 upgrading Geany.</p>
1872 </div>
1873 </div>
1876 <p>You can also ignore certain tags if they would lead to wrong parsing of
1878 configuration directory (usually <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>). Then list all tags
1879 you want to ignore in this file, separated by spaces and/or newlines.</p>
1880 <p>More detailed information about the usage from the Exuberant Ctags
1881 manual page:</p>
1883 Specifies a list of identifiers which are to be specially handled
1884 while parsing C and C++ source files. This option is specifically
1885 provided to handle special cases arising through the use of
1886 pre-processor macros. When the identifiers listed are simple identifiers,
1887 these identifiers will be ignored during parsing of the source files.
1888 If an identifier is suffixed with a '+' character, ctags will also
1889 ignore any parenthesis-enclosed argument list which may immediately
1890 follow the identifier in the source files.
1891 If two identifiers are separated with the '=' character, the first
1892 identifiers is replaced by the second identifiers for parsing purposes.
1893 </pre>
1894 <p>For even more detailed information please read the manual page of
1895 Exuberant Ctags.</p>
1896 </div>
1897 </div>
1901 dialog. Any changes you make there can be applied by hitting either
1902 the Apply or the OK button. These settings will persist between Geany
1903 sessions. Note that most settings here have descriptive popup bubble
1904 help -- just hover the mouse over the item in question to get help
1905 on it.</p>
1906 <p>You may also adjust some View settings (under the View menu) that
1907 persist between Geany sessions. The settings under the Document menu,
1908 however, are only for the current document and revert to defaults
1909 when restarting Geany.</p>
1910 <p>There are also some rarer <a class="reference internal" href="#hidden-preferences">Hidden preferences</a>.</p>
1914 comes after the screenshot of that tab.</p>
1915 </div>
1923 <dd>On startup, load the same files you had open the last time you
1924 used Geany.</dd>
1929 </dl>
1930 </div>
1935 <dd>Save the current position and size of the main window so next time
1936 you open Geany it's in the same location.</dd>
1939 </dl>
1940 </div>
1945 <dd>Path to start in when opening or saving files.
1946 It must be an absolute path.
1947 Leave it blank to use the current working directory.</dd>
1951 <dd>By default Geany looks in the global installation path and in the
1952 configuration directory. In addition the path entered here will be searched
1953 for plugins. Usually you do not need to set an additional path to search for
1954 plugins. It might be useful when Geany is installed on a multi-user machine
1955 and additional plugins are available in a common location for all users.
1956 Leave blank to not set an additional lookup path.</dd>
1957 </dl>
1958 </div>
1959 </div>
1967 <dd>Have the computer make a beeping sound when compilation of your program
1968 has completed or any errors occurred.</dd>
1970 <dd>Switch to the status message tab (in the notebook window at the bottom)
1971 once a new status message arrives.</dd>
1973 <dd>Remove all messages from the status bar. The messages are still displayed
1974 in the status messages window.</dd>
1976 <dd>Give the focus automatically to widgets below the mouse cursor.
1977 This works for the main editor widget, the scribble, the toolbar search field
1978 goto line fields and the VTE.</dd>
1979 </dl>
1980 </div>
1985 <dd>Always wrap search around the document and hide the Find dialog after clicking
1986 Find Next/Previous.</dd>
1988 <dd>Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1989 there is no selection. When this option is disabled, the search term last used in the
1990 appropriate Find dialog is used.</dd>
1992 <dd>When opening the Find in Files dialog, set the directory to search to the directory of the current
1993 active file. When this option is disabled, the directory of the last use of the Find in Files
1994 dialog is used.</dd>
1995 </dl>
1996 </div>
2001 <dd>Save your current session when closing projects. You will be able to
2002 resume different project sessions, automatically opening the files
2003 you had open previously.</dd>
2005 <dd>When creating new projects, the default path for the project file contains
2006 the project base path. Without this option enabled, the default project file
2007 path is one level above the project base path.
2008 In either case, you can easily set the final project file path in the
2010 defaults automatically for convenience.</dd>
2011 </dl>
2012 </div>
2013 </div>
2023 <dd>Show the list of functions, variables, and other information in the
2024 current document you are editing.</dd>
2026 <dd>Show all the documents you have open currently. This can be used to
2027 change between documents (see <a class="reference internal" href="#switching-between-documents">Switching between documents</a>) and
2028 to perform some common operations such as saving, closing and reloading.</dd>
2031 </dl>
2032 </div>
2042 </dl>
2043 </div>
2048 <dd>Show a notebook tab for all documents so you can switch between them
2049 using the mouse (instead of using the Documents window).</dd>
2051 <dd>Make each tab show a close button so you can easily close open
2052 documents.</dd>
2054 <dd>Whether to create a document with its notebook tab to the left or
2055 right of all existing tabs.</dd>
2058 when double-clicking on a notebook tab.</dd>
2059 </dl>
2060 </div>
2065 <dd>Set the positioning of the editor's notebook tabs to the right,
2066 left, top, or bottom of the editing window.</dd>
2068 <dd>Set the positioning of the sidebar's notebook tabs to the right,
2069 left, top, or bottom of the sidebar window.</dd>
2071 <dd>Set the positioning of the message window's notebook tabs to the
2072 right, left, top, or bottom of the message window.</dd>
2073 </dl>
2074 </div>
2079 <dd>Show the status bar at the bottom of the main window. It gives information about
2080 the file you are editing like the line and column you are on, whether any
2081 modifications were done, the file encoding, the filetype and other information.</dd>
2082 </dl>
2083 </div>
2084 </div>
2095 <dd>Allows to append the toolbar to the main menu bar instead of placing it below.
2096 This is useful to save vertical space.</dd>
2097 </dl>
2098 </div>
2103 <dd>Select the toolbar icon style to use - either icons and text, just
2104 icons or just text.</dd>
2108 <dd>See <a class="reference internal" href="#customizing-the-toolbar">Customizing the toolbar</a>.</dd>
2109 </dl>
2110 </div>
2111 </div>
2114 <img alt="./images/pref_dialog_edit_features.png" src="./images/pref_dialog_edit_features.png" />
2121 <dd>Whether to move the cursor to the first non-whitespace character
2122 on the line when you hit the home key on your keyboard. Pressing it
2123 again will go to the very start of the line.</dd>
2127 <dd>Allow groups of lines in a document to be collapsed for easier
2128 navigation/editing.</dd>
2130 <dd>Whether to fold/unfold all child fold points when a parent line
2131 is folded.</dd>
2133 <dd>Underline lines with compile errors using red squiggles to indicate
2134 them in the editor area.</dd>
2136 <dd>Remove any white space at the end of the line when you hit the
2137 Enter/Return key.</dd>
2139 <dd>The editor column number to insert a newline at when Line Breaking
2140 is enabled for the current document.</dd>
2142 <dd>A string which is added when toggling a line comment in a source file.
2143 It is used to mark the comment as toggled.</dd>
2144 </dl>
2145 </div>
2146 </div>
2149 <img alt="./images/pref_dialog_edit_indentation.png" src="./images/pref_dialog_edit_indentation.png" />
2152 <p>See <a class="reference internal" href="#indentation">Indentation</a> for more information.</p>
2160 </ul>
2163 </dd>
2165 <dd>The width of a single indent size in spaces. By default the indent
2169 display size of a tab. Otherwise this is ignored. Although
2172 <dd>Try to detect and set the indent type based on file content, when
2173 a file is opened.</dd>
2176 if any.</p>
2181 <dd>Add indentation based on the current filetype and any characters at
2182 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>
2186 </dl>
2187 </dd>
2190 unindent when pressing Shift-tab. Otherwise, the tab key will
2191 insert a tab character into the document (which can be different
2192 from indentation, depending on the indent type).</p>
2196 unindent, but this preference allows the tab key to have different
2197 meanings in different contexts - e.g. for snippet completion.</p>
2198 </div>
2199 </dd>
2200 </dl>
2201 </div>
2202 </div>
2205 <img alt="./images/pref_dialog_edit_completions.png" src="./images/pref_dialog_edit_completions.png" />
2210 <dd>Whether to replace special keywords after typing Tab into a
2211 pre-defined text snippet.
2212 See <a class="reference internal" href="#user-definable-snippets">User-definable snippets</a>.</dd>
2217 and Java when a new line is entered inside such a comment.
2218 With this option enabled, Geany will insert a <tt class="docutils literal">*</tt> on every new line
2219 inside a multi-line comment, for example when you press return in the
2220 following C code:</p>
2222 /*
2224 </pre>
2227 *
2228 </pre>
2231 </dd>
2233 <dd>When you start to type a symbol name, look for the full string to
2234 allow it to be completed for you.</dd>
2236 <dd>When you start to type a word, Geany will search the whole document for
2237 words starting with the typed part to complete it, assuming there
2238 are no tag names to show.</dd>
2240 <dd>Remove any word part to the right of the cursor when choosing a
2241 completion list item.</dd>
2243 <dd>Number of characters of a word to type before autocompletion is
2244 displayed.</dd>
2249 </dl>
2250 </div>
2253 <p>Geany can automatically insert a closing bracket and quote characters when
2254 you open them. For instance, you type a <tt class="docutils literal">(</tt> and Geany will automatically
2255 insert <tt class="docutils literal">)</tt>. With the following options, you can define for which
2256 characters this should work.</p>
2268 </dl>
2269 </div>
2270 </div>
2274 <img alt="./images/pref_dialog_edit_display.png" src="./images/pref_dialog_edit_display.png" />
2279 <dd>Invert all colors, by default this makes white text on a black
2280 background.</dd>
2282 <dd>Show vertical lines to help show how much leading indentation there
2283 is on each line.</dd>
2286 show which kinds of whitespace are used.</dd>
2288 <dd>Display a symbol everywhere that a carriage return or line feed
2289 is present.</dd>
2293 <dd>Show or hide the small margin right of the line numbers, which is used
2294 to mark lines.</dd>
2296 <dd>When enabled Geany stops scrolling when at the last line of the document.
2297 Otherwise you can scroll one more page even if there are no real lines.</dd>
2298 </dl>
2299 </div>
2302 <p>The long line marker helps to indicate overly-long lines, or as a hint
2303 to the user for when to break the line.</p>
2308 <dd>Show a thin vertical line in the editor window at the given column
2309 position.</dd>
2311 <dd>Change the background color of characters after the given column
2312 position to the color set below. (This is recommended over the
2316 </dl>
2317 </dd>
2319 <dd>Set this value to a value greater than zero to specify the column
2320 where it should appear.</dd>
2323 </dl>
2324 </div>
2325 </div>
2333 <dd>Whether to create new documents when passing filenames that don't
2334 exist from the command-line.</dd>
2340 <dd>Opens all files with the specified encoding instead of auto-detecting it.
2341 Use this option when it's not possible for Geany to detect the exact encoding.</dd>
2343 <dd>The end of line characters to which should be used for new files.
2344 On Windows systems, you generally want to use CR/LF which are the common
2345 characters to mark line breaks.
2346 On Unix-like systems, LF is default and CR is used on MAC systems.</dd>
2347 </dl>
2348 </div>
2351 <p>Perform formatting operations when a document is saved. These
2352 can each be undone with the Undo command.</p>
2359 <dd><p class="first">Replace all tabs in the document with the equivalent number of spaces.</p>
2364 </div>
2365 </dd>
2366 </dl>
2367 </div>
2375 file on disk in case it has changed. Setting it to 0 will disable
2376 this feature.</p>
2380 not checked for changes due to performance issues
2381 (remote files are files in <tt class="docutils literal"><span class="pre">~/.gvfs/</span></tt>).</p>
2382 </div>
2383 </dd>
2384 </dl>
2385 </div>
2386 </div>
2399 </dl>
2403 the grep.exe from the UnxUtils project
2404 (<a class="reference external" href="http://sourceforge.net/projects/unxutils">http://sourceforge.net/projects/unxutils</a>). The grep.exe from the
2405 Mingw project for instance might not work with Geany at the moment.</p>
2406 </div>
2407 </div>
2412 <dd>Set this to a command to execute on the current word.
2414 to the specified command.</dd>
2415 </dl>
2416 </div>
2417 </div>
2420 <p>This data is used as meta data for various template text to insert into
2421 a document, such as the file header. You only need to set fields that
2422 you want to use in your template files.</p>
2426 </div>
2439 <p class="last">You may wish to add anti-spam markup, e.g. <tt class="docutils literal">name<at>site<dot>ext</tt>.</p>
2440 </div>
2441 </dd>
2447 <dd>Specify a format for the the {year} wildcard. You can use any conversion specifiers
2448 which can be used with the ANSI C strftime function. For details please see
2451 <dd>Specify a format for the the {date} wildcard. You can use any conversion specifiers
2452 which can be used with the ANSI C strftime function. For details please see
2455 <dd>Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
2456 which can be used with the ANSI C strftime function. For details please see
2458 </dl>
2459 </div>
2460 </div>
2464 <p>There are some commands listed in the keybinding dialog that are not, by default,
2465 bound to a key combination, and may not be available as a menu item.</p>
2468 <p class="last">For more information see the section <a class="reference internal" href="#keybindings">Keybindings</a>.</p>
2469 </div>
2470 </div>
2488 <dd>How the date should be printed. You can use the same format
2489 specifiers as in the ANSI C function strftime(). For details please
2490 see <a class="reference external" href="http://man.cx/strftime">http://man.cx/strftime</a>.</dd>
2491 </dl>
2492 </div>
2495 <p>See also: <a class="reference internal" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
2521 <dd>Make the path of the terminal change according to the path of the
2522 current file.</dd>
2524 <dd>Execute programs in the virtual terminal instead of using the external
2525 terminal tool. Note that if you run multiple execute commands at once
2526 the output may become mixed together in the VTE.</dd>
2528 <dd>Don't use the simple run script which is usually used to display
2529 the exit status of the executed program.
2530 This can be useful if you already have a program running in the VTE
2531 like a Python console (e.g. ipython). Use this with care.</dd>
2532 </dl>
2533 </div>
2534 </div>
2535 </div>
2542 </ul>
2543 <p>A list of session files can be stored and opened with the project
2545 in the <em>Project</em> group of the <a class="reference internal" href="#preferences">Preferences</a> dialog.</p>
2546 <p>As long as a project is open, the Build menu will use
2547 the items defined in project's settings, instead of the defaults.
2548 See <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a> for information on configuring the menu.</p>
2549 <p>The current project's settings are saved when it is closed, or when
2550 Geany is shutdown. When restarting Geany, the previously opened project
2551 file that was in use at the end of the last session will be reopened.</p>
2556 will setup a new project file <tt class="docutils literal">~/projects/name.geany</tt>. Usually it's
2557 best to store all your project files in the same directory (they are
2558 independent of any source directory trees).</p>
2559 <p>The Base path text field is setup to use <tt class="docutils literal">~/projects/name</tt>. This
2560 can safely be set to any existing path -- it will not touch the file
2561 structure contained in it.</p>
2562 </div>
2565 <p>You can set an optional description for the project, but it is not
2566 used elsewhere by Geany.</p>
2568 The specified path can be an absolute path or it is considered to be
2569 relative to the project's file name.</p>
2572 <p>This button is a convenience to set the working directory fields
2573 in the non-filetype Build menu items to %p to use the project base path.</p>
2577 you have configured for the project.</p>
2578 </div>
2579 </div>
2580 </div>
2583 <p>The Open command displays a standard file chooser, starting in
2584 <tt class="docutils literal">~/projects</tt>. Choose a project file named with the <tt class="docutils literal">.geany</tt>
2585 extension.</p>
2586 <p>When project session support is enabled, Geany will close the currently
2587 open files and open the session files associated with the project.</p>
2588 </div>
2592 <p>When project session support is enabled, Geany will close the project
2593 session files and open any previously closed default session files.</p>
2594 </div>
2595 </div>
2598 <p>After editing code with Geany, the next step is to compile, link, build,
2599 interpret, run etc. As Geany supports many languages each with a different
2600 approach to such operations, and as there are also many language independant
2601 software building systems, Geany does not have a built in build system, nor
2602 does it limit which system you can use. Instead the build menu provides
2603 a configurable and flexible means of running any external commands to
2604 execute your preferred build system.</p>
2605 <p>This section provides a description of the default configuration of the
2606 build menu and then covers how to configure it, and where the defaults fit in.</p>
2610 <li>the output is captured in the Compiler notebook tab and parsed for
2611 warnings or errors</li>
2612 </ul>
2613 <p>Warnings and errors that can be parsed for line numbers will be shown in
2614 red in the Compiler tab and you can click on them to switch to the relevant
2615 source file (or open it) and mark the line number. Also lines with
2616 warnings or errors are marked in the source, see <a class="reference internal" href="#indicators">Indicators</a> below.</p>
2620 the tool you're using, you can set a custom regex in the Build Commands
2621 Dialog, see <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a></p>
2622 </div>
2625 <p>Indicators are red squiggly underlines which are used to highlight
2626 errors which occurred while compiling the current file. So you can
2627 easily see where your code failed to compile. To remove the indicators,
2629 <p>If you do not like this feature, you can disable it in the preferences
2630 dialog.</p>
2631 </div>
2634 <p>Depending on the current file's filetype, the default Build menu will contain
2635 the following items:</p>
2646 </ul>
2650 <p>For compilable languages such as C and C++, the Compile command is
2651 set up to compile the current source file into a binary object file.</p>
2653 <p>Interpreted languages such as Perl, Python, Ruby will compile to
2654 bytecode if the language supports it, or will run a syntax check,
2655 or if that is not available will run the file in its language interpreter.</p>
2656 </div>
2659 <p>For compilable languages such as C and C++, the Build command will link
2660 the current source file's equivalent object file into an executable. If
2661 the object file does not exist, the source will be compiled and linked
2662 in one step, producing just the executable binary.</p>
2664 </div>
2668 current file.</p>
2669 </div>
2672 <p>This is similar to running 'Make' but you will be prompted for
2673 the make target name to be passed to the Make tool. For example,
2675 </div>
2679 the current file, using the filename for 'current_file'. It is useful
2680 for building just the current file without building the whole project.</p>
2681 </div>
2685 </div>
2689 </div>
2692 <p>Execute will run the corresponding executable file, shell script or
2693 interpreted script in a terminal window. Note that the Terminal tool
2694 path must be correctly set in the Tools tab of the Preferences dialog -
2695 you can use any terminal program that runs a Bourne compatible shell
2697 selected to us the build-in VTE if it is available, see
2698 <a class="reference internal" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
2699 <p>After your program or script has finished executing, you will be
2700 prompted to press the return key. This allows you to review any text
2701 output from the program before the terminal window is closed.</p>
2703 </div>
2706 <p>When there is a running program, the Execute menu item in the menu and
2707 the Run button in the toolbar
2708 becomes a stop button and you can stop the current running program. This
2709 works by sending a signal to the process (and its child process(es))
2710 to stop the process. The signal used is SIGQUIT.</p>
2711 <p>Depending on the process you started it is possible that the process
2712 cannot be stopped. For example this can happen when the process creates
2713 more than one child process.</p>
2717 (the terminal program of Xfce), you should add the command line
2718 option <tt class="docutils literal"><span class="pre">--disable-server</span></tt> otherwise the started process cannot be
2719 stopped. Just add this option in the preferences dialog on the Tools
2720 tab in the terminal field.</p>
2721 </div>
2722 </div>
2725 <p>By default the Compile and Build commands invoke the GCC compiler and
2726 linker with only the basic arguments needed by all programs. Using
2727 Set Build Commands you can add any include paths and compile
2728 flags for the compiler, any library names and paths for the linker,
2729 and any arguments you want to use when running Execute.</p>
2730 <p>For details of configuration see <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a> below.</p>
2734 different settings, then writing a Makefile and using the Make
2735 commands is recommended; this will also make it easier for users to
2736 build your software.</p>
2737 </div>
2739 </div>
2740 </div>
2743 <p>The build menu has considerable flexibility and configurability, allowing
2744 both menu labels the commands they execute and the directory they execute
2745 in to be configured.</p>
2746 <p>For example, if you change one of the default make commands to run say 'waf'
2747 you can also change the label to match.</p>
2749 <p>The build menu is divided into four groups of items each with different
2750 behaviors:</p>
2752 <li>file items - are configurable and depend on the filetype of the current
2753 document, put the output in the compiler tab and parse it for errors</li>
2754 <li>non-file items - are configurable and mostly don't depend on the filetype
2755 of the current document, put the output in the compiler tab and parse
2756 it for errors</li>
2757 <li>execute items - are configurable and intended for executing your
2758 program or other long running programs. The output is not parsed for errors
2759 and is directed to the terminal selected in preferences.</li>
2760 <li>fixed items - are not configurable because they perform the Geany built in actions,
2761 go to the next error, go to the previous error and show the build menu
2762 commands dialog</li>
2763 </ul>
2764 <p>The maximum numbers of items in each of the configurable groups can be
2765 configured when Geany starts using hidden settings(see <a class="reference internal" href="#preferences-file-format">Preferences File Format</a>).
2766 Even though the maximum number of items may have been increased, only
2767 those menu items that have values configured are shown in the menu.</p>
2768 <p>The groups of menu items obtain their configuration from four potential
2769 sources. The highest pririty source that has the menu item defined will
2770 be used. The sources in decreasing priority are:</p>
2776 </ul>
2777 <p>The detailed relationships between sources and the configurable menu item groups
2778 is shown in the following table.</p>
2780 <colgroup>
2786 </colgroup>
2793 </tr>
2794 </thead>
2798 file</p>
2800 file</p>
2801 </td>
2803 filetype.xxx file in
2804 ~/.config/geany/filedefs</p>
2806 creating if needed.</p>
2807 </td>
2809 filetype.xxx in
2810 Geany install</p>
2812 preferences left.</p>
2813 </td>
2815 </tr>
2818 file</p>
2820 file</p>
2821 </td>
2823 geany.conf file in
2824 ~/.config/geany</p>
2826 creating if needed.</p>
2827 </td>
2829 filetype.xxx in
2830 Geany install</p>
2832 preferences left.</p>
2833 </td>
2836 <dd>Label: _Make
2837 Command: make</dd>
2839 <dd>Label: Make Custom _Target
2840 Command: make</dd>
2842 <dd>Label: Make _Object
2843 Command: make %e.o</dd>
2844 </dl>
2845 </td>
2846 </tr>
2849 file or else
2850 filetype defined in
2851 project file</p>
2853 project file</p>
2854 </td>
2856 geany.conf file in
2857 ~/.config/geany or else
2858 filetype.xxx file in
2859 ~/.config/geany/filedefs</p>
2861 filetype.xxx file in
2862 ~/.config/geany/filedefs</p>
2863 </td>
2865 filetype.xxx in
2866 Geany install</p>
2868 preferences left</p>
2869 </td>
2871 </tr>
2872 </tbody>
2873 </table>
2876 <li>General - for filetype.xxx substitute the filetype name of the
2877 current document for xxx.</li>
2878 <li>System Filetypes - Labels loaded from these sources are locale sensitive
2879 and can contain translations.</li>
2880 <li>(Filetype, Project File) and (Filetype, Preferences) - preferences use a full
2881 filetype file so that users can configure all other filetype preferences
2882 as well. Projects can only configure menu items per filetype. Saving
2883 in the project file means that there is only one file per project not
2884 a whole directory.</li>
2885 <li>(Non-Filetype, System Filetype) - although conceptually strange, defining
2886 non-filetype commands in a filetype file, this provides the ability to
2887 define filetype dependent default menu items.</li>
2888 <li>(Execute, Project File) and (Execute, Preferences) - the project filetype based execute
2889 configuration and preferences non-filetype based execute can only be set by hand editing the
2890 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 Format</a>.</li>
2891 </ul>
2892 </div>
2895 <p>Most of the configuration of the build menu is done through the Build Menu
2896 Commands Dialog. You edit the configuration sourced from preferences in the
2897 dialog opened from the Build->Build Menu Commands item and you edit the
2898 configuration from the project in the build tab of the project preferences
2899 dialog. Both use the same form shown below.</p>
2900 <img alt="./images/build_menu_commands_dialog.png" src="./images/build_menu_commands_dialog.png" />
2903 <li>Filetype menu items which will be selected based on the filetype of the
2904 currently open document,</li>
2907 </ul>
2908 <p>The filetype and non-filetype sections also contains a field for the regular
2909 expression used for parsing command output for error and warning messages.</p>
2910 <p>The columns in the first three sections allow setting of the label, command,
2911 and working directory to run the command in.</p>
2913 <p>An empty working directory will default to the directory of the current document.
2914 If there is no current document then the command will not run.</p>
2915 <p>The dialog will always show the command selected by priority, not just the
2916 commands configured in this configuration source. This ensures that you always
2917 see what the menu item is going to do if activated.</p>
2918 <p>If the current source of the menu item is higher priority than the
2919 configuration source you are editing then the command will be shown
2920 in the dialog but will be insensitive (greyed out). This can't happen
2921 with the project source but can with the preferences source dialog.</p>
2922 <p>The clear buttons remove the definition from the configuration source you are editing.
2923 When you do this the command from the next lower priority source will be shown.
2924 To hide lower priority menu items without having anything show in the menu
2925 configure with a nothing in the label but at least one character in the command.</p>
2927 <h4><a class="toc-backref" href="#id146">Substitutions in Commands and Working Directories</a></h4>
2928 <p>The first occurance of each of the following character sequences in each of the
2929 command and working directory fields is substituted by the items specified below
2930 before the command is run.</p>
2936 </ul>
2939 <p class="last">If the basepath set in the project preferences is not an absolute path , then it is
2940 taken as relative to the directory of the project file. This allows a project file
2941 stored in the source tree to specify all commands and working directories relative
2942 to the tree itself, so that the whole tree including the project file, can be moved
2943 and even checked into and out of version control without having to re-configure the
2944 build menu.</p>
2945 </div>
2946 </div>
2949 <p>Keyboard shortcuts can be defiend for the first two filetype menu items, the first three
2950 non-filetype menu items, the first two execute menu items and the fixed menu items.
2951 In the keybindings configuration dialog (see <a class="reference internal" href="#keybinding-preferences">Keybinding preferences</a>)
2952 these items are identified by the default labels shown in the <a class="reference internal" href="#build-menu">Build Menu</a> section above.</p>
2954 </div>
2957 <p>The configurable Build Menu capability was introduced in Geany V0.19 and
2958 required a new section to be added to the configuration files (See
2959 <a class="reference internal" href="#preferences-file-format">Preferences File Format</a>). Geany will still load older format project,
2960 preferences and filetype file settings and will attempt to map them into the new
2961 configuration format. There is not a simple clean mapping between the formats.
2962 The mapping used produces the most sensible results for the majority of cases.
2963 However, if they do not map the way you want, you may have to manually
2964 configure some settings using the Build Commands
2965 Dialog or the Build tab of the project preferences dialog.</p>
2966 <p>Any setting configured in either of these dialogs will override settings mapped from
2967 older format configuration files.</p>
2968 </div>
2969 </div>
2970 </div>
2974 The printed page(s) will look nearly the same as on your screen in Geany.
2975 Additionally, there are some options to modify the printed page(s).</p>
2976 <p>You can define whether to print line numbers, page numbers at the bottom of
2977 each page and whether to print a page header on each page. This header
2978 contains the filename of the printed document, the current page number and
2979 the date and time of printing. By default, the file name of the document
2980 with full path information is added to the header. If you prefer to add
2981 only the basename of the file(without any path information) you can set it
2982 in the preferences dialog. You can also adjust the format of the date and
2983 time added to the page header. The available conversion specifiers are the
2984 same as the ones which can be used with the ANSI C strftime function.</p>
2985 <p>All of these settings can also be changed in the print dialog just before
2986 actual printing is done.
2987 On Unix-like systems the provided print dialog offers a print preview. The
2988 preview file is opened with a PDF viewer and by default GTK uses <tt class="docutils literal">evince</tt>
2989 for print preview. If you have not installed evince or just want to use
2990 another PDF viewer, you can change the program to use in the file
2991 <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home directory). Simply add a line
2992 like:</p>
2995 </pre>
2996 <p>at the end of the file. Of course, you can also use xpdf, kpdf or whatever
2997 as the print preview command.</p>
2998 <p>Unfortunately, native GTK printing support is only available if Geany was
3000 If not, Geany provides basic printing support. This means you can print a
3001 file by passing the filename of the current file to a command which
3002 actually prints the file. However, the printed document contains no syntax
3003 highlighting. You can adjust the command to which the filename is
3004 passed in the preferences dialog. The default command is:</p>
3006 % lpr %f
3007 </pre>
3008 <p><tt class="docutils literal">%f</tt> will be substituted by the filename of the current file. Geany
3009 will not show errors from the command itself, so you should make
3010 sure that it works before(e.g. by trying to execute it from the
3011 command line).</p>
3014 % a2ps -1 --medium=A4 -o - %f | xfprint4
3015 </pre>
3016 <p>But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3017 gtklp or similar programs can be used.</p>
3018 </div>
3022 general preference is set. There is also a command-line option,
3023 <tt class="docutils literal"><span class="pre">-p</span></tt>, which prevents plugins being loaded. Plugins are scanned in
3024 the following directories:</p>
3026 <li><tt class="docutils literal">$prefix/lib/geany</tt> (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>)</li>
3028 </ul>
3031 should be loaded at startup. You can also load and unload plugins on the
3032 fly using this dialog. Once you click the checkbox for a specific plugin
3033 in the dialog, it is loaded or unloaded according to its previous state.
3034 By default, no plugins are loaded at startup until you select some.
3035 You can also configure some plugin specific options when the plugin
3036 provides some.</p>
3037 <p>See also <a class="reference internal" href="#plugin-documentation">Plugin documentation</a> for information about single plugins
3038 which are included in Geany.</p>
3039 </div>
3042 <p>Geany supports the default keyboard shortcuts for the Scintilla
3043 editing widget. For a list of these commands, see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla
3044 keyboard commands</a>. The Scintilla keyboard shortcuts will be overridden
3045 by any custom keybindings with the same keyboard shortcut.</p>
3048 <p>There are a few non-configurable bindings to switch between documents,
3049 listed below. These can also be overridden by custom keybindings.</p>
3051 <colgroup>
3054 </colgroup>
3058 </tr>
3059 </thead>
3063 </tr>
3066 </tr>
3069 </tr>
3072 </tr>
3073 </tbody>
3074 </table>
3075 </div>
3078 <p>For all actions listed below you can define your own keybindings. Open
3079 the Preferences dialog, select the desired action and click on
3080 change. In the resulting dialog you can press the key combination you
3081 want to assign to the action and it will be saved when you press OK.
3082 You can define only one key combination for each action and each key
3083 combination can only be defined for one action.</p>
3084 <p>Some of the default key combinations are common across many
3086 Because they are so common it is not advisable to change these, but
3087 you can add other key combinations for these actions. For example
3091 <p>The following tables list all customizable keyboard shortcuts, those
3092 which are common to many applications are marked with (C) after the
3093 shortcut.</p>
3097 <colgroup>
3101 </colgroup>
3106 </tr>
3107 </thead>
3112 </tr>
3116 </tr>
3120 </tr>
3124 </tr>
3128 </tr>
3132 </tr>
3136 </tr>
3139 <td>Reloads the current file. All unsaved changes
3140 will be lost.</td>
3141 </tr>
3145 </tr>
3146 </tbody>
3147 </table>
3148 </div>
3152 <colgroup>
3156 </colgroup>
3161 </tr>
3162 </thead>
3167 </tr>
3171 </tr>
3174 <td>Deletes the current line (and any lines with a
3175 selection).</td>
3176 </tr>
3179 <td>Deletes from the current caret position to the
3180 end of the current line.</td>
3181 </tr>
3185 </tr>
3189 </tr>
3192 <td>Scrolls the current line into the centre of the
3193 view. The cursor position and or an existing
3194 selection will not be changed.</td>
3195 </tr>
3199 </tr>
3203 </tr>
3206 <td>Shows the autocompletion list. If already showing
3207 tag completion, it shows document word completion
3208 instead, even if it is not enabled for automatic
3209 completion. Likewise if no tag suggestions are
3210 available, it shows document word completion.</td>
3211 </tr>
3214 <td>Shows call tips for the current function or
3215 method.</td>
3216 </tr>
3219 <td>Shows a list of available macros and variables in
3220 the workspace.</td>
3221 </tr>
3224 <td>If you type a construct like if or for and press
3225 this key, it will be completed with a matching
3226 template.</td>
3227 </tr>
3230 <td>If you type a construct like if or for and press
3231 this key, it will not be completed, and a space or
3232 tab will be inserted, depending on what the
3233 construct completion keybinding is set to. For
3234 example, if you have set the construct completion
3235 keybinding to space, then setting this to
3236 Shift+space will prevent construct completion and
3237 insert a space.</td>
3238 </tr>
3241 <td>Executes a command and passes the current word
3242 (near the cursor position) or selection as an
3245 </tr>
3248 <td>Jumps to the next defined cursor positions in a
3249 completed snippets if multiple cursor positions
3250 where defined.</td>
3251 </tr>
3254 <td>When the autocompletion list is visible, complete
3255 the currently selected item up to the next word
3256 part.</td>
3257 </tr>
3260 <td>Move the current line or selected lines up by
3261 one line.</td>
3262 </tr>
3265 <td>Move the current line or selected lines down by
3266 one line.</td>
3267 </tr>
3268 </tbody>
3269 </table>
3270 </div>
3274 <colgroup>
3278 </colgroup>
3283 </tr>
3284 </thead>
3289 </tr>
3293 </tr>
3297 </tr>
3300 <td>Cuts the current line (and any lines with a
3301 selection) to the clipboard.</td>
3302 </tr>
3305 <td>Copies the current line (and any lines with a
3306 selection) to the clipboard.</td>
3307 </tr>
3308 </tbody>
3309 </table>
3310 </div>
3314 <colgroup>
3318 </colgroup>
3323 </tr>
3324 </thead>
3328 <td>Makes a selection of all text in the current
3329 document.</td>
3330 </tr>
3334 </tr>
3337 <td>Selects the current paragraph under the cursor
3338 which is defined by two empty lines around it.</td>
3339 </tr>
3342 <td>Selects the current line under the cursor (and any
3343 partially selected lines).</td>
3344 </tr>
3348 </tr>
3352 </tr>
3353 </tbody>
3354 </table>
3355 </div>
3359 <colgroup>
3363 </colgroup>
3368 </tr>
3369 </thead>
3374 </tr>
3377 <td>Inserts a tab character when spaces should
3378 be used for indentation and inserts space
3379 characters of the amount of a tab width when
3380 tabs should be used for indentation.</td>
3381 </tr>
3382 </tbody>
3383 </table>
3384 </div>
3388 <colgroup>
3392 </colgroup>
3397 </tr>
3398 </thead>
3402 <td>Changes the case of the selection. A lowercase
3403 selection will be changed into uppercase and vice
3404 versa. If the selection contains lower- and
3405 uppercase characters, all will be converted to
3406 lowercase.</td>
3407 </tr>
3411 </tr>
3415 </tr>
3418 <td>Comments a line if it is not commented or removes
3419 a comment if the line is commented.</td>
3420 </tr>
3423 <td>Indents the current line or selection by one tab
3424 or by spaces in the amount of the tab width
3425 setting.</td>
3426 </tr>
3429 <td>Removes one tab or the amount of spaces of
3430 the tab width setting from the indentation of the
3431 current line or selection.</td>
3432 </tr>
3435 <td>Indents the current line or selection by one
3436 space.</td>
3437 </tr>
3440 <td>Deindents the current line or selection by one
3441 space.</td>
3442 </tr>
3445 <td>Indents the current line or all selected lines
3446 with the same indentation as the previous line.</td>
3447 </tr>
3450 <td>Passes the current selection to a configured
3451 external command (available for the first
3452 three configured commands, see
3453 <a class="reference internal" href="#sending-text-through-custom-commands">Sending text through custom commands</a> for
3454 details).</td>
3455 </tr>
3458 <td>Sends the current selection or the current
3459 line (if there is no selection) to the
3460 embedded Terminal (VTE).</td>
3461 </tr>
3464 <td>Reformat selected lines or current
3465 (indented) text block,
3466 breaking lines at the long line marker or the
3467 line breaking column if line breaking is
3468 enabled for the current document.</td>
3469 </tr>
3470 </tbody>
3471 </table>
3472 </div>
3476 <colgroup>
3480 </colgroup>
3485 </tr>
3486 </thead>
3491 </tr>
3495 </tr>
3496 </tbody>
3497 </table>
3498 </div>
3502 <colgroup>
3506 </colgroup>
3511 </tr>
3512 </thead>
3517 </tr>
3521 </tr>
3525 </tr>
3529 </tr>
3533 </tr>
3536 <td>Jumps to the line with the next message in
3537 the Messages window.</td>
3538 </tr>
3541 <td>Jumps to the line with the previous message
3542 in the Messages window.</td>
3543 </tr>
3546 <td>Finds all occurrences of the current word (near
3547 the keyboard cursor) or selection in all open
3548 documents and displays them in the messages
3549 window.</td>
3550 </tr>
3553 <td>Finds all occurrences of the current word (near
3554 the keyboard cursor) or selection in the current
3555 document and displays them in the messages
3556 window.</td>
3557 </tr>
3560 <td>Highlight all matches of the current
3561 word/selection in the current document
3562 with a colored box. If there's nothing to
3563 find, highlighted matches will be cleared.</td>
3564 </tr>
3565 </tbody>
3566 </table>
3567 </div>
3571 <colgroup>
3575 </colgroup>
3580 </tr>
3581 </thead>
3585 <td>Switches to the next location in the navigation
3586 history. See the section called <a class="reference internal" href="#code-navigation-history">Code Navigation
3588 </tr>
3591 <td>Switches to the previous location in the
3592 navigation history. See the section called
3593 <a class="reference internal" href="#code-navigation-history">Code navigation history</a>.</td>
3594 </tr>
3597 <td>Focuses the Go to Line entry (if visible) or
3598 shows the Go to line dialog.</td>
3599 </tr>
3602 <td>If the cursor is ahead or behind a brace, then it
3603 is moved to the brace which belongs to the current
3604 one. If this keyboard shortcut is pressed again,
3605 the cursor is moved back to the first brace.</td>
3606 </tr>
3609 <td>Set a marker on the current line, or clear the
3610 marker if there already is one.</td>
3611 </tr>
3615 </tr>
3619 </tr>
3622 <td>Jump to the definition of the current word (near
3623 the keyboard cursor). If the definition cannot be
3624 found (e.g. the relevant file is not open) Geany
3625 will beep and do nothing. See the section called
3627 </tr>
3630 <td>Jump to the declaration of the current word (near
3631 the keyboard cursor). If the declaration cannot be
3632 found (e.g. the relevant file is not open) Geany
3633 will beep and do nothing. See the section called
3635 </tr>
3638 <td>Move the caret to the end of the line indentation
3639 unless it is already there, in which case it moves
3640 it to the start of the line.</td>
3641 </tr>
3645 </tr>
3648 <td>Move the caret to the end of the display line.
3649 This is useful when you use line wrapping and
3650 want to jump to the end of the wrapped, virtual
3651 line, not the real end of the whole line.
3652 If the line is not wrapped, it behaves like
3654 </tr>
3658 </tr>
3662 </tr>
3663 </tbody>
3664 </table>
3665 </div>
3669 <colgroup>
3673 </colgroup>
3678 </tr>
3679 </thead>
3684 </tr>
3687 <td>Toggles the message window (status and compiler
3688 messages) on and off.</td>
3689 </tr>
3693 </tr>
3696 <td>Hide and show all additional widgets like the
3697 notebook tabs, the toolbar, the messages window
3698 and the statusbar.</td>
3699 </tr>
3703 </tr>
3707 </tr>
3708 </tbody>
3709 </table>
3710 </div>
3714 <colgroup>
3718 </colgroup>
3723 </tr>
3724 </thead>
3729 </tr>
3733 </tr>
3737 </tr>
3740 <td>Switches to the search bar in the toolbar (if
3741 visible).</td>
3742 </tr>
3746 </tr>
3750 </tr>
3754 </tr>
3755 </tbody>
3756 </table>
3757 </div>
3761 <colgroup>
3765 </colgroup>
3770 </tr>
3771 </thead>
3776 </tr>
3780 </tr>
3783 <td>Switches to the previously shown document (if it's
3784 still open).
3785 Holding Ctrl (or another modifier if the keybinding
3786 has been changed) will show a dialog, then repeated
3787 presses of the keybinding will switch to the 2nd-last
3788 used document, 3rd-last, etc. Also known as
3789 Most-Recently-Used documents switching.</td>
3790 </tr>
3793 <td>Changes the current document with the left hand
3794 one.</td>
3795 </tr>
3798 <td>Changes the current document with the right hand
3799 one.</td>
3800 </tr>
3804 </tr>
3808 </tr>
3809 </tbody>
3810 </table>
3811 </div>
3815 <colgroup>
3819 </colgroup>
3824 </tr>
3825 </thead>
3830 </tr>
3834 </tr>
3838 </tr>
3842 </tr>
3846 </tr>
3850 </tr>
3854 </tr>
3857 <td>Enables or disables automatic breaking of long
3858 lines at a configurable column.</td>
3859 </tr>
3860 </tbody>
3861 </table>
3862 </div>
3866 <colgroup>
3870 </colgroup>
3875 </tr>
3876 </thead>
3881 </tr>
3884 <td>Builds (compiles if necessary and links) the
3885 current file.</td>
3886 </tr>
3890 </tr>
3893 <td>Builds the current file with the Make tool and a
3894 given target.</td>
3895 </tr>
3899 </tr>
3902 <td>Jumps to the line with the next error from the
3903 last build process.</td>
3904 </tr>
3907 <td>Jumps to the line with the previous error from
3908 the last build process.</td>
3909 </tr>
3913 </tr>
3917 </tr>
3918 </tbody>
3919 </table>
3920 </div>
3924 <colgroup>
3928 </colgroup>
3933 </tr>
3934 </thead>
3939 </tr>
3940 </tbody>
3941 </table>
3942 </div>
3946 <colgroup>
3950 </colgroup>
3955 </tr>
3956 </thead>
3961 </tr>
3962 </tbody>
3963 </table>
3964 </div>
3965 </div>
3966 </div>
3967 </div>
3973 </div>
3977 contains items for some of the available user configuration files.
3978 Clicking on one opens it in the editor for you to update. Geany will
3979 reload the file after you have saved it.</p>
3983 them manually and usually restart Geany to see any changes.</p>
3984 </div>
3986 updated a configuration file outside of the current instance. This
3987 item is also necessary to update syntax highlighting colors.</p>
3991 filetypes.common as this can take a short while depending on which
3992 documents are open.</p>
3993 </div>
3994 </div>
3997 <p>There is a global configuration file for Geany which will be used for
3998 any settings not defined in the users local configuration file.
3999 Settings present in the local configuration file override those in the global
4000 file.</p>
4001 <p>The global configuration file is read from
4002 <tt class="docutils literal">$prefix/share/geany/geany.conf</tt> (where <tt class="docutils literal">$prefix</tt> is the path where
4003 Geany is installed, see <a class="reference internal" href="#installation-prefix">Installation prefix</a>) when starting Geany and
4004 an user configuration file does not exist. It can contain any settings
4005 which are found in the usual configuration file created by Geany but
4006 does not have to contain all settings.</p>
4010 admins who want to set up Geany in a multi user environment and
4011 set some sane default values for this environment. Usually users won't
4012 need to do that.</p>
4013 </div>
4014 </div>
4017 <p>All color definitions and other filetype specific settings are
4018 stored in the filetype definition files. Those settings are colors
4019 for syntax highlighting, general settings like comment characters or
4020 word delimiter characters as well as compiler and linker settings.</p>
4023 <p>At startup Geany looks for <tt class="docutils literal"><span class="pre">filetypes.*.conf</span></tt> files in the system and
4024 user filetype paths, adding any filetypes found with the name matching
4026 <p>Custom filetypes are not as powerful as built-in filetypes, but the following
4027 have been implemented:</p>
4028 <ul>
4031 </li>
4033 <dt>Filetype settings in the [settings] section (see <a class="reference internal" href="#format">Format</a>).</dt>
4036 <li>Using existing syntax highlighting (<tt class="docutils literal">lexer_filetype</tt> key).</li>
4037 </ul>
4038 </dd>
4039 </dl>
4040 </li>
4042 </li>
4044 type).</p>
4045 </li>
4046 </ul>
4047 </div>
4050 <p>The system-wide configuration files can be found in
4051 <tt class="docutils literal">$prefix/share/geany</tt> and are called <tt class="docutils literal"><span class="pre">filetypes.$ext</span></tt>,
4053 <a class="reference internal" href="#installation-prefix">Installation prefix</a>) and $ext is the name of the filetype. For every
4054 filetype there is a corresponding definition file. There is one
4055 exception: <tt class="docutils literal">filetypes.common</tt> -- this file is for general settings,
4056 which are not specific to a certain filetype.</p>
4060 because they will be overridden when Geany is updated.</p>
4061 </div>
4062 </div>
4065 <p>To change the settings, copy a file from <tt class="docutils literal">$prefix/share/geany</tt> to
4066 the subdirectory filedefs in your configuration directory (usually
4070 % cp /usr/local/share/geany/filetypes.c /home/username/.config/geany/filedefs/
4071 </pre>
4072 <p>Then you can edit the file and the changes are also
4073 available after an update of Geany because they reside in your
4074 configuration directory. Alternatively, you can create a file
4075 <tt class="docutils literal"><span class="pre">~/.config/geany/filedefs/filetypes.X</span></tt> and add only these settings you want
4076 to change. All missing settings will be read from the corresponding
4078 <p>As well as the sections listed below, each filetype file can contain
4079 a [build-menu] section as described in <a class="reference internal" href="#build-menu-section">[build-menu] Section</a>.</p>
4080 </div>
4085 <p>In this section the colors for syntax highlighting are defined. The
4086 manual format is:</p>
4088 <li><tt class="docutils literal">key=foreground_color;background_color;bold_flag;italic_flag</tt></li>
4089 </ul>
4090 <p>Colors have to be specified as RGB hex values prefixed by
4092 case-insensitive, but it is a good idea to use small letters. Bold
4094 value is something other than "true" or "false", "false" is assumed.</p>
4095 <p>You can omit fields to use the values from the style named <tt class="docutils literal">"default"</tt>.</p>
4097 <p>This makes the key style have red foreground text, default background
4098 color text and bold emphasis.</p>
4102 defined in filetypes.common.</p>
4106 </ul>
4107 <p>The bold and italic parts are optional, and if present are used to
4108 toggle the bold or italic flags to the opposite of the named style's
4109 flags. In contrast to style definition booleans, they are a literal
4112 <p>This makes the key style match the <tt class="docutils literal">"comment"</tt> named style, but with
4113 italic emphasis.</p>
4114 <p>To define named styles, see the filetypes.common <a class="reference internal" href="#named-styles-section">[named_styles]
4116 </div>
4117 </div>
4120 <p>This section contains keys for different keyword lists specific to
4121 the filetype. Some filetypes do not support keywords, so adding a
4122 new key will not work. You can only add or remove keywords to/from
4123 an existing list.</p>
4127 </div>
4128 </div>
4131 <p>Here any special properties for the Scintilla lexer can be set in the
4133 </div>
4139 including the period character (<tt class="docutils literal">.</tt>). The extension used should
4140 match one of the patterns associated with that filetype (see
4143 </dd>
4146 and searching using word matching options.</p>
4148 </dd>
4151 use multiline comments, also set comment_close, otherwise leave it
4152 empty.</p>
4153 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_open=/*</span></tt></p>
4154 </dd>
4157 close the comment.</p>
4158 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_close=*/</span></tt></p>
4159 </dd>
4162 column 0 of a line. If set to true it uses any indentation of the
4163 line.</p>
4166 commented (e.g. with Ctrl-D):</p>
4168 #command_example();
4169 </pre>
4171 commented (e.g. with Ctrl-D):</p>
4173 # command_example();
4174 </pre>
4175 <p>Note: This setting only works for single line comments (like '//',
4176 '#' or ';').</p>
4177 <p class="last"><em>Example:</em> <tt class="docutils literal">comment_use_indent=true</tt></p>
4178 </dd>
4181 selection.</p>
4182 <p>Example usage: Open the API documentation for the
4183 current function call at the cursor position.</p>
4184 <p>The command can
4185 be set for every filetype or if not set, a global command will
4186 be used. The command itself can be specified without the full
4187 path, then it is searched in $PATH. But for security reasons,
4188 it is recommended to specify the full path to the command. The
4189 wildcard %s will be replaced by the current word at the cursor
4190 position or by the current selection.</p>
4191 <p>Hint: for PHP files the following could be quite useful:
4192 context_action_cmd=firefox "<a class="reference external" href="http://www.php.net/%s">http://www.php.net/%s</a>"</p>
4193 <p class="last"><em>Example:</em> <tt class="docutils literal">context_action_cmd=devhelp <span class="pre">-s</span> "%s"</tt></p>
4194 </dd>
4198 <dd>A filetype name to setup syntax highlighting from another filetype.
4199 This must not be recursive, i.e. it should be a filetype name that
4200 doesn't use the lexer_filetype key itself.</dd>
4201 </dl>
4202 </div>
4205 <p>As of Geany v0.19 this section is supplemented by the <a class="reference internal" href="#build-menu-section">[build-menu] Section</a>.
4206 Values that are set in the [build-menu] section will override those in this section.</p>
4210 and line number from build output. If undefined, Geany will fall
4211 back to its default error message parsing.</p>
4212 <p>Only the first two matches will be read by Geany. Geany will look for
4213 a match that is purely digits, and use this for the line number. The
4214 remaining match will be used as the filename.</p>
4215 <p><em>Example:</em> <tt class="docutils literal"><span class="pre">error_regex=(.+):([0-9]+):[0-9]+</span></tt></p>
4218 </dd>
4219 </dl>
4221 <p>If any build menu item settings have been configured in the Build Menu Commands
4222 dialog or the Build tab of the project preferences dialog then these
4223 settings are stored in the [build-menu] section and override the settings in
4224 this section for that item.</p>
4228 it is also possible to use it with interpreted languages like Perl
4229 or Python. With these filetypes you can use this option as a kind of
4230 syntax parser, which sends output to the compiler message window.</p>
4231 <p>You should quote the filename to also support filenames with
4232 spaces. The following wildcards for filenames are available:</p>
4236 </ul>
4237 <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>
4238 </dd>
4241 already compiled, it will be compiled while linking. The -o option
4242 is automatically added by Geany. This item works well with GNU gcc,
4243 but may be problematic with other compilers (esp. with the linker).</p>
4244 <p class="last"><em>Example:</em> <tt class="docutils literal">linker=gcc <span class="pre">-Wall</span> "%f"</tt></p>
4245 </dd>
4248 already. Use the %e wildcard to have only the name of the executable
4249 (i.e. without extension) or use the %f wildcard if you need the
4250 complete filename, e.g. for shell scripts.</p>
4251 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">run_cmd="./%e"</span></tt></p>
4252 </dd>
4253 </dl>
4254 </div>
4255 </div>
4258 <p>There is a special filetype definition file called
4259 filetypes.common. This file defines some general non-filetype-specific
4260 settings.</p>
4261 <p>See the <a class="reference internal" href="#format">Format</a> section for how to define styles.</p>
4264 <p>Named styles declared here can be used in the [styling] section of any
4265 filetypes.* file.</p>
4269 [named_styles]
4271 bar=foo
4272 </pre>
4275 [styling]
4276 comment=foo
4277 </pre>
4278 <p>This saves copying and pasting the whole style definition into several
4279 different files.</p>
4282 <p class="last">You can define aliases for named styles, as shown with the <tt class="docutils literal">bar</tt>
4283 entry in the above example, but they must be declared after the
4284 original style.</p>
4285 </div>
4286 </div>
4292 filetype set.</p>
4293 <p class="last"><em>Example:</em> <tt class="docutils literal">default=0x000000;0xffffff;false;false</tt></p>
4294 </dd>
4302 </ul>
4304 the colors are not overridden, the default is a dark grey
4305 background with syntax highlighted foreground text.</p>
4306 <p class="last"><em>Example:</em> <tt class="docutils literal">selection=0xc0c0c0;0x00007F;true;true</tt></p>
4307 </dd>
4310 <p class="last"><em>Example:</em> <tt class="docutils literal">brace_good=0xff0000;0xFFFFFF;true;false</tt></p>
4311 </dd>
4314 <p class="last"><em>Example:</em> <tt class="docutils literal">brace_bad=0x0000ff;0xFFFFFF;true;false</tt></p>
4315 </dd>
4318 and third argument is interpreted.
4319 Set the third argument to true to change the caret into a block caret.</p>
4320 <p class="last"><em>Example:</em> <tt class="docutils literal">caret=0x000000;0x0;false;false</tt></p>
4321 </dd>
4324 argument is interpreted. The width is specified in pixels with
4325 a maximum of three pixel. Use the width 0 to make the caret
4326 invisible.</p>
4328 </dd>
4331 the second and third arguments are interpreted. The second argument
4332 is the background color. Use the third argument to enable or
4333 disable background highlighting for the current line (has to be
4334 true/false).</p>
4335 <p class="last"><em>Example:</em> <tt class="docutils literal">current_line=0x0;0xe5e5e5;true;false</tt></p>
4336 </dd>
4339 second arguments are interpreted.</p>
4340 <p class="last"><em>Example:</em> <tt class="docutils literal">indent_guide=0xc0c0c0;0xffffff;false;false</tt></p>
4341 </dd>
4344 both arguments define the foreground and background colors, the
4345 third argument sets whether to use the defined foreground color
4346 or to use the color defined by each filetype for the white space.
4347 The fourth argument defines whether to use the background color.</p>
4348 <p class="last"><em>Example:</em> <tt class="docutils literal">white_space=0xc0c0c0;0xffffff;true;true</tt></p>
4349 </dd>
4352 used.</p>
4357 </ul>
4362 </ul>
4363 <p class="last"><em>Example:</em> <tt class="docutils literal">folding_style=1;1;false;false</tt></p>
4364 </dd>
4367 first argument is used.</p>
4373 </ul>
4374 <p class="last"><em>Example:</em> <tt class="docutils literal">folding_horiz_line=0;0;false;false</tt></p>
4375 </dd>
4378 This is a bitmask of the values:</p>
4384 </ul>
4385 <p>Second argument: wether the visual flags to indicate a line is wrapped
4386 are drawn near the border or near the text. This is a bitmask of the values:</p>
4391 </ul>
4393 <p class="last"><em>Example:</em> <tt class="docutils literal">line_wrap_visuals=3;0;false;false</tt></p>
4394 </dd>
4396 <dd><p class="first">First argument: sets the size of indentation of sublines for wrapped lines
4397 in terms of the width of a space, only used when the second argument is <tt class="docutils literal">0</tt>.</p>
4398 <p>Second argument: wrapped sublines can be indented to the position of their
4399 first subline or one more indent level. Possible values:</p>
4403 <li>2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation</li>
4404 </ul>
4406 <p class="last"><em>Example:</em> <tt class="docutils literal">line_wrap_indent=0;1;false;false</tt></p>
4407 </dd>
4414 <p class="last"><em>Example:</em> <tt class="docutils literal">translucency=256;256;false;false</tt></p>
4415 </dd>
4418 The foreground color (first argument) is only used when the Markers margin
4419 is enabled (see View menu).</p>
4421 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_line=0x000000;0xffff00;false;false</tt></p>
4422 </dd>
4424 <dd><p class="first">The style for a marked search results (when using "Mark" in Search dialogs).
4425 The second argument sets the background colour for the drawn rectangle.</p>
4427 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_search=0x000000;0xb8f4b8;false;false</tt></p>
4428 </dd>
4430 <dd><p class="first">The style for a marked line (e.g when using the "Toggle Marker" keybinding
4431 (Ctrl-M)). The foreground color (first argument) is only used
4432 when the Markers margin is enabled (see View menu).</p>
4434 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_mark=0x000000;0xb8f4b8;false;false</tt></p>
4435 </dd>
4442 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_translucency=256;256;false;false</tt></p>
4443 </dd>
4446 The first argument defines the amount of space to be drawn above the line, the second
4447 argument defines the amount of space to be drawn below.</p>
4449 <p class="last"><em>Example:</em> <tt class="docutils literal">line_height=0;0;false;false</tt></p>
4450 </dd>
4453 define the foreground and background colors, the third and fourth
4454 arguments set whether to use the defined colors.</p>
4455 <p class="last"><em>Example:</em> <tt class="docutils literal">calltips=0xc0c0c0;0xffffff;false;false</tt></p>
4456 </dd>
4457 </dl>
4458 </div>
4464 when moving, selecting and deleting across word boundaries
4465 (see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla keyboard commands</a>).</p>
4467 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~</span></tt></p>
4468 </dd>
4469 </dl>
4470 </div>
4471 </div>
4472 </div>
4475 <p>To change the default filetype extension used when saving a new file,
4476 see <a class="reference internal" href="#filetype-definition-files">Filetype definition files</a>.</p>
4477 <p>You can override the list of file extensions that Geany uses for each
4479 <p>To override the system-wide configuration file, copy it from
4481 <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>. <tt class="docutils literal">$prefix</tt> is the path where Geany is installed
4485 % cp /usr/local/share/geany/filetype_extensions.conf /home/username/.config/geany/
4486 </pre>
4487 <p>Then edit it and remove all the lines for filetype extensions that
4488 you do not want to override. The remaining lines can be edited after
4489 the <tt class="docutils literal">=</tt> sign, using a semi-colon separated list of patterns which
4490 should be matched for that filetype.</p>
4491 <p>For example, to set the filetype extensions for Make, the
4492 <tt class="docutils literal"><span class="pre">/home/username/.config/geany/filetype_extensions.conf</span></tt> file should
4493 look like:</p>
4495 [Extensions]
4496 Make=Makefile*;*.mk;Buildfile;
4497 </pre>
4498 </div>
4501 <p>The preferences file <tt class="docutils literal"><span class="pre">~/.config/geany/geany.conf</span></tt> holds settings for all the items configured
4502 in the preferences dialog. These are not detailed as they should not be edited
4503 as they are overwritten by Geany.</p>
4506 <p>There are some rarely used preferences that are not shown in the Preferences
4507 dialog. These can be set by editing the preferences file, then
4508 restarting Geany. Search for the key name, then edit the value. Example:</p>
4509 <blockquote>
4511 <p>The table below show the key names of hidden preferences in the
4512 configuration file.</p>
4514 <colgroup>
4518 </colgroup>
4523 </tr>
4524 </thead>
4529 </tr>
4533 </tr>
4535 <td>Whether to display scrollbars. If set to
4536 false, the horizontal and vertical
4537 scrollbars are hidden completely.</td>
4539 </tr>
4541 <td>Whether to look for the end of a word when
4542 using word-boundary related Scintilla
4543 commands (see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla keyboard
4546 </tr>
4548 <td>Whether to allow completion of snippets
4549 when editing an existing line (i.e. there
4550 is some text after the current cursor
4551 position on the line). Only used when the
4555 </tr>
4559 </tr>
4561 <td>Whether to show or hide the small expander
4562 icons on the symbol list treeview (only
4565 </tr>
4567 <td>Whether files can be saved always, even if
4568 they don't have any changes. By default,
4569 the Save buttons and menu items are
4570 disabled when a file is unchanged. When
4571 setting this option to true, the Save
4572 buttons and menu items are always active
4573 and files can be saved.</td>
4575 </tr>
4579 </tr>
4581 <td>Terminal emulation mode. Only change this
4582 if you have VTE termcap files other than
4585 </tr>
4587 <td>By default, Geany strips any trailing
4588 newline characters from the current
4589 selection before sending it to the terminal
4590 to not execute arbitrary code. This is
4591 mainly a security feature.
4592 If, for whatever reasons, you really want
4593 it to be executed directly, set this option
4594 to true.</td>
4596 </tr>
4600 </tr>
4602 <td>Defines the mode how Geany saves files to
4603 disk. If disabled, Geany directly writes
4604 the content of the document to disk. This
4605 might cause in loss of data when there is
4606 no more free space on disk to save the
4607 file. When set to true, Geany first saves
4608 the contents into a temporary file and if
4609 this succeeded, the temporary file is
4610 moved to the real file to save.
4611 This gives better error checking in case of
4612 no more free disk space. But it also
4613 destroys hard links of the original file
4614 and its permissions (e.g. executable flags
4615 are reset). Use this with care as it can
4616 break things seriously.
4617 The better approach would be to ensure your
4618 disk won't run out of free space.</td>
4620 </tr>
4624 </tr>
4626 <td>The maximum number of menu items in the
4627 filetype section of the Build menu.</td>
4629 </tr>
4631 <td>The maximum number of menu items in the
4632 non-filetype section of the Build menu.</td>
4634 </tr>
4636 <td>The maximum number of menu items in the
4637 execute section of the Build menu.</td>
4639 </tr>
4640 </tbody>
4641 </table>
4642 </div>
4645 <p>The [build-menu] section contains the configuration of the build menu.
4646 This section can occur in filetype, preferences and project files and
4647 always has the format described here. Different menu items are loaded
4648 from different files, see the table in the <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>
4649 section for details. All the settings can be configured from the dialogs
4650 except the execute command in filetype files and filetype definitions in
4651 the project file, so these are the only ones which need hand editing.</p>
4652 <p>The build-menu section stores one entry for each setting for each menu item that
4653 is configured. The keys for these settings have the format:</p>
4654 <blockquote>
4662 </ul>
4663 </li>
4664 <li>NN - is a two decimal digit number of the item within the group,
4670 </ul>
4671 </li>
4672 </ul>
4673 </div>
4674 </div>
4677 <p>The project file contains project related settings and possibly a
4678 record of the current session files.</p>
4681 <p>The project file also can have extra fields in the [build-menu] section
4682 in addition to those listed in <a class="reference internal" href="#build-menu-section">[build-menu] Section</a> above.</p>
4683 <p>When filetype menu items are configured for the project they are stored
4684 in the project file.</p>
4685 <p>The <tt class="docutils literal">filetypes</tt> entry is a list of the filetypes which exist in the
4686 project file.</p>
4687 <p>For each filetype the entries for that filetype have the format defined in
4688 <a class="reference internal" href="#build-menu-section">[build-menu] Section</a> but the key is prefixed by the name of the filetype
4689 as it appears in the <tt class="docutils literal">filetypes</tt> entry, eg the entry for the label of
4691 <blockquote>
4693 </div>
4694 </div>
4705 </ul>
4706 <p>To use these templates, just open the Edit menu or open the popup menu
4708 and insert templates as you want.</p>
4709 <p>Some templates (like File header or ChangeLog entry) will always be
4710 inserted at the top of the file.</p>
4711 <p>To insert a function description, the cursor must be inside
4712 of the function, so that the function name can be determined
4713 automatically. The description will be positioned correctly one line
4714 above the function, just check it out. If the cursor is not inside
4715 of a function or the function name cannot be determined, the inserted
4717 instead.</p>
4720 <p>Meta data can be used with all templates, but by default user set
4721 meta data is only used for the ChangeLog and File header templates.</p>
4723 <a class="reference internal" href="#template-preferences">Template preferences</a>). You can define the
4724 default values which will be inserted in the templates. You should
4725 restart Geany after making changes, because they are only read
4726 at startup.</p>
4727 </div>
4730 <p>File templates are templates used as the basis of a new file. To
4732 menu.</p>
4733 <p>By default, file templates are installed for some filetypes. Custom
4734 file templates can be added by creating the appropriate template file
4735 and restarting Geany. You can also edit the default file templates.</p>
4736 <p>The file's contents are just the text to place in the document, with
4737 optional template wildcards like <tt class="docutils literal">{fileheader}</tt>. The fileheader
4738 wildcard can be placed anywhere, but it's usually put on the first
4739 line of the file, followed by a blank line.</p>
4744 <li><tt class="docutils literal">$prefix/share/geany/templates/files</tt> (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>)</li>
4745 <li><tt class="docutils literal"><span class="pre">~/.config/geany/templates/files</span></tt> (created the first time
4746 Geany is started).</li>
4747 </ul>
4748 <p>The filetype to use is detected from the template file's extension, if
4749 any. For example, creating a file <tt class="docutils literal">module.c</tt> would add a menu item
4750 which created a new document with the filetype set to 'C'.</p>
4751 <p>The template file is read from disk when the corresponding menu item is
4752 clicked, so you don't need to restart Geany after editing a custom file
4753 template, only after adding a new one.</p>
4754 </div>
4760 </div>
4761 <p>Filetype template files are read from the <tt class="docutils literal"><span class="pre">~/.config/geany/templates</span></tt>
4764 unsure about the filetype name extensions, they are the same as
4765 the filetype configuration file extensions, commonly installed in
4766 <tt class="docutils literal">/usr/share/geany</tt>, with the prefix "filetypes.".</p>
4767 <p>There is also a template file <tt class="docutils literal">filetype.none</tt> which is used when
4768 the New command is used without a filetype. This is empty by default.</p>
4769 </div>
4770 </div>
4773 <p>Each template can be customized to your needs. The templates are
4774 stored in the <tt class="docutils literal"><span class="pre">~/.config/geany/templates/</span></tt> directory (see the section called
4775 <a class="reference internal" href="#command-line-options">Command line options</a> for further information about the configuration
4776 directory). Just open the desired template with an editor (ideally,
4777 Geany ;-) ) and edit the template to your needs. There are some
4778 wildcards which will be automatically replaced by Geany at startup.</p>
4783 <colgroup>
4787 </colgroup>
4792 </tr>
4793 </thead>
4797 <td>filetype templates, file header,
4798 function description, ChangeLog entry,
4799 bsd, gpl, snippets</td>
4800 </tr>
4804 <td>filetype templates, file header,
4805 function description, ChangeLog entry,
4806 bsd, gpl, snippets</td>
4807 </tr>
4810 <td>filetype templates, file header,
4811 function description, ChangeLog entry,
4812 bsd, gpl, snippets</td>
4813 </tr>
4816 <td>filetype templates, file header,
4817 function description, ChangeLog entry,
4818 bsd, gpl, snippets</td>
4819 </tr>
4822 <td>filetype templates, file header,
4823 function description, ChangeLog entry,
4824 bsd, gpl, snippets</td>
4825 </tr>
4828 <td>filetype templates, file header,
4829 function description, ChangeLog entry,
4830 bsd, gpl, snippets</td>
4831 </tr>
4834 <td>filetype templates, file header,
4835 function description, ChangeLog entry,
4836 bsd, gpl, snippets</td>
4837 </tr>
4840 translated to your locale), used in
4841 filetype templates.</td>
4842 <td>filetype templates, file header,
4843 function description, ChangeLog entry,
4844 bsd, gpl, snippets</td>
4845 </tr>
4847 <td>The actual Geany version, e.g.
4849 <td>filetype templates, file header,
4850 function description, ChangeLog entry,
4851 bsd, gpl, snippets</td>
4852 </tr>
4854 <td>The current date and time. Default format:
4855 DD.MM.YYYY HH:mm:ss ZZZZ.</td>
4856 <td>filetype templates, file header,
4857 function description, ChangeLog entry,
4858 bsd, gpl, snippets</td>
4859 </tr>
4863 </tr>
4867 </tr>
4871 </tr>
4873 <td>The function name of the function at the
4874 cursor position. This wildcard will only be
4875 replaced in the function description
4876 template.</td>
4878 </tr>
4880 <td>The file header template. This wildcard
4881 will only be replaced in filetype
4882 templates.</td>
4883 <td>file header, snippets, custom filetype
4884 templates</td>
4885 </tr>
4886 </tbody>
4887 </table>
4891 <tr><td class="label">[1]</td><td><em>(<a class="fn-backref" href="#id7">1</a>, <a class="fn-backref" href="#id8">2</a>, <a class="fn-backref" href="#id9">3</a>)</em> The format for the <tt class="docutils literal">year</tt>, <tt class="docutils literal">date</tt> and <tt class="docutils literal">datetime</tt> wildcards can be changed
4892 in the preferences dialog, see <a class="reference internal" href="#template-preferences">Template preferences</a>. You can
4893 use any conversion specifiers which can be used with the ANSI C strftime function.
4894 For details please see <a class="reference external" href="http://man.cx/strftime">http://man.cx/strftime</a>.</td></tr>
4895 </tbody>
4896 </table>
4897 </div>
4898 </div>
4899 </div>
4902 <p>You can add, remove and reorder the elements in the toolbar by using the toolbar editor
4904 <p>The toolbar editor can be opened from the preferences editor on the Toolbar tab or
4905 by right-clicking on the toolbar itself and choosing it from the menu.</p>
4908 <p>To override the system-wide configuration file, copy it from
4910 <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt>. <tt class="docutils literal">$prefix</tt> is the path where Geany is installed
4914 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
4915 </pre>
4916 <p>Then edit it and add any of the available elements listed in the file or remove
4917 any of the existing elements. Of course, you can also reorder the elements as
4918 you wish and add or remove additional separators.
4919 This file must be valid XML, otherwise the global toolbar UI definition
4920 will be used instead.</p>
4927 </ol>
4928 </div>
4929 </div>
4933 <colgroup>
4936 </colgroup>
4940 </tr>
4941 </thead>
4945 </tr>
4948 </tr>
4951 </tr>
4954 </tr>
4957 </tr>
4960 </tr>
4963 </tr>
4966 </tr>
4969 </tr>
4972 </tr>
4975 </tr>
4978 </tr>
4981 </tr>
4984 </tr>
4987 </tr>
4990 </tr>
4993 </tr>
4995 <td>Build the current file, includes a submenu for Make commands. Geany
4996 remembers the last chosen action from the submenu and uses this as default
4997 action when the button itself is clicked.</td>
4998 </tr>
5001 </tr>
5004 </tr>
5007 </tr>
5010 </tr>
5013 </tr>
5016 </tr>
5019 </tr>
5022 </tr>
5024 <td>Find the entered text in the current file (only useful if you also
5025 use 'SearchEntry')</td>
5026 </tr>
5029 </tr>
5032 </tr>
5035 </tr>
5038 </tr>
5039 </tbody>
5040 </table>
5041 </div>
5042 </div>
5043 </div>
5051 a randomly chosen filename and set its filetype appropriate to the used template
5052 or when no template was used, to a configurable default filetype.
5053 This enables you to quickly compile, build and/or run the new file without the
5054 need to give it an explicit filename using the Save As dialog. This might be
5055 useful when you often create new files just for testing some code or something
5056 similar.</p>
5057 </div>
5060 <p>This plugin creates a backup copy of the current file in Geany when it is
5061 saved. You can specify the directory where the backup copy is saved and
5062 you can configure the automatically added extension in the configure dialog
5063 in Geany's plugin manager.</p>
5064 <p>After the plugin was loaded in Geany's plugin manager, every file is
5065 copied into the configured backup directory when the file is saved in Geany.</p>
5066 </div>
5067 </div>
5068 </div>
5071 <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>
5072 (or "reST"). The source file for it is located in Geany's <tt class="docutils literal">doc</tt>
5073 subdirectory. If you intend on making changes, you should grab the
5074 source right from SVN to make sure you've got the newest version. After
5075 editing the file, to build the HTML document to see how your changes
5076 look, run "<tt class="docutils literal">make doc</tt>" in the subdirectory <tt class="docutils literal">doc</tt> of Geany's source
5077 directory. This regenerates the <tt class="docutils literal">geany.html</tt> file. To generate a PDF
5078 file, use the command "<tt class="docutils literal">make pdf</tt>" which should generate a file called
5082 % svn diff geany.txt > foo.patch
5083 </pre>
5085 <p>Note, you will need the Python docutils software package installed
5086 to build the docs. The package is named <tt class="docutils literal"><span class="pre">python-docutils</span></tt> on Debian
5087 and Fedora systems.</p>
5088 </div>
5092 <p>This appendix is distributed under the terms of the License for
5093 Scintilla and SciTE. A copy of this license can be found in the file
5095 program and in the appendix of this document. See <a class="reference internal" href="#license-for-scintilla-and-scite">License for
5100 <p>Keyboard commands for Scintilla mostly follow common Windows and GTK+
5101 conventions. All move keys (arrows, page up/down, home and end)
5102 allows to extend or reduce the stream selection when holding the
5103 Shift key, and the rectangular selection when holding the Shift and
5104 Ctrl keys. Some keys may not be available with some national keyboards
5105 or because they are taken by the system such as by a window manager
5106 or GTK. Keyboard equivalents of menu commands are listed in the
5107 menus. Some less common commands with no menu equivalent are:</p>
5109 <colgroup>
5112 </colgroup>
5116 </tr>
5117 </thead>
5121 </tr>
5124 </tr>
5127 </tr>
5130 </tr>
5133 </tr>
5136 </tr>
5139 </tr>
5142 </tr>
5145 </tr>
5148 </tr>
5151 </tr>
5154 </tr>
5157 </tr>
5160 </tr>
5163 </tr>
5166 </tr>
5169 </tr>
5172 </tr>
5175 </tr>
5176 </tbody>
5177 </table>
5178 </div>
5179 </div>
5185 <li>Double-click on empty space in the notebook tab bar to open a
5186 new document.</li>
5187 <li>Double-click on a document's notebook tab to toggle all additional
5188 widgets (to show them again use the View menu or the keyboard
5189 shortcut). The interface pref must be enabled for this to work.</li>
5191 </ul>
5192 </div>
5201 </ul>
5202 </div>
5207 </ul>
5208 </div>
5212 <li>Scrolling the mouse wheel over a notebook tab bar will switch
5213 notebook pages.</li>
5214 </ul>
5215 <p>The following are derived from X-Windows features (but GTK still supports
5216 them on Windows):</p>
5219 <li>Middle-click on a scrollbar moves the scrollbar to that
5220 position without having to drag it.</li>
5221 </ul>
5222 </div>
5223 </div>
5226 <p>There are some options which can only be changed at compile time,
5227 and some options which are used as the default for configurable
5228 options. To change these options, edit the appropriate source file
5229 in the <tt class="docutils literal">src</tt> subdirectory. Look for a block of lines starting with
5230 <tt class="docutils literal">#define GEANY_*</tt>. Any definitions which are not listed here should
5231 not be changed.</p>
5235 </div>
5239 <colgroup>
5243 </colgroup>
5248 </tr>
5249 </thead>
5252 <td>A string used as the default name for new
5253 files. Be aware that the string can be
5254 translated, so change it only if you know
5255 what you are doing.</td>
5257 </tr>
5261 </tr>
5265 </tr>
5267 <td>The default width of the main window at the
5268 first start.</td>
5270 </tr>
5272 <td>The default height of the main window at the
5273 first start.</td>
5275 </tr>
5279 </tr>
5282 Windows file open and save dialogs instead
5283 GTK's file open and save dialogs. The
5284 default Windows file dialogs are missing
5285 some nice features like choosing a filetype
5286 or an encoding. <em>Do not touch this setting
5287 when building on a non-Win32 system.</em></td>
5289 </tr>
5290 </tbody>
5291 </table>
5292 </div>
5296 <colgroup>
5300 </colgroup>
5305 </tr>
5306 </thead>
5309 <td>The default filename extension for Geany
5310 project files. It is used when creating new
5311 projects and as filter mask for the project
5312 open dialog.</td>
5314 </tr>
5315 </tbody>
5316 </table>
5317 </div>
5321 <colgroup>
5325 </colgroup>
5330 </tr>
5331 </thead>
5334 <td>These characters define word boundaries when
5335 making selections and searching using word
5336 matching options.</td>
5337 <td>a string with:
5339 underscore.</td>
5340 </tr>
5341 </tbody>
5342 </table>
5343 </div>
5346 <p>These are default settings that can be overridden in the <a class="reference internal" href="#preferences">Preferences</a> dialog.</p>
5348 <colgroup>
5352 </colgroup>
5357 </tr>
5358 </thead>
5361 <td>How many characters you need to type to
5362 trigger the autocompletion list.</td>
5364 </tr>
5366 <td>Time in seconds between checking a file for
5367 external changes.</td>
5369 </tr>
5373 </tr>
5375 <td>A terminal emulator. It has to accept the
5377 include a path.</td>
5379 </tr>
5383 </tr>
5385 <td>A printing tool. It should be able to accept
5386 and process plain text files. This can also
5387 include a path.</td>
5389 </tr>
5391 <td>A grep tool. It should be compatible with
5392 GNU grep. This can also include a path.</td>
5394 </tr>
5398 </tr>
5400 <td>The font used in sidebar to show symbols and
5401 open files.</td>
5403 </tr>
5407 </tr>
5411 </tr>
5413 <td>A string which is used to mark a toggled
5414 comment.</td>
5416 </tr>
5418 <td>How many autocompletion suggestions should
5419 Geany provide.</td>
5421 </tr>
5422 </tbody>
5423 </table>
5424 </div>
5428 <colgroup>
5432 </colgroup>
5437 </tr>
5438 </thead>
5441 <td>Amount of build error messages which should
5442 be highlighted in the Compiler message
5443 window. This affects the special coloring
5444 when Geany detects a compiler output line as
5445 an error message and then highlight the
5446 corresponding line in the source code.
5447 Usually only the first few messages are
5448 interesting because following errors are
5449 just aftereffects.</td>
5451 </tr>
5452 </tbody>
5453 </table>
5454 </div>
5458 <colgroup>
5462 </colgroup>
5467 </tr>
5468 </thead>
5471 <td>Every time a build menu item priority
5472 calculation is run, print the state of the
5473 menu item table in the form of the table
5474 in <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>. May be
5475 useful to debug configuration file
5476 overloading. Warning produces a lot of
5477 output. Can also be enabled/disabled by the
5479 overriding the compile setting.</td>
5481 </tr>
5482 </tbody>
5483 </table>
5484 </div>
5485 </div>
5489 GNU GENERAL PUBLIC LICENSE
5494 Everyone is permitted to copy and distribute verbatim copies
5495 of this license document, but changing it is not allowed.
5497 Preamble
5499 The licenses for most software are designed to take away your
5500 freedom to share and change it. By contrast, the GNU General Public
5501 License is intended to guarantee your freedom to share and change free
5502 software--to make sure the software is free for all its users. This
5503 General Public License applies to most of the Free Software
5504 Foundation's software and to any other program whose authors commit to
5505 using it. (Some other Free Software Foundation software is covered by
5506 the GNU Library General Public License instead.) You can apply it to
5507 your programs, too.
5509 When we speak of free software, we are referring to freedom, not
5510 price. Our General Public Licenses are designed to make sure that you
5511 have the freedom to distribute copies of free software (and charge for
5512 this service if you wish), that you receive source code or can get it
5513 if you want it, that you can change the software or use pieces of it
5514 in new free programs; and that you know you can do these things.
5516 To protect your rights, we need to make restrictions that forbid
5517 anyone to deny you these rights or to ask you to surrender the rights.
5518 These restrictions translate to certain responsibilities for you if you
5519 distribute copies of the software, or if you modify it.
5521 For example, if you distribute copies of such a program, whether
5522 gratis or for a fee, you must give the recipients all the rights that
5523 you have. You must make sure that they, too, receive or can get the
5524 source code. And you must show them these terms so they know their
5525 rights.
5527 We protect your rights with two steps: (1) copyright the software, and
5528 (2) offer you this license which gives you legal permission to copy,
5529 distribute and/or modify the software.
5531 Also, for each author's protection and ours, we want to make certain
5532 that everyone understands that there is no warranty for this free
5533 software. If the software is modified by someone else and passed on, we
5534 want its recipients to know that what they have is not the original, so
5535 that any problems introduced by others will not reflect on the original
5536 authors' reputations.
5538 Finally, any free program is threatened constantly by software
5539 patents. We wish to avoid the danger that redistributors of a free
5540 program will individually obtain patent licenses, in effect making the
5541 program proprietary. To prevent this, we have made it clear that any
5542 patent must be licensed for everyone's free use or not licensed at all.
5544 The precise terms and conditions for copying, distribution and
5545 modification follow.
5547 GNU GENERAL PUBLIC LICENSE
5548 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5550 0. This License applies to any program or other work which contains
5551 a notice placed by the copyright holder saying it may be distributed
5554 means either the Program or any derivative work under copyright law:
5555 that is to say, a work containing the Program or a portion of it,
5556 either verbatim or with modifications and/or translated into another
5557 language. (Hereinafter, translation is included without limitation in
5560 Activities other than copying, distribution and modification are not
5561 covered by this License; they are outside its scope. The act of
5562 running the Program is not restricted, and the output from the Program
5563 is covered only if its contents constitute a work based on the
5564 Program (independent of having been made by running the Program).
5565 Whether that is true depends on what the Program does.
5567 1. You may copy and distribute verbatim copies of the Program's
5568 source code as you receive it, in any medium, provided that you
5569 conspicuously and appropriately publish on each copy an appropriate
5570 copyright notice and disclaimer of warranty; keep intact all the
5571 notices that refer to this License and to the absence of any warranty;
5572 and give any other recipients of the Program a copy of this License
5573 along with the Program.
5575 You may charge a fee for the physical act of transferring a copy, and
5576 you may at your option offer warranty protection in exchange for a fee.
5578 2. You may modify your copy or copies of the Program or any portion
5579 of it, thus forming a work based on the Program, and copy and
5580 distribute such modifications or work under the terms of Section 1
5581 above, provided that you also meet all of these conditions:
5583 a) You must cause the modified files to carry prominent notices
5584 stating that you changed the files and the date of any change.
5586 b) You must cause any work that you distribute or publish, that in
5587 whole or in part contains or is derived from the Program or any
5588 part thereof, to be licensed as a whole at no charge to all third
5589 parties under the terms of this License.
5591 c) If the modified program normally reads commands interactively
5592 when run, you must cause it, when started running for such
5593 interactive use in the most ordinary way, to print or display an
5594 announcement including an appropriate copyright notice and a
5595 notice that there is no warranty (or else, saying that you provide
5596 a warranty) and that users may redistribute the program under
5597 these conditions, and telling the user how to view a copy of this
5598 License. (Exception: if the Program itself is interactive but
5599 does not normally print such an announcement, your work based on
5600 the Program is not required to print an announcement.)
5602 These requirements apply to the modified work as a whole. If
5603 identifiable sections of that work are not derived from the Program,
5604 and can be reasonably considered independent and separate works in
5605 themselves, then this License, and its terms, do not apply to those
5606 sections when you distribute them as separate works. But when you
5607 distribute the same sections as part of a whole which is a work based
5608 on the Program, the distribution of the whole must be on the terms of
5609 this License, whose permissions for other licensees extend to the
5610 entire whole, and thus to each and every part regardless of who wrote it.
5612 Thus, it is not the intent of this section to claim rights or contest
5613 your rights to work written entirely by you; rather, the intent is to
5614 exercise the right to control the distribution of derivative or
5615 collective works based on the Program.
5617 In addition, mere aggregation of another work not based on the Program
5618 with the Program (or with a work based on the Program) on a volume of
5619 a storage or distribution medium does not bring the other work under
5620 the scope of this License.
5622 3. You may copy and distribute the Program (or a work based on it,
5623 under Section 2) in object code or executable form under the terms of
5626 a) Accompany it with the complete corresponding machine-readable
5627 source code, which must be distributed under the terms of Sections
5630 b) Accompany it with a written offer, valid for at least three
5631 years, to give any third party, for a charge no more than your
5632 cost of physically performing source distribution, a complete
5633 machine-readable copy of the corresponding source code, to be
5635 customarily used for software interchange; or,
5637 c) Accompany it with the information you received as to the offer
5638 to distribute corresponding source code. (This alternative is
5639 allowed only for noncommercial distribution and only if you
5640 received the program in object code or executable form with such
5641 an offer, in accord with Subsection b above.)
5643 The source code for a work means the preferred form of the work for
5644 making modifications to it. For an executable work, complete source
5645 code means all the source code for all modules it contains, plus any
5646 associated interface definition files, plus the scripts used to
5647 control compilation and installation of the executable. However, as a
5648 special exception, the source code distributed need not include
5649 anything that is normally distributed (in either source or binary
5650 form) with the major components (compiler, kernel, and so on) of the
5651 operating system on which the executable runs, unless that component
5652 itself accompanies the executable.
5654 If distribution of executable or object code is made by offering
5655 access to copy from a designated place, then offering equivalent
5656 access to copy the source code from the same place counts as
5657 distribution of the source code, even though third parties are not
5658 compelled to copy the source along with the object code.
5660 4. You may not copy, modify, sublicense, or distribute the Program
5661 except as expressly provided under this License. Any attempt
5662 otherwise to copy, modify, sublicense or distribute the Program is
5663 void, and will automatically terminate your rights under this License.
5664 However, parties who have received copies, or rights, from you under
5665 this License will not have their licenses terminated so long as such
5666 parties remain in full compliance.
5668 5. You are not required to accept this License, since you have not
5669 signed it. However, nothing else grants you permission to modify or
5670 distribute the Program or its derivative works. These actions are
5671 prohibited by law if you do not accept this License. Therefore, by
5672 modifying or distributing the Program (or any work based on the
5673 Program), you indicate your acceptance of this License to do so, and
5674 all its terms and conditions for copying, distributing or modifying
5675 the Program or works based on it.
5677 6. Each time you redistribute the Program (or any work based on the
5678 Program), the recipient automatically receives a license from the
5679 original licensor to copy, distribute or modify the Program subject to
5680 these terms and conditions. You may not impose any further
5681 restrictions on the recipients' exercise of the rights granted herein.
5682 You are not responsible for enforcing compliance by third parties to
5683 this License.
5685 7. If, as a consequence of a court judgment or allegation of patent
5686 infringement or for any other reason (not limited to patent issues),
5687 conditions are imposed on you (whether by court order, agreement or
5688 otherwise) that contradict the conditions of this License, they do not
5689 excuse you from the conditions of this License. If you cannot
5690 distribute so as to satisfy simultaneously your obligations under this
5691 License and any other pertinent obligations, then as a consequence you
5692 may not distribute the Program at all. For example, if a patent
5693 license would not permit royalty-free redistribution of the Program by
5694 all those who receive copies directly or indirectly through you, then
5695 the only way you could satisfy both it and this License would be to
5696 refrain entirely from distribution of the Program.
5698 If any portion of this section is held invalid or unenforceable under
5699 any particular circumstance, the balance of the section is intended to
5700 apply and the section as a whole is intended to apply in other
5701 circumstances.
5703 It is not the purpose of this section to induce you to infringe any
5704 patents or other property right claims or to contest validity of any
5705 such claims; this section has the sole purpose of protecting the
5706 integrity of the free software distribution system, which is
5707 implemented by public license practices. Many people have made
5708 generous contributions to the wide range of software distributed
5709 through that system in reliance on consistent application of that
5710 system; it is up to the author/donor to decide if he or she is willing
5711 to distribute software through any other system and a licensee cannot
5712 impose that choice.
5714 This section is intended to make thoroughly clear what is believed to
5715 be a consequence of the rest of this License.
5717 8. If the distribution and/or use of the Program is restricted in
5718 certain countries either by patents or by copyrighted interfaces, the
5719 original copyright holder who places the Program under this License
5720 may add an explicit geographical distribution limitation excluding
5721 those countries, so that distribution is permitted only in or among
5722 countries not thus excluded. In such case, this License incorporates
5723 the limitation as if written in the body of this License.
5725 9. The Free Software Foundation may publish revised and/or new versions
5726 of the General Public License from time to time. Such new versions will
5727 be similar in spirit to the present version, but may differ in detail to
5728 address new problems or concerns.
5730 Each version is given a distinguishing version number. If the Program
5731 specifies a version number of this License which applies to it and "any
5732 later version", you have the option of following the terms and conditions
5733 either of that version or of any later version published by the Free
5734 Software Foundation. If the Program does not specify a version number of
5735 this License, you may choose any version ever published by the Free Software
5736 Foundation.
5738 10. If you wish to incorporate parts of the Program into other free
5739 programs whose distribution conditions are different, write to the author
5740 to ask for permission. For software which is copyrighted by the Free
5741 Software Foundation, write to the Free Software Foundation; we sometimes
5742 make exceptions for this. Our decision will be guided by the two goals
5743 of preserving the free status of all derivatives of our free software and
5744 of promoting the sharing and reuse of software generally.
5746 NO WARRANTY
5748 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5749 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5750 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5752 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5753 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5754 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5755 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5756 REPAIR OR CORRECTION.
5758 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5759 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5760 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5761 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5762 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5763 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5764 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5765 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5766 POSSIBILITY OF SUCH DAMAGES.
5768 END OF TERMS AND CONDITIONS
5770 How to Apply These Terms to Your New Programs
5772 If you develop a new program, and you want it to be of the greatest
5773 possible use to the public, the best way to achieve this is to make it
5774 free software which everyone can redistribute and change under these terms.
5776 To do so, attach the following notices to the program. It is safest
5777 to attach them to the start of each source file to most effectively
5778 convey the exclusion of warranty; and each file should have at least
5784 This program is free software; you can redistribute it and/or modify
5785 it under the terms of the GNU General Public License as published by
5786 the Free Software Foundation; either version 2 of the License, or
5787 (at your option) any later version.
5789 This program is distributed in the hope that it will be useful,
5790 but WITHOUT ANY WARRANTY; without even the implied warranty of
5791 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5792 GNU General Public License for more details.
5794 You should have received a copy of the GNU General Public License
5795 along with this program; if not, write to the Free Software
5799 Also add information on how to contact you by electronic and paper mail.
5801 If the program is interactive, make it output a short notice like this
5802 when it starts in an interactive mode:
5804 Gnomovision version 69, Copyright (C) year name of author
5805 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5806 This is free software, and you are welcome to redistribute it
5807 under certain conditions; type `show c' for details.
5809 The hypothetical commands `show w' and `show c' should show the appropriate
5810 parts of the General Public License. Of course, the commands you use may
5811 be called something other than `show w' and `show c'; they could even be
5812 mouse-clicks or menu items--whatever suits your program.
5814 You should also get your employer (if you work as a programmer) or your
5816 necessary. Here is a sample; alter the names:
5818 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5819 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5822 Ty Coon, President of Vice
5824 This General Public License does not permit incorporating your program into
5825 proprietary programs. If your program is a subroutine library, you may
5826 consider it more useful to permit linking proprietary applications with the
5827 library. If this is what you want to do, use the GNU Library General
5828 Public License instead of this License.
5829 </pre>
5830 </div>
5835 <p>Permission to use, copy, modify, and distribute this software and
5836 its documentation for any purpose and without fee is hereby granted,
5837 provided that the above copyright notice appear in all copies and
5838 that both that copyright notice and this permission notice appear in
5839 supporting documentation.</p>
5840 <p>NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5841 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5842 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5843 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5844 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5845 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5846 USE OR PERFORMANCE OF THIS SOFTWARE.</p>
5847 </div>
5848 </div>
5853 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.
5855 </div>
5856 </body>
5857 </html>