1 .. |(version)| replace:: 1.39
2 .. -*- reStructuredText -*-
8 -------------------------
9 A fast, light, GTK+ IDE
10 -------------------------
12 :Authors: Enrico Tröger,
20 Copyright © 2005 The Geany contributors
22 This document is distributed under the terms of the GNU General Public
23 License as published by the Free Software Foundation; either version 2
24 of the License, or (at your option) any later version. A copy of this
25 license can be found in the file COPYING included with the source code
26 of this program, and also in the chapter `GNU General Public License`_.
40 Geany is a small and lightweight Integrated Development Environment. It
41 was developed to provide a small and fast IDE, which has only a few
42 dependencies on other packages. Another goal was to be as independent
43 as possible from a particular Desktop Environment like KDE or GNOME -
44 Geany only requires the GTK+ runtime libraries.
46 Some basic features of Geany:
50 * Autocompletion of symbols/words
51 * Construct completion/snippets
52 * Auto-closing of XML and HTML tags
54 * Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
58 * Build system to compile and execute your code
59 * Simple project management
67 You can obtain Geany from https://www.geany.org/ or perhaps also from
68 your distribution. For a list of available packages, please see
69 https://www.geany.org/Download/ThirdPartyPackages.
76 Geany is distributed under the terms of the GNU General Public License
77 as published by the Free Software Foundation; either version 2 of
78 the License, or (at your option) any later version. A copy of this
79 license can be found in the file COPYING included with the source
80 code of this program and in the chapter, `GNU General Public License`_.
82 The included Scintilla library (found in the subdirectory
83 ``scintilla/``) has its own license, which can be found in the chapter,
84 `License for Scintilla and SciTE`_.
91 This documentation is available in HTML and text formats.
92 The latest version can always be found at https://www.geany.org/.
94 If you want to contribute to it, see `Contributing to this document`_.
106 You will need the GTK (>= 2.24) libraries and their dependencies
107 (Pango, GLib and ATK). Your distro should provide packages for these,
108 usually installed by default. For Windows, you can download an installer
109 from the website which bundles these libraries.
115 There are many binary packages available. For an up-to-date but maybe
116 incomplete list see https://www.geany.org/Download/ThirdPartyPackages.
122 Compiling Geany is quite easy.
123 To do so, you need the GTK (>= 2.24) libraries and header files.
124 You also need the Pango, GLib and ATK libraries and header files.
125 All these files are available at http://www.gtk.org, but very often
126 your distro will provide development packages to save the trouble of
127 building these yourself.
129 Furthermore you need, of course, a C and C++ compiler. The GNU versions
130 of these tools are recommended.
132 Autotools based build system
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135 To compile Geany yourself, you just need the Make tool, preferably GNU Make.
137 Then run the following commands::
152 The configure script supports several common options, for a detailed
158 You may also want to read the INSTALL file for advanced installation
161 * See also `Compile-time options`_.
163 Dynamic linking loader support and VTE
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
165 In the case that your system lacks dynamic linking loader support, you
166 probably want to pass the option ``--disable-vte`` to the ``configure``
167 script. This prevents compiling Geany with dynamic linking loader
168 support for automatically loading ``libvte.so.4`` if available.
172 If there are any errors during compilation, check your build
173 environment and try to find the error, otherwise contact the mailing
174 list or one the authors. Sometimes you might need to ask for specific
175 help from your distribution.
180 If you want to find Geany's system files after installation you may
181 want to know the installation prefix.
183 Pass the ``--print-prefix`` option to Geany to check this - see
184 `Command line options`_. The first path is the prefix.
186 On Unix-like systems this is commonly ``/usr`` if you installed from
187 a binary package, or ``/usr/local`` if you build from source.
190 Editing system files is not necessary as you should use the
191 per-user configuration files instead, which don't need root
192 permissions. See `Configuration files`_.
202 You can start Geany in the following ways:
204 * From the Desktop Environment menu:
206 Choose in your application menu of your used Desktop Environment:
207 Development --> Geany.
209 At Windows-systems you will find Geany after installation inside
210 the application menu within its special folder.
212 * From the command line:
214 To start Geany from a command line, type the following and press
222 The Geany window is shown in the following figure:
224 .. image:: ./images/main_window.png
226 The workspace has the following parts:
229 * An optional toolbar.
230 * An optional sidebar that can show the following tabs:
232 * Documents - A document list, and
233 * Symbols - A list of symbols in your code.
235 * The main editor window.
236 * An optional message window which can show the following tabs:
238 * Status - A list of status messages.
239 * Compiler - The output of compiling or building programs.
240 * Messages - Results of 'Find Usage', 'Find in Files' and other actions
241 * Scribble - A text scratchpad for any use.
242 * Terminal - An optional terminal window.
246 Most of these can be configured in the `Interface preferences`_, the
247 `View menu`_, or the popup menu for the relevant area.
249 Additional tabs may be added to the sidebar and message window by plugins.
251 The position of the tabs can be selected in the interface preferences.
253 The sizes of the sidebar and message window can be adjusted by
254 dragging the dividers.
259 The sidebar has a right click menu that can control what is visible and
260 has actions specific to the tab (other tabs added by plugins are
261 described by that plugin documentation):
265 * expand/collapse the tree
266 * control sorting order
267 * locate the symbol in documents
269 The symbols tab can also be filtered by typing a string into
270 the entry at the top of the tab. All symbols that contain the entered
271 string as a substring will be shown in the tree. Multiple filters can
272 be separated by a space.
276 * expand/collapse the tree
277 * save to or reload from files
278 * search tree based at selected file
279 * show or hide the document paths
284 ============ ======================= =================================================
285 Short option Long option Function
286 ============ ======================= =================================================
287 *none* +number Set initial line number for the first opened file
288 (same as --line, do not put a space between the + sign
289 and the number). E.g. "geany +7 foo.bar" will open the
290 file foo.bar and place the cursor in line 7.
292 *none* --column Set initial column number for the first opened file.
294 -c dir_name --config=directory_name Use an alternate configuration directory. The default
295 configuration directory is ``~/.config/geany/`` and that
296 is where ``geany.conf`` and other configuration files
299 *none* --ft-names Print a list of Geany's internal filetype names (useful
300 for snippets configuration).
302 -g --generate-tags Generate a global tags file (see
303 `Generating a global tags file`_).
305 -P --no-preprocessing Don't preprocess C/C++ files when generating tags file.
307 -i --new-instance Do not open files in a running instance, force opening
308 a new instance. Only available if Geany was compiled
309 with support for Sockets.
311 -l --line Set initial line number for the first opened file.
313 *none* --list-documents Return a list of open documents in a running Geany
315 This can be used to read the currently opened documents in
316 Geany from an external script or tool. The returned list
317 is separated by newlines (LF) and consists of the full,
318 UTF-8 encoded filenames of the documents.
319 Only available if Geany was compiled with support for
322 -m --no-msgwin Do not show the message window. Use this option if you
323 do not need compiler messages or VTE support.
325 -n --no-ctags Do not load symbol completion and call tip data. Use this
326 option if you do not want to use them.
328 -p --no-plugins Do not load plugins or plugin support.
330 *none* --print-prefix Print installation prefix, the data directory, the lib
331 directory and the locale directory (in that order) to
332 stdout, one line each. This is mainly intended for plugin
333 authors to detect installation paths.
335 -r --read-only Open all files given on the command line in read-only mode.
336 This only applies to files opened explicitly from the command
337 line, so files from previous sessions or project files are
340 -s --no-session Do not load the previous session's files.
342 -t --no-terminal Do not load terminal support. Use this option if you do
343 not want to load the virtual terminal emulator widget
344 at startup. If you do not have ``libvte.so.4`` installed,
345 then terminal-support is automatically disabled. Only
346 available if Geany was compiled with support for VTE.
348 *none* --socket-file Use this socket filename for communication with a
349 running Geany instance. This can be used with the following
350 command to execute Geany on the current workspace::
352 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
354 *none* --vte-lib Specify explicitly the path including filename or only
355 the filename to the VTE library, e.g.
356 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
357 only needed when the auto-detection does not work. Only
358 available if Geany was compiled with support for VTE.
360 -v --verbose Be verbose (print useful status messages).
362 -V --version Show version information and exit.
364 -? --help Show help information and exit.
366 *none* [files ...] Open all given files at startup. This option causes
367 Geany to ignore loading stored files from the last
368 session (if enabled).
369 Geany also recognizes line and column information when
370 appended to the filename with colons, e.g.
371 "geany foo.bar:10:5" will open the file foo.bar and
372 place the cursor in line 10 at column 5.
374 Projects can also be opened but a project file (\*.geany)
375 must be the first non-option argument. All additionally
376 given files are ignored.
377 ============ ======================= =================================================
379 You can also pass line number and column number information, e.g.::
381 geany some_file.foo:55:4
383 Geany supports all generic GTK options, a list is available on the
395 At startup, Geany loads all files from the last time Geany was
396 launched. You can disable this feature in the preferences dialog
397 (see `General Startup preferences`_).
399 You can start several instances of Geany, but only the first will
400 load files from the last session. In the subsequent instances, you
401 can find these files in the file menu under the "Recent files" item.
402 By default this contains the last 10 recently opened files. You can
403 change the number of recently opened files in the preferences dialog.
405 To run a second instance of Geany, do not specify any filenames on
406 the command-line, or disable opening files in a running instance
407 using the appropriate command line option.
410 Opening files from the command-line in a running instance
411 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
413 Geany detects if there is an instance of itself already running and opens files
414 from the command-line in that instance. So, Geany can
415 be used to view and edit files by opening them from other programs
416 such as a file manager.
418 You can also pass line number and column number information, e.g.::
420 geany some_file.foo:55:4
422 This would open the file ``some_file.foo`` with the cursor on line 55,
425 If you do not like this for some reason, you can disable using the first
426 instance by using the appropriate command line option -- see the section
427 called `Command line options`_.
430 Virtual terminal emulator widget (VTE)
431 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
433 If you have installed ``libvte.so`` on your system, it is loaded
434 automatically by Geany, and you will have a terminal widget in the
435 notebook at the bottom.
437 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
438 will not be loaded. So there is no need to install the package containing
439 this file in order to run Geany. Additionally, you can disable the use
440 of the terminal widget by command line option, for more information
441 see the section called `Command line options`_.
443 You can use this terminal (from now on called VTE) much as you would
444 a terminal program like xterm. There is basic clipboard support. You
445 can paste the contents of the clipboard by pressing the right mouse
446 button to open the popup menu, and choosing Paste. To copy text from
447 the VTE, just select the desired text and then press the right mouse
448 button and choose Copy from the popup menu. On systems running the
449 X Window System you can paste the last selected text by pressing the
450 middle mouse button in the VTE (on 2-button mice, the middle button
451 can often be simulated by pressing both mouse buttons together).
453 In the preferences dialog you can specify a shell which should be
454 started in the VTE. To make the specified shell a login shell just
455 use the appropriate command line options for the shell. These options
456 should be found in the manual page of the shell. For zsh and bash
457 you can use the argument ``--login``.
460 Geany tries to load ``libvte.so``. If this fails, it tries to load
461 some other filenames. If this fails too, you should check whether you
462 installed libvte correctly. Again note, Geany will run without this
465 It could be, that the library is called something else than
466 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
467 please set a link to the correct file (as root)::
469 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
471 Obviously, you have to adjust the paths and set X to the number of your
474 You can also specify the filename of the VTE library to use on the command
475 line (see the section called `Command line options`_) or at compile time
476 by specifying the command line option ``--with-vte-module-path`` to
480 Customizing Geany's appearance using GTK+ CSS
481 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
483 To override GTK+ CSS styles, you can use traditional mechanisms or you
484 can create a file named ``geany.css`` in the user configuration directory
485 (usually ``~/.config/geany``) which will be loaded after other CSS styles
486 are applied to allow overriding the default styles.
488 Geany offers a number of CSS IDs which can be used to taylor its
489 appearance. Among the more interesting include:
491 * ``geany-compiler-context`` - the style used for build command output surrounding errors
492 * ``geany-compiler-error`` - the style used for build command errors
493 * ``geany-compiler-message`` - the style other output encountered while running build command
494 * ``geany-document-status-changed`` - the style for document tab labels when the document is changed
495 * ``geany-document-status-disk-changed`` - the style for document tab labels when the file on disk has changed
496 * ``geany-document-status-readyonly``` - the style for document tab labels when the document is read-only
497 * ``geany-search-entry-no-match`` - the style of find/replace dialog entries when no match is found
498 * ``geany-terminal-dirty`` - the style for the message window Terminal tab label when the terminal output has changed.
504 Switching between documents
505 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
507 The documents list and the editor tabs are two different ways
508 to switch between documents using the mouse. When you hit the key
509 combination to move between tabs, the order is determined by the tab
510 order. It is not alphabetical as shown in the documents list
511 (regardless of whether or not editor tabs are visible).
513 See the `Notebook tab keybindings`_ section for useful
514 shortcuts including for Most-Recently-Used document switching.
518 The `Document->Clone` menu item copies the current document's text,
519 cursor position and properties into a new untitled document. If
520 there is a selection, only the selected text is copied. This can be
521 useful when making temporary copies of text or for creating
522 documents with similar or identical contents.
524 Automatic filename insertion on `Save As...`
525 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
526 If a document is saved via `Document->Save As...` then the filename is
527 automatically inserted into the comment header replacing text like
528 `untitled.ext` in the first 3 lines of the file. E.g. if a new ``.c``
529 file is created using `File->New (with Template)` then the text `untitled.c`
530 in line 2 would be replaced with the choosen file name on `Save As...`
531 (this example assumes the default file templates being used).
534 Character sets and Unicode Byte-Order-Mark (BOM)
535 ------------------------------------------------
541 Geany provides support for detecting and converting character sets. So
542 you can open and save files in different character sets, and even
543 convert a file from one character set to another. To do this,
544 Geany uses the character conversion capabilities of the GLib library.
546 Only text files are supported, i.e. opening files which contain
547 NULL-bytes may fail. Geany will try to open the file anyway but it is
548 likely that the file will be truncated because it can only be read up
549 to the first occurrence of a NULL-byte. All characters after this
550 position are lost and are not written when you save the file.
552 Geany tries to detect the encoding of a file while opening it, but
553 auto-detecting the encoding of a file is not easy and sometimes an
554 encoding might not be detected correctly. In this case you have to
555 set the encoding of the file manually in order to display it
556 correctly. You can this in the file open dialog by selecting an
557 encoding in the drop down box or by reloading the file with the
558 file menu item "Reload as". The auto-detection works well for most
559 encodings but there are also some encodings where it is known that
560 auto-detection has problems.
562 There are different ways to set different encodings in Geany:
564 * Using the file open dialog
566 This opens the file with the encoding specified in the encoding drop
567 down box. If the encoding is set to "Detect from file" auto-detection
568 will be used. If the encoding is set to "Without encoding (None)" the
569 file will be opened without any character conversion and Geany will
570 not try to auto-detect the encoding (see below for more information).
572 * Using the "Reload as" menu item
574 This item reloads the current file with the specified encoding. It can
575 help if you opened a file and found out that the wrong encoding was used.
577 * Using the "Set encoding" menu item
579 Contrary to the above two options, this will not change or reload
580 the current file unless you save it. It is useful when you want to
581 change the encoding of the file.
583 * Specifying the encoding in the file itself
585 As mentioned above, auto-detecting the encoding of a file may fail on
586 some encodings. If you know that Geany doesn't open a certain file,
587 you can add the specification line, described in the next section,
588 to the beginning of the file to force Geany to use a specific
589 encoding when opening the file.
592 In-file encoding specification
593 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
595 Geany detects meta tags of HTML files which contain charset information
598 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
600 and the specified charset is used when opening the file. This is useful if the
601 encoding of the file cannot be detected properly.
602 For non-HTML files you can also define a line like::
604 /* geany_encoding=ISO-8859-15 */
608 # geany_encoding=ISO-8859-15 #
610 to force an encoding to be used. The #, /\* and \*/ are examples
611 of filetype-specific comment characters. It doesn't matter which
612 characters are around the string " geany_encoding=ISO-8859-15 " as long
613 as there is at least one whitespace character before and after this
614 string. Whitespace characters are in this case a space or tab character.
615 An example to use this could be you have a file with ISO-8859-15
616 encoding but Geany constantly detects the file encoding as ISO-8859-1.
617 Then you simply add such a line to the file and Geany will open it
618 correctly the next time.
620 Since Geany 0.15 you can also use lines which match the
621 regular expression used to find the encoding string:
622 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
625 These specifications must be in the first 512 bytes of the file.
626 Anything after the first 512 bytes will not be recognized.
630 # encoding = ISO-8859-15
634 # coding: ISO-8859-15
636 Special encoding "None"
637 ^^^^^^^^^^^^^^^^^^^^^^^
639 There is a special encoding "None" which uses no
640 encoding. It is useful when you know that Geany cannot auto-detect
641 the encoding of a file and it is not displayed correctly. Especially
642 when the file contains NULL-bytes this can be useful to skip auto
643 detection and open the file properly at least until the occurrence
644 of the first NULL-byte. Using this encoding opens the file as it is
645 without any character conversion.
648 Unicode Byte-Order-Mark (BOM)
649 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
651 Furthermore, Geany detects a Unicode Byte Order Mark (see
652 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
653 this feature is only available if the opened file is in a Unicode
654 encoding. The Byte Order Mark helps to detect the encoding of a file,
655 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
656 using a Byte Order Mark could cause some problems for programs not
657 expecting it, e.g. the compiler gcc stops
658 with stray errors, PHP does not parse a script containing a BOM and
659 script files starting with a she-bang maybe cannot be started. In the
660 status bar you can easily see whether the file starts with a BOM or
663 If you want to set a BOM for a file or if you want to remove it
664 from a file, just use the document menu and toggle the checkbox.
667 If you are unsure what a BOM is or if you do not understand where
668 to use it, then it is probably not important for you and you can
680 Geany provides basic code folding support. Folding means the ability to
681 show and hide parts of the text in the current file. You can hide
682 unimportant code sections and concentrate on the parts you are working on
683 and later you can show hidden sections again. In the editor window there is
684 a small grey margin on the left side with [+] and [-] symbols which
685 show hidden parts and hide parts of the file respectively. By
686 clicking on these icons you can simply show and hide sections which are
687 marked by vertical lines within this margin. For many filetypes nested
688 folding is supported, so there may be several fold points within other
692 You can customize the folding icon and line styles - see the
693 filetypes.common `Folding Settings`_.
695 If you don't like it or don't need it at all, you can simply disable
696 folding support completely in the preferences dialog.
698 The folding behaviour can be changed with the "Fold/Unfold all children of
699 a fold point" option in the preference dialog. If activated, Geany will
700 unfold all nested fold points below the current one if they are already
701 folded (when clicking on a [+] symbol).
702 When clicking on a [-] symbol, Geany will fold all nested fold points
703 below the current one if they are unfolded.
705 This option can be inverted by pressing the Shift
706 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
707 children of a fold point" option is enabled, pressing Shift will disable
708 it for this click and vice versa.
711 Column mode editing (rectangular selections)
712 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
714 There is basic support for column mode editing. To use it, create a
715 rectangular selection by holding down the Control and Shift keys
716 (or Alt and Shift on Windows) while selecting some text.
717 Once a rectangular selection exists you can start editing the text within
718 this selection and the modifications will be done for every line in the
721 It is also possible to create a zero-column selection - this is
722 useful to insert text on multiple lines.
724 Drag and drop of text
725 ^^^^^^^^^^^^^^^^^^^^^
727 If you drag selected text in the editor widget of Geany the text is
728 moved to the position where the mouse pointer is when releasing the
729 mouse button. Holding Control when releasing the mouse button will
730 copy the text instead. This behaviour was changed in Geany 0.11 -
731 before the selected text was copied to the new position.
737 Geany allows each document to indent either with a tab character,
738 multiple spaces or a combination of both.
740 The *Tabs* setting indents with one tab character per indent level, and
741 displays tabs as the indent width.
743 The *Spaces* setting indents with the number of spaces set in the indent
744 width for each level.
746 The *Tabs and Spaces* setting indents with spaces as above, then converts
747 as many spaces as it can to tab characters at the rate of one tab for
748 each multiple of the `Various preference` setting
749 *indent_hard_tab_width* (default 8) and displays tabs as the
750 *indent_hard_tab_width* value.
752 The default indent settings are set in `Editor Indentation
753 preferences`_ (see the link for more information).
755 The default settings can be overridden per-document using the
756 Document menu. They can also be overridden by projects - see
757 `Project management`_.
759 The indent mode for the current document is shown on the status bar
763 Indent with Tab characters.
767 Indent with tabs and spaces, depending on how much indentation is
770 Applying new indentation settings
771 `````````````````````````````````
772 After changing the default settings you may wish to apply the new
773 settings to every document in the current session. To do this use the
774 *Project->Apply Default Indentation* menu item.
776 Detecting indent type
777 `````````````````````
778 The *Detect from file* indentation preference can be used to
779 scan each file as it's opened and set the indent type based on
780 how many lines start with a tab vs. 2 or more spaces.
786 When enabled, auto-indentation happens when pressing *Enter* in the
787 Editor. It adds a certain amount of indentation to the new line so the
788 user doesn't always have to indent each line manually.
790 Geany has four types of auto-indentation:
793 Disables auto-indentation completely.
795 Adds the same amount of whitespace on a new line as on the previous line.
796 For the *Tabs* and the *Spaces* indent types the indentation will use the
797 same combination of characters as the previous line. The
798 *Tabs and Spaces* indentation type converts as explained above.
800 Does the same as *Basic* but also indents a new line after an opening
801 brace '{', and de-indents when typing a closing brace '}'. For Python,
802 a new line will be indented after typing ':' at the end of the
805 Similar to *Current chars* but the closing brace will be aligned to
806 match the indentation of the line with the opening brace. This
807 requires the filetype to be one where Geany knows that the Scintilla
808 lexer understands matching braces (C, C++, D, HTML, Pascal, Bash,
811 There is also XML-tag auto-indentation. This is enabled when the
812 mode is more than just Basic, and is also controlled by a filetype
813 setting - see `xml_indent_tags`_.
819 Geany provides a handy bookmarking feature that lets you mark one
820 or more lines in a document, and return the cursor to them using a
823 To place a mark on a line, either left-mouse-click in the left margin
824 of the editor window, or else use Ctrl-m. This will
825 produce a small green plus symbol in the margin. You can have as many
826 marks in a document as you like. Click again (or use Ctrl-m again)
827 to remove the bookmark. To remove all the marks in a given document,
828 use "Remove Markers" in the Document menu.
830 To navigate down your document, jumping from one mark to the next,
831 use Ctrl-. (control period). To go in the opposite direction on
832 the page, use Ctrl-, (control comma). Using the bookmarking feature
833 together with the commands to switch from one editor tab to another
834 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
835 navigate around multiple files.
838 Code navigation history
839 ^^^^^^^^^^^^^^^^^^^^^^^
841 To ease navigation in source files and especially between
842 different files, Geany lets you jump between different navigation
843 points. Currently, this works for the following:
845 * `Go to symbol declaration`_
846 * `Go to symbol definition`_
851 When using one of these actions, Geany remembers your current position
852 and jumps to the new one. If you decide to go back to your previous
853 position in the file, just use "Navigate back a location". To
854 get back to the new position again, just use "Navigate forward a
855 location". This makes it easier to navigate in e.g. foreign code
856 and between different files.
859 Sending text through custom commands
860 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
862 You can define several custom commands in Geany and send the current
863 selection to one of these commands using the *Edit->Format->Send
864 Selection to* menu or keybindings. The output of the command will be
865 used to replace the current selection. This makes it possible to use
866 text formatting tools with Geany in a general way.
868 The selected text will be sent to the standard input of the executed
869 command, so the command should be able to read from it and it should
870 print all results to its standard output which will be read by
871 Geany. To help finding errors in executing the command, the output
872 of the program's standard error will be printed on Geany's standard
875 If there is no selection, the whole current line is used instead.
877 To add a custom command, use the *Send Selection to->Set Custom
878 Commands* menu item. Click on *Add* to get a new item and type the
879 command. You can also specify some command line options. Empty
880 commands are not saved.
882 Normal shell quoting is supported, so you can do things like:
884 * ``sed 's/\./(dot)/g'``
886 The above example would normally be done with the `Replace all`_
887 function, but it can be handy to have common commands already set up.
889 Note that the command is not run in a shell, so if you want to use
890 shell features like pipes and command chains, you need to explicitly
891 launch the shell and pass it your command:
893 * ``sh -c 'sort | uniq'``
899 You can execute the context action command on the current word at the
900 cursor position or the available selection. This word or selection
901 can be used as an argument to the command.
902 The context action is invoked by a menu entry in the popup menu of the
903 editor and also a keyboard shortcut (see the section called
906 The command can be specified in the preferences dialog and also for
907 each filetype (see "context_action_cmd" in the section called
908 `Filetype configuration`_). When the context action is invoked, the filetype
909 specific command is used if available, otherwise the command
910 specified in the preferences dialog is executed.
912 The current word or selection can be referred with the wildcard "%s"
913 in the command, it will be replaced by the current word or
914 selection before the command is executed.
916 For example a context action can be used to open API documentation
917 in a browser window, the command to open the PHP API documentation
920 firefox "http://www.php.net/%s"
922 when executing the command, the %s is substituted by the word near
923 the cursor position or by the current selection. If the cursor is at
924 the word "echo", a browser window will open(assumed your browser is
925 called firefox) and it will open the address: http://www.php.net/echo.
931 Geany can offer a list of possible completions for symbols defined in the
932 tags files and for all words in open documents.
934 The autocompletion list for symbols is presented when the first few
935 characters of the symbol are typed (configurable, see `Editor Completions
936 preferences`_, default 4) or when the *Complete word*
937 keybinding is pressed (configurable, see `Editor keybindings`_,
940 When the defined keybinding is typed and the *Autocomplete all words in
941 document* preference (in `Editor Completions preferences`_)
942 is selected then the autocompletion list will show all matching words
943 in the document, if there are no matching symbols.
945 If you don't want to use autocompletion it can be dismissed until
946 the next symbol by pressing Escape. The autocompletion list is updated
947 as more characters are typed so that it only shows completions that start
948 with the characters typed so far. If no symbols begin with the sequence,
949 the autocompletion window is closed.
951 The up and down arrows will move the selected item. The highlighted
952 item on the autocompletion list can be chosen from the list by pressing
953 Enter/Return. You can also double-click to select an item. The sequence
954 will be completed to match the chosen item, and if the *Drop rest of
955 word on completion* preference is set (in `Editor Completions
956 preferences`_) then any characters after the cursor that match
957 a symbol or word are deleted.
961 By default, pressing Tab will complete the selected item by word part;
962 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
967 * gtk_combo_box_<e><TAB>
968 * gtk_combo_box_entry_<s><ENTER>
969 * gtk_combo_box_entry_set_text_column
971 The key combination can be changed from Tab - See `Editor keybindings`_.
972 If you clear/change the key combination for word part completion, Tab
973 will complete the whole word instead, like Enter.
985 When you type ``foo.`` it will show an autocompletion list with 'i' and
988 It only works for languages that set parent scope names for e.g. struct
989 members. Currently this means C-like languages. The C parser only
990 parses global scopes, so this won't work for structs or objects declared
994 User-definable snippets
995 ^^^^^^^^^^^^^^^^^^^^^^^
997 Snippets are small strings or code constructs which can be replaced or
998 completed to a more complex string. So you can save a lot of time when
999 typing common strings and letting Geany do the work for you.
1000 To know what to complete or replace Geany reads a configuration file
1001 called ``snippets.conf`` at startup.
1003 Maybe you need to often type your name, so define a snippet like this::
1006 myname=Enrico Tröger
1008 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
1009 with "Enrico Tröger". The key to start autocompletion can be changed
1010 in the preferences dialog, by default it is TAB. The corresponding keybinding
1011 is called `Complete snippet`.
1015 You can override the default snippets using the user
1016 ``snippets.conf`` file. Use the *Tools->Configuration
1017 Files->snippets.conf* menu item. See also `Configuration file paths`_.
1019 This adds the default settings to the user file if the file doesn't
1020 exist. Alternatively the file can be created manually, adding only
1021 the settings you want to change. All missing settings will be read
1022 from the system snippets file.
1026 The file ``snippets.conf`` contains sections defining snippets that
1027 are available for particular filetypes and in general.
1029 The two sections "Default" and "Special" apply to all filetypes.
1030 "Default" contains all snippets which are available for every
1031 filetype and "Special" contains snippets which can only be used in
1032 other snippets. So you can define often used parts of snippets and
1033 just use the special snippet as a placeholder (see the
1034 ``snippets.conf`` for details).
1036 You can define sections with the name of a filetype eg "C++". The
1037 snippets in that section are only available for use in files with that
1038 filetype. Snippets in filetype sections will hide snippets with the
1039 same name in the "Default" section when used in a file of that
1042 **Substitution sequences for snippets**
1044 To define snippets you can use several special character sequences which
1045 will be replaced when using the snippet:
1047 ================ =========================================================
1048 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1049 char(s): LF, CR/LF, or CR).
1051 \\t or %ws% Insert an indentation step, it will be replaced according
1052 to the current document's indent mode.
1054 \\s \\s to force whitespace at beginning or end of a value
1055 ('key= value' won't work, use 'key=\\svalue')
1057 %cursor% Place the cursor at this position after completion has
1058 been done. You can define multiple %cursor% wildcards
1059 and use the keybinding `Move cursor in snippet` to jump
1060 to the next defined cursor position in the completed
1063 %...% "..." means the name of a key in the "Special" section.
1064 If you have defined a key "brace_open" in the "Special"
1065 section you can use %brace_open% in any other snippet.
1066 ================ =========================================================
1068 Snippet names must not contain spaces otherwise they won't
1069 work correctly. But beside that you can define almost any
1070 string as a snippet and use it later in Geany. It is not limited
1071 to existing constructs of certain programming languages(like ``if``,
1072 ``for``, ``switch``). Define whatever you need.
1074 **Template wildcards**
1076 Since Geany 0.15 you can also use most of the available templates wildcards
1077 listed in `Template wildcards`_. All wildcards which are listed as
1078 `available in snippets` can be used. For instance to improve the above example::
1081 myname=My name is {developer}
1082 mysystem=My system: {command:uname -a}
1084 this will replace ``myname`` with "My name is " and the value of the template
1085 preference ``developer``.
1089 You can change the way Geany recognizes the word to complete,
1090 that is how the start and end of a word is recognised when the
1091 snippet completion is requested. The section "Special" may
1092 contain a key "wordchars" which lists all characters a string may contain
1093 to be recognized as a word for completion. Leave it commented to use
1094 default characters or define it to add or remove characters to fit your
1100 Normally you would type the snippet name and press Tab. However, you
1101 can define keybindings for snippets under the *Keybindings* group in
1106 block_cursor=<Ctrl>8
1109 Snippet keybindings may be overridden by Geany's configurable
1113 Inserting Unicode characters
1114 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1116 You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1117 Ctrl-Shift, type some hex digits representing the code point for the character
1118 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1119 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1120 insertion is completed, but the typed character is also entered. In the case
1121 of Enter/Return, it is a newline, as you might expect.
1124 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1125 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1126 or restart Geany. Note that it works slightly differently from other GTK
1127 applications, in that you'll need to continue to hold down the Ctrl and Shift
1128 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1131 Inserting color values
1132 ^^^^^^^^^^^^^^^^^^^^^^
1134 You can insert a color value by selecting *Tools->Color Chooser* from the menu.
1135 A dialog appears to select the wanted color. If the cursor is placed inside a
1136 *#RRGGBB* format color value then the dialog will show that color after opening.
1137 On clicking on *Apply* or *Select* the code for the chosen color will be inserted
1138 in the format *#RRGGBB*. If text is selected, then it will be replaced with the
1139 color code on the first click on *Apply* or *Select*. If no text is selected or
1140 on subsequent clicks the color code is inserted at the current cursor position.
1143 Search, replace and go to
1144 -------------------------
1146 This section describes search-related commands from the Search menu
1147 and the editor window's popup menu:
1154 * Go to symbol definition
1155 * Go to symbol declaration
1158 See also `Search`_ preferences.
1162 There are also two toolbar entries:
1167 There are keybindings to focus each of these - see `Focus
1168 keybindings`_. Pressing Escape will then focus the editor.
1172 The quickest way to find some text is to use the search bar entry in
1173 the toolbar. This performs a case-insensitive search in the current
1174 document whilst you type. Pressing Enter will search again, and pressing
1175 Shift-Enter will search backwards.
1180 The Find dialog is used for finding text in one or more open documents.
1182 .. image:: ./images/find_dialog.png
1188 The syntax for the *Use regular expressions* option is shown in
1189 `Regular expressions`_.
1192 *Use escape sequences* is implied for regular expressions.
1194 The *Use multi-line matching* option enables multi-line regular
1195 expressions instead of single-line ones. See `Regular expressions`_ for
1196 more details on the differences between the two modes.
1198 The *Use escape sequences* option will transform any escaped characters
1199 into their UTF-8 equivalent. For example, \\t will be transformed into
1200 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1201 (Unicode characters).
1207 To find all matches, click on the Find All expander. This will reveal
1214 Find All In Document will show a list of matching lines in the
1215 current document in the Messages tab of the Message Window. *Find All
1216 In Session* does the same for all open documents.
1218 Mark will highlight all matches in the current document with a
1219 colored box. These markers can be removed by selecting the
1220 Remove Markers command from the Document menu.
1223 Change font in search dialog text fields
1224 ````````````````````````````````````````
1226 All search related dialogs use a Monospace font for the text input fields to
1227 increase the readability of input text. This is useful when you are
1228 typing input such as regular expressions with spaces, periods and commas which
1229 might be hard to read with a proportional font.
1231 If you want to change the font, you can do this easily by using the following
1232 custom CSS snippet, see `Customizing Geany's appearance using GTK+ CSS`_::
1234 #GeanyDialogSearch GtkEntry /* GTK < 3.20 */,
1235 #GeanyDialogSearch entry /* GTK >= 3.20 */ {
1236 font: 8pt monospace;
1242 The *Find Next/Previous Selection* commands perform a search for the
1243 current selected text. If nothing is selected, by default the current
1244 word is used instead. This can be customized by the
1245 *find_selection_type* preference - see `Various preferences`_.
1247 ===== =============================================
1248 Value *find_selection_type* behaviour
1249 ===== =============================================
1250 0 Use the current word (default).
1251 1 Try the X selection first, then current word.
1252 2 Repeat last search.
1253 ===== =============================================
1259 *Find Usage* searches all open files. It is similar to the *Find All In
1260 Session* option in the Find dialog.
1262 If there is a selection, then it is used as the search text; otherwise
1263 the current word is used. The current word is either taken from the
1264 word nearest the edit cursor, or the word underneath the popup menu
1265 click position when the popup menu is used. The search results are
1266 shown in the Messages tab of the Message Window.
1269 You can also use Find Usage for symbol list items from the popup
1276 *Find in Files* is a more powerful version of *Find Usage* that searches
1277 all files in a certain directory using the Grep tool. The Grep tool
1278 must be correctly set in Preferences to the path of the system's Grep
1279 utility. GNU Grep is recommended (see note below).
1281 .. image:: ./images/find_in_files_dialog.png
1283 The *Search* field is initially set to the current word in the editor
1284 (depending on `Search`_ preferences).
1286 The *Files* setting allows to choose which files are included in the
1287 search, depending on the mode:
1290 Search in all files;
1292 Use the current project's patterns, see `Project properties`_;
1294 Use custom patterns.
1296 Both project and custom patterns use a glob-style syntax, each
1297 pattern separated by a space. To search all ``.c`` and ``.h`` files,
1299 Note that an empty pattern list searches in all files rather
1302 The *Directory* field is initially set to the current document's directory,
1303 unless this field has already been edited and the current document has
1304 not changed. Otherwise, the current document's directory is prepended to
1305 the drop-down history. This can be disabled - see `Search`_ preferences.
1307 The *Encoding* field can be used to define the encoding of the files
1308 to be searched. The entered search text is converted to the chosen encoding
1309 and the search results are converted back to UTF-8.
1311 The *Extra options* field is used to pass any additional arguments to
1315 The *Files* setting uses ``--include=`` when searching recursively,
1316 *Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
1317 not work with other Grep implementations.
1320 Filtering out version control files
1321 ```````````````````````````````````
1323 When using the *Recurse in subfolders* option with a directory that's
1324 under version control, you can set the *Extra options* field to filter
1325 out version control files.
1327 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1328 argument to filter out CVS and hidden directories like ``.svn``.
1330 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1332 If you have an older Grep, you can try using the ``--exclude`` flag
1333 to filter out filenames.
1335 SVN Example: ``--exclude=*.svn-base``
1337 The --exclude argument only matches the file name part, not the path.
1343 The Replace dialog is used for replacing text in one or more open
1346 .. image:: ./images/replace_dialog.png
1348 The Replace dialog has the same options for matching text as the Find
1349 dialog. See the section `Matching options`_.
1351 The *Use regular expressions* option allows regular expressions to
1352 be used in the search string and back references in the replacement
1353 text -- see the entry for '\\n' in `Regular expressions`_.
1358 To replace several matches, click on the *Replace All* expander. This
1359 will reveal several options:
1365 *Replace All In Document* will replace all matching text in the
1366 current document. *Replace All In Session* does the same for all open
1367 documents. *Replace All In Selection* will replace all matching text
1368 in the current selection of the current document.
1371 Go to symbol definition
1372 ^^^^^^^^^^^^^^^^^^^^^^^
1374 If the current word or selection is the name of a symbol definition
1375 (e.g. a function name) and the file containing the symbol definition is
1376 open, this command will switch to that file and go to the
1377 corresponding line number. The current word is either the word
1378 nearest the edit cursor, or the word underneath the popup menu click
1379 position when the popup menu is used.
1381 If there are more symbols with the same name to which the goto can be performed,
1382 a pop up is shown with a list of all the occurrences. After selecting a symbol
1383 from the list Geany jumps to the corresponding symbol location. Geany tries to
1384 suggest the nearest symbol (symbol from the current file, other open documents
1385 or current directory) as the best candidate for the goto and places this symbol
1386 at the beginning of the list typed in boldface.
1389 If the corresponding symbol is on the current line, Geany will first
1390 look for a symbol declaration instead, as this is more useful.
1391 Likewise *Go to symbol declaration* will search for a symbol definition
1392 first in this case also.
1395 Go to symbol declaration
1396 ^^^^^^^^^^^^^^^^^^^^^^^^
1398 Like *Go to symbol definition*, but for a forward declaration such as a
1399 C function prototype or ``extern`` declaration instead of a function
1406 Go to a particular line number in the current file.
1412 You can use regular expressions in the Find and Replace dialogs
1413 by selecting the *Use regular expressions* check box (see `Matching
1414 options`_). The syntax is Perl compatible. Basic syntax is described
1415 in the table below. For full details, see
1416 https://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
1418 By default regular expressions are matched on a line-by-line basis.
1419 If you are interested in multi-line regular expressions, matched against
1420 the whole buffer at once, see the section `Multi-line regular expressions`_
1424 1. The *Use escape sequences* dialog option always applies for regular
1426 2. Searching backwards with regular expressions is not supported.
1427 3. The *Use multi-line matching* dialog option to select single or
1428 multi-line matching.
1430 **In a regular expression, the following characters are interpreted:**
1432 ======= ============================================================
1433 . Matches any character.
1435 ( This marks the start of a region for tagging a match.
1437 ) This marks the end of a tagged region.
1439 \\n Where n is 1 through 9 refers to the first through ninth tagged
1440 region when searching or replacing.
1442 Searching for (Wiki)\\1 matches WikiWiki.
1444 If the search string was Fred([1-9])XXX and the
1445 replace string was Sam\\1YYY, when applied to Fred2XXX this
1446 would generate Sam2YYY.
1448 \\0 When replacing, the whole matching text.
1450 \\b This matches a word boundary.
1452 \\c A backslash followed by d, D, s, S, w or W, becomes a
1453 character class (both inside and outside sets []).
1456 * D: any char except decimal digits
1457 * s: whitespace (space, \\t \\n \\r \\f \\v)
1458 * S: any char except whitespace (see above)
1459 * w: alphanumeric & underscore
1460 * W: any char except alphanumeric & underscore
1462 \\x This allows you to use a character x that would otherwise have
1463 a special meaning. For example, \\[ would be interpreted as [
1464 and not as the start of a character set. Use \\\\ for a literal
1467 [...] Matches one of the characters in the set. If the first
1468 character in the set is ^, it matches the characters NOT in
1469 the set, i.e. complements the set. A shorthand S-E (start
1470 dash end) is used to specify a set of characters S up to E,
1473 The special characters ] and - have no special
1474 meaning if they appear first in the set. - can also be last
1475 in the set. To include both, put ] first: []A-Z-].
1479 []|-] matches these 3 chars
1480 []-|] matches from ] to | chars
1481 [a-z] any lowercase alpha
1482 [^]-] any char except - and ]
1483 [^A-Z] any char except uppercase alpha
1486 ^ This matches the start of a line (unless used inside a set, see
1489 $ This matches the end of a line.
1491 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1492 Saam, Saaam and so on.
1494 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1495 Saam, Saaam and so on.
1497 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1498 ======= ============================================================
1501 This table is adapted from Scintilla and SciTE documentation,
1502 distributed under the `License for Scintilla and SciTE`_.
1505 Multi-line regular expressions
1506 ``````````````````````````````
1509 The *Use multi-line matching* dialog option enables multi-line
1510 regular expressions.
1512 Multi-line regular expressions work just like single-line ones but a
1513 match can span several lines.
1515 While the syntax is the same, a few practical differences applies:
1517 ======= ============================================================
1518 . Matches any character but newlines. This behavior can be changed
1519 to also match newlines using the (?s) option, see
1520 https://www.geany.org/manual/gtk/glib/glib-regex-syntax.html#idp5671632
1522 [^...] A negative range (see above) *will* match newlines if they are
1523 not explicitly listed in that negative range. For example, range
1524 [^a-z] will match newlines, while range [^a-z\\r\\n] won't.
1525 While this is the expected behavior, it can lead to tricky
1526 problems if one doesn't think about it when writing an expression.
1527 ======= ============================================================
1532 The View menu allows various elements of the main window to be shown
1533 or hidden, and also provides various display-related editor options.
1535 Color schemes dialog
1536 ^^^^^^^^^^^^^^^^^^^^
1537 The Color Schemes dialog is available under the *View->Change Color Scheme*
1538 menu item. It lists various color schemes for editor highlighting
1539 styles, including the default scheme first. Other items are available
1540 based on what color scheme files Geany found at startup.
1542 Color scheme files are read from the `Configuration file paths`_ under
1543 the ``colorschemes`` subdirectory. They should have the extension
1544 ``.conf``. The default color scheme
1545 is read from ``filetypes.common``.
1547 The `[named_styles] section`_ and `[named_colors] section`_ are the
1548 same as for ``filetypes.common``.
1550 The ``[theme_info]`` section can contain information about the
1551 theme. The ``name`` and ``description`` keys are read to set the
1552 menu item text and tooltip, respectively. These keys can have
1553 translations, e.g.::
1559 Symbols and tags files
1560 ----------------------
1562 Upon opening, files of supported filetypes are parsed to extract the symbol
1563 information (aka "workspace symbols"). You can also have Geany automatically
1564 load external files containing the symbol information (aka "global
1565 tags files") upon startup, or manually using *Tools --> Load Tags File*.
1567 Geany uses its own tags file format, similar to what ``ctags`` uses
1568 (but is incompatible with ctags). You use Geany to generate global
1569 tags files, as described below.
1575 Each document is parsed for symbols whenever a file is loaded, saved or
1576 modified (see *Symbol list update frequency* preference in the `Editor
1577 Completions preferences`_). These are shown in the Symbol list in the
1578 Sidebar. These symbols are also used for autocompletion and calltips
1579 for all documents open in the current session that have the same filetype.
1581 The *Go to Symbol* commands can be used with all workspace symbols. See
1582 `Go to symbol definition`_.
1588 Global tags files are used to provide symbols for autocompletion and calltips
1589 without having to open the source files containing these symbols. This is intended
1590 for library APIs, as the tags file only has to be updated when you upgrade
1593 You can load a custom global tags file in two ways:
1595 * Using the *Load Tags File* command in the Tools menu.
1596 * By moving or symlinking tags files to the ``tags`` subdirectory of
1597 one of the `configuration file paths`_ before starting Geany.
1599 You can either download these files or generate your own. They have
1604 *lang_ext* is one of the extensions set for the filetype associated
1605 with the tags parser. See the section called `Filetype extensions`_ for
1609 Default global tags files
1610 `````````````````````````
1612 Some global tags files are distributed with Geany and will be loaded
1613 automatically when the corresponding filetype is first used. Currently
1614 this includes global tags files for these languages:
1619 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1624 Global tags file format
1625 ```````````````````````
1627 Global tags files can have three different formats:
1630 * Pipe-separated format
1633 The first line of global tags files should be a comment, introduced
1634 by ``#`` followed by a space and a string like ``format=pipe``,
1635 ``format=ctags`` or ``format=tagmanager`` respectively, these are
1636 case-sensitive. This helps Geany to read the file properly. If this
1637 line is missing, Geany tries to auto-detect the used format but this
1641 The Tagmanager format is a bit more complex and is used for files
1642 created by the ``geany -g`` command. There is one symbol per line.
1643 Different symbol attributes like the return value or the argument list
1644 are separated with different characters indicating the type of the
1645 following argument. This is the more complete and recommended tags file
1648 Pipe-separated format
1649 *********************
1650 The Pipe-separated format is easier to read and write.
1651 There is one symbol per line and different symbol attributes are separated
1652 by the pipe character (``|``). A line looks like::
1654 basename|string|(string path [, string suffix])|
1656 | The first field is the symbol name (usually a function name).
1657 | The second field is the type of the return value.
1658 | The third field is the argument list for this symbol.
1659 | The fourth field is the description for this symbol but
1660 currently unused and should be left empty.
1662 Except for the first field (symbol name), all other field can be left
1663 empty but the pipe separator must appear for them.
1665 You can easily write your own global tags files using this format.
1666 Just save them in your tags directory, as described earlier in the
1667 section `Global tags files`_.
1671 This is the format that ctags generates, and that is used by Vim.
1672 This format is compatible with the format historically used by Vi.
1674 The format is described at http://ctags.sourceforge.net/FORMAT, but
1675 for the full list of existing extensions please refer to ctags.
1676 However, note that Geany may actually only honor a subset of the
1677 existing extensions.
1679 Generating a global tags file
1680 `````````````````````````````
1682 You can generate your own global tags files by parsing a list of
1683 source files. The command is::
1685 geany -g [-P] <Tags File> <File list>
1687 * Tags File filename should be in the format described earlier --
1688 see the section called `Global tags files`_.
1689 * File list is a list of filenames, each with a full path (unless
1690 you are generating C/C++ tags files and have set the CFLAGS environment
1691 variable appropriately).
1692 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1693 to process ``#include`` directives for C/C++ source files. Use this
1694 option if you want to specify each source file on the command-line
1695 instead of using a 'master' header file. Also can be useful if you
1696 don't want to specify the CFLAGS environment variable.
1698 Example for the wxD library for the D programming language::
1700 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1703 Generating C/C++ tags files
1704 ***************************
1705 You may need to first setup the `C ignore.tags`_ file.
1707 For C/C++ tags files gcc is required by default, so that header files
1708 can be preprocessed to include any other headers they depend upon. If
1709 you do not want this, use the ``-P`` option described above.
1711 For preprocessing, the environment variable CFLAGS should be set with
1712 appropriate ``-I/path`` include paths. The following example works with
1713 the bash shell, generating a tags file for the GnomeUI library::
1715 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1716 /usr/include/libgnomeui-2.0/gnome.h
1718 You can adapt this command to use CFLAGS and header files appropriate
1719 for whichever libraries you want.
1722 Generating tags files on Windows
1723 ********************************
1724 This works basically the same as on other platforms::
1726 "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
1732 You can ignore certain symbols for C-based languages if they would lead
1733 to wrong parsing of the code. Use the *Tools->Configuration
1734 Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
1735 See also `Configuration file paths`_.
1737 List all symbol names you want to ignore in this file, separated by spaces
1742 G_GNUC_NULL_TERMINATED
1744 G_GNUC_WARN_UNUSED_RESULT
1747 This will ignore the above macros and will correctly detect 'Foo' as a type
1748 instead of 'BAR' in the following code:
1750 ``struct Foo BAR { int i; };``
1752 In addition, it is possible to specify macro definition similarly to the
1755 <macro>=<definition>
1756 Defines a C preprocessor <macro>. This emulates the behavior of
1757 the corresponding gcc option. All types of macros are supported,
1758 including the ones with parameters and variable arguments.
1759 Stringification, token pasting and recursive macro expansion are
1762 For even more detailed information please read the manual page of
1769 You may adjust Geany's settings using the Edit --> Preferences
1770 dialog. Any changes you make there can be applied by hitting either
1771 the Apply or the OK button. These settings will persist between Geany
1772 sessions. Note that most settings here have descriptive popup bubble
1773 help -- just hover the mouse over the item in question to get help
1776 You may also adjust some View settings (under the View menu) that
1777 persist between Geany sessions. The settings under the Document menu,
1778 however, are only for the current document and revert to defaults
1779 when restarting Geany.
1782 In the paragraphs that follow, the text describing a dialog tab
1783 comes after the screenshot of that tab.
1786 General Startup preferences
1787 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1789 .. image:: ./images/pref_dialog_gen_startup.png
1794 Load files from the last session
1795 On startup, load the same files you had open the last time you
1798 Load virtual terminal support
1799 Load the library for running a terminal in the message window area.
1801 Enable plugin support
1802 Allow plugins to be used in Geany.
1806 Save window position and geometry
1807 Save the current position and size of the main window so next time
1808 you open Geany it's in the same location.
1811 Have a dialog pop up to confirm that you really want to quit Geany.
1817 Path to start in when opening or saving files.
1818 It must be an absolute path.
1821 Path to start in when opening project files.
1824 By default Geany looks in the system installation and the user
1825 configuration - see `Plugins`_. In addition the path entered here will be
1827 Usually you do not need to set an additional path to search for
1828 plugins. It might be useful when Geany is installed on a multi-user machine
1829 and additional plugins are available in a common location for all users.
1830 Leave blank to not set an additional lookup path.
1833 General Miscellaneous preferences
1834 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1836 .. image:: ./images/pref_dialog_gen_misc.png
1841 Beep on errors when compilation has finished
1842 Have the computer make a beeping sound when compilation of your program
1843 has completed or any errors occurred.
1845 Switch status message list at new message
1846 Switch to the status message tab (in the notebook window at the bottom)
1847 once a new status message arrives.
1849 Suppress status messages in the status bar
1850 Remove all messages from the status bar. The messages are still displayed
1851 in the status messages window.
1854 Another option is to use the *Switch to Editor* keybinding - it
1855 reshows the document statistics on the status bar. See `Focus
1858 Use Windows File Open/Save dialogs
1859 Defines whether to use the native Windows File Open/Save dialogs or
1860 whether to use the GTK default dialogs.
1862 Auto-focus widgets (focus follows mouse)
1863 Give the focus automatically to widgets below the mouse cursor.
1864 This works for the main editor widget, the scribble, the toolbar search field
1865 go to line fields and the VTE.
1871 Always wrap search around the document when finding a match.
1873 Hide the Find dialog
1874 Hide the `Find`_ dialog after clicking Find Next/Previous.
1876 Use the current word under the cursor for Find dialogs
1877 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1878 there is no selection. When this option is disabled, the search term last used in the
1879 appropriate Find dialog is used.
1881 Use the current file's directory for Find in Files
1882 When opening the Find in Files dialog, set the directory to search to the directory of the current
1883 active file. When this option is disabled, the directory of the last use of the Find in Files
1884 dialog is used. See `Find in Files`_ for details.
1889 Use project-based session files
1890 Save your current session when closing projects. You will be able to
1891 resume different project sessions, automatically opening the files
1892 you had open previously.
1894 Store project file inside the project base directory
1895 When creating new projects, the default path for the project file contains
1896 the project base path. Without this option enabled, the default project file
1897 path is one level above the project base path.
1898 In either case, you can easily set the final project file path in the
1899 *New Project* dialog. This option provides the more common
1900 defaults automatically for convenience.
1903 Interface preferences
1904 ^^^^^^^^^^^^^^^^^^^^^
1906 .. image:: ./images/pref_dialog_interface_interface.png
1912 Whether to show the sidebar at all.
1915 Show the list of functions, variables, and other information in the
1916 current document you are editing.
1919 Show all the documents you have open currently. This can be used to
1920 change between documents (see `Switching between documents`_) and
1921 to perform some common operations such as saving, closing and reloading.
1924 Whether to place the sidebar on the left or right of the editor window.
1930 Whether to place the message window on the bottom or right of the editor window.
1936 Change the font used to display documents.
1939 Change the font used for the Symbols sidebar tab.
1942 Change the font used for the message window area.
1948 Show the status bar at the bottom of the main window. It gives information about
1949 the file you are editing like the line and column you are on, whether any
1950 modifications were done, the file encoding, the filetype and other information.
1952 Interface Notebook tab preferences
1953 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1955 .. image:: ./images/pref_dialog_interface_notebook.png
1961 Show a notebook tab for all documents so you can switch between them
1962 using the mouse (instead of using the Documents window).
1965 Make each tab show a close button so you can easily close open
1968 Placement of new file tabs
1969 Whether to create a document with its notebook tab to the left or
1970 right of all existing tabs.
1973 Whether to place file tabs next to the current tab
1974 rather than at the edges of the notebook.
1976 Double-clicking hides all additional widgets
1977 Whether to call the View->Toggle All Additional Widgets command
1978 when double-clicking on a notebook tab.
1984 Set the positioning of the editor's notebook tabs to the right,
1985 left, top, or bottom of the editing window.
1988 Set the positioning of the sidebar's notebook tabs to the right,
1989 left, top, or bottom of the sidebar window.
1992 Set the positioning of the message window's notebook tabs to the
1993 right, left, top, or bottom of the message window.
1996 Interface Toolbar preferences
1997 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1999 Affects the main toolbar underneath the menu bar.
2001 .. image:: ./images/pref_dialog_interface_toolbar.png
2007 Whether to show the toolbar.
2009 Append Toolbar to the Menu
2010 Allows to append the toolbar to the main menu bar instead of placing it below.
2011 This is useful to save vertical space.
2014 See `Customizing the toolbar`_.
2020 Select the toolbar icon style to use - either icons and text, just
2022 The choice System default uses whatever icon style is set by GTK.
2025 Select the size of the icons you see (large, small or very small).
2026 The choice System default uses whatever icon size is set by GTK.
2029 Editor Features preferences
2030 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2032 .. image:: ./images/pref_dialog_edit_features.png
2038 Show long lines wrapped around to new display lines.
2043 Whether to move the cursor to the first non-whitespace character
2044 on the line when you hit the home key on your keyboard. Pressing it
2045 again will go to the very start of the line.
2047 Disable Drag and Drop
2048 Do not allow the dragging and dropping of selected text in documents.
2051 Allow groups of lines in a document to be collapsed for easier
2054 Fold/Unfold all children of a fold point
2055 Whether to fold/unfold all child fold points when a parent line
2058 Use indicators to show compile errors
2059 Underline lines with compile errors using red squiggles to indicate
2060 them in the editor area.
2062 Newline strips trailing spaces
2063 Remove any whitespace at the end of the line when you hit the
2064 Enter/Return key. See also `Strip trailing spaces`_. Note
2065 auto indentation is calculated before stripping, so although this
2066 setting will clear a blank line, it will not set the next line
2067 indentation back to zero.
2069 Line breaking column
2070 The editor column number to insert a newline at when Line Breaking
2071 is enabled for the current document.
2073 Comment toggle marker
2074 A string which is added when toggling a line comment in a source file.
2075 It is used to mark the comment as toggled.
2078 Editor Indentation preferences
2079 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2081 .. image:: ./images/pref_dialog_edit_indentation.png
2086 See `Indentation`_ for more information.
2089 The width of a single indent size in spaces. By default the indent
2090 size is equivalent to 4 spaces.
2092 Detect width from file
2093 Try to detect and set the indent width based on file content, when
2097 When Geany inserts indentation, whether to use:
2101 * Tabs and Spaces, depending on how much indentation is on a line
2103 The *Tabs and Spaces* indent type is also known as *Soft tab
2104 support* in some other editors.
2106 Detect type from file
2107 Try to detect and set the indent type based on file content, when
2111 The type of auto-indentation you wish to use after pressing Enter,
2115 Just add the indentation of the previous line.
2117 Add indentation based on the current filetype and any characters at
2118 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
2120 Like *Current chars* but for C-like languages, make a closing
2121 ``}`` brace line up with the matching opening brace.
2124 If set, pressing tab will indent the current line or selection, and
2125 unindent when pressing Shift-tab. Otherwise, the tab key will
2126 insert a tab character into the document (which can be different
2127 from indentation, depending on the indent type).
2130 There are also separate configurable keybindings for indent &
2131 unindent, but this preference allows the tab key to have different
2132 meanings in different contexts - e.g. for snippet completion.
2134 Editor Completions preferences
2135 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2137 .. image:: ./images/pref_dialog_edit_completions.png
2143 Whether to replace special keywords after typing Tab into a
2144 pre-defined text snippet.
2145 See `User-definable snippets`_.
2147 XML/HTML tag auto-closing
2148 When you open an XML/HTML tag automatically generate its
2151 Automatic continuation multi-line comments
2152 Continue automatically multi-line comments in languages like C, C++
2153 and Java when a new line is entered inside such a comment.
2154 With this option enabled, Geany will insert a ``*`` on every new line
2155 inside a multi-line comment, for example when you press return in the
2159 * This is a C multi-line comment, press <Return>
2161 then Geany would insert::
2165 on the next line with the correct indentation based on the previous line,
2166 as long as the multi-line is not closed by ``*/``.
2168 Autocomplete symbols
2169 When you start to type a symbol name, look for the full string to
2170 allow it to be completed for you.
2172 Autocomplete all words in document
2173 When you start to type a word, Geany will search the whole document for
2174 words starting with the typed part to complete it, assuming there
2175 are no symbol names to show.
2177 Drop rest of word on completion
2178 Remove any word part to the right of the cursor when choosing a
2179 completion list item.
2181 Characters to type for autocompletion
2182 Number of characters of a word to type before autocompletion is
2185 Completion list height
2186 The number of rows to display for the autocompletion window.
2188 Max. symbol name suggestions
2189 The maximum number of items in the autocompletion list.
2191 Symbol list update frequency
2192 The minimum delay (in milliseconds) between two symbol list updates.
2194 This option determines how frequently the symbol list is updated for the
2195 current document. The smaller the delay, the more up-to-date the symbol
2196 list (and then the completions); but rebuilding the symbol list has a
2197 cost in performance, especially with large files.
2199 The default value is 250ms, which means the symbol list will be updated
2200 at most four times per second, even if the document changes continuously.
2202 A value of 0 disables automatic updates, so the symbol list will only be
2203 updated upon document saving.
2206 Auto-close quotes and brackets
2207 ``````````````````````````````
2209 Geany can automatically insert a closing bracket and quote characters when
2210 you open them. For instance, you type a ``(`` and Geany will automatically
2211 insert ``)``. With the following options, you can define for which
2212 characters this should work.
2215 Auto-close parenthesis when typing an opening one
2218 Auto-close curly brackets (braces) when typing an opening one
2221 Auto-close square brackets when typing an opening one
2224 Auto-close single quotes when typing an opening one
2227 Auto-close double quotes when typing an opening one
2230 Editor Display preferences
2231 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2233 This is for visual elements displayed in the editor window.
2235 .. image:: ./images/pref_dialog_edit_display.png
2240 Invert syntax highlighting colors
2241 Invert all colors, by default this makes white text on a black
2244 Show indendation guides
2245 Show vertical lines to help show how much leading indentation there
2249 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2250 show which kinds of whitespace are used.
2253 Display a symbol everywhere that a carriage return or line feed
2257 Show or hide the Line Number margin.
2260 Show or hide the small margin right of the line numbers, which is used
2263 Stop scrolling at last line
2264 When enabled Geany stops scrolling when at the last line of the document.
2265 Otherwise you can scroll one more page even if there are no real lines.
2267 Lines visible around the cursor
2268 The number of lines to maintain between the cursor and the top and bottom
2269 edges of the view. This allows some lines of context around the cursor to
2270 always be visible. If *Stop scrolling at last line* is disabled, the cursor
2271 will never reach the bottom edge when this value is greater than 0.
2277 The long line marker helps to indicate overly-long lines, or as a hint
2278 to the user for when to break the line.
2282 Show a thin vertical line in the editor window at the given column
2285 Change the background color of characters after the given column
2286 position to the color set below. (This is recommended over the
2287 *Line* setting if you use proportional fonts).
2289 Don't mark long lines at all.
2292 Set this value to a value greater than zero to specify the column
2293 where it should appear.
2295 Long line marker color
2296 Set the color of the long line marker.
2302 Virtual space is space beyond the end of each line.
2303 The cursor may be moved into virtual space but no real space will be
2304 added to the document until there is some text typed or some other
2305 text insertion command is used.
2308 Do not show virtual spaces
2310 Only for rectangular selections
2311 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2314 Always show virtual spaces beyond the end of lines
2320 .. image:: ./images/pref_dialog_files.png
2325 Open new documents from the command-line
2326 Whether to create new documents when passing filenames that don't
2327 exist from the command-line.
2329 Default encoding (new files)
2330 The type of file encoding you wish to use when creating files.
2332 Used fixed encoding when opening files
2333 Assume all files you are opening are using the type of encoding specified below.
2335 Default encoding (existing files)
2336 Opens all files with the specified encoding instead of auto-detecting it.
2337 Use this option when it's not possible for Geany to detect the exact encoding.
2339 Default end of line characters
2340 The end of line characters to which should be used for new files.
2341 On Windows systems, you generally want to use CR/LF which are the common
2342 characters to mark line breaks.
2343 On Unix-like systems, LF is default and CR is used on MAC systems.
2347 Perform formatting operations when a document is saved. These
2348 can each be undone with the Undo command.
2350 Ensure newline at file end
2351 Add a newline at the end of the document if one is missing.
2353 Ensure consistent line endings
2354 Ensures that newline characters always get converted before
2355 saving, avoiding mixed line endings in the same file.
2357 .. _Strip trailing spaces:
2359 Strip trailing spaces
2360 Remove any whitespace at the end of each document line.
2363 This does not apply to Diff documents, e.g. patch files.
2365 Replace tabs with spaces
2366 Replace all tabs in the document with the equivalent number of spaces.
2369 It is better to use spaces to indent than use this preference - see
2375 Recent files list length
2376 The number of files to remember in the recently used files list.
2379 The number of seconds to periodically check the current document's
2380 file on disk in case it has changed. Setting it to 0 will disable
2384 These checks are only performed on local files. Remote files are
2385 not checked for changes due to performance issues
2386 (remote files are files in ``~/.gvfs/``).
2392 .. image:: ./images/pref_dialog_tools.png
2398 The command to execute a script in a terminal. Occurrences of %c
2399 in the command are substituted with the run script name, see
2400 `Terminal emulators`_.
2403 The location of your web browser executable.
2406 The location of the grep executable.
2409 For Windows users: at the time of writing it is recommended to use
2410 the grep.exe from the UnxUtils project
2411 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2412 Mingw project for instance might not work with Geany at the moment.
2418 Set this to a command to execute on the current word.
2419 You can use the "%s" wildcard to pass the current word below the cursor
2420 to the specified command.
2423 Template preferences
2424 ^^^^^^^^^^^^^^^^^^^^
2426 This data is used as meta data for various template text to insert into
2427 a document, such as the file header. You only need to set fields that
2428 you want to use in your template files.
2430 .. image:: ./images/pref_dialog_templ.png
2436 The name of the developer who will be creating files.
2439 The initials of the developer.
2442 The email address of the developer.
2445 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2448 The company the developer is working for.
2451 The initial version of files you will be creating.
2454 Specify a format for the {year} wildcard. For a list of available conversion
2455 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
2458 Specify a format for the {date} wildcard. For a list of available conversion
2459 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
2462 Specify a format for the {datetime} wildcard. For a list of available conversion
2463 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
2466 Keybinding preferences
2467 ^^^^^^^^^^^^^^^^^^^^^^
2469 .. image:: ./images/pref_dialog_keys.png
2471 There are some commands listed in the keybinding dialog that are not, by default,
2472 bound to a key combination, and may not be available as a menu item.
2475 For more information see the section `Keybindings`_.
2478 Printing preferences
2479 ^^^^^^^^^^^^^^^^^^^^
2481 .. image:: ./images/pref_dialog_printing.png
2483 Use external command for printing
2484 Use a system command to print your file out.
2486 Use native GTK printing
2487 Let the GTK GUI toolkit handle your print request.
2490 Print the line numbers on the left of your paper.
2493 Print the page number on the bottom right of your paper.
2496 Print a header on every page that is sent to the printer.
2498 Use base name of the printed file
2499 Don't use the entire path for the header, only the filename.
2502 How the date should be printed. For a list of available conversion
2503 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
2509 .. image:: ./images/pref_dialog_various.png
2511 Rarely used preferences, explained in the table below. A few of them require
2512 restart to take effect, and a few other will only affect newly opened or created
2513 documents before restart.
2515 ================================ =========================================== ========== ===========
2516 Key Description Default Applies
2517 ================================ =========================================== ========== ===========
2518 **``editor`` group**
2519 use_gtk_word_boundaries Whether to look for the end of a word true to new
2520 when using word-boundary related documents
2521 Scintilla commands (see `Scintilla
2522 keyboard commands`_).
2523 brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
2524 complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
2525 when editing an existing line (i.e. there
2526 is some text after the current cursor
2527 position on the line). Only used when the
2528 keybinding `Complete snippet` is set to
2530 show_editor_scrollbars Whether to display scrollbars. If set to true immediately
2531 false, the horizontal and vertical
2532 scrollbars are hidden completely.
2533 indent_hard_tab_width The size of a tab character. Don't change 8 immediately
2534 it unless you really need to; use the
2535 indentation settings instead.
2536 editor_ime_interaction Input method editor (IME)'s candidate 0 to new
2537 window behaviour. May be 0 (windowed) or documents
2539 **``interface`` group**
2540 show_symbol_list_expanders Whether to show or hide the small true to new
2541 expander icons on the symbol list documents
2543 compiler_tab_autoscroll Whether to automatically scroll to the true immediately
2544 last line of the output in the Compiler
2546 statusbar_template The status bar statistics line format. See below. immediately
2547 (See `Statusbar Templates`_ for details).
2548 new_document_after_close Whether to open a new document after all false immediately
2549 documents have been closed.
2550 msgwin_status_visible Whether to show the Status tab in the true immediately
2552 msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
2554 msgwin_messages_visible Whether to show the Messages tab in the true immediately
2556 msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
2558 warn_on_project_close Whether to show a warning when opening true immediately
2559 a project while one is already open.
2560 **``terminal`` group**
2561 send_selection_unsafe By default, Geany strips any trailing false immediately
2562 newline characters from the current
2563 selection before sending it to the terminal
2564 to not execute arbitrary code. This is
2565 mainly a security feature.
2566 If, for whatever reasons, you really want
2567 it to be executed directly, set this option
2569 send_cmd_prefix String with which prefix the commands sent Empty immediately
2570 to the shell. This may be used to tell
2571 some shells (BASH with ``HISTCONTROL`` set
2572 to ``ignorespace``, ZSH with
2573 ``HIST_IGNORE_SPACE`` enabled, etc.) from
2574 putting these commands in their history by
2575 setting this to a space. Note that leading
2576 spaces must be escaped using `\s` in the
2579 allow_always_save Whether files can be saved always, even false immediately
2580 if they don't have any changes.
2581 By default, the Save button and menu
2582 item are disabled when a file is
2583 unchanged. When setting this option to
2584 true, the Save button and menu item are
2585 always active and files can be saved.
2586 use_atomic_file_saving Defines the mode how Geany saves files to false immediately
2587 disk. If disabled, Geany directly writes
2588 the content of the document to disk. This
2589 might cause loss of data when there is
2590 no more free space on disk to save the
2591 file. When set to true, Geany first saves
2592 the contents into a temporary file and if
2593 this succeeded, the temporary file is
2594 moved to the real file to save.
2595 This gives better error checking in case of
2596 no more free disk space. But it also
2597 destroys hard links of the original file
2598 and its permissions (e.g. executable flags
2599 are reset). Use this with care as it can
2600 break things seriously.
2601 The better approach would be to ensure your
2602 disk won't run out of free space.
2603 use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
2604 saving backend. It is better on most
2605 situations but is known not to work
2606 correctly on some complex setups.
2607 gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
2608 saving. Backup is named `filename~`.
2609 keep_edit_history_on_reload Whether to maintain the edit history when true immediately
2610 reloading a file, and allow the operation
2612 reload_clean_doc_on_file_change Whether to automatically reload documents false immediately
2613 that have no changes but which have changed
2615 If unsaved changes exist then the user is
2616 prompted to reload manually.
2617 save_config_on_file_change Automatically save Geany's configuration true immediately
2618 to disk once the document list changes
2619 (i.e. new documents are opened, saved or
2620 closed). This helps to prevent accidentally
2621 losing the session file list or other
2622 changed settings when Geany is not shut
2623 down cleanly. Disable this option if your
2624 configuration directory is on a slow drive,
2625 network share or similar and you experience
2627 extract_filetype_regex Regex to extract filetype name from file See link immediately
2628 via capture group one.
2629 See `ft_regex`_ for default.
2630 **``search`` group**
2631 find_selection_type See `Find selection`_. 0 immediately
2632 replace_and_find_by_default Set ``Replace & Find`` button as default so true immediately
2633 it will be activated when the Enter key is
2634 pressed while one of the text fields has
2637 number_ft_menu_items The maximum number of menu items in the 2 on restart
2638 filetype build section of the Build menu.
2639 number_non_ft_menu_items The maximum number of menu items in the 3 on restart
2640 independent build section.
2641 number_exec_menu_items The maximum number of menu items in the 2 on restart
2642 execute section of the Build menu.
2643 **``socket`` group**
2644 socket_remote_cmd_port TCP port number to be used for inter 2 on restart
2645 process communication (i.e. with other
2646 Geany instances, e.g. "Open with Geany").
2647 Only available on Windows, valid port
2648 range: 1024 to 65535.
2649 ================================ =========================================== ========== ===========
2654 The default statusbar template is (note ``\t`` = tab):
2656 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
2658 Settings the preference to an empty string will also cause Geany to use this
2661 The following format characters are available for the statusbar template:
2663 ============ ===========================================================
2664 Placeholder Description
2665 ============ ===========================================================
2666 ``%l`` The current line number starting at 1
2667 ``%L`` The total number of lines
2668 ``%c`` The current column number starting at 0, including virtual
2670 ``%C`` The current column number starting at 1, including virtual
2672 ``%s`` The number of selected characters or if only whole lines
2673 selected, the number of selected lines.
2674 ``%n`` The number of selected characters, even if only whole lines
2676 ``%w`` Shows ``RO`` when the document is in read-only mode,
2677 otherwise shows whether the editor is in overtype (OVR)
2678 or insert (INS) mode.
2679 ``%t`` Shows the indentation mode, either tabs (TAB),
2680 spaces (SP) or both (T/S).
2681 ``%m`` Shows whether the document is modified (MOD) or nothing.
2682 ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
2683 ``%e`` The name of the document's encoding (ex. UTF-8).
2684 ``%f`` The filetype of the document (ex. None, Python, C, etc).
2685 ``%S`` The name of the scope where the caret is located.
2686 ``%p`` The caret position in the entire document starting at 0.
2687 ``%r`` Shows whether the document is read-only (RO) or nothing.
2688 ``%Y`` The Scintilla style number at the caret position. This is
2689 useful if you're debugging color schemes or related code.
2690 ============ ===========================================================
2692 Terminal (VTE) preferences
2693 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2695 See also: `Virtual terminal emulator widget (VTE)`_.
2697 .. image:: ./images/pref_dialog_vte.png
2703 Select the font that will be used in the terminal emulation control.
2706 Select the font color.
2709 Select the background color of the terminal.
2712 Select the background image to show behind the terminal's text.
2715 The number of lines buffered so that you can scroll though the history.
2718 The location of the shell on your system.
2721 Scroll the terminal to the prompt line when pressing a key.
2724 Scroll the output down.
2727 Let the terminal cursor blink.
2729 Override Geany keybindings
2730 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2732 Disable menu shortcut key (F10 by default)
2733 Disable the menu shortcut when you are in the virtual terminal.
2735 Follow path of the current file
2736 Make the path of the terminal change according to the path of the
2739 Execute programs in VTE
2740 Execute programs in the virtual terminal instead of using the external
2741 terminal tool. Note that if you run multiple execute commands at once
2742 the output may become mixed together in the VTE.
2744 Don't use run script
2745 Don't use the simple run script which is usually used to display
2746 the exit status of the executed program.
2747 This can be useful if you already have a program running in the VTE
2748 like a Python console (e.g. ipython). Use this with care.
2754 Project management is optional in Geany. Currently it can be used for:
2756 * Storing and opening session files on a project basis.
2757 * Overriding default settings with project equivalents.
2758 * Configuring the Build menu on a project basis.
2760 A list of session files can be stored and opened with the project
2761 when the *Use project-based session files* preference is enabled,
2762 in the `Projects`_ group of the `General Miscellaneous preferences`_ tab
2763 of the `Preferences`_ dialog.
2765 As long as a project is open, the Build menu will use
2766 the items defined in project's settings, instead of the defaults.
2767 See `Build Menu Configuration`_ for information on configuring the menu.
2769 The current project's settings are saved when it is closed, or when
2770 Geany is shutdown. When restarting Geany, the previously opened project
2771 file that was in use at the end of the last session will be reopened.
2773 The project menu items are detailed below.
2779 There are two ways of creating new projects, either by using
2780 *Project->New* menu item or by using *Project->New from Folder* menu
2784 This method is more suitable for creating new, empty projects from
2785 scratch at the default location without having any existing sources.
2787 To create a new project, fill in the *Name* field. By default this
2788 will setup a new project file ``~/projects/name/name.geany``.
2790 The *Base path* text field is setup to use ``~/projects/name``. This
2791 can safely be set to any existing path -- it will not touch the file
2792 structure contained in it.
2795 This method is more suitable when there is already some folder
2796 containing source files for which you want to create a new project.
2798 When using this method, Geany first opens a directory selection
2799 dialog to select the folder containing the sources, and the
2800 *Base path* field is set to that value.
2802 Afterwards, Geany shows the same dialog as the *Project->New*
2803 method but already pre-filled with the values based on the
2804 *Base path* selection. The *Name* field is filled with the folder
2805 name, the *Filename* field is filled with
2806 ``base_path/name.geany`` and the *Base path* field is filled with
2807 the path specified in the previous dialog.
2813 You can set an optional description for the project. Currently it's
2814 only used for a template wildcard - see `Template wildcards`_.
2816 The *Base path* field is used as the directory to run the Build menu commands.
2817 The specified path can be an absolute path or it is considered to be
2818 relative to the project's file name.
2820 The *File patterns* field allows to specify a list of file patterns for the
2821 project, which can be used in the `Find in files`_ dialog.
2823 The *Indentation* tab allows you to override the default
2824 `Indentation`_ settings.
2830 The Open command displays a standard file chooser, starting in
2831 ``~/projects``. Choose a project file named with the ``.geany``
2834 When project session support is enabled, Geany will close the currently
2835 open files and open the session files associated with the project.
2841 Project file settings are saved when the project is closed.
2843 When project session support is enabled, Geany will close the project
2844 session files and open any previously closed default session files.
2849 After editing code with Geany, the next step is to compile, link, build,
2850 interpret, run etc. As Geany supports many languages each with a different
2851 approach to such operations, and as there are also many language independent
2852 software building systems, Geany does not have a built-in build system, nor
2853 does it limit which system you can use. Instead the build menu provides
2854 a configurable and flexible means of running any external commands to
2855 execute your preferred build system.
2857 This section provides a description of the default configuration of the
2858 build menu and then covers how to configure it, and where the defaults fit in.
2860 Running the commands from within Geany has two benefits:
2862 * The current file is automatically saved before the command is run.
2863 * The output is captured in the Compiler notebook tab and parsed for
2866 Warnings and errors that can be parsed for line numbers will be shown in
2867 red in the Compiler tab and you can click on them to switch to the relevant
2868 source file (or open it) and mark the line number. Also lines with
2869 warnings or errors are marked in the source, see `Indicators`_ below.
2872 If Geany's default error message parsing does not parse errors for
2873 the tool you're using, you can set a custom regex in the
2874 `Set Build Commands dialog`_, see `Build Menu Configuration`_.
2879 Indicators are red squiggly underlines which are used to highlight
2880 errors which occurred while compiling the current file. So you can
2881 easily see where your code failed to compile. You can remove them by
2882 selecting *Remove Error Indicators* in the Document menu.
2884 If you do not like this feature, you can disable it - see `Editor Features
2888 Default build menu items
2889 ^^^^^^^^^^^^^^^^^^^^^^^^
2890 Depending on the current file's filetype, the default Build menu will contain
2891 the following items:
2897 * Make Custom Target
2902 * Set Build Menu Commands
2908 The Compile command has different uses for different kinds of files.
2910 For compilable languages such as C and C++, the Compile command is
2911 set up to compile the current source file into a binary object file.
2913 Java source files will be compiled to class file bytecode.
2915 Interpreted languages such as Perl, Python, Ruby will compile to
2916 bytecode if the language supports it, or will run a syntax check,
2917 or if that is not available will run the file in its language interpreter.
2922 For compilable languages such as C and C++, the Build command will link
2923 the current source file's equivalent object file into an executable. If
2924 the object file does not exist, the source will be compiled and linked
2925 in one step, producing just the executable binary.
2927 Interpreted languages do not use the Build command.
2930 If you need complex settings for your build system, or several
2931 different settings, then writing a Makefile and using the Make
2932 commands is recommended; this will also make it easier for users to
2933 build your software.
2938 Source code linters are often used to find code that doesn't correspond to
2939 certain style guidelines: non-portable code, common or hard to find
2940 errors, code "smells", variables used before being set, unused functions,
2941 division by zero, constant conditions, etc. Linters inspect the code and
2942 issue warnings much like the compilers do. This is formally referred to as
2943 static code analysis.
2945 Some common linters are pre-configured for you in the Build menu (``pep8``
2946 for Python, ``cppcheck`` for C/C++, JSHint for JavaScript, ``xmllint`` for
2947 XML, ``hlint`` for Haskell, ``shellcheck`` for shell code, ...), but all
2948 these are standalone tools you need to obtain before using.
2953 This runs "make" in the same directory as the
2959 This is similar to running 'Make' but you will be prompted for
2960 the make target name to be passed to the Make tool. For example,
2961 typing 'clean' in the dialog prompt will run "make clean".
2967 Make object will run "make current_file.o" in the same directory as
2968 the current file, using the filename for 'current_file'. It is useful
2969 for building just the current file without building the whole project.
2974 The next error item will move to the next detected error in the file.
2978 The previous error item will move to the previous detected error in the file.
2983 Execute will run the corresponding executable file, shell script or
2984 interpreted script in a terminal window. The command set in the
2985 `Set Build Commands dialog`_ is run in a script to ensure the terminal
2986 stays open after execution completes. Note: see `Terminal emulators`_
2987 below for the command format. Alternatively the built-in VTE can be used
2988 if it is available - see `Virtual terminal emulator widget (VTE)`_.
2990 After your program or script has finished executing, the run script will
2991 prompt you to press the return key. This allows you to review any text
2992 output from the program before the terminal window is closed.
2995 The execute command output is not parsed for errors.
2998 Stopping running processes
2999 ``````````````````````````
3001 When there is a running program, the Execute menu item in the menu and
3002 the Run button in the toolbar
3003 each become a stop button so you can stop the current running program (and
3004 any child processes). This works by sending the SIGQUIT signal to the process.
3006 Depending on the process you started it is possible that the process
3007 cannot be stopped. For example this can happen when the process creates
3008 more than one child process.
3014 The Terminal field of the tools preferences tab requires a command to
3015 execute the terminal program and to pass it the name of the Geany run
3016 script that it should execute in a Bourne compatible shell (eg /bin/sh).
3017 The marker "%c" is substituted with the name of the Geany run script,
3018 which is created in the temporary directory and which changes the working
3019 directory to the directory set in the `Set Build Commands dialog`_.
3021 As an example the default (Linux) command is::
3023 xterm -e "/bin/sh %c"
3029 By default Compile, Build and Execute are fairly basic commands. You
3030 may wish to customise them using *Set Build Commands*.
3032 E.g. for C you can add any include paths and compile flags for the
3033 compiler, any library names and paths for the linker, and any
3034 arguments you want to use when running Execute.
3036 Build menu configuration
3037 ^^^^^^^^^^^^^^^^^^^^^^^^
3039 The build menu has considerable flexibility and configurability, allowing
3040 menu labels, the commands they execute and the directory they execute
3041 in to be configured. For example, if you change one of the default make
3042 commands to run say 'waf' you can also change the label to match.
3043 These settings are saved automatically when Geany is shut down.
3045 The build menu is divided into four groups of items each with different
3048 * Filetype build commands - are configurable and depend on the filetype of the
3049 current document; they capture output in the compiler tab and parse it for
3051 * Independent build commands - are configurable and mostly don't depend on the
3052 filetype of the current document; they also capture output in the
3053 compiler tab and parse it for errors.
3054 * Execute commands - are configurable and intended for executing your
3055 program or other long running programs. The output is not parsed for
3056 errors and is directed to the terminal command selected in `Tools
3058 * Fixed commands - these perform built-in actions:
3060 * Go to the next error.
3061 * Go to the previous error.
3062 * Show the build menu commands dialog.
3064 The maximum numbers of items in each of the configurable groups can be
3065 configured in `Various preferences`_. Even though the maximum number of
3066 items may have been increased, only those menu items that have commands
3067 configured are shown in the menu.
3069 The groups of menu items obtain their configuration from four potential
3070 sources. The highest priority source that has the menu item defined will
3071 be used. The sources in decreasing priority are:
3073 * A project file if open
3074 * The user preferences
3075 * The system filetype definitions
3078 The detailed relationships between sources and the configurable menu item groups
3079 is shown in the following table:
3081 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3082 | Group | Project File | Preferences | System Filetype | Defaults |
3083 +==============+=====================+==========================+===================+===============================+
3084 | Filetype | Loads From: project | Loads From: | Loads From: | None |
3085 | Build | file | filetypes.xxx file in | filetypes.xxx in | |
3086 | | | ~/.config/geany/filedefs | Geany install | |
3087 | | Saves To: project | | | |
3088 | | file | Saves to: as above, | Saves to: as user | |
3089 | | | creating if needed. | preferences left. | |
3090 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3091 | Independent | Loads From: project | Loads From: | Loads From: | 1: |
3092 | Build | file | geany.conf file in | filetypes.xxx in | Label: _Make |
3093 | | | ~/.config/geany | Geany install | Command: make |
3094 | | Saves To: project | | | |
3095 | | file | Saves to: as above, | Saves to: as user | 2: |
3096 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
3097 | | | | | Command: make |
3100 | | | | | Label: Make _Object |
3101 | | | | | Command: make %e.o |
3102 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3103 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
3104 | | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
3105 | | filetype defined in | ~/.config/geany or else | Geany install | |
3106 | | project file | filetypes.xxx file in | | |
3107 | | | ~/.config/geany/filedefs | Saves To: as user | |
3108 | | Saves To: | | preferences left. | |
3109 | | project file | Saves To: | | |
3110 | | | filetypes.xxx file in | | |
3111 | | | ~/.config/geany/filedefs | | |
3112 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3114 The following notes on the table may reference cells by coordinate as *(group, source)*:
3116 * Filetype filenames - for filetypes.xxx substitute the appropriate extension for
3117 the filetype of the current document for xxx - see `filenames`_.
3119 * System Filetypes - Labels loaded from these sources are locale sensitive
3120 and can contain translations.
3122 * *(Filetype build, Project and Preferences)* - preferences use a full
3123 filetype file so that users can configure all other filetype preferences
3124 as well. Projects can only configure menu items per filetype. Saving
3125 in the project file means that there is only one file per project not
3128 * *(Filetype-Independent build, System Filetype)* - although conceptually strange, defining
3129 filetype-independent commands in a filetype file, this provides the ability to
3130 define filetype dependent default menu items.
3132 * *(Execute, Project and Preferences)* - the project independent
3133 execute and preferences independent execute commands can only be set by hand
3134 editing the appropriate file, see `Preferences file format`_ and `Project file
3137 Set Build Commands dialog
3138 ^^^^^^^^^^^^^^^^^^^^^^^^^
3140 Most of the configuration of the build menu is done through the `Set
3141 Build Commands dialog`_. When no project is open, you can edit the
3142 configuration sourced from user preferences using the *Build->Set Build
3143 Commands* menu item. You can edit the configuration sourced from a
3144 project in the *Build* tab of the `Project Properties`_ dialog. The
3145 former menu item also shows the project dialog when a project is open.
3146 Both use the same form shown below.
3148 .. image:: ./images/build_menu_commands_dialog.png
3150 The dialog is divided into three sections:
3152 * Filetype build commands (selected based on the current document's filetype).
3153 * Independent build commands (available regardless of filetype).
3154 * Filetype execute commands.
3156 The filetype and independent build sections also each contain a field for the regular
3157 expression used for parsing command output for error and warning messages.
3159 The columns in the first three sections allow setting of the label, command,
3160 and working directory to run the command in. An item with an empty
3161 label will not be shown in the menu. An empty working directory will
3162 default to the directory of the current document.
3164 If there is no current document then the command will not run.
3166 The dialog will always show the command selected by priority, not just the
3167 commands configured in this configuration source. This ensures that you always
3168 see what the menu item is going to do if activated.
3170 If the current source of the menu item is higher priority than the
3171 configuration source you are editing then the command will be shown
3172 in the dialog but will be insensitive (greyed out). This can't happen
3173 with the project source but can with the preferences source dialog.
3175 The clear buttons remove the definition from the configuration source you are editing.
3176 When you do this the command from the next lower priority source will be shown.
3177 To hide lower priority menu items without having anything show in the menu,
3178 configure with nothing in the label but at least one character in the command.
3180 Substitutions in commands and working directories
3181 `````````````````````````````````````````````````
3183 Before the command is run, the first occurrence of each of the following
3184 two character sequences in each of the command and working directory
3185 fields is substituted by the items specified below:
3187 * %d - the absolute path to the directory of the current file.
3188 * %e - the name of the current file without the extension or path.
3189 * %f - the name of the current file without the path.
3190 * %p - if a project is open, the base path from the project.
3191 * %l - the line number at the current cursor position.
3194 If the base path set in `Project Properties`_ is not an absolute path, then it is
3195 taken as relative to the directory of the project file. This allows a project file
3196 stored in the source tree to specify all commands and working directories relative
3197 to the tree itself, so that the whole tree including the project file, can be moved
3198 and even checked into and out of version control without having to re-configure the
3201 Build menu keyboard shortcuts
3202 `````````````````````````````
3204 Keyboard shortcuts can be defined for:
3206 * the first two filetype build menu items
3207 * the first three independent build menu items
3208 * the first execute menu item
3209 * the fixed menu items (Next/Previous Error, Set Commands)
3211 In the keybindings configuration dialog (see `Keybinding preferences`_)
3212 these items are identified by the default labels shown in the `Build Menu`_ section above.
3214 It is currently not possible to bind keyboard shortcuts to more than these menu items.
3215 You can also use underlines in the labels to set mnemonic characters.
3219 The configurable Build Menu capability was introduced in Geany 0.19 and
3220 required a new section to be added to the configuration files (See
3221 `Preferences file format`_). Geany will still load older format project,
3222 preferences and filetype file settings and will attempt to map them into the new
3223 configuration format. There is not a simple clean mapping between the formats.
3224 The mapping used produces the most sensible results for the majority of cases.
3225 However, if they do not map the way you want, you may have to manually
3226 configure some settings using the `Set Build Commands dialog`_.
3228 Any setting configured in either of these dialogs will override settings mapped from
3229 older format configuration files.
3234 Since Geany 0.13 there has been printing support using GTK's printing API.
3235 The printed page(s) will look nearly the same as on your screen in Geany.
3236 Additionally, there are some options to modify the printed page(s).
3239 The background text color is set to white, except for text with
3240 a white foreground. This allows dark color schemes to save ink
3243 You can define whether to print line numbers, page numbers at the bottom of
3244 each page and whether to print a page header on each page. This header
3245 contains the filename of the printed document, the current page number and
3246 the date and time of printing. By default, the file name of the document
3247 with full path information is added to the header. If you prefer to add
3248 only the basename of the file(without any path information) you can set it
3249 in the preferences dialog. You can also adjust the format of the date and
3250 time added to the page header. For a list of available conversion
3251 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
3253 All of these settings can also be changed in the print dialog just before
3254 actual printing is done.
3255 On Unix-like systems the provided print dialog offers a print preview. The
3256 preview file is opened with a PDF viewer and by default GTK uses ``evince``
3257 for print preview. If you have not installed evince or just want to use
3258 another PDF viewer, you can change the program to use in the file
3259 ``settings.ini`` (usually found in ``~/.config/gtk-3.0``, see the
3260 `GTK documentation`_). For example, use::
3263 gtk-print-preview-command = epdfview %f
3265 Of course, you can also use xpdf, kpdf or whatever as the print preview
3266 command. That command should ideally delete the temporary file referenced by
3267 ``%f``. See the `GTK documentation for the setting`_ for more details.
3269 .. _GTK documentation: https://developer.gnome.org/gtk3/stable/GtkSettings.html#GtkSettings.description
3270 .. _GTK documentation for the setting: https://developer.gnome.org/gtk3/stable/GtkSettings.html#GtkSettings--gtk-print-preview-command
3273 Geany also provides an alternative basic printing support using a custom
3274 print command. However, the printed document contains no syntax highlighting.
3275 You can adjust the command to which the filename is passed in the preferences
3276 dialog. The default command is::
3280 ``%f`` will be substituted by the filename of the current file. Geany
3281 will not show errors from the command itself, so you should make
3282 sure that it works before(e.g. by trying to execute it from the
3285 A nicer example, which many prefer is::
3287 % a2ps -1 --medium=A4 -o - %f | xfprint4
3289 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3290 gtklp or similar programs can be used.
3297 Plugins are loaded at startup, if the *Enable plugin support*
3298 general preference is set. There is also a command-line option,
3299 ``-p``, which prevents plugins being loaded. Plugins are scanned in
3300 the following directories:
3302 * ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
3303 * The ``lib`` subfolder of the installation path on Windows.
3304 * The ``plugins`` subfolder of the user configuration directory - see
3305 `Configuration file paths`_.
3306 * The `Extra plugin path` preference (usually blank) - see `Paths`_.
3308 Most plugins add menu items to the *Tools* menu when they are loaded.
3310 See also `Plugin documentation`_ for information about single plugins
3311 which are included in Geany.
3315 The Plugin Manager dialog lets you choose which plugins
3316 should be loaded at startup. You can also load and unload plugins on the
3317 fly using this dialog. Once you click the checkbox for a specific plugin
3318 in the dialog, it is loaded or unloaded according to its previous state.
3319 By default, no plugins are loaded at startup until you select some.
3320 You can also configure some plugin specific options if the plugin
3327 Geany supports the default keyboard shortcuts for the Scintilla
3328 editing widget. For a list of these commands, see `Scintilla
3329 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
3330 by any custom keybindings with the same keyboard shortcut.
3336 There are some non-configurable bindings to switch between documents,
3337 listed below. These can also be overridden by custom keybindings.
3339 =============== ==================================
3341 =============== ==================================
3342 Alt-[1-9] Select left-most tab, from 1 to 9.
3343 Alt-0 Select right-most tab.
3344 =============== ==================================
3346 See also `Notebook tab keybindings`_.
3349 Configurable keybindings
3350 ^^^^^^^^^^^^^^^^^^^^^^^^
3352 For all actions listed below you can define your own keybindings. Open
3353 the Preferences dialog, select the desired action and click on
3354 change. In the resulting dialog you can press the key combination you
3355 want to assign to the action and it will be saved when you press OK.
3356 You can define only one key combination for each action and each key
3357 combination can only be defined for one action.
3359 The following tables list all customizable keyboard shortcuts, those
3360 which are common to many applications are marked with (C) after the
3365 =============================== ========================= ==================================================
3366 Action Default shortcut Description
3367 =============================== ========================= ==================================================
3368 New Ctrl-N (C) Creates a new file.
3370 Open Ctrl-O (C) Opens a file.
3372 Open selected file Ctrl-Shift-O Opens the selected filename.
3374 Re-open last closed tab Re-opens the last closed document tab.
3376 Save Ctrl-S (C) Saves the current file.
3378 Save As Saves the current file under a new name.
3380 Save all Ctrl-Shift-S Saves all open files.
3382 Close all Ctrl-Shift-W Closes all open files.
3384 Close Ctrl-W (C) Closes the current file.
3386 Reload file Ctrl-R (C) Reloads the current file.
3388 Reload all Reloads all open files. If the reload will not be 'undo'-able and changes that will be lost are detected (unsaved or saved) the reload will be confirmed, otherwise the reload will proceed without confirmation.
3390 Print Ctrl-P (C) Prints the current file.
3392 Quit Ctrl-Q (C) Quits Geany.
3393 =============================== ========================= ==================================================
3398 =============================== ========================= ==================================================
3399 Action Default shortcut Description
3400 =============================== ========================= ==================================================
3401 Undo Ctrl-Z (C) Un-does the last action.
3403 Redo Ctrl-Y Re-does the last action.
3405 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3408 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3409 end of the current line.
3411 Delete to line start Ctrl-Shift-BackSpace Deletes from the beginning of the line to the
3412 current caret position.
3414 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3416 Transpose current line Transposes the current line with the previous one.
3418 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3419 view. The cursor position and or an existing
3420 selection will not be changed.
3422 Scroll up by one line Alt-Up Scrolls the view.
3424 Scroll down by one line Alt-Down Scrolls the view.
3426 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3427 symbol completion, it shows document word completion
3428 instead, even if it is not enabled for automatic
3429 completion. Likewise if no symbol suggestions are
3430 available, it shows document word completion.
3432 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3435 Complete snippet Tab If you type a construct like if or for and press
3436 this key, it will be completed with a matching
3439 Suppress snippet completion If you type a construct like if or for and press
3440 this key, it will not be completed, and a space or
3441 tab will be inserted, depending on what the
3442 construct completion keybinding is set to. For
3443 example, if you have set the construct completion
3444 keybinding to space, then setting this to
3445 Shift+space will prevent construct completion and
3448 Context Action Executes a command and passes the current word
3449 (near the cursor position) or selection as an
3450 argument. See the section called `Context
3453 Move cursor in snippet Jumps to the next defined cursor positions in a
3454 completed snippets if multiple cursor positions
3457 Word part completion Tab When the autocompletion list is visible, complete
3458 the currently selected item up to the next word
3461 Move line(s) up Alt-PageUp Move the current line or selected lines up by
3464 Move line(s) down Alt-PageDown Move the current line or selected lines down by
3466 =============================== ========================= ==================================================
3469 Clipboard keybindings
3470 `````````````````````
3471 =============================== ========================= ==================================================
3472 Action Default shortcut Description
3473 =============================== ========================= ==================================================
3474 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3476 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3478 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3480 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3481 selection) to the clipboard.
3483 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3484 selection) to the clipboard.
3485 =============================== ========================= ==================================================
3490 =============================== ========================= ==================================================
3491 Action Default shortcut Description
3492 =============================== ========================= ==================================================
3493 Select all Ctrl-A (C) Makes a selection of all text in the current
3496 Select current word Alt-Shift-W Selects the current word under the cursor.
3498 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3499 which is defined by two empty lines around it.
3501 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3502 partially selected lines).
3504 Select to previous word part (Extend) selection to previous word part boundary.
3506 Select to next word part (Extend) selection to next word part boundary.
3507 =============================== ========================= ==================================================
3512 =============================== ========================= ==================================================
3513 Action Default shortcut Description
3514 =============================== ========================= ==================================================
3515 Insert date Shift-Alt-D Inserts a customisable date.
3517 Insert alternative whitespace Inserts a tab character when spaces should
3518 be used for indentation and inserts space
3519 characters of the amount of a tab width when
3520 tabs should be used for indentation.
3522 Insert New Line Before Current Inserts a new line with indentation.
3524 Insert New Line After Current Inserts a new line with indentation.
3525 =============================== ========================= ==================================================
3530 =============================== ========================= ==================================================
3531 Action Default shortcut Description
3532 =============================== ========================= ==================================================
3533 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3534 selection will be changed into uppercase and vice
3535 versa. If the selection contains lower- and
3536 uppercase characters, all will be converted to
3539 Comment line Comments current line or selection.
3541 Uncomment line Uncomments current line or selection.
3543 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3544 a comment if the line is commented.
3546 Increase indent Ctrl-I Indents the current line or selection by one tab
3547 or with spaces in the amount of the tab width
3550 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3551 the tab width setting from the indentation of the
3552 current line or selection.
3554 Increase indent by one space Indents the current line or selection by one
3557 Decrease indent by one space Deindents the current line or selection by one
3560 Smart line indent Indents the current line or all selected lines
3561 with the same indentation as the previous line.
3563 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3564 external command (available for the first
3565 9 configured commands, see
3566 `Sending text through custom commands`_ for
3569 Send Selection to Terminal Sends the current selection or the current
3570 line (if there is no selection) to the
3571 embedded Terminal (VTE).
3573 Reflow lines/block Reformat selected lines or current
3574 (indented) text block,
3575 breaking lines at the long line marker or the
3576 line breaking column if line breaking is
3577 enabled for the current document.
3578 =============================== ========================= ==================================================
3581 Settings keybindings
3582 ````````````````````
3583 =============================== ========================= ==================================================
3584 Action Default shortcut Description
3585 =============================== ========================= ==================================================
3586 Preferences Ctrl-Alt-P Opens preferences dialog.
3588 Plugin Preferences Opens plugin preferences dialog.
3589 =============================== ========================= ==================================================
3594 =============================== ========================= ==================================================
3595 Action Default shortcut Description
3596 =============================== ========================= ==================================================
3597 Find Ctrl-F (C) Opens the Find dialog.
3599 Find Next Ctrl-G Finds next result.
3601 Find Previous Ctrl-Shift-G Finds previous result.
3603 Find Next Selection Finds next occurrence of selected text.
3605 Find Previous Selection Finds previous occurrence of selected text.
3607 Replace Ctrl-H (C) Opens the Replace dialog.
3609 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3611 Next message Jumps to the line with the next message in
3612 the Messages window.
3614 Previous message Jumps to the line with the previous message
3615 in the Messages window.
3617 Find Usage Ctrl-Shift-E Finds all occurrences of the current word
3618 or selection (see note below) in all open
3619 documents and displays them in the messages
3622 Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word
3623 or selection (see note below) in the current
3624 document and displays them in the messages
3627 Mark All Ctrl-Shift-M Highlight all matches of the current
3628 word/selection (see note below) in the current
3629 document with a colored box. If there's nothing
3630 to find, or the cursor is next to an existing
3631 match, the highlighted matches will be cleared.
3632 =============================== ========================= ==================================================
3635 The keybindings marked "see note below" work like this: if no text is
3636 selected, the word under cursor is used, and *it has to match fully*
3637 (like when `Match only a whole word` is enabled in the Search dialog).
3638 However if some text is selected, then it is matched regardless of
3644 =============================== ========================= ==================================================
3645 Action Default shortcut Description
3646 =============================== ========================= ==================================================
3647 Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
3648 history. See the section called `Code Navigation
3651 Navigate back a location Alt-Left (C) Switches to the previous location in the
3652 navigation history. See the section called
3653 `Code navigation history`_.
3655 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3656 shows the Go to line dialog.
3658 Go to matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3659 is moved to the brace which belongs to the current
3660 one. If this keyboard shortcut is pressed again,
3661 the cursor is moved back to the first brace.
3663 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3664 marker if there already is one.
3666 Go to next marker Ctrl-. Go to the next marker in the current document.
3668 Go to previous marker Ctrl-, Go to the previous marker in the current document.
3670 Go to symbol definition Ctrl-T Jump to the definition of the current word or
3671 selection. See `Go to symbol definition`_.
3673 Go to symbol declaration Ctrl-Shift-T Jump to the declaration of the current word or
3674 selection. See `Go to symbol declaration`_.
3676 Go to Start of Line Home Move the caret to the start of the line.
3677 Behaves differently if smart_home_key_ is set.
3679 Go to End of Line End Move the caret to the end of the line.
3681 Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
3682 This is useful when you use line wrapping and
3683 want to jump to the start of the wrapped, virtual
3684 line, not the real start of the whole line.
3685 If the line is not wrapped, it behaves like
3686 `Go to Start of Line`.
3688 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3689 If the line is not wrapped, it behaves like
3690 `Go to End of Line`.
3692 Go to Previous Word Part Ctrl-/ Go to the previous part of the current word.
3694 Go to Next Word Part Ctrl-\\ Go to the next part of the current word.
3695 =============================== ========================= ==================================================
3699 =============================== ========================= ==================================================
3700 Action Default shortcut Description
3701 =============================== ========================= ==================================================
3702 Fullscreen F11 (C) Switches to fullscreen mode.
3704 Toggle Messages Window Toggles the message window (status and compiler
3705 messages) on and off.
3707 Toggle Sidebar Shows or hides the sidebar.
3709 Toggle all additional widgets Hide and show all additional widgets like the
3710 notebook tabs, the toolbar, the messages window
3713 Zoom In Ctrl-+ (C) Zooms in the text.
3715 Zoom Out Ctrl-- (C) Zooms out the text.
3717 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3718 =============================== ========================= ==================================================
3722 ================================ ========================= ==================================================
3723 Action Default shortcut Description
3724 ================================ ========================= ==================================================
3725 Switch to Editor F2 Switches to editor widget.
3726 Also reshows the document statistics line
3727 (after a short timeout).
3729 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3732 Switch to Message Window Focus the Message Window's current tab.
3734 Switch to Compiler Focus the Compiler message window tab.
3736 Switch to Messages Focus the Messages message window tab.
3738 Switch to Scribble F6 Switches to scribble widget.
3740 Switch to VTE F4 Switches to VTE widget.
3742 Switch to Sidebar Focus the Sidebar.
3744 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3747 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3749 ================================ ========================= ==================================================
3752 Notebook tab keybindings
3753 ````````````````````````
3754 =============================== ========================= ==================================================
3755 Action Default shortcut Description
3756 =============================== ========================= ==================================================
3757 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3759 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3761 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3763 Holding Ctrl (or another modifier if the keybinding
3764 has been changed) will show a dialog, then repeated
3765 presses of the keybinding will switch to the 2nd-last
3766 used document, 3rd-last, etc. Also known as
3767 Most-Recently-Used documents switching.
3769 Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
3772 Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
3775 Move document first Moves the current document to the first position.
3777 Move document last Moves the current document to the last position.
3778 =============================== ========================= ==================================================
3781 Document keybindings
3782 ````````````````````
3783 ==================================== ==================== ==================================================
3784 Action Default shortcut Description
3785 ==================================== ==================== ==================================================
3786 Clone See `Cloning documents`_.
3788 Replace tabs with space Replaces all tabs with the right amount of spaces
3789 in the whole document, or the current selection.
3791 Replace spaces with tabs Replaces leading spaces with tab characters in the
3792 whole document, or the current selection.
3794 Toggle current fold Toggles the folding state of the current code block.
3796 Fold all Folds all contractible code blocks.
3798 Unfold all Unfolds all contracted code blocks.
3800 Reload symbol list Ctrl-Shift-R Reloads the symbol list.
3802 Toggle Line wrapping Enables or disables wrapping of long lines.
3804 Toggle Line breaking Enables or disables automatic breaking of long
3805 lines at a configurable column.
3807 Remove Markers Remove any markers on lines or words which
3808 were set by using 'Mark All' in the
3809 search dialog or by manually marking lines.
3811 Remove Error Indicators Remove any error indicators in the
3814 Remove Markers and Error Indicators Combines ``Remove Markers`` and
3815 ``Remove Error Indicators``.
3816 ==================================== ==================== ==================================================
3821 =============================== ========================= ==================================================
3822 Action Default shortcut Description
3823 =============================== ========================= ==================================================
3824 New Create a new project.
3825 Open Opens a project file.
3826 Properties Shows project properties.
3827 Close Close the current project.
3828 =============================== ========================= ==================================================
3833 =============================== ========================= ==================================================
3834 Action Default shortcut Description
3835 =============================== ========================= ==================================================
3836 Compile F8 Compiles the current file.
3838 Build F9 Builds (compiles if necessary and links) the
3841 Make all Shift-F9 Builds the current file with the Make tool.
3843 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3846 Make object Shift-F8 Compiles the current file with the Make tool.
3848 Next error Jumps to the line with the next error from the
3851 Previous error Jumps to the line with the previous error from
3852 the last build process.
3854 Run F5 Executes the current file in a terminal emulation.
3856 Set Build Commands Opens the build commands dialog.
3857 =============================== ========================= ==================================================
3862 =============================== ========================= ==================================================
3863 Action Default shortcut Description
3864 =============================== ========================= ==================================================
3865 Show Color Chooser Opens the Color Chooser dialog.
3866 =============================== ========================= ==================================================
3871 =============================== ========================= ==================================================
3872 Action Default shortcut Description
3873 =============================== ========================= ==================================================
3874 Help F1 (C) Opens the manual.
3875 =============================== ========================= ==================================================
3883 You must use UTF-8 encoding *without BOM* for configuration files.
3886 Configuration file paths
3887 ------------------------
3888 Geany has default configuration files installed for the system and
3889 also per-user configuration files.
3891 The system files should not normally be edited because they will be
3892 overwritten when upgrading Geany.
3894 The user configuration directory can be overridden with the ``-c``
3895 switch, but this is not normally done. See `Command line options`_.
3898 Any missing subdirectories in the user configuration directory
3899 will be created when Geany starts.
3901 You can check the paths Geany is using with *Help->Debug Messages*.
3902 Near the top there should be 2 lines with something like::
3904 Geany-INFO: System data dir: /usr/share/geany
3905 Geany-INFO: User config dir: /home/username/.config/geany
3908 Paths on Unix-like systems
3909 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3910 The system path is ``$prefix/share/geany``, where ``$prefix`` is the
3911 path where Geany is installed (see `Installation prefix`_).
3913 The user configuration directory is normally:
3914 ``/home/username/.config/geany``
3918 The system path is the ``data`` subfolder of the installation path
3921 The user configuration directory might vary, but on Windows XP it's:
3922 ``C:\Documents and Settings\UserName\Application Data\geany``
3923 On Windows 7 and above you most likely will find it at:
3924 ``C:\users\UserName\Roaming\geany``
3929 There's a *Configuration files* submenu in the *Tools* menu that
3930 contains items for some of the available user configuration files.
3931 Clicking on one opens it in the editor for you to update. Geany will
3932 reload the file after you have saved it.
3935 Other configuration files not shown here will need to be opened
3936 manually, and will not be automatically reloaded when saved.
3937 (see *Reload Configuration* below).
3939 There's also a *Reload Configuration* item which can be used if you
3940 updated one of the other configuration files, or modified or added
3943 *Reload Configuration* is also necessary to update syntax highlighting colors.
3946 Syntax highlighting colors aren't updated in open documents after
3947 saving filetypes.common as this may take a significant
3951 Global configuration file
3952 -------------------------
3954 System administrators can add a global configuration file for Geany
3955 which will be used when starting Geany and a user configuration file
3958 The global configuration file is read from ``geany.conf`` in the
3959 system configuration path - see `Configuration file paths`_. It can
3960 contain any settings which are found in the usual configuration file
3961 created by Geany, but does not have to contain all settings.
3964 This feature is mainly intended for package maintainers or system
3965 admins who want to set up Geany in a multi user environment and
3966 set some sane default values for this environment. Usually users won't
3971 Filetype definition files
3972 -------------------------
3974 All color definitions and other filetype specific settings are
3975 stored in the filetype definition files. Those settings are colors
3976 for syntax highlighting, general settings like comment characters or
3977 word delimiter characters as well as compiler and linker settings.
3979 See also `Configuration file paths`_.
3983 Each filetype has a corresponding filetype definition file. The format
3984 for built-in filetype `Foo` is::
3988 The extension is normally just the filetype name in lower case.
3990 However there are some exceptions:
3992 =============== =========
3994 =============== =========
3998 Matlab/Octave matlab
3999 =============== =========
4001 There is also the `special file filetypes.common`_.
4003 For `custom filetypes`_, the filename for `Foo` is different::
4007 See the link for details.
4011 The system-wide filetype configuration files can be found in the
4012 system configuration path and are called ``filetypes.$ext``,
4013 where $ext is the name of the filetype. For every
4014 filetype there is a corresponding definition file. There is one
4015 exception: ``filetypes.common`` -- this file is for general settings,
4016 which are not specific to a certain filetype.
4019 It is not recommended that users edit the system-wide files,
4020 because they will be overridden when Geany is updated.
4024 To change the settings, copy a file from the system configuration
4025 path to the subdirectory ``filedefs`` in your user configuration
4026 directory. Then you can edit the file and the changes will still be
4027 available after an update of Geany.
4029 Alternatively, you can create the file yourself and add only the
4030 settings you want to change. All missing settings will be read from
4031 the corresponding system configuration file.
4035 At startup Geany looks for ``filetypes.*.conf`` files in the system and
4036 user filetype paths, adding any filetypes found with the name matching
4037 the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
4039 Custom filetypes are not as powerful as built-in filetypes, but
4040 support for the following has been implemented:
4042 * Recognizing and setting the filetype (after the user has manually updated
4043 the `filetype extensions`_ file).
4044 * `Filetype group membership`_.
4045 * Reading filetype settings in the ``[settings]`` section, including:
4046 * Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
4047 * Using an existing tags parser (`tag_parser`_ key).
4048 * Build commands (``[build-menu]`` section).
4049 * Loading global tags files (sharing the ``tag_parser`` filetype's namespace).
4051 See `Filetype configuration`_ for details on each setting.
4053 Creating a custom filetype from an existing filetype
4054 ````````````````````````````````````````````````````
4055 Because most filetype settings will relate to the syntax
4056 highlighting (e.g. styling, keywords, ``lexer_properties``
4057 sections), it is best to copy an existing filetype file that uses
4058 the lexer you wish to use as the basis of a custom filetype, using
4059 the correct filename extension format shown above, e.g.::
4061 cp filetypes.foo filetypes.Bar.conf
4063 Then add the ``lexer_filetype=Foo`` setting (if not already present)
4064 and add/adjust other settings.
4067 The ``[styling]`` and ``[keywords]`` sections have key names
4068 specific to each filetype/lexer. You must follow the same
4069 names - in particular, some lexers only support one keyword
4073 Filetype configuration
4074 ^^^^^^^^^^^^^^^^^^^^^^
4076 As well as the sections listed below, each filetype file can contain
4077 a [build-menu] section as described in `[build-menu] section`_.
4082 In this section the colors for syntax highlighting are defined. The
4085 * ``key=foreground_color;background_color;bold_flag;italic_flag``
4087 Colors have to be specified as RGB hex values prefixed by
4088 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4089 are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
4090 values are case-insensitive but it is a good idea to use lower-case.
4091 Note that you can also use *named colors* as well by substituting the
4092 color value with the name of a color as defined in the ``[named_colors]``
4093 section, see the `[named_colors] Section`_ for more information.
4095 Bold and italic are flags and should only be "true" or "false". If their
4096 value is something other than "true" or "false", "false" is assumed.
4098 You can omit fields to use the values from the style named ``"default"``.
4100 E.g. ``key=0xff0000;;true``
4102 This makes the key style have red foreground text, default background
4103 color text and bold emphasis.
4107 The second format uses a *named style* name to reference a style
4108 defined in filetypes.common.
4110 * ``key=named_style``
4111 * ``key2=named_style2,bold,italic``
4113 The bold and italic parts are optional, and if present are used to
4114 toggle the bold or italic flags to the opposite of the named style's
4115 flags. In contrast to style definition booleans, they are a literal
4116 ",bold,italic" and commas are used instead of semi-colons.
4118 E.g. ``key=comment,italic``
4120 This makes the key style match the ``"comment"`` named style, but with
4123 To define named styles, see the filetypes.common `[named_styles]
4126 Reading styles from another filetype
4127 ************************************
4128 You can automatically copy all of the styles from another filetype
4129 definition file by using the following syntax for the ``[styling]``
4134 Where Foo is a filetype name. The corresponding ``[styling]``
4135 section from ``filetypes.foo`` will be read.
4137 This is useful when the same lexer is being used for multiple
4138 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4139 styling the same as the C styling, you would put the following in
4148 This section contains keys for different keyword lists specific to
4149 the filetype. Some filetypes do not support keywords, so adding a
4150 new key will not work. You can only add or remove keywords to/from
4154 The keywords list must be in one line without line ending characters.
4157 [lexer_properties] section
4158 ``````````````````````````
4159 Here any special properties for the Scintilla lexer can be set in the
4160 format ``key.name.field=some.value``.
4162 Properties Geany uses are listed in the system filetype files. To find
4163 other properties you need Geany's source code::
4165 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
4172 This is the default file extension used when saving files, not
4173 including the period character (``.``). The extension used should
4174 match one of the patterns associated with that filetype (see
4175 `Filetype extensions`_).
4177 *Example:* ``extension=cxx``
4180 These characters define word boundaries when making selections
4181 and searching using word matching options.
4183 *Example:* (look at system filetypes.\* files)
4186 This overrides the *wordchars* filetypes.common setting, and
4187 has precedence over the *whitespace_chars* setting.
4190 A character or string which is used to comment code. If you want to use
4191 multiline comments only, don't set this but rather comment_open and
4194 Single-line comments are used in priority over multiline comments to
4195 comment a line, e.g. with the `Comment/Uncomment line` command.
4197 *Example:* ``comment_single=//``
4200 A character or string which is used to comment code. You need to also
4201 set comment_close to really use multiline comments. If you want to use
4202 single-line comments, prefer setting comment_single.
4204 Multiline comments are used in priority over single-line comments to
4205 comment a block, e.g. template comments.
4207 *Example:* ``comment_open=/*``
4210 If multiline comments are used, this is the character or string to
4213 *Example:* ``comment_close=*/``
4216 Set this to false if a comment character or string should start at
4217 column 0 of a line. If set to true it uses any indentation of the
4220 Note: Comment indentation
4222 ``comment_use_indent=true`` would generate this if a line is
4223 commented (e.g. with Ctrl-D)::
4227 ``comment_use_indent=false`` would generate this if a line is
4228 commented (e.g. with Ctrl-D)::
4230 # command_example();
4233 Note: This setting only works for single line comments (like '//',
4236 *Example:* ``comment_use_indent=true``
4239 A command which can be executed on the current word or the current
4242 Example usage: Open the API documentation for the
4243 current function call at the cursor position.
4246 be set for every filetype or if not set, a global command will
4247 be used. The command itself can be specified without the full
4248 path, then it is searched in $PATH. But for security reasons,
4249 it is recommended to specify the full path to the command. The
4250 wildcard %s will be replaced by the current word at the cursor
4251 position or by the current selection.
4253 Hint: for PHP files the following could be quite useful:
4254 context_action_cmd=firefox "http://www.php.net/%s"
4256 *Example:* ``context_action_cmd=devhelp -s "%s"``
4261 The TagManager language name, e.g. "C". Usually the same as the
4267 A filetype name to setup syntax highlighting from another filetype.
4268 This must not be recursive, i.e. it should be a filetype name that
4269 doesn't use the *lexer_filetype* key itself, e.g.::
4274 The second line is wrong, because ``filetypes.cpp`` itself uses
4275 ``lexer_filetype=C``, which would be recursive.
4277 symbol_list_sort_mode
4278 What the default symbol list sort order should be.
4280 ===== ========================================
4282 ===== ========================================
4283 0 Sort symbols by name
4284 1 Sort symbols by appearance (line number)
4285 ===== ========================================
4287 .. _xml_indent_tags:
4290 If this setting is set to *true*, a new line after a line ending with an
4291 unclosed XML/HTML tag will be automatically indented. This only applies
4292 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4293 this setting in their system configuration files.
4296 The MIME type for this file type, e.g. "text/x-csrc". This is used
4297 for example to chose the icon to display for this file type.
4300 [indentation] section
4301 `````````````````````
4303 This section allows definition of default indentation settings specific to
4304 the file type, overriding the ones configured in the preferences. This can
4305 be useful for file types requiring specific indentation settings (e.g. tabs
4306 only for Makefile). These settings don't override auto-detection if activated.
4309 The forced indentation width.
4312 The forced indentation type.
4314 ===== =======================
4315 Value Indentation type
4316 ===== =======================
4319 2 Mixed (tabs and spaces)
4320 ===== =======================
4323 [build-menu] filetype section
4324 `````````````````````````````
4325 This supports the same keys as the ``geany.conf`` `[build-menu] section`_.
4330 FT_00_CM=gcc -c "%f"
4333 FT_01_CM=gcc -o "%e" "%f"
4338 error_regex=^([^:]+):([0-9]+):
4340 [build_settings] section
4341 ````````````````````````
4342 As of Geany 0.19 this section is for legacy support.
4343 Values that are set in the [build-menu] section will override those in this section.
4345 If any build menu item settings have been configured in the
4346 `Set Build Commands dialog`_ (or the *Build* tab of the
4347 `Project Properties`_ dialog), then these settings are stored in the
4348 [build-menu] section and will override the settings in this section for
4352 See the [build-menu] section for details.
4357 This item specifies the command to compile source code files. But
4358 it is also possible to use it with interpreted languages like Perl
4359 or Python. With these filetypes you can use this option as a kind of
4360 syntax parser, which sends output to the compiler message window.
4362 You should quote the filename to also support filenames with
4363 spaces. The following wildcards for filenames are available:
4365 * %f -- complete filename without path
4366 * %e -- filename without path and without extension
4368 *Example:* ``compiler=gcc -Wall -c "%f"``
4371 This item specifies the command to link the file. If the file is not
4372 already compiled, it will be compiled while linking. The -o option
4373 is automatically added by Geany. This item works well with GNU gcc,
4374 but may be problematic with other compilers (esp. with the linker).
4376 *Example:* ``linker=gcc -Wall "%f"``
4379 Use this item to execute your file. It has to have been built
4380 already. Use the %e wildcard to have only the name of the executable
4381 (i.e. without extension) or use the %f wildcard if you need the
4382 complete filename, e.g. for shell scripts.
4384 *Example:* ``run_cmd="./%e"``
4387 Special file filetypes.common
4388 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4390 There is a special filetype definition file called
4391 filetypes.common. This file defines some general non-filetype-specific
4394 You can open the user filetypes.common with the
4395 *Tools->Configuration Files->filetypes.common* menu item. This adds
4396 the default settings to the user file if the file doesn't exist.
4397 Alternatively the file can be created manually, adding only the
4398 settings you want to change. All missing settings will be read from
4402 See the `Filetype configuration`_ section for how to define styles.
4405 [named_styles] section
4406 ``````````````````````
4407 Named styles declared here can be used in the [styling] section of any
4412 *In filetypes.common*::
4415 foo=0xc00000;0xffffff;false;true
4423 This saves copying and pasting the whole style definition into several
4427 You can define aliases for named styles, as shown with the ``bar``
4428 entry in the above example, but they must be declared after the
4432 [named_colors] section
4433 ``````````````````````
4434 Named colors declared here can be used in the ``[styling]`` or
4435 ``[named_styles]`` section of any filetypes.* file or color scheme.
4440 my_red_color=#FF0000
4441 my_blue_color=#0000FF
4444 foo=my_red_color;my_blue_color;false;true
4446 This allows to define a color palette by name so that to change a color
4447 scheme-wide only involves changing the hex value in a single location.
4452 This is the default style. It is used for styling files without a
4455 *Example:* ``default=0x000000;0xffffff;false;false``
4458 The style for coloring selected text. The format is:
4462 * Use foreground color
4463 * Use background color
4465 The colors are only set if the 3rd or 4th argument is true. When
4466 the colors are not overridden, the default is a dark grey
4467 background with syntax highlighted foreground text.
4469 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
4472 The style for brace highlighting when a matching brace was found.
4474 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
4477 The style for brace highlighting when no matching brace was found.
4479 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
4482 The style for coloring the caret(the blinking cursor). Only first
4483 and third argument is interpreted.
4484 Set the third argument to true to change the caret into a block caret.
4486 *Example:* ``caret=0x000000;0x0;false;false``
4489 The width for the caret(the blinking cursor). Only the first
4490 argument is interpreted. The width is specified in pixels with
4491 a maximum of three pixel. Use the width 0 to make the caret
4494 *Example:* ``caret_width=3``
4497 The style for coloring the background of the current line. Only
4498 the second and third arguments are interpreted. The second argument
4499 is the background color. Use the third argument to enable or
4500 disable background highlighting for the current line (has to be
4503 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
4506 The style for coloring the indentation guides. Only the first and
4507 second arguments are interpreted.
4509 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
4512 The style for coloring the white space if it is shown. The first
4513 both arguments define the foreground and background colors, the
4514 third argument sets whether to use the defined foreground color
4515 or to use the color defined by each filetype for the white space.
4516 The fourth argument defines whether to use the background color.
4518 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
4521 Line number margin foreground and background colors.
4523 .. _Folding Settings:
4526 Fold margin foreground and background colors.
4528 fold_symbol_highlight
4529 Highlight color of folding symbols.
4532 The style of folding icons. Only first and second arguments are
4535 Valid values for the first argument are:
4542 Valid values for the second argument are:
4545 * 1 -- for straight lines
4546 * 2 -- for curved lines
4548 *Default:* ``folding_style=1;1;``
4550 *Arrows:* ``folding_style=3;0;``
4553 Draw a thin horizontal line at the line where text is folded. Only
4554 first argument is used.
4556 Valid values for the first argument are:
4558 * 0 -- disable, do not draw a line
4559 * 1 -- draw the line above folded text
4560 * 2 -- draw the line below folded text
4562 *Example:* ``folding_horiz_line=0;0;false;false``
4565 First argument: drawing of visual flags to indicate a line is wrapped.
4566 This is a bitmask of the values:
4568 * 0 -- No visual flags
4569 * 1 -- Visual flag at end of subline of a wrapped line
4570 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
4571 indented by at least 1 to make room for the flag.
4573 Second argument: wether the visual flags to indicate a line is wrapped
4574 are drawn near the border or near the text. This is a bitmask of the values:
4576 * 0 -- Visual flags drawn near border
4577 * 1 -- Visual flag at end of subline drawn near text
4578 * 2 -- Visual flag at begin of subline drawn near text
4580 Only first and second arguments are interpreted.
4582 *Example:* ``line_wrap_visuals=3;0;false;false``
4585 First argument: sets the size of indentation of sublines for wrapped lines
4586 in terms of the width of a space, only used when the second argument is ``0``.
4588 Second argument: wrapped sublines can be indented to the position of their
4589 first subline or one more indent level. Possible values:
4591 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4592 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4593 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4595 Only first and second arguments are interpreted.
4597 *Example:* ``line_wrap_indent=0;1;false;false``
4600 Translucency for the current line (first argument) and the selection
4601 (second argument). Values between 0 and 256 are accepted.
4603 Note for Windows 95, 98 and ME users:
4604 keep this value at 256 to disable translucency otherwise Geany might crash.
4606 Only the first and second arguments are interpreted.
4608 *Example:* ``translucency=256;256;false;false``
4611 The style for a highlighted line (e.g when using Goto line or goto symbol).
4612 The foreground color (first argument) is only used when the Markers margin
4613 is enabled (see View menu).
4615 Only the first and second arguments are interpreted.
4617 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4620 The style for a marked search results (when using "Mark" in Search dialogs).
4621 The second argument sets the background color for the drawn rectangle.
4623 Only the second argument is interpreted.
4625 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4628 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4629 (Ctrl-M)). The foreground color (first argument) is only used
4630 when the Markers margin is enabled (see View menu).
4632 Only the first and second arguments are interpreted.
4634 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4637 Translucency for the line marker (first argument) and the search marker
4638 (second argument). Values between 0 and 256 are accepted.
4640 Note for Windows 95, 98 and ME users:
4641 keep this value at 256 to disable translucency otherwise Geany might crash.
4643 Only the first and second arguments are interpreted.
4645 *Example:* ``marker_translucency=256;256;false;false``
4648 Amount of space to be drawn above and below the line's baseline.
4649 The first argument defines the amount of space to be drawn above the line, the second
4650 argument defines the amount of space to be drawn below.
4652 Only the first and second arguments are interpreted.
4654 *Example:* ``line_height=0;0;false;false``
4657 The style for coloring the calltips. The first two arguments
4658 define the foreground and background colors, the third and fourth
4659 arguments set whether to use the defined colors.
4661 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4664 The color of the error indicator.
4666 Only the first argument (foreground color) is used.
4668 *Example:* ``indicator_error=0xff0000``
4674 Characters to treat as whitespace. These characters are ignored
4675 when moving, selecting and deleting across word boundaries
4676 (see `Scintilla keyboard commands`_).
4678 This should include space (\\s) and tab (\\t).
4680 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4683 These characters define word boundaries when making selections
4684 and searching using word matching options.
4686 *Example:* ``wordchars=_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``
4689 This has precedence over the *whitespace_chars* setting.
4697 To change the default filetype extension used when saving a new file,
4698 see `Filetype definition files`_.
4700 You can override the list of file extensions that Geany uses to detect
4701 filetypes using the user ``filetype_extensions.conf`` file. Use the
4702 *Tools->Configuration Files->filetype_extensions.conf* menu item. See
4703 also `Configuration file paths`_.
4705 You should only list lines for filetype extensions that you want to
4706 override in the user configuration file and remove or comment out
4707 others. The patterns are listed after the ``=`` sign, using a
4708 semi-colon separated list of patterns which should be matched for
4711 For example, to override the filetype extensions for Make, the file
4715 Make=Makefile*;*.mk;Buildfile;
4717 Filetype group membership
4718 ^^^^^^^^^^^^^^^^^^^^^^^^^
4719 Filetype groups are used in the `Document->Set Filetype` menu.
4721 Group membership is also stored in ``filetype_extensions.conf``. This
4722 file is used to store information Geany needs at startup, whereas the
4723 separate filetype definition files hold information only needed when
4724 a document with their filetype is used.
4726 The format looks like::
4735 The key names cannot be configured.
4738 Group membership is only read at startup.
4741 You can make commonly used filetypes appear in the top-level of the
4742 filetype menu by adding them to the `None` group, e.g.
4745 Preferences file format
4746 -----------------------
4748 The user preferences file ``geany.conf`` holds settings for all the items configured
4749 in the preferences dialog. This file should not be edited while Geany is running
4750 as the file will be overwritten when the preferences in Geany are changed or Geany
4754 [build-menu] section
4755 ^^^^^^^^^^^^^^^^^^^^
4757 The [build-menu] section contains the configuration of the build menu.
4758 This section can occur in filetype, preferences and project files and
4759 always has the format described here. Different menu items are loaded
4760 from different files, see the table in the `Build Menu Configuration`_
4761 section for details. All the settings can be configured from the dialogs
4762 except the execute command in filetype files and filetype definitions in
4763 the project file, so these are the only ones which need hand editing.
4767 The build-menu section stores one entry for each setting for each menu item that
4768 is configured. The keys for these settings have the format:
4774 * GG - is the menu item group,
4776 - FT for filetype build
4777 - NF for independent (non-filetype) build
4780 * NN - is a two decimal digit number of the item within the group,
4782 * FF - is the field,
4786 - WD for working directory
4788 See `[build-menu] filetype section`_ for an example.
4790 Error regular expression
4791 ````````````````````````
4793 This is a Perl-compatible regular expression (PCRE) to parse a filename
4794 (absolute or relative) and line number from the build output.
4795 If undefined, Geany will fall back to its default error message parsing.
4797 Only the first two match groups will be read by Geany. These groups can
4798 occur in any order: the match group consisting of only digits will be used
4799 as the line number, and the other group as the filename. In no group
4800 consists of only digits, the match will fail.
4802 *Example:* ``error_regex=^(.+):([0-9]+):[0-9]+``
4804 This will parse a message such as:
4805 ``test.py:7:24: E202 whitespace before ']'``
4811 The project file contains project related settings and possibly a
4812 record of the current session files.
4815 [build-menu] additions
4816 ^^^^^^^^^^^^^^^^^^^^^^
4818 The project file also can have extra fields in the [build-menu] section
4819 in addition to those listed in `[build-menu] section`_ above.
4821 When filetype menu items are configured for the project they are stored
4822 in the project file.
4824 The ``filetypes`` entry is a list of the filetypes which exist in the
4827 For each filetype the entries for that filetype have the format defined in
4828 `[build-menu] section`_ but the key is prefixed by the name of the filetype
4829 as it appears in the ``filetypes`` entry, eg the entry for the label of
4830 filetype menu item 0 for the C filetype would be
4838 Geany supports the following templates:
4842 * Function description
4847 To use these templates, just open the Edit menu or open the popup menu
4848 by right-clicking in the editor widget, and choose "Insert Comments"
4849 and insert templates as you want.
4851 Some templates (like File header or ChangeLog entry) will always be
4852 inserted at the top of the file.
4854 To insert a function description, the cursor must be inside
4855 of the function, so that the function name can be determined
4856 automatically. The description will be positioned correctly one line
4857 above the function, just check it out. If the cursor is not inside
4858 of a function or the function name cannot be determined, the inserted
4859 function description won't contain the correct function name but "unknown"
4863 Geany automatically reloads template information when it notices you
4864 save a file in the user's template configuration directory. You can
4865 also force this by selecting *Tools->Reload Configuration*.
4871 Meta data can be used with all templates, but by default user set
4872 meta data is only used for the ChangeLog and File header templates.
4874 In the configuration dialog you can find a tab "Templates" (see
4875 `Template preferences`_). You can define the default values
4876 which will be inserted in the templates.
4882 File templates are templates used as the basis of a new file. To
4883 use them, choose the *New (with Template)* menu item from the *File*
4886 By default, file templates are installed for some filetypes. Custom
4887 file templates can be added by creating the appropriate template file. You can
4888 also edit the default file templates.
4890 The file's contents are just the text to place in the document, with
4891 optional template wildcards like ``{fileheader}``. The fileheader
4892 wildcard can be placed anywhere, but it's usually put on the first
4893 line of the file, followed by a blank line.
4895 Adding file templates
4896 `````````````````````
4898 File templates are read from ``templates/files`` under the
4899 `Configuration file paths`_.
4901 The filetype to use is detected from the template file's extension, if
4902 any. For example, creating a file ``module.c`` would add a menu item
4903 which created a new document with the filetype set to 'C'.
4905 The template file is read from disk when the corresponding menu item is
4909 Customizing templates
4910 ^^^^^^^^^^^^^^^^^^^^^
4912 Each template can be customized to your needs. The templates are
4913 stored in the ``~/.config/geany/templates/`` directory (see the section called
4914 `Command line options`_ for further information about the configuration
4915 directory). Just open the desired template with an editor (ideally,
4916 Geany ;-) ) and edit the template to your needs. There are some
4917 wildcards which will be automatically replaced by Geany at startup.
4923 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4925 **Wildcards for character escaping**
4927 ============== ============================================= =======================================
4928 Wildcard Description Available in
4929 ============== ============================================= =======================================
4930 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4931 wildcards being expanded).
4932 cb } Closing Brace. file templates, file header, snippets.
4933 pc \% Percent (used to escape e.g. %block% in
4934 snippets). snippets.
4935 ============== ============================================= =======================================
4937 **Global wildcards**
4939 These are configurable, see `Template preferences`_.
4941 ============== ============================================= =======================================
4942 Wildcard Description Available in
4943 ============== ============================================= =======================================
4944 developer The name of the developer. file templates, file header,
4945 function description, ChangeLog entry,
4948 initial The developer's initials, e.g. "ET" for file templates, file header,
4949 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4952 mail The email address of the developer. file templates, file header,
4953 function description, ChangeLog entry,
4956 company The company the developer is working for. file templates, file header,
4957 function description, ChangeLog entry,
4960 version The initial version of a new file. file templates, file header,
4961 function description, ChangeLog entry,
4963 ============== ============================================= =======================================
4965 **Date & time wildcards**
4967 The format for these wildcards can be changed in the preferences
4968 dialog, see `Template preferences`_. For a list of available conversion
4969 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
4971 ============== ============================================= =======================================
4972 Wildcard Description Available in
4973 ============== ============================================= =======================================
4974 year The current year. Default format is: YYYY. file templates, file header,
4975 function description, ChangeLog entry,
4978 date The current date. Default format: file templates, file header,
4979 YYYY-MM-DD. function description, ChangeLog entry,
4982 datetime The current date and time. Default format: file templates, file header,
4983 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4985 ============== ============================================= =======================================
4987 **Dynamic wildcards**
4989 ============== ============================================= =======================================
4990 Wildcard Description Available in
4991 ============== ============================================= =======================================
4992 untitled The string "untitled" (this will be file templates, file header,
4993 translated to your locale), used in function description, ChangeLog entry,
4994 file templates. bsd, gpl, snippets.
4996 geanyversion The actual Geany version, e.g. file templates, file header,
4997 "Geany |(version)|". function description, ChangeLog entry,
5000 filename The filename of the current file. file header, snippets, file
5001 For new files, it's only replaced when templates.
5002 first saving if found on the first 4 lines
5005 project The current project's name, if any. file header, snippets, file templates.
5007 description The current project's description, if any. file header, snippets, file templates.
5009 functionname The function name of the function at the function description.
5010 cursor position. This wildcard will only be
5011 replaced in the function description
5014 command:path Executes the specified command and replace file templates, file header,
5015 the wildcard with the command's standard function description, ChangeLog entry,
5016 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
5018 ============== ============================================= =======================================
5020 **Template insertion wildcards**
5022 ============== ============================================= =======================================
5023 Wildcard Description Available in
5024 ============== ============================================= =======================================
5025 gpl This wildcard inserts a short GPL notice. file header.
5027 bsd This wildcard inserts a BSD licence notice. file header.
5029 fileheader The file header template. This wildcard snippets, file templates.
5030 will only be replaced in file templates.
5031 ============== ============================================= =======================================
5034 Special {command:} wildcard
5035 ***************************
5037 The {command:} wildcard is a special one because it can execute
5038 a specified command and put the command's output (stdout) into
5047 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
5049 Using this wildcard you can insert nearly any arbitrary text into the
5052 In the environment of the executed command the variables
5053 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
5054 The value of these variables is filled in only if Geany knows about it.
5055 For example, ``GEANY_FUNCNAME`` is only filled within the function
5056 description template. However, these variables are ``always`` set,
5057 just maybe with an empty value.
5058 You can easily access them e.g. within an executed shell script using::
5064 If the specified command could not be found or not executed, the wildcard is substituted
5065 by an empty string. In such cases, you can find the occurred error message on Geany's
5066 standard error and in the Help->Debug Messages dialog.
5069 Customizing the toolbar
5070 -----------------------
5072 You can add, remove and reorder the elements in the toolbar by using
5073 the toolbar editor, or by manually editing the configuration file
5076 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5077 by right-clicking on the toolbar itself and choosing it from the menu.
5079 Manually editing the toolbar layout
5080 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5082 To override the system-wide configuration file, copy it to your user
5083 configuration directory (see `Configuration file paths`_).
5087 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5089 Then edit it and add any of the available elements listed in the file or remove
5090 any of the existing elements. Of course, you can also reorder the elements as
5091 you wish and add or remove additional separators.
5092 This file must be valid XML, otherwise the global toolbar UI definition
5093 will be used instead.
5095 Your changes are applied once you save the file.
5098 (1) You cannot add new actions which are not listed below.
5099 (2) Everything you add or change must be inside the /ui/toolbar/ path.
5102 Available toolbar elements
5103 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5105 ================== ==============================================================================
5106 Element name Description
5107 ================== ==============================================================================
5108 New Create a new file
5109 Open Open an existing file
5110 Save Save the current file
5111 SaveAll Save all open files
5112 Reload Reload the current file from disk
5113 Close Close the current file
5114 CloseAll Close all open files
5115 Print Print the current file
5116 Cut Cut the current selection
5117 Copy Copy the current selection
5118 Paste Paste the contents of the clipboard
5119 Delete Delete the current selection
5120 Undo Undo the last modification
5121 Redo Redo the last modification
5122 NavBack Navigate back a location
5123 NavFor Navigate forward a location
5124 Compile Compile the current file
5125 Build Build the current file, includes a submenu for Make commands. Geany
5126 remembers the last chosen action from the submenu and uses this as default
5127 action when the button itself is clicked.
5128 Run Run or view the current file
5129 Color Open a color chooser dialog, to interactively pick colors from a palette
5130 ZoomIn Zoom in the text
5131 ZoomOut Zoom out the text
5132 UnIndent Decrease indentation
5133 Indent Increase indentation
5134 Replace Replace text in the current document
5135 SearchEntry The search field belonging to the 'Search' element (can be used alone)
5136 Search Find the entered text in the current file (only useful if you also
5138 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
5139 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
5140 Preferences Show the preferences dialog
5142 ================== ==============================================================================
5146 Plugin documentation
5147 ====================
5152 The HTML Characters plugin helps when working with special
5153 characters in XML/HTML, e.g. German Umlauts ü and ä.
5156 Insert entity dialog
5157 ^^^^^^^^^^^^^^^^^^^^
5159 When the plugin is enabled, you can insert special character
5160 entities using *Tools->Insert Special HTML Characters*.
5162 This opens up a dialog where you can find a huge amount of special
5163 characters sorted by category that you might like to use inside your
5164 document. You can expand and collapse the categories by clicking on
5165 the little arrow on the left hand side. Once you have found the
5166 desired character click on it and choose "Insert". This will insert
5167 the entity for the character at the current cursor position. You
5168 might also like to double click the chosen entity instead.
5171 Replace special chars by its entity
5172 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5174 To help make a XML/HTML document valid the plugin supports
5175 replacement of special chars known by the plugin. Both bulk
5176 replacement and immediate replacement during typing are supported.
5178 A few characters will not be replaced. These are
5189 You can activate/deactivate this feature using the *Tools->HTML
5190 Replacement->Auto-replace Special Characters* menu item. If it's
5191 activated, all special characters (beside the given exceptions from
5192 above) known by the plugin will be replaced by their entities.
5194 You could also set a keybinding for the plugin to toggle the status
5201 After inserting a huge amount of text, e.g. by using copy & paste, the
5202 plugin allows bulk replacement of all known characters (beside the
5203 mentioned exceptions). You can find the function under the same
5204 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
5205 configure a keybinding for the plugin.
5214 This plugin provides an option to automatically save documents.
5215 You can choose to save the current document, or all of your documents, at
5222 You can save the current document when the editor's focus goes out.
5223 Every pop-up, menu dialogs, or anything else that can make the editor lose the focus,
5224 will make the current document to be saved.
5229 This plugin sets on every new file (*File->New* or *File->New (with template)*)
5230 a randomly chosen filename and set its filetype appropriate to the used template
5231 or when no template was used, to a configurable default filetype.
5232 This enables you to quickly compile, build and/or run the new file without the
5233 need to give it an explicit filename using the Save As dialog. This might be
5234 useful when you often create new files just for testing some code or something
5241 This plugin creates a backup copy of the current file in Geany when it is
5242 saved. You can specify the directory where the backup copy is saved and
5243 you can configure the automatically added extension in the configure dialog
5244 in Geany's plugin manager.
5246 After the plugin was loaded in Geany's plugin manager, every file is
5247 copied into the configured backup directory *after* the file has been saved
5250 The created backup copy file permissions are set to read-write only for
5251 the user. This should help to not create world-readable files on possibly
5252 unsecure destination directories like /tmp (especially useful
5253 on multi-user systems).
5254 This applies only to non-Windows systems. On Windows, no explicit file
5255 permissions are set.
5258 Additionally, you can define how many levels of the original file's
5259 directory structure should be replicated in the backup copy path.
5260 For example, setting the option
5261 *Directory levels to include in the backup destination* to *2*
5262 cause the plugin to create the last two components of the original
5263 file's path in the backup copy path and place the new file there.
5266 Contributing to this document
5267 =============================
5269 This document (``geany.txt``) is written in `reStructuredText`__
5270 (or "reST"). The source file for it is located in Geany's ``doc``
5271 subdirectory. If you intend on making changes, you should grab the
5272 source right from Git to make sure you've got the newest version.
5273 First, you need to configure the build system to generate the HTML
5274 documentation passing the *--enable-html-docs* option to the *configure*
5275 script. Then after editing the file, run ``make`` (from the root build
5276 directory or from the *doc* subdirectory) to build the HTML documentation
5277 and see how your changes look. This regenerates the ``geany.html`` file
5278 inside the *doc* subdirectory. To generate a PDF file, configure with
5279 *--enable-pdf-docs* and run ``make`` as for the HTML version. The generated
5280 PDF file is named geany-|(version)|.pdf and is located inside the *doc*
5283 __ http://docutils.sourceforge.net/rst.html
5285 After you are happy with your changes, create a patch e.g. by using::
5287 % git diff geany.txt > foo.patch
5289 or even better, by creating a Git-formatted patch which will keep authoring
5290 and description data, by first committing your changes (doing so in a fresh
5291 new branch is recommended for `master` not to diverge from upstream) and then
5292 using git format-patch::
5294 % git checkout -b my-documentation-changes # create a fresh branch
5295 % git commit geany.txt
5296 Write a good commit message...
5297 % git format-patch HEAD^
5298 % git checkout master # go back to master
5300 and then submit that file to the mailing list for review.
5302 Also you can clone the Geany repository at GitHub and send a pull request.
5304 Note, you will need the Python docutils software package installed
5305 to build the docs. The package is named ``python-docutils`` on Debian
5311 Scintilla keyboard commands
5312 ===========================
5314 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
5316 This appendix is distributed under the terms of the License for
5317 Scintilla and SciTE. A copy of this license can be found in the file
5318 ``scintilla/License.txt`` included with the source code of this
5319 program and in the appendix of this document. See `License for
5320 Scintilla and SciTE`_.
5329 Keyboard commands for Scintilla mostly follow common Windows and GTK+
5330 conventions. All move keys (arrows, page up/down, home and end)
5331 allows to extend or reduce the stream selection when holding the
5332 Shift key, and the rectangular selection when holding the
5333 appropriate keys (see `Column mode editing (rectangular selections)`_).
5335 Some keys may not be available with some national keyboards
5336 or because they are taken by the system such as by a window manager
5337 or GTK. Keyboard equivalents of menu commands are listed in the
5338 menus. Some less common commands with no menu equivalent are:
5340 ============================================= ======================
5342 ============================================= ======================
5343 Magnify text size. Ctrl-Keypad+
5344 Reduce text size. Ctrl-Keypad-
5345 Restore text size to normal. Ctrl-Keypad/
5347 Dedent block. Shift-Tab
5348 Delete to start of word. Ctrl-BackSpace
5349 Delete to end of word. Ctrl-Delete
5350 Delete to start of line. Ctrl-Shift-BackSpace
5351 Go to start of document. Ctrl-Home
5352 Extend selection to start of document. Ctrl-Shift-Home
5353 Go to start of display line. Alt-Home
5354 Extend selection to start of display line. Alt-Shift-Home
5355 Go to end of document. Ctrl-End
5356 Extend selection to end of document. Ctrl-Shift-End
5357 Extend selection to end of display line. Alt-Shift-End
5358 Previous paragraph. Shift extends selection. Ctrl-Up
5359 Next paragraph. Shift extends selection. Ctrl-Down
5360 Previous word. Shift extends selection. Ctrl-Left
5361 Next word. Shift extends selection. Ctrl-Right
5362 ============================================= ======================
5373 * Double-click on empty space in the notebook tab bar to open a
5375 * Middle-click on a document's notebook tab to close the document.
5376 * Hold `Ctrl` and click on any notebook tab to switch to the last used
5378 * Double-click on a document's notebook tab to toggle all additional
5379 widgets (to show them again use the View menu or the keyboard
5380 shortcut). The interface pref must be enabled for this to work.
5385 * Alt-scroll wheel moves up/down a page.
5386 * Ctrl-scroll wheel zooms in/out.
5387 * Shift-scroll wheel scrolls 8 characters right/left.
5388 * Ctrl-click on a word in a document to perform *Go to Symbol Definition*.
5389 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
5394 * Double-click on a symbol-list group to expand or compact it.
5399 * Scrolling the mouse wheel over a notebook tab bar will switch
5402 The following are derived from X-Windows features (but GTK still supports
5405 * Middle-click pastes the last selected text.
5406 * Middle-click on a scrollbar moves the scrollbar to that
5407 position without having to drag it.
5411 Compile-time options
5412 ====================
5414 There are some options which can only be changed at compile time,
5415 and some options which are used as the default for configurable
5416 options. To change these options, edit the appropriate source file
5417 in the ``src`` subdirectory. Look for a block of lines starting with
5418 ``#define GEANY_*``. Any definitions which are not listed here should
5422 Most users should not need to change these options.
5427 ============================== ============================================ ==================
5428 Option Description Default
5429 ============================== ============================================ ==================
5430 GEANY_STRING_UNTITLED A string used as the default name for new untitled
5431 files. Be aware that the string can be
5432 translated, so change it only if you know
5434 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
5435 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
5436 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
5438 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
5440 **Windows specific**
5441 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
5442 Windows file open and save dialogs instead
5443 GTK's file open and save dialogs. The
5444 default Windows file dialogs are missing
5445 some nice features like choosing a filetype
5446 or an encoding. *Do not touch this setting
5447 when building on a non-Win32 system.*
5448 ============================== ============================================ ==================
5453 ============================== ============================================ ==================
5454 Option Description Default
5455 ============================== ============================================ ==================
5456 GEANY_PROJECT_EXT The default filename extension for Geany geany
5457 project files. It is used when creating new
5458 projects and as filter mask for the project
5460 ============================== ============================================ ==================
5465 ============================== ============================================ ==================
5466 Option Description Default
5467 ============================== ============================================ ==================
5468 GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
5469 filetype with the extract filetype regex.
5470 ============================== ============================================ ==================
5475 ============================== ============================================ ==================
5476 Option Description Default
5477 ============================== ============================================ ==================
5478 GEANY_WORDCHARS These characters define word boundaries when a string with:
5479 making selections and searching using word a-z, A-Z, 0-9 and
5480 matching options. underscore.
5481 ============================== ============================================ ==================
5486 These are default settings that can be overridden in the `Preferences`_ dialog.
5488 ============================== ============================================ ==================
5489 Option Description Default
5490 ============================== ============================================ ==================
5491 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
5492 trigger the autocompletion list.
5493 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
5495 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
5496 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator command, see See below.
5497 `Terminal emulators`_.
5498 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
5499 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
5500 and process plain text files. This can also
5502 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
5503 GNU grep. This can also include a path.
5504 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
5505 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
5507 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
5508 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
5509 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
5511 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
5513 GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
5515 ============================== ============================================ ==================
5519 The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
5521 The GEANY_DEFAULT_TOOLS_TERMINAL default value on Windows is::
5525 and on any non-Windows system is::
5527 xterm -e "/bin/sh %c"
5533 ============================== ============================================ ==================
5534 Option Description Default
5535 ============================== ============================================ ==================
5536 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
5537 be shown in the editor window.
5538 This affects the special coloring
5539 when Geany detects a compiler output line as
5540 an error message and then highlights the
5541 corresponding line in the source code.
5542 Usually only the first few messages are
5543 interesting because following errors are
5545 All errors in the Compiler window are parsed
5546 and unaffected by this value.
5547 PRINTBUILDCMDS Every time a build menu item priority FALSE
5548 calculation is run, print the state of the
5549 menu item table in the form of the table
5550 in `Build Menu Configuration`_. May be
5551 useful to debug configuration file
5552 overloading. Warning produces a lot of
5553 output. Can also be enabled/disabled by the
5554 debugger by setting printbuildcmds to 1/0
5555 overriding the compile setting.
5556 ============================== ============================================ ==================
5560 GNU General Public License
5561 ==========================
5565 GNU GENERAL PUBLIC LICENSE
5566 Version 2, June 1991
5568 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5569 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5570 Everyone is permitted to copy and distribute verbatim copies
5571 of this license document, but changing it is not allowed.
5575 The licenses for most software are designed to take away your
5576 freedom to share and change it. By contrast, the GNU General Public
5577 License is intended to guarantee your freedom to share and change free
5578 software--to make sure the software is free for all its users. This
5579 General Public License applies to most of the Free Software
5580 Foundation's software and to any other program whose authors commit to
5581 using it. (Some other Free Software Foundation software is covered by
5582 the GNU Library General Public License instead.) You can apply it to
5585 When we speak of free software, we are referring to freedom, not
5586 price. Our General Public Licenses are designed to make sure that you
5587 have the freedom to distribute copies of free software (and charge for
5588 this service if you wish), that you receive source code or can get it
5589 if you want it, that you can change the software or use pieces of it
5590 in new free programs; and that you know you can do these things.
5592 To protect your rights, we need to make restrictions that forbid
5593 anyone to deny you these rights or to ask you to surrender the rights.
5594 These restrictions translate to certain responsibilities for you if you
5595 distribute copies of the software, or if you modify it.
5597 For example, if you distribute copies of such a program, whether
5598 gratis or for a fee, you must give the recipients all the rights that
5599 you have. You must make sure that they, too, receive or can get the
5600 source code. And you must show them these terms so they know their
5603 We protect your rights with two steps: (1) copyright the software, and
5604 (2) offer you this license which gives you legal permission to copy,
5605 distribute and/or modify the software.
5607 Also, for each author's protection and ours, we want to make certain
5608 that everyone understands that there is no warranty for this free
5609 software. If the software is modified by someone else and passed on, we
5610 want its recipients to know that what they have is not the original, so
5611 that any problems introduced by others will not reflect on the original
5612 authors' reputations.
5614 Finally, any free program is threatened constantly by software
5615 patents. We wish to avoid the danger that redistributors of a free
5616 program will individually obtain patent licenses, in effect making the
5617 program proprietary. To prevent this, we have made it clear that any
5618 patent must be licensed for everyone's free use or not licensed at all.
5620 The precise terms and conditions for copying, distribution and
5621 modification follow.
5623 GNU GENERAL PUBLIC LICENSE
5624 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5626 0. This License applies to any program or other work which contains
5627 a notice placed by the copyright holder saying it may be distributed
5628 under the terms of this General Public License. The "Program", below,
5629 refers to any such program or work, and a "work based on the Program"
5630 means either the Program or any derivative work under copyright law:
5631 that is to say, a work containing the Program or a portion of it,
5632 either verbatim or with modifications and/or translated into another
5633 language. (Hereinafter, translation is included without limitation in
5634 the term "modification".) Each licensee is addressed as "you".
5636 Activities other than copying, distribution and modification are not
5637 covered by this License; they are outside its scope. The act of
5638 running the Program is not restricted, and the output from the Program
5639 is covered only if its contents constitute a work based on the
5640 Program (independent of having been made by running the Program).
5641 Whether that is true depends on what the Program does.
5643 1. You may copy and distribute verbatim copies of the Program's
5644 source code as you receive it, in any medium, provided that you
5645 conspicuously and appropriately publish on each copy an appropriate
5646 copyright notice and disclaimer of warranty; keep intact all the
5647 notices that refer to this License and to the absence of any warranty;
5648 and give any other recipients of the Program a copy of this License
5649 along with the Program.
5651 You may charge a fee for the physical act of transferring a copy, and
5652 you may at your option offer warranty protection in exchange for a fee.
5654 2. You may modify your copy or copies of the Program or any portion
5655 of it, thus forming a work based on the Program, and copy and
5656 distribute such modifications or work under the terms of Section 1
5657 above, provided that you also meet all of these conditions:
5659 a) You must cause the modified files to carry prominent notices
5660 stating that you changed the files and the date of any change.
5662 b) You must cause any work that you distribute or publish, that in
5663 whole or in part contains or is derived from the Program or any
5664 part thereof, to be licensed as a whole at no charge to all third
5665 parties under the terms of this License.
5667 c) If the modified program normally reads commands interactively
5668 when run, you must cause it, when started running for such
5669 interactive use in the most ordinary way, to print or display an
5670 announcement including an appropriate copyright notice and a
5671 notice that there is no warranty (or else, saying that you provide
5672 a warranty) and that users may redistribute the program under
5673 these conditions, and telling the user how to view a copy of this
5674 License. (Exception: if the Program itself is interactive but
5675 does not normally print such an announcement, your work based on
5676 the Program is not required to print an announcement.)
5678 These requirements apply to the modified work as a whole. If
5679 identifiable sections of that work are not derived from the Program,
5680 and can be reasonably considered independent and separate works in
5681 themselves, then this License, and its terms, do not apply to those
5682 sections when you distribute them as separate works. But when you
5683 distribute the same sections as part of a whole which is a work based
5684 on the Program, the distribution of the whole must be on the terms of
5685 this License, whose permissions for other licensees extend to the
5686 entire whole, and thus to each and every part regardless of who wrote it.
5688 Thus, it is not the intent of this section to claim rights or contest
5689 your rights to work written entirely by you; rather, the intent is to
5690 exercise the right to control the distribution of derivative or
5691 collective works based on the Program.
5693 In addition, mere aggregation of another work not based on the Program
5694 with the Program (or with a work based on the Program) on a volume of
5695 a storage or distribution medium does not bring the other work under
5696 the scope of this License.
5698 3. You may copy and distribute the Program (or a work based on it,
5699 under Section 2) in object code or executable form under the terms of
5700 Sections 1 and 2 above provided that you also do one of the following:
5702 a) Accompany it with the complete corresponding machine-readable
5703 source code, which must be distributed under the terms of Sections
5704 1 and 2 above on a medium customarily used for software interchange; or,
5706 b) Accompany it with a written offer, valid for at least three
5707 years, to give any third party, for a charge no more than your
5708 cost of physically performing source distribution, a complete
5709 machine-readable copy of the corresponding source code, to be
5710 distributed under the terms of Sections 1 and 2 above on a medium
5711 customarily used for software interchange; or,
5713 c) Accompany it with the information you received as to the offer
5714 to distribute corresponding source code. (This alternative is
5715 allowed only for noncommercial distribution and only if you
5716 received the program in object code or executable form with such
5717 an offer, in accord with Subsection b above.)
5719 The source code for a work means the preferred form of the work for
5720 making modifications to it. For an executable work, complete source
5721 code means all the source code for all modules it contains, plus any
5722 associated interface definition files, plus the scripts used to
5723 control compilation and installation of the executable. However, as a
5724 special exception, the source code distributed need not include
5725 anything that is normally distributed (in either source or binary
5726 form) with the major components (compiler, kernel, and so on) of the
5727 operating system on which the executable runs, unless that component
5728 itself accompanies the executable.
5730 If distribution of executable or object code is made by offering
5731 access to copy from a designated place, then offering equivalent
5732 access to copy the source code from the same place counts as
5733 distribution of the source code, even though third parties are not
5734 compelled to copy the source along with the object code.
5736 4. You may not copy, modify, sublicense, or distribute the Program
5737 except as expressly provided under this License. Any attempt
5738 otherwise to copy, modify, sublicense or distribute the Program is
5739 void, and will automatically terminate your rights under this License.
5740 However, parties who have received copies, or rights, from you under
5741 this License will not have their licenses terminated so long as such
5742 parties remain in full compliance.
5744 5. You are not required to accept this License, since you have not
5745 signed it. However, nothing else grants you permission to modify or
5746 distribute the Program or its derivative works. These actions are
5747 prohibited by law if you do not accept this License. Therefore, by
5748 modifying or distributing the Program (or any work based on the
5749 Program), you indicate your acceptance of this License to do so, and
5750 all its terms and conditions for copying, distributing or modifying
5751 the Program or works based on it.
5753 6. Each time you redistribute the Program (or any work based on the
5754 Program), the recipient automatically receives a license from the
5755 original licensor to copy, distribute or modify the Program subject to
5756 these terms and conditions. You may not impose any further
5757 restrictions on the recipients' exercise of the rights granted herein.
5758 You are not responsible for enforcing compliance by third parties to
5761 7. If, as a consequence of a court judgment or allegation of patent
5762 infringement or for any other reason (not limited to patent issues),
5763 conditions are imposed on you (whether by court order, agreement or
5764 otherwise) that contradict the conditions of this License, they do not
5765 excuse you from the conditions of this License. If you cannot
5766 distribute so as to satisfy simultaneously your obligations under this
5767 License and any other pertinent obligations, then as a consequence you
5768 may not distribute the Program at all. For example, if a patent
5769 license would not permit royalty-free redistribution of the Program by
5770 all those who receive copies directly or indirectly through you, then
5771 the only way you could satisfy both it and this License would be to
5772 refrain entirely from distribution of the Program.
5774 If any portion of this section is held invalid or unenforceable under
5775 any particular circumstance, the balance of the section is intended to
5776 apply and the section as a whole is intended to apply in other
5779 It is not the purpose of this section to induce you to infringe any
5780 patents or other property right claims or to contest validity of any
5781 such claims; this section has the sole purpose of protecting the
5782 integrity of the free software distribution system, which is
5783 implemented by public license practices. Many people have made
5784 generous contributions to the wide range of software distributed
5785 through that system in reliance on consistent application of that
5786 system; it is up to the author/donor to decide if he or she is willing
5787 to distribute software through any other system and a licensee cannot
5790 This section is intended to make thoroughly clear what is believed to
5791 be a consequence of the rest of this License.
5793 8. If the distribution and/or use of the Program is restricted in
5794 certain countries either by patents or by copyrighted interfaces, the
5795 original copyright holder who places the Program under this License
5796 may add an explicit geographical distribution limitation excluding
5797 those countries, so that distribution is permitted only in or among
5798 countries not thus excluded. In such case, this License incorporates
5799 the limitation as if written in the body of this License.
5801 9. The Free Software Foundation may publish revised and/or new versions
5802 of the General Public License from time to time. Such new versions will
5803 be similar in spirit to the present version, but may differ in detail to
5804 address new problems or concerns.
5806 Each version is given a distinguishing version number. If the Program
5807 specifies a version number of this License which applies to it and "any
5808 later version", you have the option of following the terms and conditions
5809 either of that version or of any later version published by the Free
5810 Software Foundation. If the Program does not specify a version number of
5811 this License, you may choose any version ever published by the Free Software
5814 10. If you wish to incorporate parts of the Program into other free
5815 programs whose distribution conditions are different, write to the author
5816 to ask for permission. For software which is copyrighted by the Free
5817 Software Foundation, write to the Free Software Foundation; we sometimes
5818 make exceptions for this. Our decision will be guided by the two goals
5819 of preserving the free status of all derivatives of our free software and
5820 of promoting the sharing and reuse of software generally.
5824 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5825 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5826 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5827 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5828 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5829 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5830 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5831 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5832 REPAIR OR CORRECTION.
5834 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5835 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5836 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5837 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5838 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5839 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5840 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5841 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5842 POSSIBILITY OF SUCH DAMAGES.
5844 END OF TERMS AND CONDITIONS
5846 How to Apply These Terms to Your New Programs
5848 If you develop a new program, and you want it to be of the greatest
5849 possible use to the public, the best way to achieve this is to make it
5850 free software which everyone can redistribute and change under these terms.
5852 To do so, attach the following notices to the program. It is safest
5853 to attach them to the start of each source file to most effectively
5854 convey the exclusion of warranty; and each file should have at least
5855 the "copyright" line and a pointer to where the full notice is found.
5857 <one line to give the program's name and a brief idea of what it does.>
5858 Copyright (C) <year> <name of author>
5860 This program is free software; you can redistribute it and/or modify
5861 it under the terms of the GNU General Public License as published by
5862 the Free Software Foundation; either version 2 of the License, or
5863 (at your option) any later version.
5865 This program is distributed in the hope that it will be useful,
5866 but WITHOUT ANY WARRANTY; without even the implied warranty of
5867 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5868 GNU General Public License for more details.
5870 You should have received a copy of the GNU General Public License along
5871 with this program; if not, write to the Free Software Foundation, Inc.,
5872 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5875 Also add information on how to contact you by electronic and paper mail.
5877 If the program is interactive, make it output a short notice like this
5878 when it starts in an interactive mode:
5880 Gnomovision version 69, Copyright (C) year name of author
5881 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5882 This is free software, and you are welcome to redistribute it
5883 under certain conditions; type `show c' for details.
5885 The hypothetical commands `show w' and `show c' should show the appropriate
5886 parts of the General Public License. Of course, the commands you use may
5887 be called something other than `show w' and `show c'; they could even be
5888 mouse-clicks or menu items--whatever suits your program.
5890 You should also get your employer (if you work as a programmer) or your
5891 school, if any, to sign a "copyright disclaimer" for the program, if
5892 necessary. Here is a sample; alter the names:
5894 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5895 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5897 <signature of Ty Coon>, 1 April 1989
5898 Ty Coon, President of Vice
5900 This General Public License does not permit incorporating your program into
5901 proprietary programs. If your program is a subroutine library, you may
5902 consider it more useful to permit linking proprietary applications with the
5903 library. If this is what you want to do, use the GNU Library General
5904 Public License instead of this License.
5909 License for Scintilla and SciTE
5910 ===============================
5912 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5916 Permission to use, copy, modify, and distribute this software and
5917 its documentation for any purpose and without fee is hereby granted,
5918 provided that the above copyright notice appear in all copies and
5919 that both that copyright notice and this permission notice appear in
5920 supporting documentation.
5922 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5923 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5924 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5925 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5926 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5927 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5928 USE OR PERFORMANCE OF THIS SOFTWARE.