| blob | 331e0bdb1d60068cb5616f616ec32aac66795425 |
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
140 <br />Frank Lanitz
146 </tbody>
147 </table>
149 <p>This document is distributed under the terms of the GNU General Public
150 License as published by the Free Software Foundation; either version 2
151 of the License, or (at your option) any later version. A copy of this
152 license can be found in the file COPYING included with the source code
153 of this program, and also in the chapter <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
161 <li><a class="reference internal" href="#about-this-document" id="id11">About this document</a></li>
162 </ul>
163 </li>
167 <li><a class="reference internal" href="#source-compilation" id="id15">Source compilation</a><ul>
168 <li><a class="reference internal" href="#autotools-based-build-system" id="id16">Autotools based build system</a></li>
169 <li><a class="reference internal" href="#waf-based-build-system" id="id17">Waf based build system</a><ul>
171 <li><a class="reference internal" href="#cleaning-the-cache" id="id19">Cleaning the cache</a></li>
172 </ul>
173 </li>
174 </ul>
175 </li>
176 <li><a class="reference internal" href="#custom-installation" id="id20">Custom installation</a></li>
177 <li><a class="reference internal" href="#dynamic-linking-loader-support-and-vte" id="id21">Dynamic linking loader support and VTE</a></li>
179 </ul>
180 </li>
181 <li><a class="reference internal" href="#installation-prefix" id="id23">Installation prefix</a></li>
182 </ul>
183 </li>
186 <li><a class="reference internal" href="#the-geany-workspace" id="id26">The Geany workspace</a></li>
187 <li><a class="reference internal" href="#command-line-options" id="id27">Command line options</a></li>
190 <li><a class="reference internal" href="#opening-files-from-the-command-line-in-a-running-instance" id="id30">Opening files from the command-line in a running instance</a></li>
191 <li><a class="reference internal" href="#virtual-terminal-emulator-widget-vte" id="id31">Virtual terminal emulator widget (VTE)</a></li>
192 <li><a class="reference internal" href="#defining-own-widget-styles-using-gtkrc-2-0" id="id32">Defining own widget styles using .gtkrc-2.0</a></li>
193 </ul>
194 </li>
196 <li><a class="reference internal" href="#switching-between-documents" id="id34">Switching between documents</a></li>
197 </ul>
198 </li>
199 <li><a class="reference internal" href="#character-sets-and-unicode-byte-order-mark-bom" id="id35">Character sets and Unicode Byte-Order-Mark (BOM)</a><ul>
200 <li><a class="reference internal" href="#using-character-sets" id="id36">Using character sets</a></li>
201 <li><a class="reference internal" href="#in-file-encoding-specification" id="id37">In-file encoding specification</a></li>
202 <li><a class="reference internal" href="#special-encoding-none" id="id38">Special encoding "None"</a></li>
203 <li><a class="reference internal" href="#unicode-byte-order-mark-bom" id="id39">Unicode Byte-Order-Mark (BOM)</a></li>
204 </ul>
205 </li>
208 <li><a class="reference internal" href="#column-mode-editing-rectangular-selections" id="id42">Column mode editing (rectangular selections)</a></li>
209 <li><a class="reference internal" href="#drag-and-drop-of-text" id="id43">Drag and drop of text</a></li>
211 <li><a class="reference internal" href="#applying-new-indentation-settings" id="id45">Applying new indentation settings</a></li>
212 <li><a class="reference internal" href="#detecting-indent-type" id="id46">Detecting indent type</a></li>
213 </ul>
214 </li>
217 <li><a class="reference internal" href="#code-navigation-history" id="id49">Code navigation history</a></li>
218 <li><a class="reference internal" href="#sending-text-through-custom-commands" id="id50">Sending text through custom commands</a></li>
221 <li><a class="reference internal" href="#word-part-completion" id="id53">Word part completion</a></li>
222 <li><a class="reference internal" href="#scope-autocompletion" id="id54">Scope autocompletion</a></li>
223 </ul>
224 </li>
225 <li><a class="reference internal" href="#user-definable-snippets" id="id55">User-definable snippets</a><ul>
226 <li><a class="reference internal" href="#snippet-keybindings" id="id56">Snippet keybindings</a></li>
227 </ul>
228 </li>
229 <li><a class="reference internal" href="#inserting-unicode-characters" id="id57">Inserting Unicode characters</a></li>
230 </ul>
231 </li>
232 <li><a class="reference internal" href="#search-replace-and-go-to" id="id58">Search, replace and go to</a><ul>
235 </ul>
236 </li>
240 <li><a class="reference internal" href="#change-font-in-search-dialog-text-fields" id="id64">Change font in search dialog text fields</a></li>
241 </ul>
242 </li>
246 <li><a class="reference internal" href="#filtering-out-version-control-files" id="id68">Filtering out version control files</a></li>
247 </ul>
248 </li>
251 </ul>
252 </li>
253 <li><a class="reference internal" href="#go-to-tag-definition" id="id71">Go to tag definition</a></li>
254 <li><a class="reference internal" href="#go-to-tag-declaration" id="id72">Go to tag declaration</a></li>
256 <li><a class="reference internal" href="#regular-expressions" id="id74">Regular expressions</a></li>
257 </ul>
258 </li>
260 <li><a class="reference internal" href="#color-schemes-menu" id="id76">Color schemes menu</a></li>
261 </ul>
262 </li>
266 <li><a class="reference internal" href="#default-global-tags-files" id="id80">Default global tags files</a></li>
267 <li><a class="reference internal" href="#global-tags-file-format" id="id81">Global tags file format</a></li>
268 <li><a class="reference internal" href="#generating-a-global-tags-file" id="id82">Generating a global tags file</a></li>
269 </ul>
270 </li>
272 </ul>
273 </li>
275 <li><a class="reference internal" href="#general-startup-preferences" id="id85">General Startup preferences</a><ul>
279 </ul>
280 </li>
281 <li><a class="reference internal" href="#general-miscellaneous-preferences" id="id89">General Miscellaneous preferences</a><ul>
285 </ul>
286 </li>
287 <li><a class="reference internal" href="#interface-preferences" id="id93">Interface preferences</a><ul>
291 </ul>
292 </li>
293 <li><a class="reference internal" href="#interface-notebook-tab-preferences" id="id97">Interface Notebook tab preferences</a><ul>
296 </ul>
297 </li>
298 <li><a class="reference internal" href="#interface-toolbar-preferences" id="id100">Interface Toolbar preferences</a><ul>
301 </ul>
302 </li>
303 <li><a class="reference internal" href="#editor-features-preferences" id="id103">Editor Features preferences</a><ul>
305 </ul>
306 </li>
307 <li><a class="reference internal" href="#editor-indentation-preferences" id="id105">Editor Indentation preferences</a><ul>
308 <li><a class="reference internal" href="#indentation-group" id="id106">Indentation group</a></li>
309 </ul>
310 </li>
311 <li><a class="reference internal" href="#editor-completions-preferences" id="id107">Editor Completions preferences</a><ul>
313 <li><a class="reference internal" href="#auto-close-quotes-and-brackets" id="id109">Auto-close quotes and brackets</a></li>
314 </ul>
315 </li>
316 <li><a class="reference internal" href="#editor-display-preferences" id="id110">Editor Display preferences</a><ul>
320 </ul>
321 </li>
322 <li><a class="reference internal" href="#files-preferences" id="id114">Files preferences</a><ul>
326 </ul>
327 </li>
328 <li><a class="reference internal" href="#tools-preferences" id="id118">Tools preferences</a><ul>
331 </ul>
332 </li>
333 <li><a class="reference internal" href="#template-preferences" id="id121">Template preferences</a><ul>
335 </ul>
336 </li>
337 <li><a class="reference internal" href="#keybinding-preferences" id="id123">Keybinding preferences</a></li>
338 <li><a class="reference internal" href="#printing-preferences" id="id124">Printing preferences</a></li>
339 <li><a class="reference internal" href="#various-preferences" id="id125">Various preferences</a></li>
340 <li><a class="reference internal" href="#terminal-vte-preferences" id="id126">Terminal (VTE) preferences</a><ul>
342 </ul>
343 </li>
344 </ul>
345 </li>
346 <li><a class="reference internal" href="#project-management" id="id128">Project management</a><ul>
348 <li><a class="reference internal" href="#project-properties" id="id130">Project properties</a></li>
351 </ul>
352 </li>
355 <li><a class="reference internal" href="#default-build-menu-items" id="id135">Default build menu items</a><ul>
359 <li><a class="reference internal" href="#make-custom-target" id="id139">Make custom target</a></li>
364 <li><a class="reference internal" href="#stopping-running-processes" id="id144">Stopping running processes</a><ul>
365 <li><a class="reference internal" href="#terminal-emulators" id="id145">Terminal emulators</a></li>
366 </ul>
367 </li>
368 <li><a class="reference internal" href="#set-build-commands" id="id146">Set build commands</a></li>
369 </ul>
370 </li>
371 <li><a class="reference internal" href="#build-menu-configuration" id="id147">Build menu configuration</a></li>
372 <li><a class="reference internal" href="#build-menu-commands-dialog" id="id148">Build menu commands dialog</a><ul>
373 <li><a class="reference internal" href="#substitutions-in-commands-and-working-directories" id="id149">Substitutions in commands and working directories</a></li>
374 <li><a class="reference internal" href="#build-menu-keyboard-shortcuts" id="id150">Build menu keyboard shortcuts</a></li>
376 </ul>
377 </li>
378 </ul>
379 </li>
383 </ul>
384 </li>
386 <li><a class="reference internal" href="#switching-documents" id="id156">Switching documents</a></li>
387 <li><a class="reference internal" href="#configurable-keybindings" id="id157">Configurable keybindings</a><ul>
389 <li><a class="reference internal" href="#editor-keybindings" id="id159">Editor keybindings</a></li>
390 <li><a class="reference internal" href="#clipboard-keybindings" id="id160">Clipboard keybindings</a></li>
391 <li><a class="reference internal" href="#select-keybindings" id="id161">Select keybindings</a></li>
392 <li><a class="reference internal" href="#insert-keybindings" id="id162">Insert keybindings</a></li>
393 <li><a class="reference internal" href="#format-keybindings" id="id163">Format keybindings</a></li>
394 <li><a class="reference internal" href="#settings-keybindings" id="id164">Settings keybindings</a></li>
395 <li><a class="reference internal" href="#search-keybindings" id="id165">Search keybindings</a></li>
396 <li><a class="reference internal" href="#go-to-keybindings" id="id166">Go to keybindings</a></li>
398 <li><a class="reference internal" href="#focus-keybindings" id="id168">Focus keybindings</a></li>
399 <li><a class="reference internal" href="#notebook-tab-keybindings" id="id169">Notebook tab keybindings</a></li>
400 <li><a class="reference internal" href="#document-keybindings" id="id170">Document keybindings</a></li>
401 <li><a class="reference internal" href="#project-keybindings" id="id171">Project keybindings</a></li>
402 <li><a class="reference internal" href="#build-keybindings" id="id172">Build keybindings</a></li>
403 <li><a class="reference internal" href="#tools-keybindings" id="id173">Tools keybindings</a></li>
405 </ul>
406 </li>
407 </ul>
408 </li>
409 </ul>
410 </li>
411 <li><a class="reference internal" href="#configuration-files" id="id175">Configuration files</a><ul>
412 <li><a class="reference internal" href="#configuration-file-paths" id="id176">Configuration file paths</a><ul>
413 <li><a class="reference internal" href="#paths-on-unix-like-systems" id="id177">Paths on Unix-like systems</a></li>
415 </ul>
416 </li>
418 <li><a class="reference internal" href="#global-configuration-file" id="id180">Global configuration file</a></li>
419 <li><a class="reference internal" href="#filetype-definition-files" id="id181">Filetype definition files</a><ul>
424 <li><a class="reference internal" href="#creating-a-custom-filetype-from-an-existing-filetype" id="id186">Creating a custom filetype from an existing filetype</a></li>
425 </ul>
426 </li>
427 <li><a class="reference internal" href="#filetype-configuration" id="id187">Filetype configuration</a><ul>
429 <li><a class="reference internal" href="#using-a-named-style" id="id189">Using a named style</a></li>
430 <li><a class="reference internal" href="#reading-styles-from-another-filetype" id="id190">Reading styles from another filetype</a></li>
431 </ul>
432 </li>
433 <li><a class="reference internal" href="#keywords-section" id="id191">[keywords] section</a></li>
434 <li><a class="reference internal" href="#lexer-properties-section" id="id192">[lexer_properties] section</a></li>
435 <li><a class="reference internal" href="#settings-section" id="id193">[settings] section</a></li>
436 <li><a class="reference internal" href="#indentation-section" id="id194">[indentation] section</a></li>
437 <li><a class="reference internal" href="#build-settings-section" id="id195">[build_settings] section</a></li>
438 </ul>
439 </li>
440 <li><a class="reference internal" href="#special-file-filetypes-common" id="id196">Special file filetypes.common</a><ul>
441 <li><a class="reference internal" href="#named-styles-section" id="id197">[named_styles] section</a></li>
442 <li><a class="reference internal" href="#named-colors-section" id="id198">[named_colors] section</a></li>
445 </ul>
446 </li>
447 </ul>
448 </li>
449 <li><a class="reference internal" href="#filetype-extensions" id="id201">Filetype extensions</a></li>
450 <li><a class="reference internal" href="#filetype-group-membership" id="id202">Filetype group membership</a></li>
451 <li><a class="reference internal" href="#preferences-file-format" id="id203">Preferences file format</a><ul>
452 <li><a class="reference internal" href="#build-menu-section" id="id204">[build-menu] section</a></li>
453 </ul>
454 </li>
455 <li><a class="reference internal" href="#project-file-format" id="id205">Project file format</a><ul>
456 <li><a class="reference internal" href="#build-menu-additions" id="id206">[build-menu] additions</a></li>
457 </ul>
458 </li>
460 <li><a class="reference internal" href="#template-meta-data" id="id208">Template meta data</a></li>
462 <li><a class="reference internal" href="#adding-file-templates" id="id210">Adding file templates</a></li>
463 </ul>
464 </li>
465 <li><a class="reference internal" href="#customizing-templates" id="id211">Customizing templates</a><ul>
466 <li><a class="reference internal" href="#template-wildcards" id="id212">Template wildcards</a><ul>
467 <li><a class="reference internal" href="#special-command-wildcard" id="id213">Special {command:} wildcard</a></li>
468 </ul>
469 </li>
470 </ul>
471 </li>
472 </ul>
473 </li>
474 <li><a class="reference internal" href="#customizing-the-toolbar" id="id214">Customizing the toolbar</a><ul>
475 <li><a class="reference internal" href="#manually-editing-the-toolbar-layout" id="id215">Manually editing the toolbar layout</a></li>
476 <li><a class="reference internal" href="#available-toolbar-elements" id="id216">Available toolbar elements</a></li>
477 </ul>
478 </li>
479 </ul>
480 </li>
481 <li><a class="reference internal" href="#plugin-documentation" id="id217">Plugin documentation</a><ul>
483 <li><a class="reference internal" href="#insert-entity-dialog" id="id219">Insert entity dialog</a></li>
484 <li><a class="reference internal" href="#replace-special-chars-by-its-entity" id="id220">Replace special chars by its entity</a><ul>
487 </ul>
488 </li>
489 </ul>
490 </li>
494 </ul>
495 </li>
496 </ul>
497 </li>
498 <li><a class="reference internal" href="#contributing-to-this-document" id="id226">Contributing to this document</a></li>
499 <li><a class="reference internal" href="#scintilla-keyboard-commands" id="id227">Scintilla keyboard commands</a><ul>
500 <li><a class="reference internal" href="#keyboard-commands" id="id228">Keyboard commands</a></li>
501 </ul>
502 </li>
504 <li><a class="reference internal" href="#document-notebook" id="id230">Document notebook</a></li>
508 </ul>
509 </li>
510 <li><a class="reference internal" href="#compile-time-options" id="id234">Compile-time options</a><ul>
517 </ul>
518 </li>
519 <li><a class="reference internal" href="#gnu-general-public-license" id="id241">GNU General Public License</a></li>
520 <li><a class="reference internal" href="#license-for-scintilla-and-scite" id="id242">License for Scintilla and SciTE</a></li>
521 </ul>
522 </div>
527 <p>Geany is a small and lightweight Integrated Development Environment. It
528 was developed to provide a small and fast IDE, which has only a few
529 dependencies on other packages. Another goal was to be as independent
530 as possible from a particular Desktop Environment like KDE or GNOME -
531 Geany only requires the GTK2 runtime libraries.</p>
540 <li>Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
541 Pascal, and others</li>
547 </ul>
548 </div>
551 <p>You can obtain Geany from <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a> or perhaps also from
552 your distribution. For a list of available packages, please see
553 <a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
554 </div>
557 <p>Geany is distributed under the terms of the GNU General Public License
558 as published by the Free Software Foundation; either version 2 of
559 the License, or (at your option) any later version. A copy of this
560 license can be found in the file COPYING included with the source
561 code of this program and in the chapter, <a class="reference internal" href="#gnu-general-public-license">GNU General Public License</a>.</p>
562 <p>The included Scintilla library (found in the subdirectory
563 <tt class="docutils literal">scintilla/</tt>) has its own license, which can be found in the chapter,
564 <a class="reference internal" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
565 </div>
568 <p>This documentation is available in HTML and text formats.
569 The latest version can always be found at <a class="reference external" href="http://www.geany.org/">http://www.geany.org/</a>.</p>
570 <p>If you want to contribute to it, see <a class="reference internal" href="#contributing-to-this-document">Contributing to this document</a>.</p>
571 </div>
572 </div>
578 (Pango, GLib and ATK). Your distro should provide packages for these,
579 usually installed by default. For Windows, you can download an installer
580 from the website which bundles these libraries.</p>
581 </div>
584 <p>There are many binary packages available. For an up-to-date but maybe
585 incomplete list see <a class="reference external" href="http://www.geany.org/Download/ThirdPartyPackages">http://www.geany.org/Download/ThirdPartyPackages</a>.</p>
586 </div>
589 <p>Compiling Geany is quite easy.
591 You also need the Pango, GLib and ATK libraries and header files.
592 All these files are available at <a class="reference external" href="http://www.gtk.org">http://www.gtk.org</a>, but very often
593 your distro will provide development packages to save the trouble of
594 building these yourself.</p>
595 <p>Furthermore you need, of course, a C and C++ compiler. The GNU versions
596 of these tools are recommended.</p>
599 <p>The Autotools based build system is very mature and has been well tested.
600 To use it, you just need the Make tool, preferably GNU Make.</p>
603 $ ./configure
604 $ make
605 </pre>
608 % make install
609 </pre>
610 </div>
613 <p>The Waf build system is still quite young and under heavy development but already in a
614 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
615 to install Python on your system.
616 The advantage of the Waf build system over the Autotools based build system is that the whole
617 build process might be a bit faster. Especially when you use the Waf
618 cache feature for repetitive builds (e.g. when changing only a few source files
619 to test something) will become much faster since Waf will cache and re-use the
620 unchanged built files and only compile the changed code again. See <a class="reference internal" href="#waf-cache">Waf Cache</a> for details.
621 To build Geany with Waf as run:</p>
623 $ ./waf configure
624 $ ./waf build
625 </pre>
628 % ./waf install
629 </pre>
632 <p>The Waf build system has a nice and interesting feature which can help to avoid
633 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
634 or trying to debug something in Geany.
635 Waf is able to store and retrieve the object files from a cache. This cache is declared
637 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
638 this, you first need to create this directory:</p>
640 $ mkdir -p ~/.cache/waf
641 </pre>
642 <p>then add the environment variable to your shell configuration (the following example is for
643 Bash and should be adjusted to your used shell):</p>
645 export WAFCACHE=/home/username/.cache/waf
646 </pre>
647 <p>Remember to replace <tt class="docutils literal">username</tt> with your actual username.</p>
648 <p>More information about the Waf cache feature are available at
649 <a class="reference external" href="http://code.google.com/p/waf/wiki/CacheObjectFiles">http://code.google.com/p/waf/wiki/CacheObjectFiles</a>.</p>
652 <p>You should be careful about the size of the cache directory as it may
653 grow rapidly over time.
654 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
655 clean by yourself.
656 An easy way to keep it clean is to run the following command regularly to remove old
657 cached files:</p>
659 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
660 </pre>
662 <p>For details about the <tt class="docutils literal">find</tt> command and its options, check its manual page.</p>
663 </div>
664 </div>
665 </div>
668 <p>The configure script supports several common options, for a detailed
669 list, type:</p>
671 $ ./configure --help
672 </pre>
676 </dl>
678 <p>You may also want to read the INSTALL file for advanced installation
679 options.</p>
681 <li>See also <a class="reference internal" href="#compile-time-options">Compile-time options</a>.</li>
682 </ul>
683 </div>
686 <p>In the case that your system lacks dynamic linking loader support, you
687 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>
688 script. This prevents compiling Geany with dynamic linking loader
689 support for automatically loading <tt class="docutils literal">libvte.so.4</tt> if available.</p>
690 </div>
693 <p>If there are any errors during compilation, check your build
694 environment and try to find the error, otherwise contact the mailing
695 list or one the authors. Sometimes you might need to ask for specific
696 help from your distribution.</p>
697 </div>
698 </div>
701 <p>If you want to find Geany's system files after installation you may
702 want to know the installation prefix.</p>
703 <p>Pass the <tt class="docutils literal"><span class="pre">--print-prefix</span></tt> option to Geany to check this - see
704 <a class="reference internal" href="#command-line-options">Command line options</a>. The first path is the prefix.</p>
705 <p>On Unix-like systems this is commonly <tt class="docutils literal">/usr</tt> if you installed from
710 per-user configuration files instead, which don't need root
711 permissions. See <a class="reference internal" href="#configuration-files">Configuration files</a>.</p>
712 </div>
713 </div>
714 </div>
720 <ul>
722 <p>Choose in your application menu of your used Desktop Environment:
724 </li>
726 <p>To start Geany from a command line, type the following and press
727 Return:</p>
729 % geany
730 </pre>
731 </li>
732 </ul>
733 </div>
745 </ul>
746 </li>
754 </ul>
755 </li>
757 </ul>
758 <p>Most of these can be configured in the <a class="reference internal" href="#interface-preferences">Interface preferences</a>, the
759 <a class="reference internal" href="#view-menu">View menu</a>, or the popup menu for the relevant area.</p>
762 <p>The sizes of the sidebar and message window can be adjusted by
763 dragging the dividers.</p>
764 </div>
768 <colgroup>
772 </colgroup>
777 </tr>
778 </thead>
782 <td>Set initial line number for the first opened file
783 (same as --line, do not put a space between the + sign
786 </tr>
790 </tr>
793 <td>Use an alternate configuration directory. The default
794 configuration directory is <tt class="docutils literal"><span class="pre">~/.config/geany/</span></tt> and that
796 reside.</td>
797 </tr>
800 <td>Print a list of Geany's internal filetype names (useful
801 for snippets configuration).</td>
802 </tr>
805 <td>Generate a global tags file (see
806 <a class="reference internal" href="#generating-a-global-tags-file">Generating a global tags file</a>).</td>
807 </tr>
811 </tr>
814 <td>Do not open files in a running instance, force opening
815 a new instance. Only available if Geany was compiled
816 with support for Sockets.</td>
817 </tr>
821 </tr>
824 <td>Return a list of open documents in a running Geany
825 instance.
826 This can be used to read the currently opened documents in
827 Geany from an external script or tool. The returned list
828 is separated by newlines (LF) and consists of the full,
829 UTF-8 encoded filenames of the documents.
830 Only available if Geany was compiled with support for
831 Sockets.</td>
832 </tr>
835 <td>Do not show the message window. Use this option if you
836 do not need compiler messages or VTE support.</td>
837 </tr>
840 <td>Do not load symbol completion and call tip data. Use this
841 option if you do not want to use them.</td>
842 </tr>
846 </tr>
849 <td>Print installation prefix, the data directory, the lib
850 directory and the locale directory (in that order) to
851 stdout, one line each. This is mainly intended for plugin
852 authors to detect installation paths.</td>
853 </tr>
856 <td>Open all files given on the command line in read-only mode.
857 This only applies to files opened explicitly from the command
858 line, so files from previous sessions or project files are
859 unaffected.</td>
860 </tr>
864 </tr>
867 <td>Do not load terminal support. Use this option if you do
868 not want to load the virtual terminal emulator widget
870 then terminal-support is automatically disabled. Only
871 available if Geany was compiled with support for VTE.</td>
872 </tr>
876 running Geany instance. This can be used with the following
877 command to execute Geany on the current workspace:</p>
879 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
880 </pre>
881 </td>
882 </tr>
885 <td>Specify explicitly the path including filename or only
886 the filename to the VTE library, e.g.
887 <tt class="docutils literal">/usr/lib/libvte.so</tt> or <tt class="docutils literal">libvte.so</tt>. This option is
888 only needed when the auto-detection does not work. Only
889 available if Geany was compiled with support for VTE.</td>
890 </tr>
894 </tr>
898 </tr>
902 </tr>
906 Geany to ignore loading stored files from the last
907 session (if enabled).
908 Geany also recognizes line and column information when
909 appended to the filename with colons, e.g.
913 must be the first non-option argument. All additionally
914 given files are ignored.</p>
915 </td>
916 </tr>
917 </tbody>
918 </table>
922 </pre>
923 <p>Geany supports all generic GTK options, a list is available on the
924 help screen.</p>
925 </div>
930 <p>At startup, Geany loads all files from the last time Geany was
931 launched. You can disable this feature in the preferences dialog
932 (see <a class="reference internal" href="#general-startup-preferences">General Startup preferences</a>). If you specify some
933 files on the command line, only these files will be opened, but you
934 can find the files from the last session in the file menu under the
936 opened files. You can change the number of recently opened files in
937 the preferences dialog.</p>
938 <p>You can start several instances of Geany, but only the first will
939 load files from the last session. To run a second instance of Geany,
940 do not specify any filenames on the command-line, or disable opening
941 files in a running instance using the appropriate command line option.</p>
942 </div>
944 <h3><a class="toc-backref" href="#id30">Opening files from the command-line in a running instance</a></h3>
945 <p>Geany detects if there is an an instance of itself already running and opens files
946 from the command-line in that instance. So, Geany can
947 be used to view and edit files by opening them from other programs
948 such as a file manager.</p>
952 </pre>
953 <p>This would open the file <tt class="docutils literal">some_file.foo</tt> with the cursor on line 55,
955 <p>If you do not like this for some reason, you can disable using the first
956 instance by using the appropriate command line option -- see the section
958 </div>
961 <p>If you have installed <tt class="docutils literal">libvte.so</tt> on your system, it is loaded
962 automatically by Geany, and you will have a terminal widget in the
963 notebook at the bottom.</p>
964 <p>If Geany cannot find any <tt class="docutils literal">libvte.so</tt> at startup, the terminal widget
965 will not be loaded. So there is no need to install the package containing
966 this file in order to run Geany. Additionally, you can disable the use
967 of the terminal widget by command line option, for more information
968 see the section called <a class="reference internal" href="#command-line-options">Command line options</a>.</p>
969 <p>You can use this terminal (from now on called VTE) much as you would
970 a terminal program like xterm. There is basic clipboard support. You
971 can paste the contents of the clipboard by pressing the right mouse
972 button to open the popup menu, and choosing Paste. To copy text from
973 the VTE, just select the desired text and then press the right mouse
974 button and choose Copy from the popup menu. On systems running the
975 X Window System you can paste the last selected text by pressing the
976 middle mouse button in the VTE (on 2-button mice, the middle button
977 can often be simulated by pressing both mouse buttons together).</p>
978 <p>In the preferences dialog you can specify a shell which should be
979 started in the VTE. To make the specified shell a login shell just
980 use the appropriate command line options for the shell. These options
981 should be found in the manual page of the shell. For zsh and bash
982 you can use the argument <tt class="docutils literal"><span class="pre">--login</span></tt>.</p>
985 <p class="last">Geany tries to load <tt class="docutils literal">libvte.so</tt>. If this fails, it tries to load
986 some other filenames. If this fails too, you should check whether you
987 installed libvte correctly. Again note, Geany will run without this
988 library.</p>
989 </div>
990 <p>It could be, that the library is called something else than
991 <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
992 please set a link to the correct file (as root):</p>
994 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
995 </pre>
996 <p>Obviously, you have to adjust the paths and set X to the number of your
998 <p>You can also specify the filename of the VTE library to use on the command
999 line (see the section called <a class="reference internal" href="#command-line-options">Command line options</a>) or at compile time
1000 by specifying the command line option <tt class="docutils literal"><span class="pre">--with-vte-module-path</span></tt> to
1001 ./configure.</p>
1002 </div>
1005 <p>You can define your widget style for many of Geany's GUI parts. To
1006 do this, just edit your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home
1007 directory on UNIX-like systems and in the etc subdirectory of your
1008 Geany installation on Windows).</p>
1009 <p>To have a defined style used by Geany you must assign it to
1010 at least one of Geany's widgets. For example use the following line:</p>
1013 </pre>
1015 widgets. You can also assign styles only to specific widgets. At the
1016 moment you can use the following widgets:</p>
1027 </ul>
1028 <p>An example of a simple <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>:</p>
1031 {
1033 }
1037 {
1039 }
1041 </pre>
1042 </div>
1043 </div>
1048 <p>The documents list and the editor tabs are two different ways
1049 to switch between documents using the mouse. When you hit the key
1050 combination to move between tabs, the order is determined by the tab
1051 order. It is not alphabetical as shown in the documents list
1052 (regardless of whether or not editor tabs are visible).</p>
1053 <p>See the <a class="reference internal" href="#notebook-tab-keybindings">Notebook tab keybindings</a> section for useful
1054 shortcuts including for Most-Recently-Used document switching.</p>
1055 </div>
1056 </div>
1058 <h2><a class="toc-backref" href="#id35">Character sets and Unicode Byte-Order-Mark (BOM)</a></h2>
1061 <p>Geany provides support for detecting and converting character sets. So
1062 you can open and save files in different character sets, and even
1063 convert a file from one character set to another. To do this,
1064 Geany uses the character conversion capabilities of the GLib library.</p>
1065 <p>Only text files are supported, i.e. opening files which contain
1066 NULL-bytes may fail. Geany will try to open the file anyway but it is
1067 likely that the file will be truncated because it can only be read up
1068 to the first occurrence of a NULL-byte. All characters after this
1069 position are lost and are not written when you save the file.</p>
1070 <p>Geany tries to detect the encoding of a file while opening it, but
1071 auto-detecting the encoding of a file is not easy and sometimes an
1072 encoding might not be detected correctly. In this case you have to
1073 set the encoding of the file manually in order to display it
1074 correctly. You can this in the file open dialog by selecting an
1075 encoding in the drop down box or by reloading the file with the
1077 encodings but there are also some encodings where it is known that
1078 auto-detection has problems.</p>
1080 <ul>
1082 <p>This opens the file with the encoding specified in the encoding drop
1085 file will be opened without any character conversion and Geany will
1086 not try to auto-detect the encoding (see below for more information).</p>
1087 </li>
1089 <p>This item reloads the current file with the specified encoding. It can
1090 help if you opened a file and found out that the wrong encoding was used.</p>
1091 </li>
1093 <p>Contrary to the above two options, this will not change or reload
1094 the current file unless you save it. It is useful when you want to
1095 change the encoding of the file.</p>
1096 </li>
1098 <p>As mentioned above, auto-detecting the encoding of a file may fail on
1099 some encodings. If you know that Geany doesn't open a certain file,
1100 you can add the specification line, described in the next section,
1101 to the beginning of the file to force Geany to use a specific
1102 encoding when opening the file.</p>
1103 </li>
1104 </ul>
1105 </div>
1108 <p>Geany detects meta tags of HTML files which contain charset information
1109 like:</p>
1111 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
1112 </pre>
1113 <p>and the specified charset is used when opening the file. This is useful if the
1114 encoding of the file cannot be detected properly.
1115 For non-HTML files you can also define a line like:</p>
1118 </pre>
1122 </pre>
1123 <p>to force an encoding to be used. The #, /* and */ are examples
1124 of filetype-specific comment characters. It doesn't matter which
1126 as there is at least one whitespace character before and after this
1127 string. Whitespace characters are in this case a space or tab character.
1130 Then you simply add such a line to the file and Geany will open it
1131 correctly the next time.</p>
1133 regular expression used to find the encoding string:
1134 <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>
1139 </div>
1143 </pre>
1147 </pre>
1148 </div>
1152 encoding. It is useful when you know that Geany cannot auto-detect
1153 the encoding of a file and it is not displayed correctly. Especially
1154 when the file contains NULL-bytes this can be useful to skip auto
1155 detection and open the file properly at least until the occurrence
1156 of the first NULL-byte. Using this encoding opens the file as it is
1157 without any character conversion.</p>
1158 </div>
1161 <p>Furthermore, Geany detects a Unicode Byte Order Mark (see
1162 <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,
1163 this feature is only available if the opened file is in a Unicode
1164 encoding. The Byte Order Mark helps to detect the encoding of a file,
1166 using a Byte Order Mark could cause some problems for programs not
1167 expecting it, e.g. the compiler gcc stops
1168 with stray errors, PHP does not parse a script containing a BOM and
1169 script files starting with a she-bang maybe cannot be started. In the
1170 status bar you can easily see whether the file starts with a BOM or
1171 not.</p>
1172 <p>If you want to set a BOM for a file or if you want to remove it
1173 from a file, just use the document menu and toggle the checkbox.</p>
1177 to use it, then it is probably not important for you and you can
1178 safely ignore it.</p>
1179 </div>
1180 </div>
1181 </div>
1186 <p>Geany provides basic code folding support. Folding means the ability to
1187 show and hide parts of the text in the current file. You can hide
1188 unimportant code sections and concentrate on the parts you are working on
1189 and later you can show hidden sections again. In the editor window there is
1190 a small grey margin on the left side with [+] and [-] symbols which
1191 show hidden parts and hide parts of the file respectively. By
1192 clicking on these icons you can simply show and hide sections which are
1193 marked by vertical lines within this margin. For many filetypes nested
1194 folding is supported, so there may be several fold points within other
1195 fold points.</p>
1199 filetypes.common <a class="reference internal" href="#folding-settings">Folding Settings</a>.</p>
1200 </div>
1201 <p>If you don't like it or don't need it at all, you can simply disable
1202 folding support completely in the preferences dialog.</p>
1204 a fold point" option in the preference dialog. If activated, Geany will
1205 unfold all nested fold points below the current one if they are already
1206 folded (when clicking on a [+] symbol).
1207 When clicking on a [-] symbol, Geany will fold all nested fold points
1208 below the current one if they are unfolded.</p>
1209 <p>This option can be inverted by pressing the Shift
1210 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
1211 children of a fold point" option is enabled, pressing Shift will disable
1212 it for this click and vice versa.</p>
1213 </div>
1216 <p>There is basic support for column mode editing. To use it, create a
1217 rectangular selection by holding down the Control and Shift keys
1218 (or Alt and Shift on Windows) while selecting some text.
1219 Once a rectangular selection exists you can start editing the text within
1220 this selection and the modifications will be done for every line in the
1221 selection.</p>
1222 <p>It is also possible to create a zero-column selection - this is
1223 useful to insert text on multiple lines.</p>
1224 </div>
1227 <p>If you drag selected text in the editor widget of Geany the text is
1228 moved to the position where the mouse pointer is when releasing the
1229 mouse button. Holding Control when releasing the mouse button will
1230 copy the text instead. This behaviour was changed in Geany 0.11 -
1231 before the selected text was copied to the new position.</p>
1232 </div>
1235 <p>Geany allows each document to indent either with a tab character,
1236 multiple spaces or a combination of both. The default indent
1237 settings are set in <a class="reference internal" href="#editor-indentation-preferences">Editor Indentation preferences</a> (see the link
1238 for more information).</p>
1239 <p>The default settings can be overridden per-document using the
1240 Document menu. They can also be overridden by projects - see
1242 <p>The indent mode for the current document is shown on the status bar
1243 as follows:</p>
1250 <dd>Indent with tabs and spaces, depending on how much indentation is
1251 on a line.</dd>
1252 </dl>
1255 <p>After changing the default settings you may wish to apply the new
1256 settings to every document in the current session. To do this use the
1258 </div>
1262 scan each file as it's opened and set the indent type based on
1264 </div>
1265 </div>
1269 Editor. It adds a certain amount of indentation to the new line so the
1270 user doesn't always have to indent each line manually.</p>
1279 brace '{', and de-indents when typing a closing brace '}'. For Python,
1280 a new line will be indented after typing ':' at the end of the
1281 previous line.</dd>
1284 match the indentation of the line with the opening brace.</dd>
1285 </dl>
1286 <p>There is also XML-tag auto-indentation. This is enabled when the
1287 mode is more than just Basic, and is also controlled by a filetype
1289 </div>
1292 <p>Geany provides a handy bookmarking feature that lets you mark one
1293 or more lines in a document, and return the cursor to them using a
1294 key combination.</p>
1295 <p>To place a mark on a line, either left-mouse-click in the left margin
1296 of the editor window, or else use Ctrl-m. This will
1297 produce a small green plus symbol in the margin. You can have as many
1298 marks in a document as you like. Click again (or use Ctrl-m again)
1299 to remove the bookmark. To remove all the marks in a given document,
1301 <p>To navigate down your document, jumping from one mark to the next,
1302 use Ctrl-. (control period). To go in the opposite direction on
1303 the page, use Ctrl-, (control comma). Using the bookmarking feature
1304 together with the commands to switch from one editor tab to another
1305 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
1306 navigate around multiple files.</p>
1307 </div>
1310 <p>To ease navigation in source files and especially between
1311 different files, Geany lets you jump between different navigation
1312 points. Currently, this works for the following:</p>
1319 </ul>
1320 <p>When using one of these actions, Geany remembers your current position
1321 and jumps to the new one. If you decide to go back to your previous
1323 get back to the new position again, just use "Navigate forward a
1324 location". This makes it easier to navigate in e.g. foreign code
1325 and between different files.</p>
1326 </div>
1329 <p>You can define several custom commands in Geany and send the current
1331 Selection to</em> menu or keybindings. The output of the command will be
1332 used to replace the current selection. This makes it possible to use
1333 text formatting tools with Geany in a general way.</p>
1334 <p>The selected text will be sent to the standard input of the executed
1335 command, so the command should be able to read from it and it should
1336 print all results to its standard output which will be read by
1337 Geany. To help finding errors in executing the command, the output
1338 of the program's standard error will be printed on Geany's standard
1339 output.</p>
1343 command. You can also specify some command line options. Empty
1344 commands are not saved.</p>
1348 </ul>
1349 <p>The above example would normally be done with the <a class="reference internal" href="#replace-all">Replace all</a>
1350 function, but it can be handy to have common commands already set up.</p>
1351 </div>
1354 <p>You can execute the context action command on the current word at the
1355 cursor position or the available selection. This word or selection
1356 can be used as an argument to the command.
1357 The context action is invoked by a menu entry in the popup menu of the
1358 editor and also a keyboard shortcut (see the section called
1360 <p>The command can be specified in the preferences dialog and also for
1362 <a class="reference internal" href="#filetype-configuration">Filetype configuration</a>). When the context action is invoked, the filetype
1363 specific command is used if available, otherwise the command
1364 specified in the preferences dialog is executed.</p>
1366 in the command, it will be replaced by the current word or
1367 selection before the command is executed.</p>
1368 <p>For example a context action can be used to open API documentation
1369 in a browser window, the command to open the PHP API documentation
1370 would be:</p>
1373 </pre>
1374 <p>when executing the command, the %s is substituted by the word near
1375 the cursor position or by the current selection. If the cursor is at
1377 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>
1378 </div>
1381 <p>Geany can offer a list of possible completions for symbols defined in the
1382 tags and for all words in a document.</p>
1383 <p>The autocompletion list for symbols is presented when the first few
1384 characters of the symbol are typed (configurable, see <a class="reference internal" href="#editor-completions-preferences">Editor Completions
1386 keybinding is pressed (configurable, see <a class="reference internal" href="#editor-keybindings">Editor keybindings</a>,
1387 default Ctrl-Space).</p>
1389 document</em> preference (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions preferences</a>)
1390 is selected then the autocompletion list will show all matching words
1391 in the document, if there are no matching symbols.</p>
1392 <p>If you don't want to use autocompletion it can be dismissed until
1393 the next symbol by pressing Escape. The autocompletion list is updated
1394 as more characters are typed so that it only shows completions that start
1395 with the characters typed so far. If no symbols begin with the sequence,
1396 the autocompletion window is closed.</p>
1397 <p>The up and down arrows will move the selected item. The highlighted
1398 item on the autocompletion list can be chosen from the list by pressing
1399 Enter/Return. You can also double-click to select an item. The sequence
1400 will be completed to match the chosen item, and if the <em>Drop rest of
1401 word on completion</em> preference is set (in <a class="reference internal" href="#editor-completions-preferences">Editor Completions
1402 preferences</a>) then any characters after the cursor that match
1403 a symbol or word are deleted.</p>
1406 <p>By default, pressing Tab will complete the selected item by word part;
1407 useful e.g. for adding the prefix <tt class="docutils literal">gtk_combo_box_entry_</tt> without typing it
1408 manually:</p>
1415 </ul>
1416 <p>The key combination can be changed from Tab - See <a class="reference internal" href="#editor-keybindings">Editor keybindings</a>.
1417 If you clear/change the key combination for word part completion, Tab
1418 will complete the whole word instead, like Enter.</p>
1419 </div>
1424 struct
1425 {
1426 int i;
1427 char c;
1428 } foo;
1429 </pre>
1430 <p>When you type <tt class="docutils literal">foo.</tt> it will show an autocompletion list with 'i' and
1431 'c' symbols.</p>
1432 <p>It only works for languages that set parent scope names for e.g. struct
1433 members. Currently this means C-like languages. The C tag parser only
1434 parses global scopes, so this won't work for structs or objects declared
1435 in local scope.</p>
1436 </div>
1437 </div>
1440 <p>Snippets are small strings or code constructs which can be replaced or
1441 completed to a more complex string. So you can save a lot of time when
1442 typing common strings and letting Geany do the work for you.
1443 To know what to complete or replace Geany reads a configuration file
1447 [Default]
1448 myname=Enrico Tröger
1449 </pre>
1450 <p>Every time you write <tt class="docutils literal">myname</tt> <TAB> in Geany, it will replace "myname"
1452 in the preferences dialog, by default it is TAB. The corresponding keybinding
1455 <p>You can override the default snippets using the user
1457 Files->snippets.conf</em> menu item. See also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
1458 <p>This adds the default settings to the user file if the file doesn't
1459 exist. Alternatively the file can be created manually, adding only
1460 the settings you want to change. All missing settings will be read
1461 from the system snippets file.</p>
1463 <p>The file <tt class="docutils literal">snippets.conf</tt> contains sections defining snippets that
1464 are available for particular filetypes and in general.</p>
1468 other snippets. So you can define often used parts of snippets and
1469 just use the special snippet as a placeholder (see the
1472 snippets in that section are only available for use in files with that
1473 filetype. Snippets in filetype sections will hide snippets with the
1475 filetype.</p>
1477 <p>To define snippets you can use several special character sequences which
1478 will be replaced when using the snippet:</p>
1480 <colgroup>
1483 </colgroup>
1486 <td>Insert a new line (it will be replaced by the used EOL
1487 char(s): LF, CR/LF, or CR).</td>
1488 </tr>
1490 <td>Insert an indentation step, it will be replaced according
1491 to the current document's indent mode.</td>
1492 </tr>
1494 <td>\s to force whitespace at beginning or end of a value
1495 ('key= value' won't work, use 'key=\svalue')</td>
1496 </tr>
1498 <td>Place the cursor at this position after completion has
1499 been done. You can define multiple %cursor% wildcards
1501 to the next defined cursor position in the completed
1502 snippet.</td>
1503 </tr>
1507 section you can use %brace_open% in any other snippet.</td>
1508 </tr>
1509 </tbody>
1510 </table>
1511 <p>Snippet names must not contain spaces otherwise they won't
1512 work correctly. But beside that you can define almost any
1513 string as a snippet and use it later in Geany. It is not limited
1514 to existing contructs of certain programming languages(like <tt class="docutils literal">if</tt>,
1515 <tt class="docutils literal">for</tt>, <tt class="docutils literal">switch</tt>). Define whatever you need.</p>
1518 listed in <a class="reference internal" href="#template-wildcards">Template wildcards</a>. All wildcards which are listed as
1521 [Default]
1522 myname=My name is {developer}
1523 mysystem=My system: {command:uname -a}
1524 </pre>
1525 <p>this will replace <tt class="docutils literal">myname</tt> with "My name is " and the value of the template
1528 <p>You can change the way Geany recognizes the word to complete,
1529 that is how the start and end of a word is recognised when the
1532 to be recognized as a word for completion. Leave it commented to use
1533 default characters or define it to add or remove characters to fit your
1534 needs.</p>
1537 <p>Normally you would type the snippet name and press Tab. However, you
1541 [Keybindings]
1544 </pre>
1548 keybindings.</p>
1549 </div>
1550 </div>
1551 </div>
1554 <p>You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1555 Ctrl-Shift, type some hex digits representing the code point for the character
1556 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1557 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1558 insertion is completed, but the typed character is also entered. In the case
1559 of Enter/Return, it is a newline, as you might expect.</p>
1560 <p>In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1561 in the <a class="reference internal" href="#keybinding-preferences">keybinding preferences</a>, then select <em>Tools->Reload Configuration</em>
1562 or restart Geany. Note that it works slightly differently from other GTK
1563 applications, in that you'll need to continue to hold down the Ctrl and Shift
1564 keys while typing the code point hex digits (and the Enter or Return to finish the code point).</p>
1565 </div>
1566 </div>
1569 <p>This section describes search-related commands from the Search menu
1570 and the editor window's popup menu:</p>
1580 </ul>
1587 </ul>
1588 <p>There are keybindings to focus each of these - see <a class="reference internal" href="#focus-keybindings">Focus
1592 <p>The quickest way to find some text is to use the search bar entry in
1593 the toolbar. This performs a case-insensitive search in the current
1594 document whilst you type. Pressing Enter will search again, and pressing
1595 Shift-Enter will search backwards.</p>
1596 </div>
1597 </div>
1609 </div>
1611 into their UTF-8 equivalent. For example, \t will be transformed into
1612 a tab character. Other recognized symbols are: \\, \n, \r, \uXXXX
1613 (Unicode characters).</p>
1614 </div>
1617 <p>To find all matches, click on the Find All expander. This will reveal
1618 several options:</p>
1623 </ul>
1624 <p>Find All In Document will show a list of matching lines in the
1625 current document in the Messages tab of the Message Window. <em>Find All
1627 <p>Mark will highlight all matches in the current document with a
1628 colored box. These markers can be removed by selecting the
1629 Remove Markers command from the Document menu.</p>
1630 </div>
1633 <p>All search related dialogs use a Monospace for the text input fields to
1634 increase the readability of input text. This is useful when you are
1635 typing input such as regular expressions with spaces, periods and commas which
1636 might it hard to read with a proportional font.</p>
1637 <p>If you want to change the font, you can do this easily
1638 by inserting the following style into your <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt>
1639 (usually found in your home directory on UNIX-like systems and in the
1640 etc subdirectory of your Geany installation on Windows):</p>
1643 {
1645 }
1647 </pre>
1649 of this style to the highest available. Otherwise, the style is ignored
1650 for the search dialogs.</p>
1651 </div>
1652 </div>
1656 current selected text. If nothing is selected, by default the current
1657 word is used instead. This can be customized by the
1658 <em>find_selection_type</em> preference - see <a class="reference internal" href="#various-preferences">Various preferences</a>.</p>
1660 <colgroup>
1663 </colgroup>
1667 </tr>
1668 </thead>
1672 </tr>
1675 </tr>
1678 </tr>
1679 </tbody>
1680 </table>
1681 </div>
1684 <p>Find usage searches all open files. It is similar to the Find All In
1685 Session option in the Find dialog.</p>
1686 <p>If there is a selection, then it is used as the search text; otherwise
1687 the current word is used. The current word is either taken from the
1688 word nearest the edit cursor, or the word underneath the popup menu
1689 click position when the popup menu is used. The search results are
1690 shown in the Messages tab of the Message Window.</p>
1691 </div>
1694 <p>Find in files is a more powerful version of Find usage that searches
1695 all files in a certain directory using the Grep tool. The Grep tool
1696 must be correctly set in Preferences to the path of the system's Grep
1697 utility. GNU Grep is recommended (see note below).</p>
1700 search, depending on the mode:</p>
1705 <dd>Use the current project's patterns, see <a class="reference internal" href="#project-properties">Project properties</a>;</dd>
1708 </dl>
1709 <p>Both project and custom patterns use a glob-style syntax, each
1710 pattern separated by a space. To search all <tt class="docutils literal">.c</tt> and <tt class="docutils literal">.h</tt> files,
1712 Note that an empty pattern list searches in all files rather
1713 than none.</p>
1715 to be searched. The entered search text is converted to the chosen encoding
1718 the grep tool.</p>
1721 <p class="last">The <em>Files</em> setting uses <tt class="docutils literal"><span class="pre">--include=</span></tt> when searching recursively,
1722 <em>Recurse in subfolders</em> uses <tt class="docutils literal"><span class="pre">-r</span></tt>; both are GNU Grep options and may
1723 not work with other Grep implementations.</p>
1724 </div>
1729 out version control files.</p>
1730 <p>If you have GNU Grep >= 2.5.2 you can use the <tt class="docutils literal"><span class="pre">--exclude-dir</span></tt>
1731 argument to filter out CVS and hidden directories like <tt class="docutils literal">.svn</tt>.</p>
1732 <p>Example: <tt class="docutils literal"><span class="pre">--exclude-dir=.svn</span> <span class="pre">--exclude-dir=CVS</span></tt></p>
1733 <p>If you have an older Grep, you can try using the <tt class="docutils literal"><span class="pre">--exclude</span></tt> flag
1734 to filter out filenames.</p>
1735 <p>SVN Example: <tt class="docutils literal"><span class="pre">--exclude=*.svn-base</span></tt></p>
1737 </div>
1738 </div>
1741 <p>The Replace dialog is used for replacing text in one or more open
1742 documents.</p>
1744 <p>The Replace dialog has the same options for matching text as the Find
1745 dialog. See the section <a class="reference internal" href="#matching-options">Matching options</a>.</p>
1747 be used in the search string and back references in the replacement
1748 text -- see the entry for '\n' in <a class="reference internal" href="#regular-expressions">Regular expressions</a>.</p>
1752 will reveal several options:</p>
1757 </ul>
1761 in the current selection of the current document.</p>
1762 </div>
1763 </div>
1766 <p>If the current word or selection is the name of a tag definition
1767 (e.g. a function name) and the file containing the tag definition is
1768 open, this command will switch to that file and go to the
1769 corresponding line number. The current word is either the word
1770 nearest the edit cursor, or the word underneath the popup menu click
1771 position when the popup menu is used.</p>
1775 look for a tag declaration instead, as this is more useful.
1777 first in this case also.</p>
1778 </div>
1779 </div>
1783 C function prototype or <tt class="docutils literal">extern</tt> declaration instead of a function
1784 body.</p>
1785 </div>
1789 </div>
1792 <p>You can use regular expressions in the Find and Replace dialogs
1793 by selecting the <em>Use regular expressions</em> check box (see <a class="reference internal" href="#matching-options">Matching
1794 options</a>). The syntax is Perl compatible. Basic syntax is described
1795 in the table below. For full details, see
1796 <a class="reference external" href="http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html">http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html</a>.</p>
1801 expressions.</li>
1803 </ol>
1804 </div>
1807 <colgroup>
1810 </colgroup>
1814 </tr>
1817 </tr>
1820 </tr>
1823 region when searching or replacing.</p>
1826 replace string was Sam\1YYY, when applied to Fred2XXX this
1827 would generate Sam2YYY.</p>
1828 </td>
1829 </tr>
1832 </tr>
1835 </tr>
1838 character class (both inside and outside sets []).</p>
1846 </ul>
1847 </td>
1848 </tr>
1850 <td>This allows you to use a character x that would otherwise have
1851 a special meaning. For example, \[ would be interpreted as [
1852 and not as the start of a character set. Use \\ for a literal
1853 backslash.</td>
1854 </tr>
1857 character in the set is ^, it matches the characters NOT in
1858 the set, i.e. complements the set. A shorthand S-E (start
1859 dash end) is used to specify a set of characters S up to E,
1860 inclusive.</p>
1861 <p>The special characters ] and - have no special
1862 meaning if they appear first in the set. - can also be last
1863 in the set. To include both, put ] first: []A-Z-].</p>
1866 []|-] matches these 3 chars
1867 []-|] matches from ] to | chars
1868 [a-z] any lowercase alpha
1869 [^]-] any char except - and ]
1870 [^A-Z] any char except uppercase alpha
1871 [a-zA-Z] any alpha
1872 </pre>
1873 </td>
1874 </tr>
1876 <td>This matches the start of a line (unless used inside a set, see
1877 above).</td>
1878 </tr>
1881 </tr>
1884 Saam, Saaam and so on.</td>
1885 </tr>
1888 Saam, Saaam and so on.</td>
1889 </tr>
1892 </tr>
1893 </tbody>
1894 </table>
1898 distributed under the <a class="reference internal" href="#license-for-scintilla-and-scite">License for Scintilla and SciTE</a>.</p>
1899 </div>
1900 </div>
1901 </div>
1904 <p>The View menu allows various elements of the main window to be shown
1905 or hidden, and also provides various display-related editor options.</p>
1909 It lists various color schemes for editor highlighting styles,
1910 including the default scheme first. Other items are available based
1911 on what color scheme files Geany found at startup.</p>
1912 <p>Color scheme files are read from the <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a> under
1913 the <tt class="docutils literal">colorschemes</tt> subdirectory. They should have the extension
1916 <p>The <a class="reference internal" href="#named-styles-section">[named_styles] section</a> and <a class="reference internal" href="#named-colors-section">[named_colors] section</a> are the
1918 <p>The <tt class="docutils literal">[theme_info]</tt> section can contain information about the
1919 theme. The <tt class="docutils literal">name</tt> and <tt class="docutils literal">description</tt> keys are read to set the
1920 menu item text and tooltip, respectively. These keys can have
1921 translations, e.g.:</p>
1923 key=Hello
1924 key[de]=Hallo
1925 key[fr_FR]=Bonjour
1926 </pre>
1927 </div>
1928 </div>
1931 <p>Tags are information that relates symbols in a program with the
1932 source file location of the declaration and definition.</p>
1933 <p>Geany has built-in functionality for generating tag information (aka
1935 can also have Geany automatically load external tag files (aka "global
1937 <p>Geany uses its own tag file format, similar to what <tt class="docutils literal">ctags</tt> uses
1938 (but is incompatible with ctags). You use Geany to generate global
1939 tags files, as described below.</p>
1942 <p>Tags for each document are parsed whenever a file is loaded, saved or
1943 modified (see <em>Symbol list update frequency</em> preference in the <a class="reference internal" href="#editor-completions-preferences">Editor
1944 Completions preferences</a>). These are shown in the Symbol list in the
1945 Sidebar. These tags are also used for autocompletion of symbols and calltips
1946 for all documents open in the current session that have the same filetype.</p>
1949 </div>
1952 <p>Global tags are used to provide autocompletion of symbols and calltips
1953 without having to open the corresponding source files. This is intended
1954 for library APIs, as the tags file only has to be updated when you upgrade
1955 the library.</p>
1959 <li>By moving or symlinking tags files to the <tt class="docutils literal">tags</tt> subdirectory of
1960 one of the <a class="reference internal" href="#configuration-file-paths">configuration file paths</a> before starting Geany.</li>
1961 </ul>
1962 <p>You can either download these files or generate your own. They have
1963 the format:</p>
1965 name.lang_ext.tags
1966 </pre>
1968 with the tags. See the section called <a class="reference internal" href="#filetype-extensions">Filetype extensions</a> for
1969 more information.</p>
1972 <p>For some languages, a list of global tags is loaded when the
1973 corresponding filetype is first used. Currently these are for:</p>
1981 </ul>
1982 </div>
1989 </ul>
1990 <p>The first line of global tags files should be a comment, introduced
1991 by <tt class="docutils literal">#</tt> followed by a space and a string like <tt class="docutils literal">format=pipe</tt>
1993 This helps Geany to read the file properly. If this line
1994 is missing, Geany tries to auto-detect the used format but this
1995 might fail.</p>
1996 <p>The Tagmanager format is a bit more complex and is used for files
1997 created by the <tt class="docutils literal">geany <span class="pre">-g</span></tt> command. There is one tag per line.
1998 Different tag attributes like the return value or the argument list
1999 are separated with different characters indicating the type of the
2000 following argument.</p>
2001 <p>The Pipe-separated format is easier to read and write.
2002 There is one tag per line and different tag attributes are separated
2005 basename|string|(string path [, string suffix])|
2006 </pre>
2012 currently unused and should be left empty.</div>
2013 </div>
2014 <p>Except for the first field (tag name), all other field can be left
2015 empty but the pipe separator must appear for them.</p>
2016 <p>You can easily write your own global tag files using this format.
2017 Just save them in your tags directory, as described earlier in the
2019 </div>
2022 <p>You can generate your own global tags files by parsing a list of
2023 source files. The command is:</p>
2026 </pre>
2028 <li>Tag File filename should be in the format described earlier --
2030 <li>File list is a list of filenames, each with a full path (unless
2031 you are generating C/C++ tags and have set the CFLAGS environment
2032 variable appropriately).</li>
2033 <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
2034 to process <tt class="docutils literal">#include</tt> directives for C/C++ source files. Use this
2035 option if you want to specify each source file on the command-line
2036 instead of using a 'master' header file. Also can be useful if you
2037 don't want to specify the CFLAGS environment variable.</li>
2038 </ul>
2041 geany -g wxd.d.tags /home/username/wxd/wx/*.d
2042 </pre>
2044 <p>For C/C++ tag files, gcc and grep are required, so that header files
2045 can be preprocessed to include any other headers they depend upon.</p>
2046 <p>For C/C++ files, the environment variable CFLAGS should be set with
2047 appropriate <tt class="docutils literal"><span class="pre">-I/path</span></tt> include paths. The following example works with
2048 the bash shell, generating tags for the GnomeUI library:</p>
2050 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
2051 /usr/include/libgnomeui-2.0/gnome.h
2052 </pre>
2053 <p>You can adapt this command to use CFLAGS and header files appropriate
2054 for whichever libraries you want.</p>
2056 <p>Geany currently uses a default global tags file c99.tags for
2057 C and C++, commonly installed in /usr/share/geany. This file can
2058 be replaced with one containing tags parsed from a different set
2059 of header files. When Geany is next started, your custom tags file
2060 will be loaded instead of the default c99.tags. You should keep a
2061 copy of the generated tags file because it will get overwritten when
2062 upgrading Geany.</p>
2064 <p>This works basically the same as on other platforms but you need to make
2065 sure you have grep installed and Geany can find it, i.e. it must be
2066 in the PATH environment variable. To test this, open a console window
2068 If it is, then you can create a tags file like the following:</p>
2071 </pre>
2072 </div>
2073 </div>
2076 <p>You can ignore certain tags for C-based languages if they would lead
2078 Files->ignore.tags</em> menu item to open the user <tt class="docutils literal">ignore.tags</tt> file.
2079 See also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
2080 <p>List all tag names you want to ignore in this file, separated by spaces
2081 and/or newlines.</p>
2084 G_GNUC_NULL_TERMINATED
2085 G_GNUC_PRINTF
2086 G_GNUC_WARN_UNUSED_RESULT
2087 </pre>
2089 <p><tt class="docutils literal">gchar **utils_strv_new(const gchar *first, <span class="pre">...)</span>
2090 G_GNUC_NULL_TERMINATED;</tt></p>
2091 <p>More detailed information about ignore tags usage from the Exuberant Ctags
2092 manual page:</p>
2093 <blockquote>
2094 Specifies a list of identifiers which are to be specially handled
2095 while parsing C and C++ source files. This option is specifically
2096 provided to handle special cases arising through the use of
2097 pre-processor macros. When the identifiers listed are simple identifiers,
2098 these identifiers will be ignored during parsing of the source files.
2099 If an identifier is suffixed with a '+' character, ctags will also
2100 ignore any parenthesis-enclosed argument list which may immediately
2101 follow the identifier in the source files.
2102 If two identifiers are separated with the '=' character, the first
2103 identifiers is replaced by the second identifiers for parsing purposes.</blockquote>
2104 <p>For even more detailed information please read the manual page of
2105 Exuberant Ctags.</p>
2106 </div>
2107 </div>
2111 dialog. Any changes you make there can be applied by hitting either
2112 the Apply or the OK button. These settings will persist between Geany
2113 sessions. Note that most settings here have descriptive popup bubble
2114 help -- just hover the mouse over the item in question to get help
2115 on it.</p>
2116 <p>You may also adjust some View settings (under the View menu) that
2117 persist between Geany sessions. The settings under the Document menu,
2118 however, are only for the current document and revert to defaults
2119 when restarting Geany.</p>
2123 comes after the screenshot of that tab.</p>
2124 </div>
2132 <dd>On startup, load the same files you had open the last time you
2133 used Geany.</dd>
2138 </dl>
2139 </div>
2144 <dd>Save the current position and size of the main window so next time
2145 you open Geany it's in the same location.</dd>
2148 </dl>
2149 </div>
2154 <dd>Path to start in when opening or saving files.
2155 It must be an absolute path.
2156 Leave it blank to use the current working directory.</dd>
2160 <dd>By default Geany looks in the system installation and the user
2161 configuration - see <a class="reference internal" href="#plugins">Plugins</a>. In addition the path entered here will be
2162 searched.
2163 Usually you do not need to set an additional path to search for
2164 plugins. It might be useful when Geany is installed on a multi-user machine
2165 and additional plugins are available in a common location for all users.
2166 Leave blank to not set an additional lookup path.</dd>
2167 </dl>
2168 </div>
2169 </div>
2177 <dd>Have the computer make a beeping sound when compilation of your program
2178 has completed or any errors occurred.</dd>
2180 <dd>Switch to the status message tab (in the notebook window at the bottom)
2181 once a new status message arrives.</dd>
2184 in the status messages window.</p>
2188 reshows the document statistics on the status bar. See <a class="reference internal" href="#focus-keybindings">Focus
2190 </div>
2191 </dd>
2193 <dd>Defines whether to use the native Windows File Open/Save dialogs or
2194 whether to use the GTK default dialogs.</dd>
2196 <dd>Give the focus automatically to widgets below the mouse cursor.
2197 This works for the main editor widget, the scribble, the toolbar search field
2198 goto line fields and the VTE.</dd>
2199 </dl>
2200 </div>
2205 <dd>Always wrap search around the document and hide the Find dialog after clicking
2206 Find Next/Previous.</dd>
2208 <dd>Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
2209 there is no selection. When this option is disabled, the search term last used in the
2210 appropriate Find dialog is used.</dd>
2212 <dd>When opening the Find in Files dialog, set the directory to search to the directory of the current
2213 active file. When this option is disabled, the directory of the last use of the Find in Files
2214 dialog is used.</dd>
2215 </dl>
2216 </div>
2221 <dd>Save your current session when closing projects. You will be able to
2222 resume different project sessions, automatically opening the files
2223 you had open previously.</dd>
2225 <dd>When creating new projects, the default path for the project file contains
2226 the project base path. Without this option enabled, the default project file
2227 path is one level above the project base path.
2228 In either case, you can easily set the final project file path in the
2230 defaults automatically for convenience.</dd>
2231 </dl>
2232 </div>
2233 </div>
2236 <img alt="./images/pref_dialog_interface_interface.png" src="./images/pref_dialog_interface_interface.png" />
2243 <dd>Show the list of functions, variables, and other information in the
2244 current document you are editing.</dd>
2246 <dd>Show all the documents you have open currently. This can be used to
2247 change between documents (see <a class="reference internal" href="#switching-between-documents">Switching between documents</a>) and
2248 to perform some common operations such as saving, closing and reloading.</dd>
2251 </dl>
2252 </div>
2262 </dl>
2263 </div>
2268 <dd>Show the status bar at the bottom of the main window. It gives information about
2269 the file you are editing like the line and column you are on, whether any
2270 modifications were done, the file encoding, the filetype and other information.</dd>
2271 </dl>
2272 </div>
2273 </div>
2276 <img alt="./images/pref_dialog_interface_notebook.png" src="./images/pref_dialog_interface_notebook.png" />
2281 <dd>Show a notebook tab for all documents so you can switch between them
2282 using the mouse (instead of using the Documents window).</dd>
2284 <dd>Make each tab show a close button so you can easily close open
2285 documents.</dd>
2287 <dd>Whether to create a document with its notebook tab to the left or
2288 right of all existing tabs.</dd>
2290 <dd>Whether to place file tabs next to the current tab
2291 rather than at the edges of the notebook.</dd>
2294 when double-clicking on a notebook tab.</dd>
2295 </dl>
2296 </div>
2301 <dd>Set the positioning of the editor's notebook tabs to the right,
2302 left, top, or bottom of the editing window.</dd>
2304 <dd>Set the positioning of the sidebar's notebook tabs to the right,
2305 left, top, or bottom of the sidebar window.</dd>
2307 <dd>Set the positioning of the message window's notebook tabs to the
2308 right, left, top, or bottom of the message window.</dd>
2309 </dl>
2310 </div>
2311 </div>
2315 <img alt="./images/pref_dialog_interface_toolbar.png" src="./images/pref_dialog_interface_toolbar.png" />
2322 <dd>Allows to append the toolbar to the main menu bar instead of placing it below.
2323 This is useful to save vertical space.</dd>
2325 <dd>See <a class="reference internal" href="#customizing-the-toolbar">Customizing the toolbar</a>.</dd>
2326 </dl>
2327 </div>
2332 <dd>Select the toolbar icon style to use - either icons and text, just
2333 icons or just text.
2334 The choice System default uses whatever icon style is set by GTK.</dd>
2336 <dd>Select the size of the icons you see (large, small or very small).
2337 The choice System default uses whatever icon size is set by GTK.</dd>
2338 </dl>
2339 </div>
2340 </div>
2343 <img alt="./images/pref_dialog_edit_features.png" src="./images/pref_dialog_edit_features.png" />
2350 <dd>Whether to move the cursor to the first non-whitespace character
2351 on the line when you hit the home key on your keyboard. Pressing it
2352 again will go to the very start of the line.</dd>
2356 <dd>Allow groups of lines in a document to be collapsed for easier
2357 navigation/editing.</dd>
2359 <dd>Whether to fold/unfold all child fold points when a parent line
2360 is folded.</dd>
2362 <dd>Underline lines with compile errors using red squiggles to indicate
2363 them in the editor area.</dd>
2365 <dd>Remove any white space at the end of the line when you hit the
2366 Enter/Return key.</dd>
2368 <dd>The editor column number to insert a newline at when Line Breaking
2369 is enabled for the current document.</dd>
2371 <dd>A string which is added when toggling a line comment in a source file.
2372 It is used to mark the comment as toggled.</dd>
2373 </dl>
2374 </div>
2375 </div>
2378 <img alt="./images/pref_dialog_edit_indentation.png" src="./images/pref_dialog_edit_indentation.png" />
2381 <p>See <a class="reference internal" href="#indentation">Indentation</a> for more information.</p>
2384 <dd>The width of a single indent size in spaces. By default the indent
2387 <dd>Try to detect and set the indent width based on file content, when
2388 a file is opened.</dd>
2395 </ul>
2398 </dd>
2400 <dd>Try to detect and set the indent type based on file content, when
2401 a file is opened.</dd>
2404 if any.</p>
2409 <dd>Add indentation based on the current filetype and any characters at
2410 the end of the line such as <tt class="docutils literal">{</tt>, <tt class="docutils literal">}</tt> for C, <tt class="docutils literal">:</tt> for Python.</dd>
2414 </dl>
2415 </dd>
2418 unindent when pressing Shift-tab. Otherwise, the tab key will
2419 insert a tab character into the document (which can be different
2420 from indentation, depending on the indent type).</p>
2424 unindent, but this preference allows the tab key to have different
2425 meanings in different contexts - e.g. for snippet completion.</p>
2426 </div>
2427 </dd>
2428 </dl>
2429 </div>
2430 </div>
2433 <img alt="./images/pref_dialog_edit_completions.png" src="./images/pref_dialog_edit_completions.png" />
2438 <dd>Whether to replace special keywords after typing Tab into a
2439 pre-defined text snippet.
2440 See <a class="reference internal" href="#user-definable-snippets">User-definable snippets</a>.</dd>
2442 <dd>When you open an XML/HTML tag automatically generate its
2443 completion tag.</dd>
2446 and Java when a new line is entered inside such a comment.
2447 With this option enabled, Geany will insert a <tt class="docutils literal">*</tt> on every new line
2448 inside a multi-line comment, for example when you press return in the
2449 following C code:</p>
2451 /*
2453 </pre>
2456 *
2457 </pre>
2460 </dd>
2462 <dd>When you start to type a symbol name, look for the full string to
2463 allow it to be completed for you.</dd>
2465 <dd>When you start to type a word, Geany will search the whole document for
2466 words starting with the typed part to complete it, assuming there
2467 are no tag names to show.</dd>
2469 <dd>Remove any word part to the right of the cursor when choosing a
2470 completion list item.</dd>
2472 <dd>Number of characters of a word to type before autocompletion is
2473 displayed.</dd>
2480 <p>This option determines how frequently the tag list is updated for the
2481 current document. The smaller the delay, the more up-to-date the symbol
2482 list (and then the completions); but rebuilding the symbol list has a
2483 cost in performance, especially with large files.</p>
2485 at most four times per second, even if the document changes continuously.</p>
2487 updated upon document saving.</p>
2488 </dd>
2489 </dl>
2490 </div>
2493 <p>Geany can automatically insert a closing bracket and quote characters when
2494 you open them. For instance, you type a <tt class="docutils literal">(</tt> and Geany will automatically
2495 insert <tt class="docutils literal">)</tt>. With the following options, you can define for which
2496 characters this should work.</p>
2508 </dl>
2509 </div>
2510 </div>
2514 <img alt="./images/pref_dialog_edit_display.png" src="./images/pref_dialog_edit_display.png" />
2519 <dd>Invert all colors, by default this makes white text on a black
2520 background.</dd>
2522 <dd>Show vertical lines to help show how much leading indentation there
2523 is on each line.</dd>
2526 show which kinds of whitespace are used.</dd>
2528 <dd>Display a symbol everywhere that a carriage return or line feed
2529 is present.</dd>
2533 <dd>Show or hide the small margin right of the line numbers, which is used
2534 to mark lines.</dd>
2536 <dd>When enabled Geany stops scrolling when at the last line of the document.
2537 Otherwise you can scroll one more page even if there are no real lines.</dd>
2538 </dl>
2539 </div>
2542 <p>The long line marker helps to indicate overly-long lines, or as a hint
2543 to the user for when to break the line.</p>
2548 <dd>Show a thin vertical line in the editor window at the given column
2549 position.</dd>
2551 <dd>Change the background color of characters after the given column
2552 position to the color set below. (This is recommended over the
2556 </dl>
2557 </dd>
2559 <dd>Set this value to a value greater than zero to specify the column
2560 where it should appear.</dd>
2563 </dl>
2564 </div>
2567 <p>Virtual space is space beyond the end of each line.
2568 The cursor may be moved into virtual space but no real space will be
2569 added to the document until there is some text typed or some other
2570 text insertion command is used.</p>
2578 </dl>
2579 </div>
2580 </div>
2588 <dd>Whether to create new documents when passing filenames that don't
2589 exist from the command-line.</dd>
2595 <dd>Opens all files with the specified encoding instead of auto-detecting it.
2596 Use this option when it's not possible for Geany to detect the exact encoding.</dd>
2598 <dd>The end of line characters to which should be used for new files.
2599 On Windows systems, you generally want to use CR/LF which are the common
2600 characters to mark line breaks.
2601 On Unix-like systems, LF is default and CR is used on MAC systems.</dd>
2602 </dl>
2603 </div>
2606 <p>Perform formatting operations when a document is saved. These
2607 can each be undone with the Undo command.</p>
2612 <dd>Ensures that newline characters always get converted before
2613 saving, avoiding mixed line endings in the same file.</dd>
2617 <dd><p class="first">Replace all tabs in the document with the equivalent number of spaces.</p>
2622 </div>
2623 </dd>
2624 </dl>
2625 </div>
2633 file on disk in case it has changed. Setting it to 0 will disable
2634 this feature.</p>
2638 not checked for changes due to performance issues
2639 (remote files are files in <tt class="docutils literal"><span class="pre">~/.gvfs/</span></tt>).</p>
2640 </div>
2641 </dd>
2642 </dl>
2643 </div>
2644 </div>
2657 </dl>
2661 the grep.exe from the UnxUtils project
2662 (<a class="reference external" href="http://sourceforge.net/projects/unxutils">http://sourceforge.net/projects/unxutils</a>). The grep.exe from the
2663 Mingw project for instance might not work with Geany at the moment.</p>
2664 </div>
2665 </div>
2670 <dd>Set this to a command to execute on the current word.
2672 to the specified command.</dd>
2673 </dl>
2674 </div>
2675 </div>
2678 <p>This data is used as meta data for various template text to insert into
2679 a document, such as the file header. You only need to set fields that
2680 you want to use in your template files.</p>
2693 <p class="last">You may wish to add anti-spam markup, e.g. <tt class="docutils literal">name<at>site<dot>ext</tt>.</p>
2694 </div>
2695 </dd>
2701 <dd>Specify a format for the the {year} wildcard. You can use any conversion specifiers
2702 which can be used with the ANSI C strftime function. For details please see
2705 <dd>Specify a format for the the {date} wildcard. You can use any conversion specifiers
2706 which can be used with the ANSI C strftime function. For details please see
2709 <dd>Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
2710 which can be used with the ANSI C strftime function. For details please see
2712 </dl>
2713 </div>
2714 </div>
2718 <p>There are some commands listed in the keybinding dialog that are not, by default,
2719 bound to a key combination, and may not be available as a menu item.</p>
2722 <p class="last">For more information see the section <a class="reference internal" href="#keybindings">Keybindings</a>.</p>
2723 </div>
2724 </div>
2742 <dd>How the date should be printed. You can use the same format
2743 specifiers as in the ANSI C function strftime(). For details please
2744 see <a class="reference external" href="http://man.cx/strftime">http://man.cx/strftime</a>.</dd>
2745 </dl>
2746 </div>
2750 <p>Rarely used preferences, explained in the table below. A few of them require
2751 restart to take effect, and a few other will only affect newly opened or created
2752 documents before restart.</p>
2754 <colgroup>
2759 </colgroup>
2765 </tr>
2766 </thead>
2772 </tr>
2774 <td>Whether to look for the end of a word
2775 when using word-boundary related
2776 Scintilla commands (see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla
2779 <td>to new
2780 documents</td>
2781 </tr>
2786 </tr>
2788 <td>Whether to allow completion of snippets
2789 when editing an existing line (i.e. there
2790 is some text after the current cursor
2791 position on the line). Only used when the
2796 </tr>
2798 <td>Whether to display scrollbars. If set to
2799 false, the horizontal and vertical
2800 scrollbars are hidden completely.</td>
2803 </tr>
2805 <td>The size of a tab character. Don't change
2806 it unless you really need to; use the
2807 indentation settings instead.</td>
2810 </tr>
2815 </tr>
2817 <td>Whether to show or hide the small
2818 expander icons on the symbol list</td>
2820 <td>to new
2821 documents</td>
2822 </tr>
2824 <td>treeview. Whether files can be saved
2825 always, even if they don't have any
2826 changes. By default, the Save button and
2827 menu item are disabled when a file is
2828 unchanged. When setting this option to
2829 true, the Save button and menu item are
2830 always active and files can be saved.</td>
2833 </tr>
2835 <td>Whether to automatically scroll to the
2836 last line of the output in the Compiler
2837 tab.</td>
2840 </tr>
2842 <td>The status bar statistics line format.
2843 (Search in src/ui_utils.c for details).</td>
2846 </tr>
2848 <td>Whether to open a new document after all
2849 documents have been closed.</td>
2852 </tr>
2854 <td>Whether to show the Status tab in the
2855 Messages Window</td>
2858 </tr>
2860 <td>Whether to show the Compiler tab in the
2861 Messages Window</td>
2864 </tr>
2866 <td>Whether to show the Messages tab in the
2867 Messages Window</td>
2870 </tr>
2872 <td>Whether to show the Scribble tab in the
2873 Messages Window</td>
2876 </tr>
2877 </tbody>
2878 </table>
2879 <p>By default, statusbar_template is empty. This tells Geany to use its
2880 internal default, which is currently:</p>
2881 <p><tt class="docutils literal">line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S</tt></p>
2884 <colgroup>
2889 </colgroup>
2895 </tr>
2896 </thead>
2902 </tr>
2904 <td>Terminal emulation mode. Only change this
2905 if you have VTE termcap files other than
2909 </tr>
2911 <td>By default, Geany strips any trailing
2912 newline characters from the current
2913 selection before sending it to the terminal
2914 to not execute arbitrary code. This is
2915 mainly a security feature.
2916 If, for whatever reasons, you really want
2917 it to be executed directly, set this option
2918 to true.</td>
2921 </tr>
2923 <td>String with which prefix the commands sent
2924 to the shell. This may be used to tell
2928 putting these commands in their history by
2929 setting this to a space. Note that leading
2931 configuration file.</td>
2934 </tr>
2939 </tr>
2941 <td>Defines the mode how Geany saves files to
2942 disk. If disabled, Geany directly writes
2943 the content of the document to disk. This
2944 might cause loss of data when there is
2945 no more free space on disk to save the
2946 file. When set to true, Geany first saves
2947 the contents into a temporary file and if
2948 this succeeded, the temporary file is
2949 moved to the real file to save.
2950 This gives better error checking in case of
2951 no more free disk space. But it also
2952 destroys hard links of the original file
2953 and its permissions (e.g. executable flags
2954 are reset). Use this with care as it can
2955 break things seriously.
2956 The better approach would be to ensure your
2957 disk won't run out of free space.</td>
2960 </tr>
2962 <td>Whether to use GIO as the unsafe file
2963 saving backend. It is better on most
2964 situations but is known not to work
2965 correctly on some complex setups.</td>
2968 </tr>
2970 <td>Make a backup when using GIO unsafe file
2974 </tr>
2979 </tr>
2981 <td>Regex to extract filetype name from file
2982 via capture group one.</td>
2985 </tr>
2990 </tr>
2995 </tr>
3000 </tr>
3002 <td>The maximum number of menu items in the
3003 filetype section of the Build menu.</td>
3006 </tr>
3008 <td>The maximum number of menu items in the
3009 independent section of the Build menu.</td>
3012 </tr>
3014 <td>The maximum number of menu items in the
3015 execute section of the Build menu.</td>
3018 </tr>
3019 </tbody>
3020 </table>
3022 </div>
3025 <p>See also: <a class="reference internal" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
3051 <dd>Make the path of the terminal change according to the path of the
3052 current file.</dd>
3054 <dd>Execute programs in the virtual terminal instead of using the external
3055 terminal tool. Note that if you run multiple execute commands at once
3056 the output may become mixed together in the VTE.</dd>
3058 <dd>Don't use the simple run script which is usually used to display
3059 the exit status of the executed program.
3060 This can be useful if you already have a program running in the VTE
3061 like a Python console (e.g. ipython). Use this with care.</dd>
3062 </dl>
3063 </div>
3064 </div>
3065 </div>
3073 </ul>
3074 <p>A list of session files can be stored and opened with the project
3076 in the <em>Project</em> group of the <a class="reference internal" href="#preferences">Preferences</a> dialog.</p>
3077 <p>As long as a project is open, the Build menu will use
3078 the items defined in project's settings, instead of the defaults.
3079 See <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a> for information on configuring the menu.</p>
3080 <p>The current project's settings are saved when it is closed, or when
3081 Geany is shutdown. When restarting Geany, the previously opened project
3082 file that was in use at the end of the last session will be reopened.</p>
3087 will setup a new project file <tt class="docutils literal">~/projects/name.geany</tt>. Usually it's
3088 best to store all your project files in the same directory (they are
3089 independent of any source directory trees).</p>
3090 <p>The Base path text field is setup to use <tt class="docutils literal">~/projects/name</tt>. This
3091 can safely be set to any existing path -- it will not touch the file
3092 structure contained in it.</p>
3093 </div>
3096 <p>You can set an optional description for the project. Currently it's
3097 only used for a template wildcard - see <a class="reference internal" href="#template-wildcards">Template wildcards</a>.</p>
3099 The specified path can be an absolute path or it is considered to be
3100 relative to the project's file name.</p>
3102 project, which can be used in the <a class="reference internal" href="#find-in-files">Find in files</a> dialog.</p>
3105 </div>
3108 <p>The Open command displays a standard file chooser, starting in
3109 <tt class="docutils literal">~/projects</tt>. Choose a project file named with the <tt class="docutils literal">.geany</tt>
3110 extension.</p>
3111 <p>When project session support is enabled, Geany will close the currently
3112 open files and open the session files associated with the project.</p>
3113 </div>
3117 <p>When project session support is enabled, Geany will close the project
3118 session files and open any previously closed default session files.</p>
3119 </div>
3120 </div>
3123 <p>After editing code with Geany, the next step is to compile, link, build,
3124 interpret, run etc. As Geany supports many languages each with a different
3125 approach to such operations, and as there are also many language independent
3126 software building systems, Geany does not have a built-in build system, nor
3127 does it limit which system you can use. Instead the build menu provides
3128 a configurable and flexible means of running any external commands to
3129 execute your preferred build system.</p>
3130 <p>This section provides a description of the default configuration of the
3131 build menu and then covers how to configure it, and where the defaults fit in.</p>
3135 <li>The output is captured in the Compiler notebook tab and parsed for
3136 warnings or errors.</li>
3137 </ul>
3138 <p>Warnings and errors that can be parsed for line numbers will be shown in
3139 red in the Compiler tab and you can click on them to switch to the relevant
3140 source file (or open it) and mark the line number. Also lines with
3141 warnings or errors are marked in the source, see <a class="reference internal" href="#indicators">Indicators</a> below.</p>
3145 the tool you're using, you can set a custom regex in the Build Commands
3146 Dialog, see <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>.</p>
3147 </div>
3150 <p>Indicators are red squiggly underlines which are used to highlight
3151 errors which occurred while compiling the current file. So you can
3152 easily see where your code failed to compile. You can remove them by
3154 <p>If you do not like this feature, you can disable it - see <a class="reference internal" href="#editor-features-preferences">Editor Features
3156 </div>
3159 <p>Depending on the current file's filetype, the default Build menu will contain
3160 the following items:</p>
3171 </ul>
3175 <p>For compilable languages such as C and C++, the Compile command is
3176 set up to compile the current source file into a binary object file.</p>
3178 <p>Interpreted languages such as Perl, Python, Ruby will compile to
3179 bytecode if the language supports it, or will run a syntax check,
3180 or if that is not available will run the file in its language interpreter.</p>
3181 </div>
3184 <p>For compilable languages such as C and C++, the Build command will link
3185 the current source file's equivalent object file into an executable. If
3186 the object file does not exist, the source will be compiled and linked
3187 in one step, producing just the executable binary.</p>
3192 different settings, then writing a Makefile and using the Make
3193 commands is recommended; this will also make it easier for users to
3194 build your software.</p>
3195 </div>
3196 </div>
3200 current file.</p>
3201 </div>
3204 <p>This is similar to running 'Make' but you will be prompted for
3205 the make target name to be passed to the Make tool. For example,
3207 </div>
3211 the current file, using the filename for 'current_file'. It is useful
3212 for building just the current file without building the whole project.</p>
3213 </div>
3217 </div>
3221 </div>
3224 <p>Execute will run the corresponding executable file, shell script or
3225 interpreted script in a terminal window. Note that the Terminal tool
3226 path must be correctly set in the Tools tab of the Preferences dialog -
3227 you can use any terminal program that runs a Bourne compatible shell
3229 selected to use the built-in VTE if it is available - see
3230 <a class="reference internal" href="#virtual-terminal-emulator-widget-vte">Virtual terminal emulator widget (VTE)</a>.</p>
3231 <p>After your program or script has finished executing, you will be
3232 prompted to press the return key. This allows you to review any text
3233 output from the program before the terminal window is closed.</p>
3237 </div>
3238 </div>
3241 <p>When there is a running program, the Execute menu item in the menu and
3242 the Run button in the toolbar
3243 each become a stop button so you can stop the current running program (and
3244 any child processes). This works by sending the SIGQUIT signal to the process.</p>
3245 <p>Depending on the process you started it is possible that the process
3246 cannot be stopped. For example this can happen when the process creates
3247 more than one child process.</p>
3251 (the terminal program of Xfce), you should add the command line
3252 option <tt class="docutils literal"><span class="pre">--disable-server</span></tt> otherwise the started process cannot be
3253 stopped. Just add this option in the preferences dialog on the Tools
3254 tab in the terminal field.</p>
3255 </div>
3256 </div>
3259 <p>By default Compile, Build and Execute are fairly basic commands. You
3261 <p>E.g. for C you can add any include paths and compile flags for the
3262 compiler, any library names and paths for the linker, and any
3263 arguments you want to use when running Execute.</p>
3264 </div>
3265 </div>
3268 <p>The build menu has considerable flexibility and configurability, allowing
3269 both menu labels the commands they execute and the directory they execute
3270 in to be configured.</p>
3271 <p>For example, if you change one of the default make commands to run say 'waf'
3272 you can also change the label to match.</p>
3274 <p>The build menu is divided into four groups of items each with different
3275 behaviors:</p>
3277 <li>Filetype build commands - are configurable and depend on the filetype of the
3278 current document; they capture output in the compiler tab and parse it for
3279 errors.</li>
3280 <li>Independent build commands - are configurable and mostly don't depend on the
3281 filetype of the current document; they also capture output in the
3282 compiler tab and parse it for errors.</li>
3283 <li>Execute commands - are configurable and intended for executing your
3284 program or other long running programs. The output is not parsed for errors
3285 and is directed to the terminal selected in preferences.</li>
3290 </ul>
3291 </li>
3292 </ul>
3293 <p>The maximum numbers of items in each of the configurable groups can be
3294 configured in the <a class="reference internal" href="#various-preferences">Various preferences</a>. Even though the maximum number of
3295 items may have been increased, only those menu items that have values
3296 configured are shown in the menu.</p>
3297 <p>The groups of menu items obtain their configuration from four potential
3298 sources. The highest priority source that has the menu item defined will
3299 be used. The sources in decreasing priority are:</p>
3305 </ul>
3306 <p>The detailed relationships between sources and the configurable menu item groups
3307 is shown in the following table.</p>
3309 <colgroup>
3315 </colgroup>
3322 </tr>
3323 </thead>
3327 file</p>
3329 file</p>
3330 </td>
3332 filetypes.xxx file in
3333 ~/.config/geany/filedefs</p>
3335 creating if needed.</p>
3336 </td>
3338 filetypes.xxx in
3339 Geany install</p>
3341 preferences left.</p>
3342 </td>
3344 </tr>
3345 <tr><td>Filetype
3346 Independent</td>
3348 file</p>
3350 file</p>
3351 </td>
3353 geany.conf file in
3354 ~/.config/geany</p>
3356 creating if needed.</p>
3357 </td>
3359 filetypes.xxx in
3360 Geany install</p>
3362 preferences left.</p>
3363 </td>
3366 <dd>Label: _Make
3367 Command: make</dd>
3369 <dd>Label: Make Custom _Target
3370 Command: make</dd>
3372 <dd>Label: Make _Object
3373 Command: make %e.o</dd>
3374 </dl>
3375 </td>
3376 </tr>
3379 file or else
3380 filetype defined in
3381 project file</p>
3383 project file</p>
3384 </td>
3386 geany.conf file in
3387 ~/.config/geany or else
3388 filetypes.xxx file in
3389 ~/.config/geany/filedefs</p>
3391 filetypes.xxx file in
3392 ~/.config/geany/filedefs</p>
3393 </td>
3395 filetypes.xxx in
3396 Geany install</p>
3398 preferences left.</p>
3399 </td>
3400 <td>Label: _Execute
3401 Command: ./%e</td>
3402 </tr>
3403 </tbody>
3404 </table>
3407 <li>General - for filetypes.xxx substitute the appropriate extension for
3408 the filetype of the current document for xxx - see <a class="reference internal" href="#filenames">filenames</a>.</li>
3409 <li>System Filetypes - Labels loaded from these sources are locale sensitive
3410 and can contain translations.</li>
3411 <li>(Filetype, Project File) and (Filetype, Preferences) - preferences use a full
3412 filetype file so that users can configure all other filetype preferences
3413 as well. Projects can only configure menu items per filetype. Saving
3414 in the project file means that there is only one file per project not
3415 a whole directory.</li>
3416 <li>(Filetype-Independent, System Filetype) - although conceptually strange, defining
3417 filetype-independent commands in a filetype file, this provides the ability to
3418 define filetype dependent default menu items.</li>
3419 <li>(Execute, Project File) and (Execute, Preferences) - the project independent
3420 execute and preferences independent execute commands can only be set by hand
3421 editing the appropriate file, see <a class="reference internal" href="#preferences-file-format">Preferences file format</a> and <a class="reference internal" href="#project-file-format">Project file
3423 </ul>
3424 </div>
3427 <p>Most of the configuration of the build menu is done through the Build Menu
3428 Commands Dialog. You edit the configuration sourced from preferences in the
3429 dialog opened from the Build->Build Menu Commands item and you edit the
3430 configuration from the project in the build tab of the project preferences
3431 dialog. Both use the same form shown below.</p>
3432 <img alt="./images/build_menu_commands_dialog.png" src="./images/build_menu_commands_dialog.png" />
3438 </ul>
3439 <p>The filetype and independent sections also each contain a field for the regular
3440 expression used for parsing command output for error and warning messages.</p>
3441 <p>The columns in the first three sections allow setting of the label, command,
3442 and working directory to run the command in.</p>
3444 <p>An empty working directory will default to the directory of the current document.
3445 If there is no current document then the command will not run.</p>
3446 <p>The dialog will always show the command selected by priority, not just the
3447 commands configured in this configuration source. This ensures that you always
3448 see what the menu item is going to do if activated.</p>
3449 <p>If the current source of the menu item is higher priority than the
3450 configuration source you are editing then the command will be shown
3451 in the dialog but will be insensitive (greyed out). This can't happen
3452 with the project source but can with the preferences source dialog.</p>
3453 <p>The clear buttons remove the definition from the configuration source you are editing.
3454 When you do this the command from the next lower priority source will be shown.
3455 To hide lower priority menu items without having anything show in the menu
3456 configure with a nothing in the label but at least one character in the command.</p>
3458 <h4><a class="toc-backref" href="#id149">Substitutions in commands and working directories</a></h4>
3459 <p>The first occurence of each of the following character sequences in each of the
3460 command and working directory fields is substituted by the items specified below
3461 before the command is run.</p>
3467 </ul>
3470 <p class="last">If the basepath set in the project preferences is not an absolute path , then it is
3471 taken as relative to the directory of the project file. This allows a project file
3472 stored in the source tree to specify all commands and working directories relative
3473 to the tree itself, so that the whole tree including the project file, can be moved
3474 and even checked into and out of version control without having to re-configure the
3475 build menu.</p>
3476 </div>
3477 </div>
3480 <p>Keyboard shortcuts can be defined for the first two filetype menu items, the first three
3481 independent menu items, the first two execute menu items and the fixed menu items.
3482 In the keybindings configuration dialog (see <a class="reference internal" href="#keybinding-preferences">Keybinding preferences</a>)
3483 these items are identified by the default labels shown in the <a class="reference internal" href="#build-menu">Build Menu</a> section above.</p>
3486 </div>
3490 required a new section to be added to the configuration files (See
3491 <a class="reference internal" href="#preferences-file-format">Preferences file format</a>). Geany will still load older format project,
3492 preferences and filetype file settings and will attempt to map them into the new
3493 configuration format. There is not a simple clean mapping between the formats.
3494 The mapping used produces the most sensible results for the majority of cases.
3495 However, if they do not map the way you want, you may have to manually
3496 configure some settings using the Build Commands
3497 Dialog or the Build tab of the project preferences dialog.</p>
3498 <p>Any setting configured in either of these dialogs will override settings mapped from
3499 older format configuration files.</p>
3500 </div>
3501 </div>
3502 </div>
3506 The printed page(s) will look nearly the same as on your screen in Geany.
3507 Additionally, there are some options to modify the printed page(s).</p>
3511 a white foreground. This allows dark color schemes to save ink
3512 when printing.</p>
3513 </div>
3514 <p>You can define whether to print line numbers, page numbers at the bottom of
3515 each page and whether to print a page header on each page. This header
3516 contains the filename of the printed document, the current page number and
3517 the date and time of printing. By default, the file name of the document
3518 with full path information is added to the header. If you prefer to add
3519 only the basename of the file(without any path information) you can set it
3520 in the preferences dialog. You can also adjust the format of the date and
3521 time added to the page header. The available conversion specifiers are the
3522 same as the ones which can be used with the ANSI C strftime function.</p>
3523 <p>All of these settings can also be changed in the print dialog just before
3524 actual printing is done.
3525 On Unix-like systems the provided print dialog offers a print preview. The
3526 preview file is opened with a PDF viewer and by default GTK uses <tt class="docutils literal">evince</tt>
3527 for print preview. If you have not installed evince or just want to use
3528 another PDF viewer, you can change the program to use in the file
3529 <tt class="docutils literal"><span class="pre">.gtkrc-2.0</span></tt> (usually found in your home directory). Simply add a line
3530 like:</p>
3533 </pre>
3534 <p>at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3535 as the print preview command.</p>
3536 <p>Geany also provides an alternative basic printing support using a custom
3537 print command. However, the printed document contains no syntax highlighting.
3538 You can adjust the command to which the filename is passed in the preferences
3539 dialog. The default command is:</p>
3541 % lpr %f
3542 </pre>
3543 <p><tt class="docutils literal">%f</tt> will be substituted by the filename of the current file. Geany
3544 will not show errors from the command itself, so you should make
3545 sure that it works before(e.g. by trying to execute it from the
3546 command line).</p>
3549 % a2ps -1 --medium=A4 -o - %f | xfprint4
3550 </pre>
3551 <p>But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3552 gtklp or similar programs can be used.</p>
3553 </div>
3557 general preference is set. There is also a command-line option,
3558 <tt class="docutils literal"><span class="pre">-p</span></tt>, which prevents plugins being loaded. Plugins are scanned in
3559 the following directories:</p>
3561 <li><tt class="docutils literal">$prefix/lib/geany</tt> on Unix-like systems (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>)</li>
3562 <li>The <tt class="docutils literal">lib</tt> subfolder of the installation path on Windows.</li>
3563 <li>The <tt class="docutils literal">plugins</tt> subfolder of the user configuration directory - see
3564 <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</li>
3565 <li>The <cite>Extra plugin path</cite> preference (usually blank) - see <a class="reference internal" href="#paths">Paths</a>.</li>
3566 </ul>
3568 <p>See also <a class="reference internal" href="#plugin-documentation">Plugin documentation</a> for information about single plugins
3569 which are included in Geany.</p>
3572 <p>The Plugin Manager dialog lets you choose which plugins
3573 should be loaded at startup. You can also load and unload plugins on the
3574 fly using this dialog. Once you click the checkbox for a specific plugin
3575 in the dialog, it is loaded or unloaded according to its previous state.
3576 By default, no plugins are loaded at startup until you select some.
3577 You can also configure some plugin specific options if the plugin
3578 provides any.</p>
3579 </div>
3580 </div>
3583 <p>Geany supports the default keyboard shortcuts for the Scintilla
3584 editing widget. For a list of these commands, see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla
3585 keyboard commands</a>. The Scintilla keyboard shortcuts will be overridden
3586 by any custom keybindings with the same keyboard shortcut.</p>
3589 <p>There are some non-configurable bindings to switch between documents,
3590 listed below. These can also be overridden by custom keybindings.</p>
3592 <colgroup>
3595 </colgroup>
3599 </tr>
3600 </thead>
3604 </tr>
3607 </tr>
3608 </tbody>
3609 </table>
3610 <p>See also <a class="reference internal" href="#notebook-tab-keybindings">Notebook tab keybindings</a>.</p>
3611 </div>
3614 <p>For all actions listed below you can define your own keybindings. Open
3615 the Preferences dialog, select the desired action and click on
3616 change. In the resulting dialog you can press the key combination you
3617 want to assign to the action and it will be saved when you press OK.
3618 You can define only one key combination for each action and each key
3619 combination can only be defined for one action.</p>
3620 <p>Some of the default key combinations are common across many
3622 Because they are so common it is not advisable to change these, but
3623 you can add other key combinations for these actions. For example
3627 <p>The following tables list all customizable keyboard shortcuts, those
3628 which are common to many applications are marked with (C) after the
3629 shortcut.</p>
3633 <colgroup>
3637 </colgroup>
3642 </tr>
3643 </thead>
3648 </tr>
3652 </tr>
3656 </tr>
3660 </tr>
3664 </tr>
3668 </tr>
3672 </tr>
3676 </tr>
3680 </tr>
3683 <td>Reloads the current file. All unsaved changes
3684 will be lost.</td>
3685 </tr>
3689 </tr>
3690 </tbody>
3691 </table>
3692 </div>
3696 <colgroup>
3700 </colgroup>
3705 </tr>
3706 </thead>
3711 </tr>
3715 </tr>
3718 <td>Deletes the current line (and any lines with a
3719 selection).</td>
3720 </tr>
3723 <td>Deletes from the current caret position to the
3724 end of the current line.</td>
3725 </tr>
3729 </tr>
3733 </tr>
3736 <td>Scrolls the current line into the centre of the
3737 view. The cursor position and or an existing
3738 selection will not be changed.</td>
3739 </tr>
3743 </tr>
3747 </tr>
3750 <td>Shows the autocompletion list. If already showing
3751 tag completion, it shows document word completion
3752 instead, even if it is not enabled for automatic
3753 completion. Likewise if no tag suggestions are
3754 available, it shows document word completion.</td>
3755 </tr>
3758 <td>Shows a calltip for the current function or
3759 method.</td>
3760 </tr>
3763 <td>Shows a list of available macros and variables in
3764 the workspace.</td>
3765 </tr>
3768 <td>If you type a construct like if or for and press
3769 this key, it will be completed with a matching
3770 template.</td>
3771 </tr>
3774 <td>If you type a construct like if or for and press
3775 this key, it will not be completed, and a space or
3776 tab will be inserted, depending on what the
3777 construct completion keybinding is set to. For
3778 example, if you have set the construct completion
3779 keybinding to space, then setting this to
3780 Shift+space will prevent construct completion and
3781 insert a space.</td>
3782 </tr>
3785 <td>Executes a command and passes the current word
3786 (near the cursor position) or selection as an
3789 </tr>
3792 <td>Jumps to the next defined cursor positions in a
3793 completed snippets if multiple cursor positions
3794 where defined.</td>
3795 </tr>
3798 <td>When the autocompletion list is visible, complete
3799 the currently selected item up to the next word
3800 part.</td>
3801 </tr>
3804 <td>Move the current line or selected lines up by
3805 one line.</td>
3806 </tr>
3809 <td>Move the current line or selected lines down by
3810 one line.</td>
3811 </tr>
3812 </tbody>
3813 </table>
3814 </div>
3818 <colgroup>
3822 </colgroup>
3827 </tr>
3828 </thead>
3833 </tr>
3837 </tr>
3841 </tr>
3844 <td>Cuts the current line (and any lines with a
3845 selection) to the clipboard.</td>
3846 </tr>
3849 <td>Copies the current line (and any lines with a
3850 selection) to the clipboard.</td>
3851 </tr>
3852 </tbody>
3853 </table>
3854 </div>
3858 <colgroup>
3862 </colgroup>
3867 </tr>
3868 </thead>
3872 <td>Makes a selection of all text in the current
3873 document.</td>
3874 </tr>
3878 </tr>
3881 <td>Selects the current paragraph under the cursor
3882 which is defined by two empty lines around it.</td>
3883 </tr>
3886 <td>Selects the current line under the cursor (and any
3887 partially selected lines).</td>
3888 </tr>
3892 </tr>
3896 </tr>
3897 </tbody>
3898 </table>
3899 </div>
3903 <colgroup>
3907 </colgroup>
3912 </tr>
3913 </thead>
3918 </tr>
3921 <td>Inserts a tab character when spaces should
3922 be used for indentation and inserts space
3923 characters of the amount of a tab width when
3924 tabs should be used for indentation.</td>
3925 </tr>
3929 </tr>
3933 </tr>
3934 </tbody>
3935 </table>
3936 </div>
3940 <colgroup>
3944 </colgroup>
3949 </tr>
3950 </thead>
3954 <td>Changes the case of the selection. A lowercase
3955 selection will be changed into uppercase and vice
3956 versa. If the selection contains lower- and
3957 uppercase characters, all will be converted to
3958 lowercase.</td>
3959 </tr>
3963 </tr>
3967 </tr>
3970 <td>Comments a line if it is not commented or removes
3971 a comment if the line is commented.</td>
3972 </tr>
3975 <td>Indents the current line or selection by one tab
3976 or by spaces in the amount of the tab width
3977 setting.</td>
3978 </tr>
3981 <td>Removes one tab or the amount of spaces of
3982 the tab width setting from the indentation of the
3983 current line or selection.</td>
3984 </tr>
3987 <td>Indents the current line or selection by one
3988 space.</td>
3989 </tr>
3992 <td>Deindents the current line or selection by one
3993 space.</td>
3994 </tr>
3997 <td>Indents the current line or all selected lines
3998 with the same indentation as the previous line.</td>
3999 </tr>
4002 <td>Passes the current selection to a configured
4003 external command (available for the first
4004 three configured commands, see
4005 <a class="reference internal" href="#sending-text-through-custom-commands">Sending text through custom commands</a> for
4006 details).</td>
4007 </tr>
4010 <td>Sends the current selection or the current
4011 line (if there is no selection) to the
4012 embedded Terminal (VTE).</td>
4013 </tr>
4016 <td>Reformat selected lines or current
4017 (indented) text block,
4018 breaking lines at the long line marker or the
4019 line breaking column if line breaking is
4020 enabled for the current document.</td>
4021 </tr>
4022 </tbody>
4023 </table>
4024 </div>
4028 <colgroup>
4032 </colgroup>
4037 </tr>
4038 </thead>
4043 </tr>
4047 </tr>
4048 </tbody>
4049 </table>
4050 </div>
4054 <colgroup>
4058 </colgroup>
4063 </tr>
4064 </thead>
4069 </tr>
4073 </tr>
4077 </tr>
4081 </tr>
4085 </tr>
4089 </tr>
4093 </tr>
4096 <td>Jumps to the line with the next message in
4097 the Messages window.</td>
4098 </tr>
4101 <td>Jumps to the line with the previous message
4102 in the Messages window.</td>
4103 </tr>
4106 <td>Finds all occurrences of the current word (near
4107 the keyboard cursor) or selection in all open
4108 documents and displays them in the messages
4109 window.</td>
4110 </tr>
4113 <td>Finds all occurrences of the current word (near
4114 the keyboard cursor) or selection in the current
4115 document and displays them in the messages
4116 window.</td>
4117 </tr>
4120 <td>Highlight all matches of the current
4121 word/selection in the current document
4122 with a colored box. If there's nothing to
4123 find, highlighted matches will be cleared.</td>
4124 </tr>
4125 </tbody>
4126 </table>
4127 </div>
4131 <colgroup>
4135 </colgroup>
4140 </tr>
4141 </thead>
4145 <td>Switches to the next location in the navigation
4146 history. See the section called <a class="reference internal" href="#code-navigation-history">Code Navigation
4148 </tr>
4151 <td>Switches to the previous location in the
4152 navigation history. See the section called
4153 <a class="reference internal" href="#code-navigation-history">Code navigation history</a>.</td>
4154 </tr>
4157 <td>Focuses the Go to Line entry (if visible) or
4158 shows the Go to line dialog.</td>
4159 </tr>
4162 <td>If the cursor is ahead or behind a brace, then it
4163 is moved to the brace which belongs to the current
4164 one. If this keyboard shortcut is pressed again,
4165 the cursor is moved back to the first brace.</td>
4166 </tr>
4169 <td>Set a marker on the current line, or clear the
4170 marker if there already is one.</td>
4171 </tr>
4175 </tr>
4179 </tr>
4182 <td>Jump to the definition of the current word or
4183 selection. See <a class="reference internal" href="#go-to-tag-definition">Go to tag definition</a>.</td>
4184 </tr>
4187 <td>Jump to the declaration of the current word or
4188 selection. See <a class="reference internal" href="#go-to-tag-declaration">Go to tag declaration</a>.</td>
4189 </tr>
4192 <td>Move the caret to the end of the line indentation
4193 unless it is already there, in which case it moves
4194 it to the start of the line.</td>
4195 </tr>
4199 </tr>
4202 <td>Move the caret to the end of the display line.
4203 This is useful when you use line wrapping and
4204 want to jump to the end of the wrapped, virtual
4205 line, not the real end of the whole line.
4206 If the line is not wrapped, it behaves like
4208 </tr>
4212 </tr>
4216 </tr>
4217 </tbody>
4218 </table>
4219 </div>
4223 <colgroup>
4227 </colgroup>
4232 </tr>
4233 </thead>
4238 </tr>
4241 <td>Toggles the message window (status and compiler
4242 messages) on and off.</td>
4243 </tr>
4247 </tr>
4250 <td>Hide and show all additional widgets like the
4251 notebook tabs, the toolbar, the messages window
4252 and the status bar.</td>
4253 </tr>
4257 </tr>
4261 </tr>
4265 </tr>
4266 </tbody>
4267 </table>
4268 </div>
4272 <colgroup>
4276 </colgroup>
4281 </tr>
4282 </thead>
4286 <td>Switches to editor widget.
4287 Also reshows the document statistics line
4288 (after a short timeout).</td>
4289 </tr>
4292 <td>Switches to the search bar in the toolbar (if
4293 visible).</td>
4294 </tr>
4298 </tr>
4302 </tr>
4306 </tr>
4310 </tr>
4314 </tr>
4318 </tr>
4321 <td>Focus the Symbol list tab in the Sidebar
4322 (if visible).</td>
4323 </tr>
4326 <td>Focus the Document list tab in the Sidebar
4327 (if visible).</td>
4328 </tr>
4329 </tbody>
4330 </table>
4331 </div>
4335 <colgroup>
4339 </colgroup>
4344 </tr>
4345 </thead>
4350 </tr>
4354 </tr>
4357 <td>Switches to the previously shown document (if it's
4358 still open).
4359 Holding Ctrl (or another modifier if the keybinding
4360 has been changed) will show a dialog, then repeated
4361 presses of the keybinding will switch to the 2nd-last
4362 used document, 3rd-last, etc. Also known as
4363 Most-Recently-Used documents switching.</td>
4364 </tr>
4367 <td>Changes the current document with the left hand
4368 one.</td>
4369 </tr>
4372 <td>Changes the current document with the right hand
4373 one.</td>
4374 </tr>
4378 </tr>
4382 </tr>
4383 </tbody>
4384 </table>
4385 </div>
4389 <colgroup>
4393 </colgroup>
4398 </tr>
4399 </thead>
4404 </tr>
4408 </tr>
4412 </tr>
4416 </tr>
4420 </tr>
4424 </tr>
4428 </tr>
4431 <td>Enables or disables automatic breaking of long
4432 lines at a configurable column.</td>
4433 </tr>
4436 <td>Remove any markers on lines or words which
4437 were set by using 'Mark All' in the
4438 search dialog or by manually marking lines.</td>
4439 </tr>
4442 <td>Remove any error indicators in the
4443 current document.</td>
4444 </tr>
4449 </tr>
4450 </tbody>
4451 </table>
4452 </div>
4456 <colgroup>
4460 </colgroup>
4465 </tr>
4466 </thead>
4471 </tr>
4475 </tr>
4479 </tr>
4483 </tr>
4484 </tbody>
4485 </table>
4486 </div>
4490 <colgroup>
4494 </colgroup>
4499 </tr>
4500 </thead>
4505 </tr>
4508 <td>Builds (compiles if necessary and links) the
4509 current file.</td>
4510 </tr>
4514 </tr>
4517 <td>Builds the current file with the Make tool and a
4518 given target.</td>
4519 </tr>
4523 </tr>
4526 <td>Jumps to the line with the next error from the
4527 last build process.</td>
4528 </tr>
4531 <td>Jumps to the line with the previous error from
4532 the last build process.</td>
4533 </tr>
4537 </tr>
4541 </tr>
4542 </tbody>
4543 </table>
4544 </div>
4548 <colgroup>
4552 </colgroup>
4557 </tr>
4558 </thead>
4563 </tr>
4564 </tbody>
4565 </table>
4566 </div>
4570 <colgroup>
4574 </colgroup>
4579 </tr>
4580 </thead>
4585 </tr>
4586 </tbody>
4587 </table>
4588 </div>
4589 </div>
4590 </div>
4591 </div>
4597 </div>
4600 <p>Geany has default configuration files installed for the system and
4601 also per-user configuration files.</p>
4602 <p>The system files should not normally be edited because they will be
4603 overwritten when upgrading Geany.</p>
4604 <p>The user configuration directory can be overridden with the <tt class="docutils literal"><span class="pre">-c</span></tt>
4605 switch, but this is not normally done. See <a class="reference internal" href="#command-line-options">Command line options</a>.</p>
4609 will be created when Geany starts.</p>
4610 </div>
4614 Geany-INFO: System data dir: /usr/share/geany
4615 Geany-INFO: User config dir: /home/username/.config/geany
4616 </pre>
4619 <p>The system path is <tt class="docutils literal">$prefix/share/geany</tt>, where <tt class="docutils literal">$prefix</tt> is the
4620 path where Geany is installed (see <a class="reference internal" href="#installation-prefix">Installation prefix</a>).</p>
4621 <p>The user configuration directory is normally:
4623 </div>
4626 <p>The system path is the <tt class="docutils literal">data</tt> subfolder of the installation path
4627 on Windows.</p>
4628 <p>The user configuration directory might vary, but on Windows XP it's:
4629 <tt class="docutils literal"><span class="pre">C:\Documents</span> and Settings\UserName\Application Data\geany</tt></p>
4630 </div>
4631 </div>
4635 contains items for some of the available user configuration files.
4636 Clicking on one opens it in the editor for you to update. Geany will
4637 reload the file after you have saved it.</p>
4641 manually, and will not be automatically reloaded when saved.
4643 </div>
4645 updated one of the other configuration files, or modified or added
4646 template files.</p>
4651 saving filetypes.common as this may take a significant
4652 amount of time.</p>
4653 </div>
4654 </div>
4657 <p>System administrators can add a global configuration file for Geany
4658 which will be used when starting Geany and a user configuration file
4659 does not exist.</p>
4660 <p>The global configuration file is read from <tt class="docutils literal">geany.conf</tt> in the
4661 system configuration path - see <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>. It can
4662 contain any settings which are found in the usual configuration file
4663 created by Geany, but does not have to contain all settings.</p>
4667 admins who want to set up Geany in a multi user environment and
4668 set some sane default values for this environment. Usually users won't
4669 need to do that.</p>
4670 </div>
4671 </div>
4674 <p>All color definitions and other filetype specific settings are
4675 stored in the filetype definition files. Those settings are colors
4676 for syntax highlighting, general settings like comment characters or
4677 word delimiter characters as well as compiler and linker settings.</p>
4678 <p>See also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
4681 <p>Each filetype has a corresponding filetype definition file. The format
4684 filetypes.foo
4685 </pre>
4689 <colgroup>
4692 </colgroup>
4696 </tr>
4697 </thead>
4701 </tr>
4704 </tr>
4707 </tr>
4710 </tr>
4711 </tbody>
4712 </table>
4713 <p>There is also the <a class="reference internal" href="#special-file-filetypes-common">special file filetypes.common</a>.</p>
4714 <p>For <a class="reference internal" href="#custom-filetypes">custom filetypes</a>, the filename for <cite>Foo</cite> is different:</p>
4716 filetypes.Foo.conf
4717 </pre>
4719 </div>
4722 <p>The system-wide filetype configuration files can be found in the
4723 system configuration path and are called <tt class="docutils literal"><span class="pre">filetypes.$ext</span></tt>,
4724 where $ext is the name of the filetype. For every
4725 filetype there is a corresponding definition file. There is one
4726 exception: <tt class="docutils literal">filetypes.common</tt> -- this file is for general settings,
4727 which are not specific to a certain filetype.</p>
4731 because they will be overridden when Geany is updated.</p>
4732 </div>
4733 </div>
4736 <p>To change the settings, copy a file from the system configuration
4738 directory. Then you can edit the file and the changes will still be
4739 available after an update of Geany.</p>
4740 <p>Alternatively, you can create the file yourself and add only the
4741 settings you want to change. All missing settings will be read from
4742 the corresponding system configuration file.</p>
4743 </div>
4746 <p>At startup Geany looks for <tt class="docutils literal"><span class="pre">filetypes.*.conf</span></tt> files in the system and
4747 user filetype paths, adding any filetypes found with the name matching
4748 the '<tt class="docutils literal">*</tt>' wildcard - e.g. <tt class="docutils literal">filetypes.Bar.conf</tt>.</p>
4749 <p>Custom filetypes are not as powerful as built-in filetypes, but
4750 support for the following has been implemented:</p>
4751 <ul>
4754 </li>
4756 <dt>Reading filetype settings in the <tt class="docutils literal">[settings]</tt> section, including:</dt>
4758 <li>Using an existing syntax highlighting lexer (<a class="reference internal" href="#lexer-filetype">lexer_filetype</a> key).</li>
4760 </ul>
4761 </dd>
4762 </dl>
4763 </li>
4764 <li><p class="first">Build commands (<tt class="docutils literal"><span class="pre">[build-menu]</span></tt> section).</p>
4765 </li>
4766 <li><p class="first">Loading global tags files (sharing the <tt class="docutils literal">tag_parser</tt> namespace).</p>
4767 </li>
4768 </ul>
4769 <p>See <a class="reference internal" href="#filetype-configuration">Filetype configuration</a> for details on each setting.</p>
4771 <h4><a class="toc-backref" href="#id186">Creating a custom filetype from an existing filetype</a></h4>
4772 <p>Because most filetype settings will relate to the syntax
4774 sections), it is best to copy an existing filetype file that uses
4775 the lexer you wish to use as the basis of a custom filetype, using
4776 the correct filename extension format shown above, e.g.:</p>
4778 cp filetypes.foo filetypes.Bar.conf
4779 </pre>
4780 <p>Then add the <tt class="docutils literal">lexer_filetype=Foo</tt> setting (if not already present)
4781 and add/adjust other settings.</p>
4784 <p class="last">The <tt class="docutils literal">[styling]</tt> and <tt class="docutils literal">[keywords]</tt> sections have key names
4785 specific to each filetype/lexer. You must follow the same
4786 names - in particular, some lexers only support one keyword
4787 list, or none.</p>
4788 </div>
4789 </div>
4790 </div>
4793 <p>As well as the sections listed below, each filetype file can contain
4794 a [build-menu] section as described in <a class="reference internal" href="#build-menu-section">[build-menu] section</a>.</p>
4797 <p>In this section the colors for syntax highlighting are defined. The
4798 manual format is:</p>
4800 <li><tt class="docutils literal">key=foreground_color;background_color;bold_flag;italic_flag</tt></li>
4801 </ul>
4802 <p>Colors have to be specified as RGB hex values prefixed by
4803 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4805 values are case-insensitive but it is a good idea to use lower-case.
4807 color value with the name of a color as defined in the <tt class="docutils literal">[named_colors]</tt>
4808 section, see the <a class="reference internal" href="#named-colors-section">[named_colors] Section</a> for more information.</p>
4809 <p>Bold and italic are flags and should only be "true" or "false". If their
4810 value is something other than "true" or "false", "false" is assumed.</p>
4811 <p>You can omit fields to use the values from the style named <tt class="docutils literal">"default"</tt>.</p>
4813 <p>This makes the key style have red foreground text, default background
4814 color text and bold emphasis.</p>
4818 defined in filetypes.common.</p>
4822 </ul>
4823 <p>The bold and italic parts are optional, and if present are used to
4824 toggle the bold or italic flags to the opposite of the named style's
4825 flags. In contrast to style definition booleans, they are a literal
4828 <p>This makes the key style match the <tt class="docutils literal">"comment"</tt> named style, but with
4829 italic emphasis.</p>
4830 <p>To define named styles, see the filetypes.common <a class="reference internal" href="#named-styles-section">[named_styles]
4832 </div>
4835 <p>You can automatically copy all of the styles from another filetype
4836 definition file by using the following syntax for the <tt class="docutils literal">[styling]</tt>
4837 group:</p>
4839 [styling=Foo]
4840 </pre>
4843 <p>This is useful when the same lexer is being used for multiple
4844 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4845 styling the same as the C styling, you would put the following in
4848 [styling=C]
4849 </pre>
4850 </div>
4851 </div>
4854 <p>This section contains keys for different keyword lists specific to
4855 the filetype. Some filetypes do not support keywords, so adding a
4856 new key will not work. You can only add or remove keywords to/from
4857 an existing list.</p>
4861 </div>
4862 </div>
4865 <p>Here any special properties for the Scintilla lexer can be set in the
4867 <p>Properties Geany uses are listed in the system filetype files. To find
4868 other properties you need Geany's source code:</p>
4871 </pre>
4872 </div>
4878 including the period character (<tt class="docutils literal">.</tt>). The extension used should
4879 match one of the patterns associated with that filetype (see
4882 </dd>
4885 and searching using word matching options.</p>
4890 filetypes.common setting.</p>
4891 </div>
4892 </dd>
4895 multiline comments only, don't set this but rather comment_open and
4896 comment_close.</p>
4897 <p>Single-line comments are used in priority over multiline comments to
4899 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_single=//</span></tt></p>
4900 </dd>
4903 set comment_close to really use multiline comments. If you want to use
4904 single-line comments, prefer setting comment_single.</p>
4905 <p>Multiline comments are used in priority over single-line comments to
4906 comment a block, e.g. template comments.</p>
4907 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_open=/*</span></tt></p>
4908 </dd>
4911 close the comment.</p>
4912 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">comment_close=*/</span></tt></p>
4913 </dd>
4916 column 0 of a line. If set to true it uses any indentation of the
4917 line.</p>
4920 commented (e.g. with Ctrl-D):</p>
4922 #command_example();
4923 </pre>
4925 commented (e.g. with Ctrl-D):</p>
4927 # command_example();
4928 </pre>
4929 <p>Note: This setting only works for single line comments (like '//',
4930 '#' or ';').</p>
4931 <p class="last"><em>Example:</em> <tt class="docutils literal">comment_use_indent=true</tt></p>
4932 </dd>
4935 selection.</p>
4936 <p>Example usage: Open the API documentation for the
4937 current function call at the cursor position.</p>
4938 <p>The command can
4939 be set for every filetype or if not set, a global command will
4940 be used. The command itself can be specified without the full
4941 path, then it is searched in $PATH. But for security reasons,
4942 it is recommended to specify the full path to the command. The
4943 wildcard %s will be replaced by the current word at the cursor
4944 position or by the current selection.</p>
4945 <p>Hint: for PHP files the following could be quite useful:
4946 context_action_cmd=firefox "<a class="reference external" href="http://www.php.net/%s">http://www.php.net/%s</a>"</p>
4947 <p class="last"><em>Example:</em> <tt class="docutils literal">context_action_cmd=devhelp <span class="pre">-s</span> "%s"</tt></p>
4948 </dd>
4951 filetype name.</dd>
4952 </dl>
4956 This must not be recursive, i.e. it should be a filetype name that
4959 lexer_filetype=C
4960 #lexer_filetype=C++
4961 </pre>
4962 <p class="last">The second line is wrong, because <tt class="docutils literal">filetypes.cpp</tt> itself uses
4964 </dd>
4968 <colgroup>
4971 </colgroup>
4975 </tr>
4976 </thead>
4980 </tr>
4983 </tr>
4984 </tbody>
4985 </table>
4986 </dd>
4987 </dl>
4991 unclosed XML/HTML tag will be automatically indented. This only applies
4992 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4993 this setting in their system configuration files.</dd>
4994 </dl>
4995 </div>
4998 <p>This section allows definition of default indentation settings specific to
4999 the file type, overriding the ones configured in the preferences. This can
5000 be useful for file types requiring specific indentation settings (e.g. tabs
5001 only for Makefile). These settings don't override auto-detection if activated.</p>
5008 <colgroup>
5011 </colgroup>
5015 </tr>
5016 </thead>
5020 </tr>
5023 </tr>
5026 </tr>
5027 </tbody>
5028 </table>
5029 </dd>
5030 </dl>
5031 </div>
5034 <p>As of Geany 0.19 this section is supplemented by the <a class="reference internal" href="#build-menu-section">[build-menu] section</a>.
5035 Values that are set in the [build-menu] section will override those in this section.</p>
5039 and line number from build output. If undefined, Geany will fall
5040 back to its default error message parsing.</p>
5041 <p>Only the first two matches will be read by Geany. Geany will look for
5042 a match that is purely digits, and use this for the line number. The
5043 remaining match will be used as the filename.</p>
5044 <p><em>Example:</em> <tt class="docutils literal"><span class="pre">error_regex=(.+):([0-9]+):[0-9]+</span></tt></p>
5047 </dd>
5048 </dl>
5050 <p>If any build menu item settings have been configured in the Build Menu Commands
5051 dialog or the Build tab of the project preferences dialog then these
5052 settings are stored in the [build-menu] section and override the settings in
5053 this section for that item.</p>
5057 it is also possible to use it with interpreted languages like Perl
5058 or Python. With these filetypes you can use this option as a kind of
5059 syntax parser, which sends output to the compiler message window.</p>
5060 <p>You should quote the filename to also support filenames with
5061 spaces. The following wildcards for filenames are available:</p>
5065 </ul>
5066 <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>
5067 </dd>
5070 already compiled, it will be compiled while linking. The -o option
5071 is automatically added by Geany. This item works well with GNU gcc,
5072 but may be problematic with other compilers (esp. with the linker).</p>
5073 <p class="last"><em>Example:</em> <tt class="docutils literal">linker=gcc <span class="pre">-Wall</span> "%f"</tt></p>
5074 </dd>
5077 already. Use the %e wildcard to have only the name of the executable
5078 (i.e. without extension) or use the %f wildcard if you need the
5079 complete filename, e.g. for shell scripts.</p>
5080 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">run_cmd="./%e"</span></tt></p>
5081 </dd>
5082 </dl>
5083 </div>
5084 </div>
5087 <p>There is a special filetype definition file called
5088 filetypes.common. This file defines some general non-filetype-specific
5089 settings.</p>
5090 <p>You can open the user filetypes.common with the
5092 the default settings to the user file if the file doesn't exist.
5093 Alternatively the file can be created manually, adding only the
5094 settings you want to change. All missing settings will be read from
5095 the system file.</p>
5098 <p class="last">See the <a class="reference internal" href="#filetype-configuration">Filetype configuration</a> section for how to define styles.</p>
5099 </div>
5102 <p>Named styles declared here can be used in the [styling] section of any
5103 filetypes.* file.</p>
5107 [named_styles]
5109 bar=foo
5110 </pre>
5113 [styling]
5114 comment=foo
5115 </pre>
5116 <p>This saves copying and pasting the whole style definition into several
5117 different files.</p>
5120 <p class="last">You can define aliases for named styles, as shown with the <tt class="docutils literal">bar</tt>
5121 entry in the above example, but they must be declared after the
5122 original style.</p>
5123 </div>
5124 </div>
5127 <p>Named colors declared here can be used in the <tt class="docutils literal">[styling]</tt> or
5128 <tt class="docutils literal">[named_styles]</tt> section of any filetypes.* file or color scheme.</p>
5131 [named_colors]
5132 my_red_color=#FF0000
5133 my_blue_color=#0000FF
5135 [named_styles]
5136 foo=my_red_color;my_blue_color;false;true
5137 </pre>
5138 <p>This allows to define a color pallete by name so that to change a color
5139 scheme-wide only involves changing the hex value in a single location.</p>
5140 </div>
5146 filetype set.</p>
5147 <p class="last"><em>Example:</em> <tt class="docutils literal">default=0x000000;0xffffff;false;false</tt></p>
5148 </dd>
5156 </ul>
5158 the colors are not overridden, the default is a dark grey
5159 background with syntax highlighted foreground text.</p>
5160 <p class="last"><em>Example:</em> <tt class="docutils literal">selection=0xc0c0c0;0x00007F;true;true</tt></p>
5161 </dd>
5164 <p class="last"><em>Example:</em> <tt class="docutils literal">brace_good=0xff0000;0xFFFFFF;true;false</tt></p>
5165 </dd>
5168 <p class="last"><em>Example:</em> <tt class="docutils literal">brace_bad=0x0000ff;0xFFFFFF;true;false</tt></p>
5169 </dd>
5172 and third argument is interpreted.
5173 Set the third argument to true to change the caret into a block caret.</p>
5174 <p class="last"><em>Example:</em> <tt class="docutils literal">caret=0x000000;0x0;false;false</tt></p>
5175 </dd>
5178 argument is interpreted. The width is specified in pixels with
5179 a maximum of three pixel. Use the width 0 to make the caret
5180 invisible.</p>
5182 </dd>
5185 the second and third arguments are interpreted. The second argument
5186 is the background color. Use the third argument to enable or
5187 disable background highlighting for the current line (has to be
5188 true/false).</p>
5189 <p class="last"><em>Example:</em> <tt class="docutils literal">current_line=0x0;0xe5e5e5;true;false</tt></p>
5190 </dd>
5193 second arguments are interpreted.</p>
5194 <p class="last"><em>Example:</em> <tt class="docutils literal">indent_guide=0xc0c0c0;0xffffff;false;false</tt></p>
5195 </dd>
5198 both arguments define the foreground and background colors, the
5199 third argument sets whether to use the defined foreground color
5200 or to use the color defined by each filetype for the white space.
5201 The fourth argument defines whether to use the background color.</p>
5202 <p class="last"><em>Example:</em> <tt class="docutils literal">white_space=0xc0c0c0;0xffffff;true;true</tt></p>
5203 </dd>
5206 </dl>
5214 used.</p>
5221 </ul>
5227 </ul>
5230 </dd>
5233 first argument is used.</p>
5239 </ul>
5240 <p class="last"><em>Example:</em> <tt class="docutils literal">folding_horiz_line=0;0;false;false</tt></p>
5241 </dd>
5244 This is a bitmask of the values:</p>
5250 </ul>
5251 <p>Second argument: wether the visual flags to indicate a line is wrapped
5252 are drawn near the border or near the text. This is a bitmask of the values:</p>
5257 </ul>
5259 <p class="last"><em>Example:</em> <tt class="docutils literal">line_wrap_visuals=3;0;false;false</tt></p>
5260 </dd>
5262 <dd><p class="first">First argument: sets the size of indentation of sublines for wrapped lines
5263 in terms of the width of a space, only used when the second argument is <tt class="docutils literal">0</tt>.</p>
5264 <p>Second argument: wrapped sublines can be indented to the position of their
5265 first subline or one more indent level. Possible values:</p>
5269 <li>2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation</li>
5270 </ul>
5272 <p class="last"><em>Example:</em> <tt class="docutils literal">line_wrap_indent=0;1;false;false</tt></p>
5273 </dd>
5280 <p class="last"><em>Example:</em> <tt class="docutils literal">translucency=256;256;false;false</tt></p>
5281 </dd>
5284 The foreground color (first argument) is only used when the Markers margin
5285 is enabled (see View menu).</p>
5287 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_line=0x000000;0xffff00;false;false</tt></p>
5288 </dd>
5290 <dd><p class="first">The style for a marked search results (when using "Mark" in Search dialogs).
5291 The second argument sets the background color for the drawn rectangle.</p>
5293 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_search=0x000000;0xb8f4b8;false;false</tt></p>
5294 </dd>
5296 <dd><p class="first">The style for a marked line (e.g when using the "Toggle Marker" keybinding
5297 (Ctrl-M)). The foreground color (first argument) is only used
5298 when the Markers margin is enabled (see View menu).</p>
5300 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_mark=0x000000;0xb8f4b8;false;false</tt></p>
5301 </dd>
5308 <p class="last"><em>Example:</em> <tt class="docutils literal">marker_translucency=256;256;false;false</tt></p>
5309 </dd>
5312 The first argument defines the amount of space to be drawn above the line, the second
5313 argument defines the amount of space to be drawn below.</p>
5315 <p class="last"><em>Example:</em> <tt class="docutils literal">line_height=0;0;false;false</tt></p>
5316 </dd>
5319 define the foreground and background colors, the third and fourth
5320 arguments set whether to use the defined colors.</p>
5321 <p class="last"><em>Example:</em> <tt class="docutils literal">calltips=0xc0c0c0;0xffffff;false;false</tt></p>
5322 </dd>
5323 </dl>
5324 </div>
5330 when moving, selecting and deleting across word boundaries
5331 (see <a class="reference internal" href="#scintilla-keyboard-commands">Scintilla keyboard commands</a>).</p>
5333 <p class="last"><em>Example:</em> <tt class="docutils literal"><span class="pre">whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~</span></tt></p>
5334 </dd>
5335 </dl>
5336 </div>
5337 </div>
5338 </div>
5341 <p>To change the default filetype extension used when saving a new file,
5342 see <a class="reference internal" href="#filetype-definition-files">Filetype definition files</a>.</p>
5343 <p>You can override the list of file extensions that Geany uses to detect
5344 filetypes using the user <tt class="docutils literal">filetype_extensions.conf</tt> file. Use the
5346 also <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
5347 <p>You should only list lines for filetype extensions that you want to
5348 override in the user configuration file and remove or comment out
5350 semi-colon separated list of patterns which should be matched for
5351 that filetype.</p>
5352 <p>For example, to override the filetype extensions for Make, the file
5353 should look like:</p>
5355 [Extensions]
5356 Make=Makefile*;*.mk;Buildfile;
5357 </pre>
5358 </div>
5361 <p>Group membership is also stored in <tt class="docutils literal">filetype_extensions.conf</tt>. This
5362 file is used to store information Geany needs at startup, whereas the
5363 separate filetype definition files hold information only needed when
5364 a document with their filetype is used.</p>
5367 [Groups]
5368 Programming=C;C++;
5369 Script=Perl;Python;
5370 Markup=HTML;XML;
5371 Misc=Diff;Conf;
5372 None=None;
5373 </pre>
5378 </div>
5379 </div>
5382 <p>The user preferences file <tt class="docutils literal">geany.conf</tt> holds settings for all the items configured
5383 in the preferences dialog. This file should not be edited while Geany is running
5384 as the file will be overwritten when the preferences in Geany are changed or Geany
5385 is quit.</p>
5388 <p>The [build-menu] section contains the configuration of the build menu.
5389 This section can occur in filetype, preferences and project files and
5390 always has the format described here. Different menu items are loaded
5391 from different files, see the table in the <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>
5392 section for details. All the settings can be configured from the dialogs
5393 except the execute command in filetype files and filetype definitions in
5394 the project file, so these are the only ones which need hand editing.</p>
5395 <p>The build-menu section stores one entry for each setting for each menu item that
5396 is configured. The keys for these settings have the format:</p>
5397 <blockquote>
5405 </ul>
5406 </li>
5407 <li>NN - is a two decimal digit number of the item within the group,
5413 </ul>
5414 </li>
5415 </ul>
5416 </div>
5417 </div>
5420 <p>The project file contains project related settings and possibly a
5421 record of the current session files.</p>
5424 <p>The project file also can have extra fields in the [build-menu] section
5425 in addition to those listed in <a class="reference internal" href="#build-menu-section">[build-menu] section</a> above.</p>
5426 <p>When filetype menu items are configured for the project they are stored
5427 in the project file.</p>
5428 <p>The <tt class="docutils literal">filetypes</tt> entry is a list of the filetypes which exist in the
5429 project file.</p>
5430 <p>For each filetype the entries for that filetype have the format defined in
5431 <a class="reference internal" href="#build-menu-section">[build-menu] section</a> but the key is prefixed by the name of the filetype
5432 as it appears in the <tt class="docutils literal">filetypes</tt> entry, eg the entry for the label of
5434 <blockquote>
5436 </div>
5437 </div>
5448 </ul>
5449 <p>To use these templates, just open the Edit menu or open the popup menu
5451 and insert templates as you want.</p>
5452 <p>Some templates (like File header or ChangeLog entry) will always be
5453 inserted at the top of the file.</p>
5454 <p>To insert a function description, the cursor must be inside
5455 of the function, so that the function name can be determined
5456 automatically. The description will be positioned correctly one line
5457 above the function, just check it out. If the cursor is not inside
5458 of a function or the function name cannot be determined, the inserted
5460 instead.</p>
5464 save a file in the user's template configuration directory. You can
5466 </div>
5469 <p>Meta data can be used with all templates, but by default user set
5470 meta data is only used for the ChangeLog and File header templates.</p>
5472 <a class="reference internal" href="#template-preferences">Template preferences</a>). You can define the default values
5473 which will be inserted in the templates.</p>
5474 </div>
5477 <p>File templates are templates used as the basis of a new file. To
5479 menu.</p>
5480 <p>By default, file templates are installed for some filetypes. Custom
5481 file templates can be added by creating the appropriate template file. You can
5482 also edit the default file templates.</p>
5483 <p>The file's contents are just the text to place in the document, with
5484 optional template wildcards like <tt class="docutils literal">{fileheader}</tt>. The fileheader
5485 wildcard can be placed anywhere, but it's usually put on the first
5486 line of the file, followed by a blank line.</p>
5490 <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>.</p>
5491 <p>The filetype to use is detected from the template file's extension, if
5492 any. For example, creating a file <tt class="docutils literal">module.c</tt> would add a menu item
5493 which created a new document with the filetype set to 'C'.</p>
5494 <p>The template file is read from disk when the corresponding menu item is
5495 clicked.</p>
5496 </div>
5497 </div>
5500 <p>Each template can be customized to your needs. The templates are
5501 stored in the <tt class="docutils literal"><span class="pre">~/.config/geany/templates/</span></tt> directory (see the section called
5502 <a class="reference internal" href="#command-line-options">Command line options</a> for further information about the configuration
5503 directory). Just open the desired template with an editor (ideally,
5504 Geany ;-) ) and edit the template to your needs. There are some
5505 wildcards which will be automatically replaced by Geany at startup.</p>
5511 <colgroup>
5515 </colgroup>
5520 </tr>
5521 </thead>
5524 <td>{ Opening Brace (used to prevent other
5525 wildcards being expanded).</td>
5527 </tr>
5531 </tr>
5533 <td>% Percent (used to escape e.g. %block% in
5534 snippets).</td>
5536 </tr>
5537 </tbody>
5538 </table>
5540 <p>These are configurable, see <a class="reference internal" href="#template-preferences">Template preferences</a>.</p>
5542 <colgroup>
5546 </colgroup>
5551 </tr>
5552 </thead>
5556 <td>file templates, file header,
5557 function description, ChangeLog entry,
5558 bsd, gpl, snippets.</td>
5559 </tr>
5563 <td>file templates, file header,
5564 function description, ChangeLog entry,
5565 bsd, gpl, snippets.</td>
5566 </tr>
5569 <td>file templates, file header,
5570 function description, ChangeLog entry,
5571 bsd, gpl, snippets.</td>
5572 </tr>
5575 <td>file templates, file header,
5576 function description, ChangeLog entry,
5577 bsd, gpl, snippets.</td>
5578 </tr>
5581 <td>file templates, file header,
5582 function description, ChangeLog entry,
5583 bsd, gpl, snippets.</td>
5584 </tr>
5585 </tbody>
5586 </table>
5588 <p>The format for these wildcards can be changed in the preferences
5589 dialog, see <a class="reference internal" href="#template-preferences">Template preferences</a>. You can use any conversion
5590 specifiers which can be used with the ANSI C strftime function.
5591 For details please see <a class="reference external" href="http://man.cx/strftime">http://man.cx/strftime</a>.</p>
5593 <colgroup>
5597 </colgroup>
5602 </tr>
5603 </thead>
5607 <td>file templates, file header,
5608 function description, ChangeLog entry,
5609 bsd, gpl, snippets.</td>
5610 </tr>
5612 <td>The current date. Default format:
5613 YYYY-MM-DD.</td>
5614 <td>file templates, file header,
5615 function description, ChangeLog entry,
5616 bsd, gpl, snippets.</td>
5617 </tr>
5619 <td>The current date and time. Default format:
5620 DD.MM.YYYY HH:mm:ss ZZZZ.</td>
5621 <td>file templates, file header,
5622 function description, ChangeLog entry,
5623 bsd, gpl, snippets.</td>
5624 </tr>
5625 </tbody>
5626 </table>
5629 <colgroup>
5633 </colgroup>
5638 </tr>
5639 </thead>
5643 translated to your locale), used in
5644 file templates.</td>
5645 <td>file templates, file header,
5646 function description, ChangeLog entry,
5647 bsd, gpl, snippets.</td>
5648 </tr>
5650 <td>The actual Geany version, e.g.
5652 <td>file templates, file header,
5653 function description, ChangeLog entry,
5654 bsd, gpl, snippets.</td>
5655 </tr>
5657 <td>The filename of the current file.
5658 For new files, it's only replaced when
5659 first saving if found on the first 3 lines
5660 of the file.</td>
5661 <td>file header, snippets, file
5662 templates.</td>
5663 </tr>
5667 </tr>
5671 </tr>
5673 <td>The function name of the function at the
5674 cursor position. This wildcard will only be
5675 replaced in the function description
5676 template.</td>
5678 </tr>
5680 <td>Executes the specified command and replace
5681 the wildcard with the command's standard
5682 output. See <a class="reference internal" href="#special-command-wildcard">Special {command:} wildcard</a>
5683 for details.</td>
5684 <td>file templates, file header,
5685 function description, ChangeLog entry,
5686 bsd, gpl, snippets.</td>
5687 </tr>
5688 </tbody>
5689 </table>
5692 <colgroup>
5696 </colgroup>
5701 </tr>
5702 </thead>
5707 </tr>
5711 </tr>
5713 <td>The file header template. This wildcard
5714 will only be replaced in file templates.</td>
5716 </tr>
5717 </tbody>
5718 </table>
5721 <p>The {command:} wildcard is a special one because it can execute
5722 a specified command and put the command's output (stdout) into
5723 the template.</p>
5726 {command:uname -a}
5727 </pre>
5731 </pre>
5732 <p>Using this wildcard you can insert nearly any arbitrary text into the
5733 template.</p>
5734 <p>In the environment of the executed command the variables
5735 <tt class="docutils literal">GEANY_FILENAME</tt>, <tt class="docutils literal">GEANY_FILETYPE</tt> and <tt class="docutils literal">GEANY_FUNCNAME</tt> are set.
5736 The value of these variables is filled in only if Geany knows about it.
5737 For example, <tt class="docutils literal">GEANY_FUNCNAME</tt> is only filled within the function
5738 description template. However, these variables are <tt class="docutils literal">always</tt> set,
5739 just maybe with an empty value.
5740 You can easily access them e.g. within an executed shell script using:</p>
5742 $GEANY_FILENAME
5743 </pre>
5746 <p class="last">If the specified command could not be found or not executed, the wildcard is substituted
5747 by an empty string. In such cases, you can find the occurred error message on Geany's
5749 </div>
5750 </div>
5751 </div>
5752 </div>
5753 </div>
5756 <p>You can add, remove and reorder the elements in the toolbar by using
5757 the toolbar editor, or by manually editing the configuration file
5759 <p>The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5760 by right-clicking on the toolbar itself and choosing it from the menu.</p>
5763 <p>To override the system-wide configuration file, copy it to your user
5764 configuration directory (see <a class="reference internal" href="#configuration-file-paths">Configuration file paths</a>).</p>
5767 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5768 </pre>
5769 <p>Then edit it and add any of the available elements listed in the file or remove
5770 any of the existing elements. Of course, you can also reorder the elements as
5771 you wish and add or remove additional separators.
5772 This file must be valid XML, otherwise the global toolbar UI definition
5773 will be used instead.</p>
5780 </ol>
5781 </div>
5782 </div>
5786 <colgroup>
5789 </colgroup>
5793 </tr>
5794 </thead>
5798 </tr>
5801 </tr>
5804 </tr>
5807 </tr>
5810 </tr>
5813 </tr>
5816 </tr>
5819 </tr>
5822 </tr>
5825 </tr>
5828 </tr>
5831 </tr>
5834 </tr>
5837 </tr>
5840 </tr>
5843 </tr>
5846 </tr>
5848 <td>Build the current file, includes a submenu for Make commands. Geany
5849 remembers the last chosen action from the submenu and uses this as default
5850 action when the button itself is clicked.</td>
5851 </tr>
5854 </tr>
5857 </tr>
5860 </tr>
5863 </tr>
5866 </tr>
5869 </tr>
5872 </tr>
5875 </tr>
5877 <td>Find the entered text in the current file (only useful if you also
5878 use 'SearchEntry')</td>
5879 </tr>
5882 </tr>
5885 </tr>
5888 </tr>
5891 </tr>
5892 </tbody>
5893 </table>
5894 </div>
5895 </div>
5896 </div>
5901 <p>The HTML Characters plugin helps when working with special
5902 characters in XML/HTML, e.g. German Umlauts ü and ä.</p>
5905 <p>When the plugin is enabled, you can insert special character
5907 <p>This opens up a dialog where you can find a huge amount of special
5908 characters sorted by category that you might like to use inside your
5909 document. You can expand and collapse the categories by clicking on
5910 the little arrow on the left hand side. Once you have found the
5912 the entity for the character at the current cursor position. You
5913 might also like to double click the chosen entity instead.</p>
5914 </div>
5917 <p>To help make a XML/HTML document valid the plugin supports
5918 replacement of special chars known by the plugin. Both bulk
5919 replacement and immediate replacement during typing are supported.</p>
5928 </ul>
5929 </dd>
5930 </dl>
5935 activated, all special characters (beside the given exceptions from
5936 above) known by the plugin will be replaced by their entities.</p>
5937 <p>You could also set a keybinding for the plugin to toggle the status
5938 of this feature.</p>
5939 </div>
5943 plugin allows bulk replacement of all known characters (beside the
5944 mentioned exceptions). You can find the function under the same
5946 configure a keybinding for the plugin.</p>
5947 </div>
5948 </div>
5949 </div>
5954 <p>This plugin sets on every new file (<em>File->New</em> or <em>File->New (with template)</em>)
5955 a randomly chosen filename and set its filetype appropriate to the used template
5956 or when no template was used, to a configurable default filetype.
5957 This enables you to quickly compile, build and/or run the new file without the
5958 need to give it an explicit filename using the Save As dialog. This might be
5959 useful when you often create new files just for testing some code or something
5960 similar.</p>
5961 </div>
5964 <p>This plugin creates a backup copy of the current file in Geany when it is
5965 saved. You can specify the directory where the backup copy is saved and
5966 you can configure the automatically added extension in the configure dialog
5967 in Geany's plugin manager.</p>
5968 <p>After the plugin was loaded in Geany's plugin manager, every file is
5969 copied into the configured backup directory when the file is saved in Geany.</p>
5970 </div>
5971 </div>
5972 </div>
5975 <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>
5976 (or "reST"). The source file for it is located in Geany's <tt class="docutils literal">doc</tt>
5977 subdirectory. If you intend on making changes, you should grab the
5978 source right from SVN to make sure you've got the newest version. After
5979 editing the file, to build the HTML document to see how your changes
5980 look, run "<tt class="docutils literal">make doc</tt>" in the subdirectory <tt class="docutils literal">doc</tt> of Geany's source
5981 directory. This regenerates the <tt class="docutils literal">geany.html</tt> file. To generate a PDF
5982 file, use the command "<tt class="docutils literal">make pdf</tt>" which should generate a file called
5986 % svn diff geany.txt > foo.patch
5987 </pre>
5989 <p>Note, you will need the Python docutils software package installed
5990 to build the docs. The package is named <tt class="docutils literal"><span class="pre">python-docutils</span></tt> on Debian
5991 and Fedora systems.</p>
5992 </div>
5996 <p>This appendix is distributed under the terms of the License for
5997 Scintilla and SciTE. A copy of this license can be found in the file
5999 program and in the appendix of this document. See <a class="reference internal" href="#license-for-scintilla-and-scite">License for
6004 <p>Keyboard commands for Scintilla mostly follow common Windows and GTK+
6005 conventions. All move keys (arrows, page up/down, home and end)
6006 allows to extend or reduce the stream selection when holding the
6007 Shift key, and the rectangular selection when holding the
6008 appropriate keys (see <a class="reference internal" href="#column-mode-editing-rectangular-selections">Column mode editing (rectangular selections)</a>).</p>
6009 <p>Some keys may not be available with some national keyboards
6010 or because they are taken by the system such as by a window manager
6011 or GTK. Keyboard equivalents of menu commands are listed in the
6012 menus. Some less common commands with no menu equivalent are:</p>
6014 <colgroup>
6017 </colgroup>
6021 </tr>
6022 </thead>
6026 </tr>
6029 </tr>
6032 </tr>
6035 </tr>
6038 </tr>
6041 </tr>
6044 </tr>
6047 </tr>
6050 </tr>
6053 </tr>
6056 </tr>
6059 </tr>
6062 </tr>
6065 </tr>
6068 </tr>
6071 </tr>
6074 </tr>
6077 </tr>
6080 </tr>
6081 </tbody>
6082 </table>
6083 </div>
6084 </div>
6090 <li>Double-click on empty space in the notebook tab bar to open a
6091 new document.</li>
6094 document.</li>
6095 <li>Double-click on a document's notebook tab to toggle all additional
6096 widgets (to show them again use the View menu or the keyboard
6097 shortcut). The interface pref must be enabled for this to work.</li>
6098 </ul>
6099 </div>
6108 </ul>
6109 </div>
6114 </ul>
6115 </div>
6119 <li>Scrolling the mouse wheel over a notebook tab bar will switch
6120 notebook pages.</li>
6121 </ul>
6122 <p>The following are derived from X-Windows features (but GTK still supports
6123 them on Windows):</p>
6126 <li>Middle-click on a scrollbar moves the scrollbar to that
6127 position without having to drag it.</li>
6128 </ul>
6129 </div>
6130 </div>
6133 <p>There are some options which can only be changed at compile time,
6134 and some options which are used as the default for configurable
6135 options. To change these options, edit the appropriate source file
6136 in the <tt class="docutils literal">src</tt> subdirectory. Look for a block of lines starting with
6137 <tt class="docutils literal">#define GEANY_*</tt>. Any definitions which are not listed here should
6138 not be changed.</p>
6142 </div>
6146 <colgroup>
6150 </colgroup>
6155 </tr>
6156 </thead>
6159 <td>A string used as the default name for new
6160 files. Be aware that the string can be
6161 translated, so change it only if you know
6162 what you are doing.</td>
6164 </tr>
6168 </tr>
6172 </tr>
6174 <td>The default width of the main window at the
6175 first start.</td>
6177 </tr>
6179 <td>The default height of the main window at the
6180 first start.</td>
6182 </tr>
6186 </tr>
6189 Windows file open and save dialogs instead
6190 GTK's file open and save dialogs. The
6191 default Windows file dialogs are missing
6192 some nice features like choosing a filetype
6193 or an encoding. <em>Do not touch this setting
6194 when building on a non-Win32 system.</em></td>
6196 </tr>
6197 </tbody>
6198 </table>
6199 </div>
6203 <colgroup>
6207 </colgroup>
6212 </tr>
6213 </thead>
6216 <td>The default filename extension for Geany
6217 project files. It is used when creating new
6218 projects and as filter mask for the project
6219 open dialog.</td>
6221 </tr>
6222 </tbody>
6223 </table>
6224 </div>
6228 <colgroup>
6232 </colgroup>
6237 </tr>
6238 </thead>
6241 <td>The number of lines to search for the
6242 filetype with the extract filetype regex.</td>
6244 </tr>
6245 </tbody>
6246 </table>
6247 </div>
6251 <colgroup>
6255 </colgroup>
6260 </tr>
6261 </thead>
6264 <td>These characters define word boundaries when
6265 making selections and searching using word
6266 matching options.</td>
6267 <td>a string with:
6269 underscore.</td>
6270 </tr>
6271 </tbody>
6272 </table>
6273 </div>
6276 <p>These are default settings that can be overridden in the <a class="reference internal" href="#preferences">Preferences</a> dialog.</p>
6278 <colgroup>
6282 </colgroup>
6287 </tr>
6288 </thead>
6291 <td>How many characters you need to type to
6292 trigger the autocompletion list.</td>
6294 </tr>
6296 <td>Time in seconds between checking a file for
6297 external changes.</td>
6299 </tr>
6303 </tr>
6305 <td>A terminal emulator. It has to accept the
6307 include a path.</td>
6309 </tr>
6313 </tr>
6315 <td>A printing tool. It should be able to accept
6316 and process plain text files. This can also
6317 include a path.</td>
6319 </tr>
6321 <td>A grep tool. It should be compatible with
6322 GNU grep. This can also include a path.</td>
6324 </tr>
6328 </tr>
6330 <td>The font used in sidebar to show symbols and
6331 open files.</td>
6333 </tr>
6337 </tr>
6341 </tr>
6343 <td>A string which is used to mark a toggled
6344 comment.</td>
6346 </tr>
6348 <td>How many autocompletion suggestions should
6349 Geany provide.</td>
6351 </tr>
6353 <td>The default regex to extract filetypes from
6354 files.</td>
6356 </tr>
6357 </tbody>
6358 </table>
6359 <p>The GEANY_DEFAULT_FILETYPE_REGEX default value is -\*-\s*([^\s]+)\s*-\*- which finds Emacs filetypes.</p>
6360 </div>
6364 <colgroup>
6368 </colgroup>
6373 </tr>
6374 </thead>
6377 <td>Amount of build error indicators to
6378 be shown in the editor window.
6379 This affects the special coloring
6380 when Geany detects a compiler output line as
6381 an error message and then highlights the
6382 corresponding line in the source code.
6383 Usually only the first few messages are
6384 interesting because following errors are
6385 just after-effects.
6386 All errors in the Compiler window are parsed
6387 and unaffected by this value.</td>
6389 </tr>
6391 <td>Every time a build menu item priority
6392 calculation is run, print the state of the
6393 menu item table in the form of the table
6394 in <a class="reference internal" href="#build-menu-configuration">Build Menu Configuration</a>. May be
6395 useful to debug configuration file
6396 overloading. Warning produces a lot of
6397 output. Can also be enabled/disabled by the
6399 overriding the compile setting.</td>
6401 </tr>
6402 </tbody>
6403 </table>
6404 </div>
6405 </div>
6409 GNU GENERAL PUBLIC LICENSE
6414 Everyone is permitted to copy and distribute verbatim copies
6415 of this license document, but changing it is not allowed.
6417 Preamble
6419 The licenses for most software are designed to take away your
6420 freedom to share and change it. By contrast, the GNU General Public
6421 License is intended to guarantee your freedom to share and change free
6422 software--to make sure the software is free for all its users. This
6423 General Public License applies to most of the Free Software
6424 Foundation's software and to any other program whose authors commit to
6425 using it. (Some other Free Software Foundation software is covered by
6426 the GNU Library General Public License instead.) You can apply it to
6427 your programs, too.
6429 When we speak of free software, we are referring to freedom, not
6430 price. Our General Public Licenses are designed to make sure that you
6431 have the freedom to distribute copies of free software (and charge for
6432 this service if you wish), that you receive source code or can get it
6433 if you want it, that you can change the software or use pieces of it
6434 in new free programs; and that you know you can do these things.
6436 To protect your rights, we need to make restrictions that forbid
6437 anyone to deny you these rights or to ask you to surrender the rights.
6438 These restrictions translate to certain responsibilities for you if you
6439 distribute copies of the software, or if you modify it.
6441 For example, if you distribute copies of such a program, whether
6442 gratis or for a fee, you must give the recipients all the rights that
6443 you have. You must make sure that they, too, receive or can get the
6444 source code. And you must show them these terms so they know their
6445 rights.
6447 We protect your rights with two steps: (1) copyright the software, and
6448 (2) offer you this license which gives you legal permission to copy,
6449 distribute and/or modify the software.
6451 Also, for each author's protection and ours, we want to make certain
6452 that everyone understands that there is no warranty for this free
6453 software. If the software is modified by someone else and passed on, we
6454 want its recipients to know that what they have is not the original, so
6455 that any problems introduced by others will not reflect on the original
6456 authors' reputations.
6458 Finally, any free program is threatened constantly by software
6459 patents. We wish to avoid the danger that redistributors of a free
6460 program will individually obtain patent licenses, in effect making the
6461 program proprietary. To prevent this, we have made it clear that any
6462 patent must be licensed for everyone's free use or not licensed at all.
6464 The precise terms and conditions for copying, distribution and
6465 modification follow.
6467 GNU GENERAL PUBLIC LICENSE
6468 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
6470 0. This License applies to any program or other work which contains
6471 a notice placed by the copyright holder saying it may be distributed
6474 means either the Program or any derivative work under copyright law:
6475 that is to say, a work containing the Program or a portion of it,
6476 either verbatim or with modifications and/or translated into another
6477 language. (Hereinafter, translation is included without limitation in
6480 Activities other than copying, distribution and modification are not
6481 covered by this License; they are outside its scope. The act of
6482 running the Program is not restricted, and the output from the Program
6483 is covered only if its contents constitute a work based on the
6484 Program (independent of having been made by running the Program).
6485 Whether that is true depends on what the Program does.
6487 1. You may copy and distribute verbatim copies of the Program's
6488 source code as you receive it, in any medium, provided that you
6489 conspicuously and appropriately publish on each copy an appropriate
6490 copyright notice and disclaimer of warranty; keep intact all the
6491 notices that refer to this License and to the absence of any warranty;
6492 and give any other recipients of the Program a copy of this License
6493 along with the Program.
6495 You may charge a fee for the physical act of transferring a copy, and
6496 you may at your option offer warranty protection in exchange for a fee.
6498 2. You may modify your copy or copies of the Program or any portion
6499 of it, thus forming a work based on the Program, and copy and
6500 distribute such modifications or work under the terms of Section 1
6501 above, provided that you also meet all of these conditions:
6503 a) You must cause the modified files to carry prominent notices
6504 stating that you changed the files and the date of any change.
6506 b) You must cause any work that you distribute or publish, that in
6507 whole or in part contains or is derived from the Program or any
6508 part thereof, to be licensed as a whole at no charge to all third
6509 parties under the terms of this License.
6511 c) If the modified program normally reads commands interactively
6512 when run, you must cause it, when started running for such
6513 interactive use in the most ordinary way, to print or display an
6514 announcement including an appropriate copyright notice and a
6515 notice that there is no warranty (or else, saying that you provide
6516 a warranty) and that users may redistribute the program under
6517 these conditions, and telling the user how to view a copy of this
6518 License. (Exception: if the Program itself is interactive but
6519 does not normally print such an announcement, your work based on
6520 the Program is not required to print an announcement.)
6522 These requirements apply to the modified work as a whole. If
6523 identifiable sections of that work are not derived from the Program,
6524 and can be reasonably considered independent and separate works in
6525 themselves, then this License, and its terms, do not apply to those
6526 sections when you distribute them as separate works. But when you
6527 distribute the same sections as part of a whole which is a work based
6528 on the Program, the distribution of the whole must be on the terms of
6529 this License, whose permissions for other licensees extend to the
6530 entire whole, and thus to each and every part regardless of who wrote it.
6532 Thus, it is not the intent of this section to claim rights or contest
6533 your rights to work written entirely by you; rather, the intent is to
6534 exercise the right to control the distribution of derivative or
6535 collective works based on the Program.
6537 In addition, mere aggregation of another work not based on the Program
6538 with the Program (or with a work based on the Program) on a volume of
6539 a storage or distribution medium does not bring the other work under
6540 the scope of this License.
6542 3. You may copy and distribute the Program (or a work based on it,
6543 under Section 2) in object code or executable form under the terms of
6546 a) Accompany it with the complete corresponding machine-readable
6547 source code, which must be distributed under the terms of Sections
6550 b) Accompany it with a written offer, valid for at least three
6551 years, to give any third party, for a charge no more than your
6552 cost of physically performing source distribution, a complete
6553 machine-readable copy of the corresponding source code, to be
6555 customarily used for software interchange; or,
6557 c) Accompany it with the information you received as to the offer
6558 to distribute corresponding source code. (This alternative is
6559 allowed only for noncommercial distribution and only if you
6560 received the program in object code or executable form with such
6561 an offer, in accord with Subsection b above.)
6563 The source code for a work means the preferred form of the work for
6564 making modifications to it. For an executable work, complete source
6565 code means all the source code for all modules it contains, plus any
6566 associated interface definition files, plus the scripts used to
6567 control compilation and installation of the executable. However, as a
6568 special exception, the source code distributed need not include
6569 anything that is normally distributed (in either source or binary
6570 form) with the major components (compiler, kernel, and so on) of the
6571 operating system on which the executable runs, unless that component
6572 itself accompanies the executable.
6574 If distribution of executable or object code is made by offering
6575 access to copy from a designated place, then offering equivalent
6576 access to copy the source code from the same place counts as
6577 distribution of the source code, even though third parties are not
6578 compelled to copy the source along with the object code.
6580 4. You may not copy, modify, sublicense, or distribute the Program
6581 except as expressly provided under this License. Any attempt
6582 otherwise to copy, modify, sublicense or distribute the Program is
6583 void, and will automatically terminate your rights under this License.
6584 However, parties who have received copies, or rights, from you under
6585 this License will not have their licenses terminated so long as such
6586 parties remain in full compliance.
6588 5. You are not required to accept this License, since you have not
6589 signed it. However, nothing else grants you permission to modify or
6590 distribute the Program or its derivative works. These actions are
6591 prohibited by law if you do not accept this License. Therefore, by
6592 modifying or distributing the Program (or any work based on the
6593 Program), you indicate your acceptance of this License to do so, and
6594 all its terms and conditions for copying, distributing or modifying
6595 the Program or works based on it.
6597 6. Each time you redistribute the Program (or any work based on the
6598 Program), the recipient automatically receives a license from the
6599 original licensor to copy, distribute or modify the Program subject to
6600 these terms and conditions. You may not impose any further
6601 restrictions on the recipients' exercise of the rights granted herein.
6602 You are not responsible for enforcing compliance by third parties to
6603 this License.
6605 7. If, as a consequence of a court judgment or allegation of patent
6606 infringement or for any other reason (not limited to patent issues),
6607 conditions are imposed on you (whether by court order, agreement or
6608 otherwise) that contradict the conditions of this License, they do not
6609 excuse you from the conditions of this License. If you cannot
6610 distribute so as to satisfy simultaneously your obligations under this
6611 License and any other pertinent obligations, then as a consequence you
6612 may not distribute the Program at all. For example, if a patent
6613 license would not permit royalty-free redistribution of the Program by
6614 all those who receive copies directly or indirectly through you, then
6615 the only way you could satisfy both it and this License would be to
6616 refrain entirely from distribution of the Program.
6618 If any portion of this section is held invalid or unenforceable under
6619 any particular circumstance, the balance of the section is intended to
6620 apply and the section as a whole is intended to apply in other
6621 circumstances.
6623 It is not the purpose of this section to induce you to infringe any
6624 patents or other property right claims or to contest validity of any
6625 such claims; this section has the sole purpose of protecting the
6626 integrity of the free software distribution system, which is
6627 implemented by public license practices. Many people have made
6628 generous contributions to the wide range of software distributed
6629 through that system in reliance on consistent application of that
6630 system; it is up to the author/donor to decide if he or she is willing
6631 to distribute software through any other system and a licensee cannot
6632 impose that choice.
6634 This section is intended to make thoroughly clear what is believed to
6635 be a consequence of the rest of this License.
6637 8. If the distribution and/or use of the Program is restricted in
6638 certain countries either by patents or by copyrighted interfaces, the
6639 original copyright holder who places the Program under this License
6640 may add an explicit geographical distribution limitation excluding
6641 those countries, so that distribution is permitted only in or among
6642 countries not thus excluded. In such case, this License incorporates
6643 the limitation as if written in the body of this License.
6645 9. The Free Software Foundation may publish revised and/or new versions
6646 of the General Public License from time to time. Such new versions will
6647 be similar in spirit to the present version, but may differ in detail to
6648 address new problems or concerns.
6650 Each version is given a distinguishing version number. If the Program
6651 specifies a version number of this License which applies to it and "any
6652 later version", you have the option of following the terms and conditions
6653 either of that version or of any later version published by the Free
6654 Software Foundation. If the Program does not specify a version number of
6655 this License, you may choose any version ever published by the Free Software
6656 Foundation.
6658 10. If you wish to incorporate parts of the Program into other free
6659 programs whose distribution conditions are different, write to the author
6660 to ask for permission. For software which is copyrighted by the Free
6661 Software Foundation, write to the Free Software Foundation; we sometimes
6662 make exceptions for this. Our decision will be guided by the two goals
6663 of preserving the free status of all derivatives of our free software and
6664 of promoting the sharing and reuse of software generally.
6666 NO WARRANTY
6668 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
6669 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
6670 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
6672 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
6673 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
6674 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
6675 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
6676 REPAIR OR CORRECTION.
6678 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
6679 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
6680 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
6681 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
6682 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
6683 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
6684 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
6685 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
6686 POSSIBILITY OF SUCH DAMAGES.
6688 END OF TERMS AND CONDITIONS
6690 How to Apply These Terms to Your New Programs
6692 If you develop a new program, and you want it to be of the greatest
6693 possible use to the public, the best way to achieve this is to make it
6694 free software which everyone can redistribute and change under these terms.
6696 To do so, attach the following notices to the program. It is safest
6697 to attach them to the start of each source file to most effectively
6698 convey the exclusion of warranty; and each file should have at least
6704 This program is free software; you can redistribute it and/or modify
6705 it under the terms of the GNU General Public License as published by
6706 the Free Software Foundation; either version 2 of the License, or
6707 (at your option) any later version.
6709 This program is distributed in the hope that it will be useful,
6710 but WITHOUT ANY WARRANTY; without even the implied warranty of
6711 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
6712 GNU General Public License for more details.
6714 You should have received a copy of the GNU General Public License
6715 along with this program; if not, write to the Free Software
6719 Also add information on how to contact you by electronic and paper mail.
6721 If the program is interactive, make it output a short notice like this
6722 when it starts in an interactive mode:
6724 Gnomovision version 69, Copyright (C) year name of author
6725 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
6726 This is free software, and you are welcome to redistribute it
6727 under certain conditions; type `show c' for details.
6729 The hypothetical commands `show w' and `show c' should show the appropriate
6730 parts of the General Public License. Of course, the commands you use may
6731 be called something other than `show w' and `show c'; they could even be
6732 mouse-clicks or menu items--whatever suits your program.
6734 You should also get your employer (if you work as a programmer) or your
6736 necessary. Here is a sample; alter the names:
6738 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
6739 `Gnomovision' (which makes passes at compilers) written by James Hacker.
6742 Ty Coon, President of Vice
6744 This General Public License does not permit incorporating your program into
6745 proprietary programs. If your program is a subroutine library, you may
6746 consider it more useful to permit linking proprietary applications with the
6747 library. If this is what you want to do, use the GNU Library General
6748 Public License instead of this License.
6749 </pre>
6750 </div>
6755 <p>Permission to use, copy, modify, and distribute this software and
6756 its documentation for any purpose and without fee is hereby granted,
6757 provided that the above copyright notice appear in all copies and
6758 that both that copyright notice and this permission notice appear in
6759 supporting documentation.</p>
6760 <p>NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
6761 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
6762 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
6763 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
6764 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6765 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
6766 USE OR PERFORMANCE OF THIS SOFTWARE.</p>
6767 </div>
6768 </div>
6773 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.
6775 </div>
6776 </body>
6777 </html>