1 .. |(version)| replace:: 1.37
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 ============ ======================= =================================================
260 Short option Long option Function
261 ============ ======================= =================================================
262 *none* +number Set initial line number for the first opened file
263 (same as --line, do not put a space between the + sign
264 and the number). E.g. "geany +7 foo.bar" will open the
265 file foo.bar and place the cursor in line 7.
267 *none* --column Set initial column number for the first opened file.
269 -c dir_name --config=directory_name Use an alternate configuration directory. The default
270 configuration directory is ``~/.config/geany/`` and that
271 is where ``geany.conf`` and other configuration files
274 *none* --ft-names Print a list of Geany's internal filetype names (useful
275 for snippets configuration).
277 -g --generate-tags Generate a global tags file (see
278 `Generating a global tags file`_).
280 -P --no-preprocessing Don't preprocess C/C++ files when generating tags file.
282 -i --new-instance Do not open files in a running instance, force opening
283 a new instance. Only available if Geany was compiled
284 with support for Sockets.
286 -l --line Set initial line number for the first opened file.
288 *none* --list-documents Return a list of open documents in a running Geany
290 This can be used to read the currently opened documents in
291 Geany from an external script or tool. The returned list
292 is separated by newlines (LF) and consists of the full,
293 UTF-8 encoded filenames of the documents.
294 Only available if Geany was compiled with support for
297 -m --no-msgwin Do not show the message window. Use this option if you
298 do not need compiler messages or VTE support.
300 -n --no-ctags Do not load symbol completion and call tip data. Use this
301 option if you do not want to use them.
303 -p --no-plugins Do not load plugins or plugin support.
305 *none* --print-prefix Print installation prefix, the data directory, the lib
306 directory and the locale directory (in that order) to
307 stdout, one line each. This is mainly intended for plugin
308 authors to detect installation paths.
310 -r --read-only Open all files given on the command line in read-only mode.
311 This only applies to files opened explicitly from the command
312 line, so files from previous sessions or project files are
315 -s --no-session Do not load the previous session's files.
317 -t --no-terminal Do not load terminal support. Use this option if you do
318 not want to load the virtual terminal emulator widget
319 at startup. If you do not have ``libvte.so.4`` installed,
320 then terminal-support is automatically disabled. Only
321 available if Geany was compiled with support for VTE.
323 *none* --socket-file Use this socket filename for communication with a
324 running Geany instance. This can be used with the following
325 command to execute Geany on the current workspace::
327 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
329 *none* --vte-lib Specify explicitly the path including filename or only
330 the filename to the VTE library, e.g.
331 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
332 only needed when the auto-detection does not work. Only
333 available if Geany was compiled with support for VTE.
335 -v --verbose Be verbose (print useful status messages).
337 -V --version Show version information and exit.
339 -? --help Show help information and exit.
341 *none* [files ...] Open all given files at startup. This option causes
342 Geany to ignore loading stored files from the last
343 session (if enabled).
344 Geany also recognizes line and column information when
345 appended to the filename with colons, e.g.
346 "geany foo.bar:10:5" will open the file foo.bar and
347 place the cursor in line 10 at column 5.
349 Projects can also be opened but a project file (\*.geany)
350 must be the first non-option argument. All additionally
351 given files are ignored.
352 ============ ======================= =================================================
354 You can also pass line number and column number information, e.g.::
356 geany some_file.foo:55:4
358 Geany supports all generic GTK options, a list is available on the
370 At startup, Geany loads all files from the last time Geany was
371 launched. You can disable this feature in the preferences dialog
372 (see `General Startup preferences`_).
374 You can start several instances of Geany, but only the first will
375 load files from the last session. In the subsequent instances, you
376 can find these files in the file menu under the "Recent files" item.
377 By default this contains the last 10 recently opened files. You can
378 change the number of recently opened files in the preferences dialog.
380 To run a second instance of Geany, do not specify any filenames on
381 the command-line, or disable opening files in a running instance
382 using the appropriate command line option.
385 Opening files from the command-line in a running instance
386 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
388 Geany detects if there is an instance of itself already running and opens files
389 from the command-line in that instance. So, Geany can
390 be used to view and edit files by opening them from other programs
391 such as a file manager.
393 You can also pass line number and column number information, e.g.::
395 geany some_file.foo:55:4
397 This would open the file ``some_file.foo`` with the cursor on line 55,
400 If you do not like this for some reason, you can disable using the first
401 instance by using the appropriate command line option -- see the section
402 called `Command line options`_.
405 Virtual terminal emulator widget (VTE)
406 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
408 If you have installed ``libvte.so`` on your system, it is loaded
409 automatically by Geany, and you will have a terminal widget in the
410 notebook at the bottom.
412 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
413 will not be loaded. So there is no need to install the package containing
414 this file in order to run Geany. Additionally, you can disable the use
415 of the terminal widget by command line option, for more information
416 see the section called `Command line options`_.
418 You can use this terminal (from now on called VTE) much as you would
419 a terminal program like xterm. There is basic clipboard support. You
420 can paste the contents of the clipboard by pressing the right mouse
421 button to open the popup menu, and choosing Paste. To copy text from
422 the VTE, just select the desired text and then press the right mouse
423 button and choose Copy from the popup menu. On systems running the
424 X Window System you can paste the last selected text by pressing the
425 middle mouse button in the VTE (on 2-button mice, the middle button
426 can often be simulated by pressing both mouse buttons together).
428 In the preferences dialog you can specify a shell which should be
429 started in the VTE. To make the specified shell a login shell just
430 use the appropriate command line options for the shell. These options
431 should be found in the manual page of the shell. For zsh and bash
432 you can use the argument ``--login``.
435 Geany tries to load ``libvte.so``. If this fails, it tries to load
436 some other filenames. If this fails too, you should check whether you
437 installed libvte correctly. Again note, Geany will run without this
440 It could be, that the library is called something else than
441 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
442 please set a link to the correct file (as root)::
444 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
446 Obviously, you have to adjust the paths and set X to the number of your
449 You can also specify the filename of the VTE library to use on the command
450 line (see the section called `Command line options`_) or at compile time
451 by specifying the command line option ``--with-vte-module-path`` to
455 Defining own widget styles using .gtkrc-2.0
456 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
458 You can define your widget style for many of Geany's GUI parts. To
459 do this, just edit your ``.gtkrc-2.0`` (usually found in your home
460 directory on UNIX-like systems and in the etc subdirectory of your
461 Geany installation on Windows).
463 To have a defined style used by Geany you must assign it to
464 at least one of Geany's widgets. For example use the following line::
466 widget "Geany*" style "geanyStyle"
468 This would assign your style "geany_style" to all Geany
469 widgets. You can also assign styles only to specific widgets. At the
470 moment you can use the following widgets:
482 An example of a simple ``.gtkrc-2.0``::
488 widget "GeanyMainWindow" style "geanyStyle"
494 widget "GeanyPrefsDialog" style "geanyStyle"
497 Customizing Geany's appearance using GTK+ 3 CSS
498 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
500 To override GTK+ CSS styles, you can use traditional mechanisms or you
501 can create a file named ``geany.css`` in the user configuration directory
502 (usually ``~/.config/geany``) which will be loaded after other CSS styles
503 are applied to allow overriding the default styles.
505 Geany offers a number of CSS IDs which can be used to taylor its
506 appearence. Among the more interesting include:
508 * ``geany-compiler-context`` - the style used for build command output surrounding errors
509 * ``geany-compiler-error`` - the style used for build command errors
510 * ``geany-compiler-message`` - the style other output encountered while running build command
511 * ``geany-document-status-changed`` - the style for document tab labels when the document is changed
512 * ``geany-document-status-disk-changed`` - the style for document tab labels when the file on disk has changed
513 * ``geany-document-status-readyonly``` - the style for document tab labels when the document is read-only
514 * ``geany-search-entry-no-match`` - the style of find/replace diaog entries when no match is found
515 * ``geany-terminal-dirty`` - the style for the message window Terminal tab label when the terminal output has changed.
521 Switching between documents
522 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
524 The documents list and the editor tabs are two different ways
525 to switch between documents using the mouse. When you hit the key
526 combination to move between tabs, the order is determined by the tab
527 order. It is not alphabetical as shown in the documents list
528 (regardless of whether or not editor tabs are visible).
530 See the `Notebook tab keybindings`_ section for useful
531 shortcuts including for Most-Recently-Used document switching.
535 The `Document->Clone` menu item copies the current document's text,
536 cursor position and properties into a new untitled document. If
537 there is a selection, only the selected text is copied. This can be
538 useful when making temporary copies of text or for creating
539 documents with similar or identical contents.
541 Automatic filename insertion on `Save As...`
542 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
543 If a document is saved via `Document->Save As...` then the filename is
544 automatically inserted into the comment header replacing text like
545 `untitled.ext` in the first 3 lines of the file. E.g. if a new ``.c``
546 file is created using `File->New (with Template)` then the text `untitled.c`
547 in line 2 would be replaced with the choosen file name on `Save As...`
548 (this example assumes the default file templates being used).
551 Character sets and Unicode Byte-Order-Mark (BOM)
552 ------------------------------------------------
558 Geany provides support for detecting and converting character sets. So
559 you can open and save files in different character sets, and even
560 convert a file from one character set to another. To do this,
561 Geany uses the character conversion capabilities of the GLib library.
563 Only text files are supported, i.e. opening files which contain
564 NULL-bytes may fail. Geany will try to open the file anyway but it is
565 likely that the file will be truncated because it can only be read up
566 to the first occurrence of a NULL-byte. All characters after this
567 position are lost and are not written when you save the file.
569 Geany tries to detect the encoding of a file while opening it, but
570 auto-detecting the encoding of a file is not easy and sometimes an
571 encoding might not be detected correctly. In this case you have to
572 set the encoding of the file manually in order to display it
573 correctly. You can this in the file open dialog by selecting an
574 encoding in the drop down box or by reloading the file with the
575 file menu item "Reload as". The auto-detection works well for most
576 encodings but there are also some encodings where it is known that
577 auto-detection has problems.
579 There are different ways to set different encodings in Geany:
581 * Using the file open dialog
583 This opens the file with the encoding specified in the encoding drop
584 down box. If the encoding is set to "Detect from file" auto-detection
585 will be used. If the encoding is set to "Without encoding (None)" the
586 file will be opened without any character conversion and Geany will
587 not try to auto-detect the encoding (see below for more information).
589 * Using the "Reload as" menu item
591 This item reloads the current file with the specified encoding. It can
592 help if you opened a file and found out that the wrong encoding was used.
594 * Using the "Set encoding" menu item
596 Contrary to the above two options, this will not change or reload
597 the current file unless you save it. It is useful when you want to
598 change the encoding of the file.
600 * Specifying the encoding in the file itself
602 As mentioned above, auto-detecting the encoding of a file may fail on
603 some encodings. If you know that Geany doesn't open a certain file,
604 you can add the specification line, described in the next section,
605 to the beginning of the file to force Geany to use a specific
606 encoding when opening the file.
609 In-file encoding specification
610 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
612 Geany detects meta tags of HTML files which contain charset information
615 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
617 and the specified charset is used when opening the file. This is useful if the
618 encoding of the file cannot be detected properly.
619 For non-HTML files you can also define a line like::
621 /* geany_encoding=ISO-8859-15 */
625 # geany_encoding=ISO-8859-15 #
627 to force an encoding to be used. The #, /\* and \*/ are examples
628 of filetype-specific comment characters. It doesn't matter which
629 characters are around the string " geany_encoding=ISO-8859-15 " as long
630 as there is at least one whitespace character before and after this
631 string. Whitespace characters are in this case a space or tab character.
632 An example to use this could be you have a file with ISO-8859-15
633 encoding but Geany constantly detects the file encoding as ISO-8859-1.
634 Then you simply add such a line to the file and Geany will open it
635 correctly the next time.
637 Since Geany 0.15 you can also use lines which match the
638 regular expression used to find the encoding string:
639 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
642 These specifications must be in the first 512 bytes of the file.
643 Anything after the first 512 bytes will not be recognized.
647 # encoding = ISO-8859-15
651 # coding: ISO-8859-15
653 Special encoding "None"
654 ^^^^^^^^^^^^^^^^^^^^^^^
656 There is a special encoding "None" which uses no
657 encoding. It is useful when you know that Geany cannot auto-detect
658 the encoding of a file and it is not displayed correctly. Especially
659 when the file contains NULL-bytes this can be useful to skip auto
660 detection and open the file properly at least until the occurrence
661 of the first NULL-byte. Using this encoding opens the file as it is
662 without any character conversion.
665 Unicode Byte-Order-Mark (BOM)
666 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
668 Furthermore, Geany detects a Unicode Byte Order Mark (see
669 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
670 this feature is only available if the opened file is in a Unicode
671 encoding. The Byte Order Mark helps to detect the encoding of a file,
672 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
673 using a Byte Order Mark could cause some problems for programs not
674 expecting it, e.g. the compiler gcc stops
675 with stray errors, PHP does not parse a script containing a BOM and
676 script files starting with a she-bang maybe cannot be started. In the
677 status bar you can easily see whether the file starts with a BOM or
680 If you want to set a BOM for a file or if you want to remove it
681 from a file, just use the document menu and toggle the checkbox.
684 If you are unsure what a BOM is or if you do not understand where
685 to use it, then it is probably not important for you and you can
697 Geany provides basic code folding support. Folding means the ability to
698 show and hide parts of the text in the current file. You can hide
699 unimportant code sections and concentrate on the parts you are working on
700 and later you can show hidden sections again. In the editor window there is
701 a small grey margin on the left side with [+] and [-] symbols which
702 show hidden parts and hide parts of the file respectively. By
703 clicking on these icons you can simply show and hide sections which are
704 marked by vertical lines within this margin. For many filetypes nested
705 folding is supported, so there may be several fold points within other
709 You can customize the folding icon and line styles - see the
710 filetypes.common `Folding Settings`_.
712 If you don't like it or don't need it at all, you can simply disable
713 folding support completely in the preferences dialog.
715 The folding behaviour can be changed with the "Fold/Unfold all children of
716 a fold point" option in the preference dialog. If activated, Geany will
717 unfold all nested fold points below the current one if they are already
718 folded (when clicking on a [+] symbol).
719 When clicking on a [-] symbol, Geany will fold all nested fold points
720 below the current one if they are unfolded.
722 This option can be inverted by pressing the Shift
723 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
724 children of a fold point" option is enabled, pressing Shift will disable
725 it for this click and vice versa.
728 Column mode editing (rectangular selections)
729 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
731 There is basic support for column mode editing. To use it, create a
732 rectangular selection by holding down the Control and Shift keys
733 (or Alt and Shift on Windows) while selecting some text.
734 Once a rectangular selection exists you can start editing the text within
735 this selection and the modifications will be done for every line in the
738 It is also possible to create a zero-column selection - this is
739 useful to insert text on multiple lines.
741 Drag and drop of text
742 ^^^^^^^^^^^^^^^^^^^^^
744 If you drag selected text in the editor widget of Geany the text is
745 moved to the position where the mouse pointer is when releasing the
746 mouse button. Holding Control when releasing the mouse button will
747 copy the text instead. This behaviour was changed in Geany 0.11 -
748 before the selected text was copied to the new position.
754 Geany allows each document to indent either with a tab character,
755 multiple spaces or a combination of both.
757 The *Tabs* setting indents with one tab character per indent level, and
758 displays tabs as the indent width.
760 The *Spaces* setting indents with the number of spaces set in the indent
761 width for each level.
763 The *Tabs and Spaces* setting indents with spaces as above, then converts
764 as many spaces as it can to tab characters at the rate of one tab for
765 each multiple of the `Various preference` setting
766 *indent_hard_tab_width* (default 8) and displays tabs as the
767 *indent_hard_tab_width* value.
769 The default indent settings are set in `Editor Indentation
770 preferences`_ (see the link for more information).
772 The default settings can be overridden per-document using the
773 Document menu. They can also be overridden by projects - see
774 `Project management`_.
776 The indent mode for the current document is shown on the status bar
780 Indent with Tab characters.
784 Indent with tabs and spaces, depending on how much indentation is
787 Applying new indentation settings
788 `````````````````````````````````
789 After changing the default settings you may wish to apply the new
790 settings to every document in the current session. To do this use the
791 *Project->Apply Default Indentation* menu item.
793 Detecting indent type
794 `````````````````````
795 The *Detect from file* indentation preference can be used to
796 scan each file as it's opened and set the indent type based on
797 how many lines start with a tab vs. 2 or more spaces.
803 When enabled, auto-indentation happens when pressing *Enter* in the
804 Editor. It adds a certain amount of indentation to the new line so the
805 user doesn't always have to indent each line manually.
807 Geany has four types of auto-indentation:
810 Disables auto-indentation completely.
812 Adds the same amount of whitespace on a new line as on the previous line.
813 For the *Tabs* and the *Spaces* indent types the indentation will use the
814 same combination of characters as the previous line. The
815 *Tabs and Spaces* indentation type converts as explained above.
817 Does the same as *Basic* but also indents a new line after an opening
818 brace '{', and de-indents when typing a closing brace '}'. For Python,
819 a new line will be indented after typing ':' at the end of the
822 Similar to *Current chars* but the closing brace will be aligned to
823 match the indentation of the line with the opening brace. This
824 requires the filetype to be one where Geany knows that the Scintilla
825 lexer understands matching braces (C, C++, D, HTML, Pascal, Bash,
828 There is also XML-tag auto-indentation. This is enabled when the
829 mode is more than just Basic, and is also controlled by a filetype
830 setting - see `xml_indent_tags`_.
836 Geany provides a handy bookmarking feature that lets you mark one
837 or more lines in a document, and return the cursor to them using a
840 To place a mark on a line, either left-mouse-click in the left margin
841 of the editor window, or else use Ctrl-m. This will
842 produce a small green plus symbol in the margin. You can have as many
843 marks in a document as you like. Click again (or use Ctrl-m again)
844 to remove the bookmark. To remove all the marks in a given document,
845 use "Remove Markers" in the Document menu.
847 To navigate down your document, jumping from one mark to the next,
848 use Ctrl-. (control period). To go in the opposite direction on
849 the page, use Ctrl-, (control comma). Using the bookmarking feature
850 together with the commands to switch from one editor tab to another
851 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
852 navigate around multiple files.
855 Code navigation history
856 ^^^^^^^^^^^^^^^^^^^^^^^
858 To ease navigation in source files and especially between
859 different files, Geany lets you jump between different navigation
860 points. Currently, this works for the following:
862 * `Go to symbol declaration`_
863 * `Go to symbol definition`_
868 When using one of these actions, Geany remembers your current position
869 and jumps to the new one. If you decide to go back to your previous
870 position in the file, just use "Navigate back a location". To
871 get back to the new position again, just use "Navigate forward a
872 location". This makes it easier to navigate in e.g. foreign code
873 and between different files.
876 Sending text through custom commands
877 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
879 You can define several custom commands in Geany and send the current
880 selection to one of these commands using the *Edit->Format->Send
881 Selection to* menu or keybindings. The output of the command will be
882 used to replace the current selection. This makes it possible to use
883 text formatting tools with Geany in a general way.
885 The selected text will be sent to the standard input of the executed
886 command, so the command should be able to read from it and it should
887 print all results to its standard output which will be read by
888 Geany. To help finding errors in executing the command, the output
889 of the program's standard error will be printed on Geany's standard
892 If there is no selection, the whole current line is used instead.
894 To add a custom command, use the *Send Selection to->Set Custom
895 Commands* menu item. Click on *Add* to get a new item and type the
896 command. You can also specify some command line options. Empty
897 commands are not saved.
899 Normal shell quoting is supported, so you can do things like:
901 * ``sed 's/\./(dot)/g'``
903 The above example would normally be done with the `Replace all`_
904 function, but it can be handy to have common commands already set up.
906 Note that the command is not run in a shell, so if you want to use
907 shell features like pipes and command chains, you need to explicitly
908 launch the shell and pass it your command:
910 * ``sh -c 'sort | uniq'``
916 You can execute the context action command on the current word at the
917 cursor position or the available selection. This word or selection
918 can be used as an argument to the command.
919 The context action is invoked by a menu entry in the popup menu of the
920 editor and also a keyboard shortcut (see the section called
923 The command can be specified in the preferences dialog and also for
924 each filetype (see "context_action_cmd" in the section called
925 `Filetype configuration`_). When the context action is invoked, the filetype
926 specific command is used if available, otherwise the command
927 specified in the preferences dialog is executed.
929 The current word or selection can be referred with the wildcard "%s"
930 in the command, it will be replaced by the current word or
931 selection before the command is executed.
933 For example a context action can be used to open API documentation
934 in a browser window, the command to open the PHP API documentation
937 firefox "http://www.php.net/%s"
939 when executing the command, the %s is substituted by the word near
940 the cursor position or by the current selection. If the cursor is at
941 the word "echo", a browser window will open(assumed your browser is
942 called firefox) and it will open the address: http://www.php.net/echo.
948 Geany can offer a list of possible completions for symbols defined in the
949 tags files and for all words in open documents.
951 The autocompletion list for symbols is presented when the first few
952 characters of the symbol are typed (configurable, see `Editor Completions
953 preferences`_, default 4) or when the *Complete word*
954 keybinding is pressed (configurable, see `Editor keybindings`_,
957 When the defined keybinding is typed and the *Autocomplete all words in
958 document* preference (in `Editor Completions preferences`_)
959 is selected then the autocompletion list will show all matching words
960 in the document, if there are no matching symbols.
962 If you don't want to use autocompletion it can be dismissed until
963 the next symbol by pressing Escape. The autocompletion list is updated
964 as more characters are typed so that it only shows completions that start
965 with the characters typed so far. If no symbols begin with the sequence,
966 the autocompletion window is closed.
968 The up and down arrows will move the selected item. The highlighted
969 item on the autocompletion list can be chosen from the list by pressing
970 Enter/Return. You can also double-click to select an item. The sequence
971 will be completed to match the chosen item, and if the *Drop rest of
972 word on completion* preference is set (in `Editor Completions
973 preferences`_) then any characters after the cursor that match
974 a symbol or word are deleted.
978 By default, pressing Tab will complete the selected item by word part;
979 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
984 * gtk_combo_box_<e><TAB>
985 * gtk_combo_box_entry_<s><ENTER>
986 * gtk_combo_box_entry_set_text_column
988 The key combination can be changed from Tab - See `Editor keybindings`_.
989 If you clear/change the key combination for word part completion, Tab
990 will complete the whole word instead, like Enter.
1002 When you type ``foo.`` it will show an autocompletion list with 'i' and
1005 It only works for languages that set parent scope names for e.g. struct
1006 members. Currently this means C-like languages. The C parser only
1007 parses global scopes, so this won't work for structs or objects declared
1011 User-definable snippets
1012 ^^^^^^^^^^^^^^^^^^^^^^^
1014 Snippets are small strings or code constructs which can be replaced or
1015 completed to a more complex string. So you can save a lot of time when
1016 typing common strings and letting Geany do the work for you.
1017 To know what to complete or replace Geany reads a configuration file
1018 called ``snippets.conf`` at startup.
1020 Maybe you need to often type your name, so define a snippet like this::
1023 myname=Enrico Tröger
1025 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
1026 with "Enrico Tröger". The key to start autocompletion can be changed
1027 in the preferences dialog, by default it is TAB. The corresponding keybinding
1028 is called `Complete snippet`.
1032 You can override the default snippets using the user
1033 ``snippets.conf`` file. Use the *Tools->Configuration
1034 Files->snippets.conf* menu item. See also `Configuration file paths`_.
1036 This adds the default settings to the user file if the file doesn't
1037 exist. Alternatively the file can be created manually, adding only
1038 the settings you want to change. All missing settings will be read
1039 from the system snippets file.
1043 The file ``snippets.conf`` contains sections defining snippets that
1044 are available for particular filetypes and in general.
1046 The two sections "Default" and "Special" apply to all filetypes.
1047 "Default" contains all snippets which are available for every
1048 filetype and "Special" contains snippets which can only be used in
1049 other snippets. So you can define often used parts of snippets and
1050 just use the special snippet as a placeholder (see the
1051 ``snippets.conf`` for details).
1053 You can define sections with the name of a filetype eg "C++". The
1054 snippets in that section are only available for use in files with that
1055 filetype. Snippets in filetype sections will hide snippets with the
1056 same name in the "Default" section when used in a file of that
1059 **Substitution sequences for snippets**
1061 To define snippets you can use several special character sequences which
1062 will be replaced when using the snippet:
1064 ================ =========================================================
1065 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1066 char(s): LF, CR/LF, or CR).
1068 \\t or %ws% Insert an indentation step, it will be replaced according
1069 to the current document's indent mode.
1071 \\s \\s to force whitespace at beginning or end of a value
1072 ('key= value' won't work, use 'key=\\svalue')
1074 %cursor% Place the cursor at this position after completion has
1075 been done. You can define multiple %cursor% wildcards
1076 and use the keybinding `Move cursor in snippet` to jump
1077 to the next defined cursor position in the completed
1080 %...% "..." means the name of a key in the "Special" section.
1081 If you have defined a key "brace_open" in the "Special"
1082 section you can use %brace_open% in any other snippet.
1083 ================ =========================================================
1085 Snippet names must not contain spaces otherwise they won't
1086 work correctly. But beside that you can define almost any
1087 string as a snippet and use it later in Geany. It is not limited
1088 to existing contructs of certain programming languages(like ``if``,
1089 ``for``, ``switch``). Define whatever you need.
1091 **Template wildcards**
1093 Since Geany 0.15 you can also use most of the available templates wildcards
1094 listed in `Template wildcards`_. All wildcards which are listed as
1095 `available in snippets` can be used. For instance to improve the above example::
1098 myname=My name is {developer}
1099 mysystem=My system: {command:uname -a}
1101 this will replace ``myname`` with "My name is " and the value of the template
1102 preference ``developer``.
1106 You can change the way Geany recognizes the word to complete,
1107 that is how the start and end of a word is recognised when the
1108 snippet completion is requested. The section "Special" may
1109 contain a key "wordchars" which lists all characters a string may contain
1110 to be recognized as a word for completion. Leave it commented to use
1111 default characters or define it to add or remove characters to fit your
1117 Normally you would type the snippet name and press Tab. However, you
1118 can define keybindings for snippets under the *Keybindings* group in
1123 block_cursor=<Ctrl>8
1126 Snippet keybindings may be overridden by Geany's configurable
1130 Inserting Unicode characters
1131 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1133 You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1134 Ctrl-Shift, type some hex digits representing the code point for the character
1135 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1136 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1137 insertion is completed, but the typed character is also entered. In the case
1138 of Enter/Return, it is a newline, as you might expect.
1141 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1142 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1143 or restart Geany. Note that it works slightly differently from other GTK
1144 applications, in that you'll need to continue to hold down the Ctrl and Shift
1145 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1148 Search, replace and go to
1149 -------------------------
1151 This section describes search-related commands from the Search menu
1152 and the editor window's popup menu:
1159 * Go to symbol definition
1160 * Go to symbol declaration
1163 See also `Search`_ preferences.
1167 There are also two toolbar entries:
1172 There are keybindings to focus each of these - see `Focus
1173 keybindings`_. Pressing Escape will then focus the editor.
1177 The quickest way to find some text is to use the search bar entry in
1178 the toolbar. This performs a case-insensitive search in the current
1179 document whilst you type. Pressing Enter will search again, and pressing
1180 Shift-Enter will search backwards.
1185 The Find dialog is used for finding text in one or more open documents.
1187 .. image:: ./images/find_dialog.png
1193 The syntax for the *Use regular expressions* option is shown in
1194 `Regular expressions`_.
1197 *Use escape sequences* is implied for regular expressions.
1199 The *Use multi-line matching* option enables multi-line regular
1200 expressions instead of single-line ones. See `Regular expressions`_ for
1201 more details on the differences between the two modes.
1203 The *Use escape sequences* option will transform any escaped characters
1204 into their UTF-8 equivalent. For example, \\t will be transformed into
1205 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1206 (Unicode characters).
1212 To find all matches, click on the Find All expander. This will reveal
1219 Find All In Document will show a list of matching lines in the
1220 current document in the Messages tab of the Message Window. *Find All
1221 In Session* does the same for all open documents.
1223 Mark will highlight all matches in the current document with a
1224 colored box. These markers can be removed by selecting the
1225 Remove Markers command from the Document menu.
1228 Change font in search dialog text fields
1229 ````````````````````````````````````````
1231 All search related dialogs use a Monospace for the text input fields to
1232 increase the readability of input text. This is useful when you are
1233 typing input such as regular expressions with spaces, periods and commas which
1234 might it hard to read with a proportional font.
1236 If you want to change the font, you can do this easily
1237 by inserting the following style into your ``.gtkrc-2.0``
1238 (usually found in your home directory on UNIX-like systems and in the
1239 etc subdirectory of your Geany installation on Windows)::
1241 style "search_style"
1243 font_name="Monospace 8"
1245 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1247 Please note the addition of ":highest" in the last line which sets the priority
1248 of this style to the highest available. Otherwise, the style is ignored
1249 for the search dialogs.
1254 The *Find Next/Previous Selection* commands perform a search for the
1255 current selected text. If nothing is selected, by default the current
1256 word is used instead. This can be customized by the
1257 *find_selection_type* preference - see `Various preferences`_.
1259 ===== =============================================
1260 Value *find_selection_type* behaviour
1261 ===== =============================================
1262 0 Use the current word (default).
1263 1 Try the X selection first, then current word.
1264 2 Repeat last search.
1265 ===== =============================================
1271 *Find Usage* searches all open files. It is similar to the *Find All In
1272 Session* option in the Find dialog.
1274 If there is a selection, then it is used as the search text; otherwise
1275 the current word is used. The current word is either taken from the
1276 word nearest the edit cursor, or the word underneath the popup menu
1277 click position when the popup menu is used. The search results are
1278 shown in the Messages tab of the Message Window.
1281 You can also use Find Usage for symbol list items from the popup
1288 *Find in Files* is a more powerful version of *Find Usage* that searches
1289 all files in a certain directory using the Grep tool. The Grep tool
1290 must be correctly set in Preferences to the path of the system's Grep
1291 utility. GNU Grep is recommended (see note below).
1293 .. image:: ./images/find_in_files_dialog.png
1295 The *Search* field is initially set to the current word in the editor
1296 (depending on `Search`_ preferences).
1298 The *Files* setting allows to choose which files are included in the
1299 search, depending on the mode:
1302 Search in all files;
1304 Use the current project's patterns, see `Project properties`_;
1306 Use custom patterns.
1308 Both project and custom patterns use a glob-style syntax, each
1309 pattern separated by a space. To search all ``.c`` and ``.h`` files,
1311 Note that an empty pattern list searches in all files rather
1314 The *Directory* field is initially set to the current document's directory,
1315 unless this field has already been edited and the current document has
1316 not changed. Otherwise, the current document's directory is prepended to
1317 the drop-down history. This can be disabled - see `Search`_ preferences.
1319 The *Encoding* field can be used to define the encoding of the files
1320 to be searched. The entered search text is converted to the chosen encoding
1321 and the search results are converted back to UTF-8.
1323 The *Extra options* field is used to pass any additional arguments to
1327 The *Files* setting uses ``--include=`` when searching recursively,
1328 *Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
1329 not work with other Grep implementations.
1332 Filtering out version control files
1333 ```````````````````````````````````
1335 When using the *Recurse in subfolders* option with a directory that's
1336 under version control, you can set the *Extra options* field to filter
1337 out version control files.
1339 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1340 argument to filter out CVS and hidden directories like ``.svn``.
1342 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1344 If you have an older Grep, you can try using the ``--exclude`` flag
1345 to filter out filenames.
1347 SVN Example: ``--exclude=*.svn-base``
1349 The --exclude argument only matches the file name part, not the path.
1355 The Replace dialog is used for replacing text in one or more open
1358 .. image:: ./images/replace_dialog.png
1360 The Replace dialog has the same options for matching text as the Find
1361 dialog. See the section `Matching options`_.
1363 The *Use regular expressions* option allows regular expressions to
1364 be used in the search string and back references in the replacement
1365 text -- see the entry for '\\n' in `Regular expressions`_.
1370 To replace several matches, click on the *Replace All* expander. This
1371 will reveal several options:
1377 *Replace All In Document* will replace all matching text in the
1378 current document. *Replace All In Session* does the same for all open
1379 documents. *Replace All In Selection* will replace all matching text
1380 in the current selection of the current document.
1383 Go to symbol definition
1384 ^^^^^^^^^^^^^^^^^^^^^^^
1386 If the current word or selection is the name of a symbol definition
1387 (e.g. a function name) and the file containing the symbol definition is
1388 open, this command will switch to that file and go to the
1389 corresponding line number. The current word is either the word
1390 nearest the edit cursor, or the word underneath the popup menu click
1391 position when the popup menu is used.
1393 If there are more symbols with the same name to which the goto can be performed,
1394 a pop up is shown with a list of all the occurrences. After selecting a symbol
1395 from the list Geany jumps to the corresponding symbol location. Geany tries to
1396 suggest the nearest symbol (symbol from the current file, other open documents
1397 or current directory) as the best candidate for the goto and places this symbol
1398 at the beginning of the list typed in boldface.
1401 If the corresponding symbol is on the current line, Geany will first
1402 look for a symbol declaration instead, as this is more useful.
1403 Likewise *Go to symbol declaration* will search for a symbol definition
1404 first in this case also.
1407 Go to symbol declaration
1408 ^^^^^^^^^^^^^^^^^^^^^^^^
1410 Like *Go to symbol definition*, but for a forward declaration such as a
1411 C function prototype or ``extern`` declaration instead of a function
1418 Go to a particular line number in the current file.
1424 You can use regular expressions in the Find and Replace dialogs
1425 by selecting the *Use regular expressions* check box (see `Matching
1426 options`_). The syntax is Perl compatible. Basic syntax is described
1427 in the table below. For full details, see
1428 https://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
1430 By default regular expressions are matched on a line-by-line basis.
1431 If you are interested in multi-line regular expressions, matched against
1432 the whole buffer at once, see the section `Multi-line regular expressions`_
1436 1. The *Use escape sequences* dialog option always applies for regular
1438 2. Searching backwards with regular expressions is not supported.
1439 3. The *Use multi-line matching* dialog option to select single or
1440 multi-line matching.
1442 **In a regular expression, the following characters are interpreted:**
1444 ======= ============================================================
1445 . Matches any character.
1447 ( This marks the start of a region for tagging a match.
1449 ) This marks the end of a tagged region.
1451 \\n Where n is 1 through 9 refers to the first through ninth tagged
1452 region when searching or replacing.
1454 Searching for (Wiki)\\1 matches WikiWiki.
1456 If the search string was Fred([1-9])XXX and the
1457 replace string was Sam\\1YYY, when applied to Fred2XXX this
1458 would generate Sam2YYY.
1460 \\0 When replacing, the whole matching text.
1462 \\b This matches a word boundary.
1464 \\c A backslash followed by d, D, s, S, w or W, becomes a
1465 character class (both inside and outside sets []).
1468 * D: any char except decimal digits
1469 * s: whitespace (space, \\t \\n \\r \\f \\v)
1470 * S: any char except whitespace (see above)
1471 * w: alphanumeric & underscore
1472 * W: any char except alphanumeric & underscore
1474 \\x This allows you to use a character x that would otherwise have
1475 a special meaning. For example, \\[ would be interpreted as [
1476 and not as the start of a character set. Use \\\\ for a literal
1479 [...] Matches one of the characters in the set. If the first
1480 character in the set is ^, it matches the characters NOT in
1481 the set, i.e. complements the set. A shorthand S-E (start
1482 dash end) is used to specify a set of characters S up to E,
1485 The special characters ] and - have no special
1486 meaning if they appear first in the set. - can also be last
1487 in the set. To include both, put ] first: []A-Z-].
1491 []|-] matches these 3 chars
1492 []-|] matches from ] to | chars
1493 [a-z] any lowercase alpha
1494 [^]-] any char except - and ]
1495 [^A-Z] any char except uppercase alpha
1498 ^ This matches the start of a line (unless used inside a set, see
1501 $ This matches the end of a line.
1503 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1504 Saam, Saaam and so on.
1506 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1507 Saam, Saaam and so on.
1509 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1510 ======= ============================================================
1513 This table is adapted from Scintilla and SciTE documentation,
1514 distributed under the `License for Scintilla and SciTE`_.
1517 Multi-line regular expressions
1518 ``````````````````````````````
1521 The *Use multi-line matching* dialog option enables multi-line
1522 regular expressions.
1524 Multi-line regular expressions work just like single-line ones but a
1525 match can span several lines.
1527 While the syntax is the same, a few practical differences applies:
1529 ======= ============================================================
1530 . Matches any character but newlines. This behavior can be changed
1531 to also match newlines using the (?s) option, see
1532 https://www.geany.org/manual/gtk/glib/glib-regex-syntax.html#idp5671632
1534 [^...] A negative range (see above) *will* match newlines if they are
1535 not explicitly listed in that negative range. For example, range
1536 [^a-z] will match newlines, while range [^a-z\\r\\n] won't.
1537 While this is the expected behavior, it can lead to tricky
1538 problems if one doesn't think about it when writing an expression.
1539 ======= ============================================================
1544 The View menu allows various elements of the main window to be shown
1545 or hidden, and also provides various display-related editor options.
1547 Color schemes dialog
1548 ^^^^^^^^^^^^^^^^^^^^
1549 The Color Schemes dialog is available under the *View->Change Color Scheme*
1550 menu item. It lists various color schemes for editor highlighting
1551 styles, including the default scheme first. Other items are available
1552 based on what color scheme files Geany found at startup.
1554 Color scheme files are read from the `Configuration file paths`_ under
1555 the ``colorschemes`` subdirectory. They should have the extension
1556 ``.conf``. The default color scheme
1557 is read from ``filetypes.common``.
1559 The `[named_styles] section`_ and `[named_colors] section`_ are the
1560 same as for ``filetypes.common``.
1562 The ``[theme_info]`` section can contain information about the
1563 theme. The ``name`` and ``description`` keys are read to set the
1564 menu item text and tooltip, respectively. These keys can have
1565 translations, e.g.::
1571 Symbols and tags files
1572 ----------------------
1574 Upon opening, files of supported filetypes are parsed to extract the symbol
1575 information (aka "workspace symbols"). You can also have Geany automatically
1576 load external files containing the symbol information (aka "global
1577 tags files") upon startup, or manually using *Tools --> Load Tags File*.
1579 Geany uses its own tags file format, similar to what ``ctags`` uses
1580 (but is incompatible with ctags). You use Geany to generate global
1581 tags files, as described below.
1587 Each document is parsed for symbols whenever a file is loaded, saved or
1588 modified (see *Symbol list update frequency* preference in the `Editor
1589 Completions preferences`_). These are shown in the Symbol list in the
1590 Sidebar. These symbols are also used for autocompletion and calltips
1591 for all documents open in the current session that have the same filetype.
1593 The *Go to Symbol* commands can be used with all workspace symbols. See
1594 `Go to symbol definition`_.
1600 Global tags files are used to provide symbols for autocompletion and calltips
1601 without having to open the source files containing these symbols. This is intended
1602 for library APIs, as the tags file only has to be updated when you upgrade
1605 You can load a custom global tags file in two ways:
1607 * Using the *Load Tags File* command in the Tools menu.
1608 * By moving or symlinking tags files to the ``tags`` subdirectory of
1609 one of the `configuration file paths`_ before starting Geany.
1611 You can either download these files or generate your own. They have
1616 *lang_ext* is one of the extensions set for the filetype associated
1617 with the tags parser. See the section called `Filetype extensions`_ for
1621 Default global tags files
1622 `````````````````````````
1624 Some global tags files are distributed with Geany and will be loaded
1625 automatically when the corresponding filetype is first used. Currently
1626 this includes global tags files for these languages:
1631 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1636 Global tags file format
1637 ```````````````````````
1639 Global tags files can have three different formats:
1642 * Pipe-separated format
1645 The first line of global tags files should be a comment, introduced
1646 by ``#`` followed by a space and a string like ``format=pipe``,
1647 ``format=ctags`` or ``format=tagmanager`` respectively, these are
1648 case-sensitive. This helps Geany to read the file properly. If this
1649 line is missing, Geany tries to auto-detect the used format but this
1653 The Tagmanager format is a bit more complex and is used for files
1654 created by the ``geany -g`` command. There is one symbol per line.
1655 Different symbol attributes like the return value or the argument list
1656 are separated with different characters indicating the type of the
1657 following argument. This is the more complete and recommended tags file
1660 Pipe-separated format
1661 *********************
1662 The Pipe-separated format is easier to read and write.
1663 There is one symbol per line and different symbol attributes are separated
1664 by the pipe character (``|``). A line looks like::
1666 basename|string|(string path [, string suffix])|
1668 | The first field is the symbol name (usually a function name).
1669 | The second field is the type of the return value.
1670 | The third field is the argument list for this symbol.
1671 | The fourth field is the description for this symbol but
1672 currently unused and should be left empty.
1674 Except for the first field (symbol name), all other field can be left
1675 empty but the pipe separator must appear for them.
1677 You can easily write your own global tags files using this format.
1678 Just save them in your tags directory, as described earlier in the
1679 section `Global tags files`_.
1683 This is the format that ctags generates, and that is used by Vim.
1684 This format is compatible with the format historically used by Vi.
1686 The format is described at http://ctags.sourceforge.net/FORMAT, but
1687 for the full list of existing extensions please refer to ctags.
1688 However, note that Geany may actually only honor a subset of the
1689 existing extensions.
1691 Generating a global tags file
1692 `````````````````````````````
1694 You can generate your own global tags files by parsing a list of
1695 source files. The command is::
1697 geany -g [-P] <Tags File> <File list>
1699 * Tags File filename should be in the format described earlier --
1700 see the section called `Global tags files`_.
1701 * File list is a list of filenames, each with a full path (unless
1702 you are generating C/C++ tags files and have set the CFLAGS environment
1703 variable appropriately).
1704 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1705 to process ``#include`` directives for C/C++ source files. Use this
1706 option if you want to specify each source file on the command-line
1707 instead of using a 'master' header file. Also can be useful if you
1708 don't want to specify the CFLAGS environment variable.
1710 Example for the wxD library for the D programming language::
1712 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1715 Generating C/C++ tags files
1716 ***************************
1717 You may need to first setup the `C ignore.tags`_ file.
1719 For C/C++ tags files gcc is required by default, so that header files
1720 can be preprocessed to include any other headers they depend upon. If
1721 you do not want this, use the ``-P`` option described above.
1723 For preprocessing, the environment variable CFLAGS should be set with
1724 appropriate ``-I/path`` include paths. The following example works with
1725 the bash shell, generating a tags file for the GnomeUI library::
1727 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1728 /usr/include/libgnomeui-2.0/gnome.h
1730 You can adapt this command to use CFLAGS and header files appropriate
1731 for whichever libraries you want.
1734 Generating tags files on Windows
1735 ********************************
1736 This works basically the same as on other platforms::
1738 "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
1744 You can ignore certain symbols for C-based languages if they would lead
1745 to wrong parsing of the code. Use the *Tools->Configuration
1746 Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
1747 See also `Configuration file paths`_.
1749 List all symbol names you want to ignore in this file, separated by spaces
1754 G_GNUC_NULL_TERMINATED
1756 G_GNUC_WARN_UNUSED_RESULT
1758 This will parse code like:
1760 ``gchar **utils_strv_new(const gchar *first, ...)
1761 G_GNUC_NULL_TERMINATED;``
1763 More detailed information about ignore.tags usage from the Exuberant Ctags
1766 Specifies a list of identifiers which are to be specially handled
1767 while parsing C and C++ source files. This option is specifically
1768 provided to handle special cases arising through the use of
1769 pre-processor macros. When the identifiers listed are simple identifiers,
1770 these identifiers will be ignored during parsing of the source files.
1771 If an identifier is suffixed with a '+' character, ctags will also
1772 ignore any parenthesis-enclosed argument list which may immediately
1773 follow the identifier in the source files.
1774 If two identifiers are separated with the '=' character, the first
1775 identifiers is replaced by the second identifiers for parsing purposes.
1777 For even more detailed information please read the manual page of
1780 Geany extends Ctags with a '*' character suffix - this means use
1781 prefix matching, e.g. G_GNUC_* will match G_GNUC_NULL_TERMINATED, etc.
1782 Note that prefix match items should be put after other items to ensure
1783 that items like G_GNUC_PRINTF+ get parsed correctly.
1789 You may adjust Geany's settings using the Edit --> Preferences
1790 dialog. Any changes you make there can be applied by hitting either
1791 the Apply or the OK button. These settings will persist between Geany
1792 sessions. Note that most settings here have descriptive popup bubble
1793 help -- just hover the mouse over the item in question to get help
1796 You may also adjust some View settings (under the View menu) that
1797 persist between Geany sessions. The settings under the Document menu,
1798 however, are only for the current document and revert to defaults
1799 when restarting Geany.
1802 In the paragraphs that follow, the text describing a dialog tab
1803 comes after the screenshot of that tab.
1806 General Startup preferences
1807 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1809 .. image:: ./images/pref_dialog_gen_startup.png
1814 Load files from the last session
1815 On startup, load the same files you had open the last time you
1818 Load virtual terminal support
1819 Load the library for running a terminal in the message window area.
1821 Enable plugin support
1822 Allow plugins to be used in Geany.
1826 Save window position and geometry
1827 Save the current position and size of the main window so next time
1828 you open Geany it's in the same location.
1831 Have a dialog pop up to confirm that you really want to quit Geany.
1837 Path to start in when opening or saving files.
1838 It must be an absolute path.
1841 Path to start in when opening project files.
1844 By default Geany looks in the system installation and the user
1845 configuration - see `Plugins`_. In addition the path entered here will be
1847 Usually you do not need to set an additional path to search for
1848 plugins. It might be useful when Geany is installed on a multi-user machine
1849 and additional plugins are available in a common location for all users.
1850 Leave blank to not set an additional lookup path.
1853 General Miscellaneous preferences
1854 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1856 .. image:: ./images/pref_dialog_gen_misc.png
1861 Beep on errors when compilation has finished
1862 Have the computer make a beeping sound when compilation of your program
1863 has completed or any errors occurred.
1865 Switch status message list at new message
1866 Switch to the status message tab (in the notebook window at the bottom)
1867 once a new status message arrives.
1869 Suppress status messages in the status bar
1870 Remove all messages from the status bar. The messages are still displayed
1871 in the status messages window.
1874 Another option is to use the *Switch to Editor* keybinding - it
1875 reshows the document statistics on the status bar. See `Focus
1878 Use Windows File Open/Save dialogs
1879 Defines whether to use the native Windows File Open/Save dialogs or
1880 whether to use the GTK default dialogs.
1882 Auto-focus widgets (focus follows mouse)
1883 Give the focus automatically to widgets below the mouse cursor.
1884 This works for the main editor widget, the scribble, the toolbar search field
1885 goto line fields and the VTE.
1891 Always wrap search around the document when finding a match.
1893 Hide the Find dialog
1894 Hide the `Find`_ dialog after clicking Find Next/Previous.
1896 Use the current word under the cursor for Find dialogs
1897 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1898 there is no selection. When this option is disabled, the search term last used in the
1899 appropriate Find dialog is used.
1901 Use the current file's directory for Find in Files
1902 When opening the Find in Files dialog, set the directory to search to the directory of the current
1903 active file. When this option is disabled, the directory of the last use of the Find in Files
1904 dialog is used. See `Find in Files`_ for details.
1909 Use project-based session files
1910 Save your current session when closing projects. You will be able to
1911 resume different project sessions, automatically opening the files
1912 you had open previously.
1914 Store project file inside the project base directory
1915 When creating new projects, the default path for the project file contains
1916 the project base path. Without this option enabled, the default project file
1917 path is one level above the project base path.
1918 In either case, you can easily set the final project file path in the
1919 *New Project* dialog. This option provides the more common
1920 defaults automatically for convenience.
1923 Interface preferences
1924 ^^^^^^^^^^^^^^^^^^^^^
1926 .. image:: ./images/pref_dialog_interface_interface.png
1932 Whether to show the sidebar at all.
1935 Show the list of functions, variables, and other information in the
1936 current document you are editing.
1939 Show all the documents you have open currently. This can be used to
1940 change between documents (see `Switching between documents`_) and
1941 to perform some common operations such as saving, closing and reloading.
1944 Whether to place the sidebar on the left or right of the editor window.
1950 Whether to place the message window on the bottom or right of the editor window.
1956 Change the font used to display documents.
1959 Change the font used for the Symbols sidebar tab.
1962 Change the font used for the message window area.
1968 Show the status bar at the bottom of the main window. It gives information about
1969 the file you are editing like the line and column you are on, whether any
1970 modifications were done, the file encoding, the filetype and other information.
1972 Interface Notebook tab preferences
1973 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1975 .. image:: ./images/pref_dialog_interface_notebook.png
1981 Show a notebook tab for all documents so you can switch between them
1982 using the mouse (instead of using the Documents window).
1985 Make each tab show a close button so you can easily close open
1988 Placement of new file tabs
1989 Whether to create a document with its notebook tab to the left or
1990 right of all existing tabs.
1993 Whether to place file tabs next to the current tab
1994 rather than at the edges of the notebook.
1996 Double-clicking hides all additional widgets
1997 Whether to call the View->Toggle All Additional Widgets command
1998 when double-clicking on a notebook tab.
2004 Set the positioning of the editor's notebook tabs to the right,
2005 left, top, or bottom of the editing window.
2008 Set the positioning of the sidebar's notebook tabs to the right,
2009 left, top, or bottom of the sidebar window.
2012 Set the positioning of the message window's notebook tabs to the
2013 right, left, top, or bottom of the message window.
2016 Interface Toolbar preferences
2017 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2019 Affects the main toolbar underneath the menu bar.
2021 .. image:: ./images/pref_dialog_interface_toolbar.png
2027 Whether to show the toolbar.
2029 Append Toolbar to the Menu
2030 Allows to append the toolbar to the main menu bar instead of placing it below.
2031 This is useful to save vertical space.
2034 See `Customizing the toolbar`_.
2040 Select the toolbar icon style to use - either icons and text, just
2042 The choice System default uses whatever icon style is set by GTK.
2045 Select the size of the icons you see (large, small or very small).
2046 The choice System default uses whatever icon size is set by GTK.
2049 Editor Features preferences
2050 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2052 .. image:: ./images/pref_dialog_edit_features.png
2058 Show long lines wrapped around to new display lines.
2063 Whether to move the cursor to the first non-whitespace character
2064 on the line when you hit the home key on your keyboard. Pressing it
2065 again will go to the very start of the line.
2067 Disable Drag and Drop
2068 Do not allow the dragging and dropping of selected text in documents.
2071 Allow groups of lines in a document to be collapsed for easier
2074 Fold/Unfold all children of a fold point
2075 Whether to fold/unfold all child fold points when a parent line
2078 Use indicators to show compile errors
2079 Underline lines with compile errors using red squiggles to indicate
2080 them in the editor area.
2082 Newline strips trailing spaces
2083 Remove any whitespace at the end of the line when you hit the
2084 Enter/Return key. See also `Strip trailing spaces`_. Note
2085 auto indentation is calculated before stripping, so although this
2086 setting will clear a blank line, it will not set the next line
2087 indentation back to zero.
2089 Line breaking column
2090 The editor column number to insert a newline at when Line Breaking
2091 is enabled for the current document.
2093 Comment toggle marker
2094 A string which is added when toggling a line comment in a source file.
2095 It is used to mark the comment as toggled.
2098 Editor Indentation preferences
2099 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2101 .. image:: ./images/pref_dialog_edit_indentation.png
2106 See `Indentation`_ for more information.
2109 The width of a single indent size in spaces. By default the indent
2110 size is equivalent to 4 spaces.
2112 Detect width from file
2113 Try to detect and set the indent width based on file content, when
2117 When Geany inserts indentation, whether to use:
2121 * Tabs and Spaces, depending on how much indentation is on a line
2123 The *Tabs and Spaces* indent type is also known as *Soft tab
2124 support* in some other editors.
2126 Detect type from file
2127 Try to detect and set the indent type based on file content, when
2131 The type of auto-indentation you wish to use after pressing Enter,
2135 Just add the indentation of the previous line.
2137 Add indentation based on the current filetype and any characters at
2138 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
2140 Like *Current chars* but for C-like languages, make a closing
2141 ``}`` brace line up with the matching opening brace.
2144 If set, pressing tab will indent the current line or selection, and
2145 unindent when pressing Shift-tab. Otherwise, the tab key will
2146 insert a tab character into the document (which can be different
2147 from indentation, depending on the indent type).
2150 There are also separate configurable keybindings for indent &
2151 unindent, but this preference allows the tab key to have different
2152 meanings in different contexts - e.g. for snippet completion.
2154 Editor Completions preferences
2155 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2157 .. image:: ./images/pref_dialog_edit_completions.png
2163 Whether to replace special keywords after typing Tab into a
2164 pre-defined text snippet.
2165 See `User-definable snippets`_.
2167 XML/HTML tag auto-closing
2168 When you open an XML/HTML tag automatically generate its
2171 Automatic continuation multi-line comments
2172 Continue automatically multi-line comments in languages like C, C++
2173 and Java when a new line is entered inside such a comment.
2174 With this option enabled, Geany will insert a ``*`` on every new line
2175 inside a multi-line comment, for example when you press return in the
2179 * This is a C multi-line comment, press <Return>
2181 then Geany would insert::
2185 on the next line with the correct indentation based on the previous line,
2186 as long as the multi-line is not closed by ``*/``.
2188 Autocomplete symbols
2189 When you start to type a symbol name, look for the full string to
2190 allow it to be completed for you.
2192 Autocomplete all words in document
2193 When you start to type a word, Geany will search the whole document for
2194 words starting with the typed part to complete it, assuming there
2195 are no symbol names to show.
2197 Drop rest of word on completion
2198 Remove any word part to the right of the cursor when choosing a
2199 completion list item.
2201 Characters to type for autocompletion
2202 Number of characters of a word to type before autocompletion is
2205 Completion list height
2206 The number of rows to display for the autocompletion window.
2208 Max. symbol name suggestions
2209 The maximum number of items in the autocompletion list.
2211 Symbol list update frequency
2212 The minimum delay (in milliseconds) between two symbol list updates.
2214 This option determines how frequently the symbol list is updated for the
2215 current document. The smaller the delay, the more up-to-date the symbol
2216 list (and then the completions); but rebuilding the symbol list has a
2217 cost in performance, especially with large files.
2219 The default value is 250ms, which means the symbol list will be updated
2220 at most four times per second, even if the document changes continuously.
2222 A value of 0 disables automatic updates, so the symbol list will only be
2223 updated upon document saving.
2226 Auto-close quotes and brackets
2227 ``````````````````````````````
2229 Geany can automatically insert a closing bracket and quote characters when
2230 you open them. For instance, you type a ``(`` and Geany will automatically
2231 insert ``)``. With the following options, you can define for which
2232 characters this should work.
2235 Auto-close parenthesis when typing an opening one
2238 Auto-close curly brackets (braces) when typing an opening one
2241 Auto-close square brackets when typing an opening one
2244 Auto-close single quotes when typing an opening one
2247 Auto-close double quotes when typing an opening one
2250 Editor Display preferences
2251 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2253 This is for visual elements displayed in the editor window.
2255 .. image:: ./images/pref_dialog_edit_display.png
2260 Invert syntax highlighting colors
2261 Invert all colors, by default this makes white text on a black
2264 Show indendation guides
2265 Show vertical lines to help show how much leading indentation there
2269 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2270 show which kinds of whitespace are used.
2273 Display a symbol everywhere that a carriage return or line feed
2277 Show or hide the Line Number margin.
2280 Show or hide the small margin right of the line numbers, which is used
2283 Stop scrolling at last line
2284 When enabled Geany stops scrolling when at the last line of the document.
2285 Otherwise you can scroll one more page even if there are no real lines.
2287 Lines visible around the cursor
2288 The number of lines to maintain between the cursor and the top and bottom
2289 edges of the view. This allows some lines of context around the cursor to
2290 always be visible. If *Stop scrolling at last line* is disabled, the cursor
2291 will never reach the bottom edge when this value is greater than 0.
2297 The long line marker helps to indicate overly-long lines, or as a hint
2298 to the user for when to break the line.
2302 Show a thin vertical line in the editor window at the given column
2305 Change the background color of characters after the given column
2306 position to the color set below. (This is recommended over the
2307 *Line* setting if you use proportional fonts).
2309 Don't mark long lines at all.
2312 Set this value to a value greater than zero to specify the column
2313 where it should appear.
2315 Long line marker color
2316 Set the color of the long line marker.
2322 Virtual space is space beyond the end of each line.
2323 The cursor may be moved into virtual space but no real space will be
2324 added to the document until there is some text typed or some other
2325 text insertion command is used.
2328 Do not show virtual spaces
2330 Only for rectangular selections
2331 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2334 Always show virtual spaces beyond the end of lines
2340 .. image:: ./images/pref_dialog_files.png
2345 Open new documents from the command-line
2346 Whether to create new documents when passing filenames that don't
2347 exist from the command-line.
2349 Default encoding (new files)
2350 The type of file encoding you wish to use when creating files.
2352 Used fixed encoding when opening files
2353 Assume all files you are opening are using the type of encoding specified below.
2355 Default encoding (existing files)
2356 Opens all files with the specified encoding instead of auto-detecting it.
2357 Use this option when it's not possible for Geany to detect the exact encoding.
2359 Default end of line characters
2360 The end of line characters to which should be used for new files.
2361 On Windows systems, you generally want to use CR/LF which are the common
2362 characters to mark line breaks.
2363 On Unix-like systems, LF is default and CR is used on MAC systems.
2367 Perform formatting operations when a document is saved. These
2368 can each be undone with the Undo command.
2370 Ensure newline at file end
2371 Add a newline at the end of the document if one is missing.
2373 Ensure consistent line endings
2374 Ensures that newline characters always get converted before
2375 saving, avoiding mixed line endings in the same file.
2377 .. _Strip trailing spaces:
2379 Strip trailing spaces
2380 Remove any whitespace at the end of each document line.
2383 This does not apply to Diff documents, e.g. patch files.
2385 Replace tabs with spaces
2386 Replace all tabs in the document with the equivalent number of spaces.
2389 It is better to use spaces to indent than use this preference - see
2395 Recent files list length
2396 The number of files to remember in the recently used files list.
2399 The number of seconds to periodically check the current document's
2400 file on disk in case it has changed. Setting it to 0 will disable
2404 These checks are only performed on local files. Remote files are
2405 not checked for changes due to performance issues
2406 (remote files are files in ``~/.gvfs/``).
2412 .. image:: ./images/pref_dialog_tools.png
2418 The command to execute a script in a terminal. Occurrences of %c
2419 in the command are substituted with the run script name, see
2420 `Terminal emulators`_.
2423 The location of your web browser executable.
2426 The location of the grep executable.
2429 For Windows users: at the time of writing it is recommended to use
2430 the grep.exe from the UnxUtils project
2431 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2432 Mingw project for instance might not work with Geany at the moment.
2438 Set this to a command to execute on the current word.
2439 You can use the "%s" wildcard to pass the current word below the cursor
2440 to the specified command.
2443 Template preferences
2444 ^^^^^^^^^^^^^^^^^^^^
2446 This data is used as meta data for various template text to insert into
2447 a document, such as the file header. You only need to set fields that
2448 you want to use in your template files.
2450 .. image:: ./images/pref_dialog_templ.png
2456 The name of the developer who will be creating files.
2459 The initials of the developer.
2462 The email address of the developer.
2465 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2468 The company the developer is working for.
2471 The initial version of files you will be creating.
2474 Specify a format for the {year} wildcard. You can use any conversion specifiers
2475 which can be used with the ANSI C strftime function. For details please see
2476 http://man.cx/strftime.
2479 Specify a format for the {date} wildcard. You can use any conversion specifiers
2480 which can be used with the ANSI C strftime function. For details please see
2481 http://man.cx/strftime.
2484 Specify a format for the {datetime} wildcard. You can use any conversion specifiers
2485 which can be used with the ANSI C strftime function. For details please see
2486 http://man.cx/strftime.
2489 Keybinding preferences
2490 ^^^^^^^^^^^^^^^^^^^^^^
2492 .. image:: ./images/pref_dialog_keys.png
2494 There are some commands listed in the keybinding dialog that are not, by default,
2495 bound to a key combination, and may not be available as a menu item.
2498 For more information see the section `Keybindings`_.
2501 Printing preferences
2502 ^^^^^^^^^^^^^^^^^^^^
2504 .. image:: ./images/pref_dialog_printing.png
2506 Use external command for printing
2507 Use a system command to print your file out.
2509 Use native GTK printing
2510 Let the GTK GUI toolkit handle your print request.
2513 Print the line numbers on the left of your paper.
2516 Print the page number on the bottom right of your paper.
2519 Print a header on every page that is sent to the printer.
2521 Use base name of the printed file
2522 Don't use the entire path for the header, only the filename.
2525 How the date should be printed. You can use the same format
2526 specifiers as in the ANSI C function strftime(). For details please
2527 see http://man.cx/strftime.
2533 .. image:: ./images/pref_dialog_various.png
2535 Rarely used preferences, explained in the table below. A few of them require
2536 restart to take effect, and a few other will only affect newly opened or created
2537 documents before restart.
2539 ================================ =========================================== ========== ===========
2540 Key Description Default Applies
2541 ================================ =========================================== ========== ===========
2542 **``editor`` group**
2543 use_gtk_word_boundaries Whether to look for the end of a word true to new
2544 when using word-boundary related documents
2545 Scintilla commands (see `Scintilla
2546 keyboard commands`_).
2547 brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
2548 complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
2549 when editing an existing line (i.e. there
2550 is some text after the current cursor
2551 position on the line). Only used when the
2552 keybinding `Complete snippet` is set to
2554 show_editor_scrollbars Whether to display scrollbars. If set to true immediately
2555 false, the horizontal and vertical
2556 scrollbars are hidden completely.
2557 indent_hard_tab_width The size of a tab character. Don't change 8 immediately
2558 it unless you really need to; use the
2559 indentation settings instead.
2560 editor_ime_interaction Input method editor (IME)'s candidate 0 to new
2561 window behaviour. May be 0 (windowed) or documents
2563 **``interface`` group**
2564 show_symbol_list_expanders Whether to show or hide the small true to new
2565 expander icons on the symbol list documents
2567 compiler_tab_autoscroll Whether to automatically scroll to the true immediately
2568 last line of the output in the Compiler
2570 statusbar_template The status bar statistics line format. See below. immediately
2571 (See `Statusbar Templates`_ for details).
2572 new_document_after_close Whether to open a new document after all false immediately
2573 documents have been closed.
2574 msgwin_status_visible Whether to show the Status tab in the true immediately
2576 msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
2578 msgwin_messages_visible Whether to show the Messages tab in the true immediately
2580 msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
2582 **``terminal`` group**
2583 send_selection_unsafe By default, Geany strips any trailing false immediately
2584 newline characters from the current
2585 selection before sending it to the terminal
2586 to not execute arbitrary code. This is
2587 mainly a security feature.
2588 If, for whatever reasons, you really want
2589 it to be executed directly, set this option
2591 send_cmd_prefix String with which prefix the commands sent Empty immediately
2592 to the shell. This may be used to tell
2593 some shells (BASH with ``HISTCONTROL`` set
2594 to ``ignorespace``, ZSH with
2595 ``HIST_IGNORE_SPACE`` enabled, etc.) from
2596 putting these commands in their history by
2597 setting this to a space. Note that leading
2598 spaces must be escaped using `\s` in the
2601 allow_always_save Whether files can be saved always, even false immediately
2602 if they don't have any changes.
2603 By default, the Save button and menu
2604 item are disabled when a file is
2605 unchanged. When setting this option to
2606 true, the Save button and menu item are
2607 always active and files can be saved.
2608 use_atomic_file_saving Defines the mode how Geany saves files to false immediately
2609 disk. If disabled, Geany directly writes
2610 the content of the document to disk. This
2611 might cause loss of data when there is
2612 no more free space on disk to save the
2613 file. When set to true, Geany first saves
2614 the contents into a temporary file and if
2615 this succeeded, the temporary file is
2616 moved to the real file to save.
2617 This gives better error checking in case of
2618 no more free disk space. But it also
2619 destroys hard links of the original file
2620 and its permissions (e.g. executable flags
2621 are reset). Use this with care as it can
2622 break things seriously.
2623 The better approach would be to ensure your
2624 disk won't run out of free space.
2625 use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
2626 saving backend. It is better on most
2627 situations but is known not to work
2628 correctly on some complex setups.
2629 gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
2630 saving. Backup is named `filename~`.
2631 keep_edit_history_on_reload Whether to maintain the edit history when true immediately
2632 reloading a file, and allow the operation
2634 reload_clean_doc_on_file_change Whether to automatically reload documents false immediately
2635 that have no changes but which have changed
2637 If unsaved changes exist then the user is
2638 prompted to reload manually.
2639 extract_filetype_regex Regex to extract filetype name from file See link immediately
2640 via capture group one.
2641 See `ft_regex`_ for default.
2642 **``search`` group**
2643 find_selection_type See `Find selection`_. 0 immediately
2644 replace_and_find_by_default Set ``Replace & Find`` button as default so true immediately
2645 it will be activated when the Enter key is
2646 pressed while one of the text fields has
2649 number_ft_menu_items The maximum number of menu items in the 2 on restart
2650 filetype build section of the Build menu.
2651 number_non_ft_menu_items The maximum number of menu items in the 3 on restart
2652 independent build section.
2653 number_exec_menu_items The maximum number of menu items in the 2 on restart
2654 execute section of the Build menu.
2655 ================================ =========================================== ========== ===========
2660 The default statusbar template is (note ``\t`` = tab):
2662 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
2664 Settings the preference to an empty string will also cause Geany to use this
2667 The following format characters are available for the statusbar template:
2669 ============ ===========================================================
2670 Placeholder Description
2671 ============ ===========================================================
2672 ``%l`` The current line number starting at 1
2673 ``%L`` The total number of lines
2674 ``%c`` The current column number starting at 0, including virtual
2676 ``%C`` The current column number starting at 1, including virtual
2678 ``%s`` The number of selected characters or if only whole lines
2679 selected, the number of selected lines.
2680 ``%n`` The number of selected characters, even if only whole lines
2682 ``%w`` Shows ``RO`` when the document is in read-only mode,
2683 otherwise shows whether the editor is in overtype (OVR)
2684 or insert (INS) mode.
2685 ``%t`` Shows the indentation mode, either tabs (TAB),
2686 spaces (SP) or both (T/S).
2687 ``%m`` Shows whether the document is modified (MOD) or nothing.
2688 ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
2689 ``%e`` The name of the document's encoding (ex. UTF-8).
2690 ``%f`` The filetype of the document (ex. None, Python, C, etc).
2691 ``%S`` The name of the scope where the caret is located.
2692 ``%p`` The caret position in the entire document starting at 0.
2693 ``%r`` Shows whether the document is read-only (RO) or nothing.
2694 ``%Y`` The Scintilla style number at the caret position. This is
2695 useful if you're debugging color schemes or related code.
2696 ============ ===========================================================
2698 Terminal (VTE) preferences
2699 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2701 See also: `Virtual terminal emulator widget (VTE)`_.
2703 .. image:: ./images/pref_dialog_vte.png
2709 Select the font that will be used in the terminal emulation control.
2712 Select the font color.
2715 Select the background color of the terminal.
2718 Select the background image to show behind the terminal's text.
2721 The number of lines buffered so that you can scroll though the history.
2724 The location of the shell on your system.
2727 Scroll the terminal to the prompt line when pressing a key.
2730 Scroll the output down.
2733 Let the terminal cursor blink.
2735 Override Geany keybindings
2736 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2738 Disable menu shortcut key (F10 by default)
2739 Disable the menu shortcut when you are in the virtual terminal.
2741 Follow path of the current file
2742 Make the path of the terminal change according to the path of the
2745 Execute programs in VTE
2746 Execute programs in the virtual terminal instead of using the external
2747 terminal tool. Note that if you run multiple execute commands at once
2748 the output may become mixed together in the VTE.
2750 Don't use run script
2751 Don't use the simple run script which is usually used to display
2752 the exit status of the executed program.
2753 This can be useful if you already have a program running in the VTE
2754 like a Python console (e.g. ipython). Use this with care.
2760 Project management is optional in Geany. Currently it can be used for:
2762 * Storing and opening session files on a project basis.
2763 * Overriding default settings with project equivalents.
2764 * Configuring the Build menu on a project basis.
2766 A list of session files can be stored and opened with the project
2767 when the *Use project-based session files* preference is enabled,
2768 in the `Projects`_ group of the `General Miscellaneous preferences`_ tab
2769 of the `Preferences`_ dialog.
2771 As long as a project is open, the Build menu will use
2772 the items defined in project's settings, instead of the defaults.
2773 See `Build Menu Configuration`_ for information on configuring the menu.
2775 The current project's settings are saved when it is closed, or when
2776 Geany is shutdown. When restarting Geany, the previously opened project
2777 file that was in use at the end of the last session will be reopened.
2779 The project menu items are detailed below.
2785 To create a new project, fill in the *Name* field. By default this
2786 will setup a new project file ``~/projects/name.geany``. Usually it's
2787 best to store all your project files in the same directory (they are
2788 independent of any source directory trees).
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.
2798 You can set an optional description for the project. Currently it's
2799 only used for a template wildcard - see `Template wildcards`_.
2801 The *Base path* field is used as the directory to run the Build menu commands.
2802 The specified path can be an absolute path or it is considered to be
2803 relative to the project's file name.
2805 The *File patterns* field allows to specify a list of file patterns for the
2806 project, which can be used in the `Find in files`_ dialog.
2808 The *Indentation* tab allows you to override the default
2809 `Indentation`_ settings.
2815 The Open command displays a standard file chooser, starting in
2816 ``~/projects``. Choose a project file named with the ``.geany``
2819 When project session support is enabled, Geany will close the currently
2820 open files and open the session files associated with the project.
2826 Project file settings are saved when the project is closed.
2828 When project session support is enabled, Geany will close the project
2829 session files and open any previously closed default session files.
2834 After editing code with Geany, the next step is to compile, link, build,
2835 interpret, run etc. As Geany supports many languages each with a different
2836 approach to such operations, and as there are also many language independent
2837 software building systems, Geany does not have a built-in build system, nor
2838 does it limit which system you can use. Instead the build menu provides
2839 a configurable and flexible means of running any external commands to
2840 execute your preferred build system.
2842 This section provides a description of the default configuration of the
2843 build menu and then covers how to configure it, and where the defaults fit in.
2845 Running the commands from within Geany has two benefits:
2847 * The current file is automatically saved before the command is run.
2848 * The output is captured in the Compiler notebook tab and parsed for
2851 Warnings and errors that can be parsed for line numbers will be shown in
2852 red in the Compiler tab and you can click on them to switch to the relevant
2853 source file (or open it) and mark the line number. Also lines with
2854 warnings or errors are marked in the source, see `Indicators`_ below.
2857 If Geany's default error message parsing does not parse errors for
2858 the tool you're using, you can set a custom regex in the
2859 `Set Build Commands dialog`_, see `Build Menu Configuration`_.
2864 Indicators are red squiggly underlines which are used to highlight
2865 errors which occurred while compiling the current file. So you can
2866 easily see where your code failed to compile. You can remove them by
2867 selecting *Remove Error Indicators* in the Document menu.
2869 If you do not like this feature, you can disable it - see `Editor Features
2873 Default build menu items
2874 ^^^^^^^^^^^^^^^^^^^^^^^^
2875 Depending on the current file's filetype, the default Build menu will contain
2876 the following items:
2882 * Make Custom Target
2887 * Set Build Menu Commands
2893 The Compile command has different uses for different kinds of files.
2895 For compilable languages such as C and C++, the Compile command is
2896 set up to compile the current source file into a binary object file.
2898 Java source files will be compiled to class file bytecode.
2900 Interpreted languages such as Perl, Python, Ruby will compile to
2901 bytecode if the language supports it, or will run a syntax check,
2902 or if that is not available will run the file in its language interpreter.
2907 For compilable languages such as C and C++, the Build command will link
2908 the current source file's equivalent object file into an executable. If
2909 the object file does not exist, the source will be compiled and linked
2910 in one step, producing just the executable binary.
2912 Interpreted languages do not use the Build command.
2915 If you need complex settings for your build system, or several
2916 different settings, then writing a Makefile and using the Make
2917 commands is recommended; this will also make it easier for users to
2918 build your software.
2923 Source code linters are often used to find code that doesn't correspond to
2924 certain style guidelines: non-portable code, common or hard to find
2925 errors, code "smells", variables used before being set, unused functions,
2926 division by zero, constant conditions, etc. Linters inspect the code and
2927 issue warnings much like the compilers do. This is formally referred to as
2928 static code analysis.
2930 Some common linters are pre-configured for you in the Build menu (``pep8``
2931 for Python, ``cppcheck`` for C/C++, JSHint for JavaScript, ``xmllint`` for
2932 XML, ``hlint`` for Haskell, ``shellcheck`` for shell code, ...), but all
2933 these are standalone tools you need to obtain before using.
2938 This runs "make" in the same directory as the
2944 This is similar to running 'Make' but you will be prompted for
2945 the make target name to be passed to the Make tool. For example,
2946 typing 'clean' in the dialog prompt will run "make clean".
2952 Make object will run "make current_file.o" in the same directory as
2953 the current file, using the filename for 'current_file'. It is useful
2954 for building just the current file without building the whole project.
2959 The next error item will move to the next detected error in the file.
2963 The previous error item will move to the previous detected error in the file.
2968 Execute will run the corresponding executable file, shell script or
2969 interpreted script in a terminal window. The command set in the
2970 `Set Build Commands dialog`_ is run in a script to ensure the terminal
2971 stays open after execution completes. Note: see `Terminal emulators`_
2972 below for the command format. Alternatively the built-in VTE can be used
2973 if it is available - see `Virtual terminal emulator widget (VTE)`_.
2975 After your program or script has finished executing, the run script will
2976 prompt you to press the return key. This allows you to review any text
2977 output from the program before the terminal window is closed.
2980 The execute command output is not parsed for errors.
2983 Stopping running processes
2984 ``````````````````````````
2986 When there is a running program, the Execute menu item in the menu and
2987 the Run button in the toolbar
2988 each become a stop button so you can stop the current running program (and
2989 any child processes). This works by sending the SIGQUIT signal to the process.
2991 Depending on the process you started it is possible that the process
2992 cannot be stopped. For example this can happen when the process creates
2993 more than one child process.
2999 The Terminal field of the tools preferences tab requires a command to
3000 execute the terminal program and to pass it the name of the Geany run
3001 script that it should execute in a Bourne compatible shell (eg /bin/sh).
3002 The marker "%c" is substituted with the name of the Geany run script,
3003 which is created in the temporary directory and which changes the working
3004 directory to the directory set in the `Set Build Commands dialog`_.
3006 As an example the default (Linux) command is::
3008 xterm -e "/bin/sh %c"
3014 By default Compile, Build and Execute are fairly basic commands. You
3015 may wish to customise them using *Set Build Commands*.
3017 E.g. for C you can add any include paths and compile flags for the
3018 compiler, any library names and paths for the linker, and any
3019 arguments you want to use when running Execute.
3021 Build menu configuration
3022 ^^^^^^^^^^^^^^^^^^^^^^^^
3024 The build menu has considerable flexibility and configurability, allowing
3025 menu labels, the commands they execute and the directory they execute
3026 in to be configured.
3027 For example, if you change one of the default make commands to run say 'waf'
3028 you can also change the label to match.
3029 These settings are saved automatically when Geany is shut down.
3031 The build menu is divided into four groups of items each with different
3034 * Filetype build commands - are configurable and depend on the filetype of the
3035 current document; they capture output in the compiler tab and parse it for
3037 * Independent build commands - are configurable and mostly don't depend on the
3038 filetype of the current document; they also capture output in the
3039 compiler tab and parse it for errors.
3040 * Execute commands - are configurable and intended for executing your
3041 program or other long running programs. The output is not parsed for errors
3042 and is directed to the terminal command selected in *Preferences*.
3043 * Fixed commands - these perform built-in actions:
3045 * Go to the next error.
3046 * Go to the previous error.
3047 * Show the build menu commands dialog.
3049 The maximum numbers of items in each of the configurable groups can be
3050 configured in `Various preferences`_. Even though the maximum number of
3051 items may have been increased, only those menu items that have commands
3052 configured are shown in the menu.
3054 The groups of menu items obtain their configuration from four potential
3055 sources. The highest priority source that has the menu item defined will
3056 be used. The sources in decreasing priority are:
3058 * A project file if open
3059 * The user preferences
3060 * The system filetype definitions
3063 The detailed relationships between sources and the configurable menu item groups
3064 is shown in the following table:
3066 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3067 | Group | Project File | Preferences | System Filetype | Defaults |
3068 +==============+=====================+==========================+===================+===============================+
3069 | Filetype | Loads From: project | Loads From: | Loads From: | None |
3070 | Build | file | filetypes.xxx file in | filetypes.xxx in | |
3071 | | | ~/.config/geany/filedefs | Geany install | |
3072 | | Saves To: project | | | |
3073 | | file | Saves to: as above, | Saves to: as user | |
3074 | | | creating if needed. | preferences left. | |
3075 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3076 | Independent | Loads From: project | Loads From: | Loads From: | 1: |
3077 | Build | file | geany.conf file in | filetypes.xxx in | Label: _Make |
3078 | | | ~/.config/geany | Geany install | Command: make |
3079 | | Saves To: project | | | |
3080 | | file | Saves to: as above, | Saves to: as user | 2: |
3081 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
3082 | | | | | Command: make |
3085 | | | | | Label: Make _Object |
3086 | | | | | Command: make %e.o |
3087 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3088 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
3089 | | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
3090 | | filetype defined in | ~/.config/geany or else | Geany install | |
3091 | | project file | filetypes.xxx file in | | |
3092 | | | ~/.config/geany/filedefs | Saves To: as user | |
3093 | | Saves To: | | preferences left. | |
3094 | | project file | Saves To: | | |
3095 | | | filetypes.xxx file in | | |
3096 | | | ~/.config/geany/filedefs | | |
3097 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3099 The following notes on the table may reference cells by coordinate as *(group, source)*:
3101 * Filetype filenames - for filetypes.xxx substitute the appropriate extension for
3102 the filetype of the current document for xxx - see `filenames`_.
3104 * System Filetypes - Labels loaded from these sources are locale sensitive
3105 and can contain translations.
3107 * *(Filetype build, Project and Preferences)* - preferences use a full
3108 filetype file so that users can configure all other filetype preferences
3109 as well. Projects can only configure menu items per filetype. Saving
3110 in the project file means that there is only one file per project not
3113 * *(Filetype-Independent build, System Filetype)* - although conceptually strange, defining
3114 filetype-independent commands in a filetype file, this provides the ability to
3115 define filetype dependent default menu items.
3117 * *(Execute, Project and Preferences)* - the project independent
3118 execute and preferences independent execute commands can only be set by hand
3119 editing the appropriate file, see `Preferences file format`_ and `Project file
3122 Set Build Commands dialog
3123 ^^^^^^^^^^^^^^^^^^^^^^^^^
3125 Most of the configuration of the build menu is done through the *Set Build Commands* dialog.
3126 The configuration sourced from user preferences can be edited in the
3127 dialog opened from the *Build->Set Build Commands* menu item. The
3128 configuration sourced from the project can be edited in the *Build* tab of the `Project Properties`_
3129 dialog. The former menu item also shows the project dialog when a project is open. Both use the same form shown below.
3131 .. image:: ./images/build_menu_commands_dialog.png
3133 The dialog is divided into three sections:
3135 * Filetype build commands (selected based on the current document's filetype).
3136 * Independent build commands (available regardless of filetype).
3137 * Filetype execute commands.
3139 The filetype and independent build sections also each contain a field for the regular
3140 expression used for parsing command output for error and warning messages.
3142 The columns in the first three sections allow setting of the label, command,
3143 and working directory to run the command in.
3144 An item with an empty label will not be shown in the menu.
3145 An empty working directory will default to the directory of the current document.
3146 If there is no current document then the command will not run.
3148 The dialog will always show the command selected by priority, not just the
3149 commands configured in this configuration source. This ensures that you always
3150 see what the menu item is going to do if activated.
3152 If the current source of the menu item is higher priority than the
3153 configuration source you are editing then the command will be shown
3154 in the dialog but will be insensitive (greyed out). This can't happen
3155 with the project source but can with the preferences source dialog.
3157 The clear buttons remove the definition from the configuration source you are editing.
3158 When you do this the command from the next lower priority source will be shown.
3159 To hide lower priority menu items without having anything show in the menu,
3160 configure with nothing in the label but at least one character in the command.
3162 Substitutions in commands and working directories
3163 `````````````````````````````````````````````````
3165 Before the command is run, the first occurrence of each of the following two character sequences in each of the
3166 command and working directory fields is substituted by the items specified below:
3168 * %d - the absolute path to the directory of the current file.
3169 * %e - the name of the current file without the extension or path.
3170 * %f - the name of the current file without the path.
3171 * %p - if a project is open, the base path from the project.
3172 * %l - the line number at the current cursor position.
3175 If the base path set in `Project Properties`_ is not an absolute path, then it is
3176 taken as relative to the directory of the project file. This allows a project file
3177 stored in the source tree to specify all commands and working directories relative
3178 to the tree itself, so that the whole tree including the project file, can be moved
3179 and even checked into and out of version control without having to re-configure the
3182 Build menu keyboard shortcuts
3183 `````````````````````````````
3185 Keyboard shortcuts can be defined for:
3187 * the first two filetype build menu items
3188 * the first three independent build menu items
3189 * the first execute menu item
3190 * the fixed menu items (Next/Previous Error, Set Commands)
3192 In the keybindings configuration dialog (see `Keybinding preferences`_)
3193 these items are identified by the default labels shown in the `Build Menu`_ section above.
3195 It is currently not possible to bind keyboard shortcuts to more than these menu items.
3196 You can also use underlines in the labels to set mnemonic characters.
3200 The configurable Build Menu capability was introduced in Geany 0.19 and
3201 required a new section to be added to the configuration files (See
3202 `Preferences file format`_). Geany will still load older format project,
3203 preferences and filetype file settings and will attempt to map them into the new
3204 configuration format. There is not a simple clean mapping between the formats.
3205 The mapping used produces the most sensible results for the majority of cases.
3206 However, if they do not map the way you want, you may have to manually
3207 configure some settings using the `Set Build Commands dialog`_.
3209 Any setting configured in either of these dialogs will override settings mapped from
3210 older format configuration files.
3215 Since Geany 0.13 there has been printing support using GTK's printing API.
3216 The printed page(s) will look nearly the same as on your screen in Geany.
3217 Additionally, there are some options to modify the printed page(s).
3220 The background text color is set to white, except for text with
3221 a white foreground. This allows dark color schemes to save ink
3224 You can define whether to print line numbers, page numbers at the bottom of
3225 each page and whether to print a page header on each page. This header
3226 contains the filename of the printed document, the current page number and
3227 the date and time of printing. By default, the file name of the document
3228 with full path information is added to the header. If you prefer to add
3229 only the basename of the file(without any path information) you can set it
3230 in the preferences dialog. You can also adjust the format of the date and
3231 time added to the page header. The available conversion specifiers are the
3232 same as the ones which can be used with the ANSI C strftime function.
3234 All of these settings can also be changed in the print dialog just before
3235 actual printing is done.
3236 On Unix-like systems the provided print dialog offers a print preview. The
3237 preview file is opened with a PDF viewer and by default GTK uses ``evince``
3238 for print preview. If you have not installed evince or just want to use
3239 another PDF viewer, you can change the program to use in the file
3240 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
3243 gtk-print-preview-command = "epdfview %f"
3245 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3246 as the print preview command.
3248 Geany also provides an alternative basic printing support using a custom
3249 print command. However, the printed document contains no syntax highlighting.
3250 You can adjust the command to which the filename is passed in the preferences
3251 dialog. The default command is::
3255 ``%f`` will be substituted by the filename of the current file. Geany
3256 will not show errors from the command itself, so you should make
3257 sure that it works before(e.g. by trying to execute it from the
3260 A nicer example, which many prefer is::
3262 % a2ps -1 --medium=A4 -o - %f | xfprint4
3264 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3265 gtklp or similar programs can be used.
3272 Plugins are loaded at startup, if the *Enable plugin support*
3273 general preference is set. There is also a command-line option,
3274 ``-p``, which prevents plugins being loaded. Plugins are scanned in
3275 the following directories:
3277 * ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
3278 * The ``lib`` subfolder of the installation path on Windows.
3279 * The ``plugins`` subfolder of the user configuration directory - see
3280 `Configuration file paths`_.
3281 * The `Extra plugin path` preference (usually blank) - see `Paths`_.
3283 Most plugins add menu items to the *Tools* menu when they are loaded.
3285 See also `Plugin documentation`_ for information about single plugins
3286 which are included in Geany.
3290 The Plugin Manager dialog lets you choose which plugins
3291 should be loaded at startup. You can also load and unload plugins on the
3292 fly using this dialog. Once you click the checkbox for a specific plugin
3293 in the dialog, it is loaded or unloaded according to its previous state.
3294 By default, no plugins are loaded at startup until you select some.
3295 You can also configure some plugin specific options if the plugin
3302 Geany supports the default keyboard shortcuts for the Scintilla
3303 editing widget. For a list of these commands, see `Scintilla
3304 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
3305 by any custom keybindings with the same keyboard shortcut.
3311 There are some non-configurable bindings to switch between documents,
3312 listed below. These can also be overridden by custom keybindings.
3314 =============== ==================================
3316 =============== ==================================
3317 Alt-[1-9] Select left-most tab, from 1 to 9.
3318 Alt-0 Select right-most tab.
3319 =============== ==================================
3321 See also `Notebook tab keybindings`_.
3324 Configurable keybindings
3325 ^^^^^^^^^^^^^^^^^^^^^^^^
3327 For all actions listed below you can define your own keybindings. Open
3328 the Preferences dialog, select the desired action and click on
3329 change. In the resulting dialog you can press the key combination you
3330 want to assign to the action and it will be saved when you press OK.
3331 You can define only one key combination for each action and each key
3332 combination can only be defined for one action.
3334 The following tables list all customizable keyboard shortcuts, those
3335 which are common to many applications are marked with (C) after the
3340 =============================== ========================= ==================================================
3341 Action Default shortcut Description
3342 =============================== ========================= ==================================================
3343 New Ctrl-N (C) Creates a new file.
3345 Open Ctrl-O (C) Opens a file.
3347 Open selected file Ctrl-Shift-O Opens the selected filename.
3349 Re-open last closed tab Re-opens the last closed document tab.
3351 Save Ctrl-S (C) Saves the current file.
3353 Save As Saves the current file under a new name.
3355 Save all Ctrl-Shift-S Saves all open files.
3357 Close all Ctrl-Shift-W Closes all open files.
3359 Close Ctrl-W (C) Closes the current file.
3361 Reload file Ctrl-R (C) Reloads the current file.
3363 Print Ctrl-P (C) Prints the current file.
3365 Quit Ctrl-Q (C) Quits Geany.
3366 =============================== ========================= ==================================================
3371 =============================== ========================= ==================================================
3372 Action Default shortcut Description
3373 =============================== ========================= ==================================================
3374 Undo Ctrl-Z (C) Un-does the last action.
3376 Redo Ctrl-Y Re-does the last action.
3378 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3381 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3382 end of the current line.
3384 Delete to line start Ctrl-Shift-BackSpace Deletes from the beginning of the line to the
3385 current caret position.
3387 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3389 Transpose current line Transposes the current line with the previous one.
3391 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3392 view. The cursor position and or an existing
3393 selection will not be changed.
3395 Scroll up by one line Alt-Up Scrolls the view.
3397 Scroll down by one line Alt-Down Scrolls the view.
3399 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3400 symbol completion, it shows document word completion
3401 instead, even if it is not enabled for automatic
3402 completion. Likewise if no symbol suggestions are
3403 available, it shows document word completion.
3405 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3408 Complete snippet Tab If you type a construct like if or for and press
3409 this key, it will be completed with a matching
3412 Suppress snippet completion If you type a construct like if or for and press
3413 this key, it will not be completed, and a space or
3414 tab will be inserted, depending on what the
3415 construct completion keybinding is set to. For
3416 example, if you have set the construct completion
3417 keybinding to space, then setting this to
3418 Shift+space will prevent construct completion and
3421 Context Action Executes a command and passes the current word
3422 (near the cursor position) or selection as an
3423 argument. See the section called `Context
3426 Move cursor in snippet Jumps to the next defined cursor positions in a
3427 completed snippets if multiple cursor positions
3430 Word part completion Tab When the autocompletion list is visible, complete
3431 the currently selected item up to the next word
3434 Move line(s) up Alt-PageUp Move the current line or selected lines up by
3437 Move line(s) down Alt-PageDown Move the current line or selected lines down by
3439 =============================== ========================= ==================================================
3442 Clipboard keybindings
3443 `````````````````````
3444 =============================== ========================= ==================================================
3445 Action Default shortcut Description
3446 =============================== ========================= ==================================================
3447 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3449 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3451 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3453 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3454 selection) to the clipboard.
3456 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3457 selection) to the clipboard.
3458 =============================== ========================= ==================================================
3463 =============================== ========================= ==================================================
3464 Action Default shortcut Description
3465 =============================== ========================= ==================================================
3466 Select all Ctrl-A (C) Makes a selection of all text in the current
3469 Select current word Alt-Shift-W Selects the current word under the cursor.
3471 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3472 which is defined by two empty lines around it.
3474 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3475 partially selected lines).
3477 Select to previous word part (Extend) selection to previous word part boundary.
3479 Select to next word part (Extend) selection to next word part boundary.
3480 =============================== ========================= ==================================================
3485 =============================== ========================= ==================================================
3486 Action Default shortcut Description
3487 =============================== ========================= ==================================================
3488 Insert date Shift-Alt-D Inserts a customisable date.
3490 Insert alternative whitespace Inserts a tab character when spaces should
3491 be used for indentation and inserts space
3492 characters of the amount of a tab width when
3493 tabs should be used for indentation.
3495 Insert New Line Before Current Inserts a new line with indentation.
3497 Insert New Line After Current Inserts a new line with indentation.
3498 =============================== ========================= ==================================================
3503 =============================== ========================= ==================================================
3504 Action Default shortcut Description
3505 =============================== ========================= ==================================================
3506 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3507 selection will be changed into uppercase and vice
3508 versa. If the selection contains lower- and
3509 uppercase characters, all will be converted to
3512 Comment line Comments current line or selection.
3514 Uncomment line Uncomments current line or selection.
3516 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3517 a comment if the line is commented.
3519 Increase indent Ctrl-I Indents the current line or selection by one tab
3520 or with spaces in the amount of the tab width
3523 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3524 the tab width setting from the indentation of the
3525 current line or selection.
3527 Increase indent by one space Indents the current line or selection by one
3530 Decrease indent by one space Deindents the current line or selection by one
3533 Smart line indent Indents the current line or all selected lines
3534 with the same indentation as the previous line.
3536 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3537 external command (available for the first
3538 9 configured commands, see
3539 `Sending text through custom commands`_ for
3542 Send Selection to Terminal Sends the current selection or the current
3543 line (if there is no selection) to the
3544 embedded Terminal (VTE).
3546 Reflow lines/block Reformat selected lines or current
3547 (indented) text block,
3548 breaking lines at the long line marker or the
3549 line breaking column if line breaking is
3550 enabled for the current document.
3551 =============================== ========================= ==================================================
3554 Settings keybindings
3555 ````````````````````
3556 =============================== ========================= ==================================================
3557 Action Default shortcut Description
3558 =============================== ========================= ==================================================
3559 Preferences Ctrl-Alt-P Opens preferences dialog.
3561 Plugin Preferences Opens plugin preferences dialog.
3562 =============================== ========================= ==================================================
3567 =============================== ========================= ==================================================
3568 Action Default shortcut Description
3569 =============================== ========================= ==================================================
3570 Find Ctrl-F (C) Opens the Find dialog.
3572 Find Next Ctrl-G Finds next result.
3574 Find Previous Ctrl-Shift-G Finds previous result.
3576 Find Next Selection Finds next occurrence of selected text.
3578 Find Previous Selection Finds previous occurrence of selected text.
3580 Replace Ctrl-H (C) Opens the Replace dialog.
3582 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3584 Next message Jumps to the line with the next message in
3585 the Messages window.
3587 Previous message Jumps to the line with the previous message
3588 in the Messages window.
3590 Find Usage Ctrl-Shift-E Finds all occurrences of the current word
3591 or selection (see note below) in all open
3592 documents and displays them in the messages
3595 Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word
3596 or selection (see note below) in the current
3597 document and displays them in the messages
3600 Mark All Ctrl-Shift-M Highlight all matches of the current
3601 word/selection (see note below) in the current
3602 document with a colored box. If there's nothing
3603 to find, or the cursor is next to an existing
3604 match, the highlighted matches will be cleared.
3605 =============================== ========================= ==================================================
3608 The keybindings marked "see note below" work like this: if no text is
3609 selected, the word under cursor is used, and *it has to match fully*
3610 (like when `Match only a whole word` is enabled in the Search dialog).
3611 However if some text is selected, then it is matched regardless of
3617 =============================== ========================= ==================================================
3618 Action Default shortcut Description
3619 =============================== ========================= ==================================================
3620 Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
3621 history. See the section called `Code Navigation
3624 Navigate back a location Alt-Left (C) Switches to the previous location in the
3625 navigation history. See the section called
3626 `Code navigation history`_.
3628 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3629 shows the Go to line dialog.
3631 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3632 is moved to the brace which belongs to the current
3633 one. If this keyboard shortcut is pressed again,
3634 the cursor is moved back to the first brace.
3636 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3637 marker if there already is one.
3639 Goto next marker Ctrl-. Goto the next marker in the current document.
3641 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3643 Go to symbol definition Ctrl-T Jump to the definition of the current word or
3644 selection. See `Go to symbol definition`_.
3646 Go to symbol declaration Ctrl-Shift-T Jump to the declaration of the current word or
3647 selection. See `Go to symbol declaration`_.
3649 Go to Start of Line Home Move the caret to the start of the line.
3650 Behaves differently if smart_home_key_ is set.
3652 Go to End of Line End Move the caret to the end of the line.
3654 Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
3655 This is useful when you use line wrapping and
3656 want to jump to the start of the wrapped, virtual
3657 line, not the real start of the whole line.
3658 If the line is not wrapped, it behaves like
3659 `Go to Start of Line`.
3661 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3662 If the line is not wrapped, it behaves like
3663 `Go to End of Line`.
3665 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3667 Go to Next Word Part Ctrl-\\ Goto the next part of the current word.
3668 =============================== ========================= ==================================================
3672 =============================== ========================= ==================================================
3673 Action Default shortcut Description
3674 =============================== ========================= ==================================================
3675 Fullscreen F11 (C) Switches to fullscreen mode.
3677 Toggle Messages Window Toggles the message window (status and compiler
3678 messages) on and off.
3680 Toggle Sidebar Shows or hides the sidebar.
3682 Toggle all additional widgets Hide and show all additional widgets like the
3683 notebook tabs, the toolbar, the messages window
3686 Zoom In Ctrl-+ (C) Zooms in the text.
3688 Zoom Out Ctrl-- (C) Zooms out the text.
3690 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3691 =============================== ========================= ==================================================
3695 ================================ ========================= ==================================================
3696 Action Default shortcut Description
3697 ================================ ========================= ==================================================
3698 Switch to Editor F2 Switches to editor widget.
3699 Also reshows the document statistics line
3700 (after a short timeout).
3702 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3705 Switch to Message Window Focus the Message Window's current tab.
3707 Switch to Compiler Focus the Compiler message window tab.
3709 Switch to Messages Focus the Messages message window tab.
3711 Switch to Scribble F6 Switches to scribble widget.
3713 Switch to VTE F4 Switches to VTE widget.
3715 Switch to Sidebar Focus the Sidebar.
3717 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3720 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3722 ================================ ========================= ==================================================
3725 Notebook tab keybindings
3726 ````````````````````````
3727 =============================== ========================= ==================================================
3728 Action Default shortcut Description
3729 =============================== ========================= ==================================================
3730 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3732 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3734 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3736 Holding Ctrl (or another modifier if the keybinding
3737 has been changed) will show a dialog, then repeated
3738 presses of the keybinding will switch to the 2nd-last
3739 used document, 3rd-last, etc. Also known as
3740 Most-Recently-Used documents switching.
3742 Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
3745 Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
3748 Move document first Moves the current document to the first position.
3750 Move document last Moves the current document to the last position.
3751 =============================== ========================= ==================================================
3754 Document keybindings
3755 ````````````````````
3756 ==================================== ==================== ==================================================
3757 Action Default shortcut Description
3758 ==================================== ==================== ==================================================
3759 Clone See `Cloning documents`_.
3761 Replace tabs with space Replaces all tabs with the right amount of spaces
3762 in the whole document, or the current selection.
3764 Replace spaces with tabs Replaces leading spaces with tab characters in the
3765 whole document, or the current selection.
3767 Toggle current fold Toggles the folding state of the current code block.
3769 Fold all Folds all contractible code blocks.
3771 Unfold all Unfolds all contracted code blocks.
3773 Reload symbol list Ctrl-Shift-R Reloads the symbol list.
3775 Toggle Line wrapping Enables or disables wrapping of long lines.
3777 Toggle Line breaking Enables or disables automatic breaking of long
3778 lines at a configurable column.
3780 Remove Markers Remove any markers on lines or words which
3781 were set by using 'Mark All' in the
3782 search dialog or by manually marking lines.
3784 Remove Error Indicators Remove any error indicators in the
3787 Remove Markers and Error Indicators Combines ``Remove Markers`` and
3788 ``Remove Error Indicators``.
3789 ==================================== ==================== ==================================================
3794 =============================== ========================= ==================================================
3795 Action Default shortcut Description
3796 =============================== ========================= ==================================================
3797 New Create a new project.
3798 Open Opens a project file.
3799 Properties Shows project properties.
3800 Close Close the current project.
3801 =============================== ========================= ==================================================
3806 =============================== ========================= ==================================================
3807 Action Default shortcut Description
3808 =============================== ========================= ==================================================
3809 Compile F8 Compiles the current file.
3811 Build F9 Builds (compiles if necessary and links) the
3814 Make all Shift-F9 Builds the current file with the Make tool.
3816 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3819 Make object Shift-F8 Compiles the current file with the Make tool.
3821 Next error Jumps to the line with the next error from the
3824 Previous error Jumps to the line with the previous error from
3825 the last build process.
3827 Run F5 Executes the current file in a terminal emulation.
3829 Set Build Commands Opens the build commands dialog.
3830 =============================== ========================= ==================================================
3835 =============================== ========================= ==================================================
3836 Action Default shortcut Description
3837 =============================== ========================= ==================================================
3838 Show Color Chooser Opens the Color Chooser dialog.
3839 =============================== ========================= ==================================================
3844 =============================== ========================= ==================================================
3845 Action Default shortcut Description
3846 =============================== ========================= ==================================================
3847 Help F1 (C) Opens the manual.
3848 =============================== ========================= ==================================================
3856 You must use UTF-8 encoding *without BOM* for configuration files.
3859 Configuration file paths
3860 ------------------------
3861 Geany has default configuration files installed for the system and
3862 also per-user configuration files.
3864 The system files should not normally be edited because they will be
3865 overwritten when upgrading Geany.
3867 The user configuration directory can be overridden with the ``-c``
3868 switch, but this is not normally done. See `Command line options`_.
3871 Any missing subdirectories in the user configuration directory
3872 will be created when Geany starts.
3874 You can check the paths Geany is using with *Help->Debug Messages*.
3875 Near the top there should be 2 lines with something like::
3877 Geany-INFO: System data dir: /usr/share/geany
3878 Geany-INFO: User config dir: /home/username/.config/geany
3881 Paths on Unix-like systems
3882 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3883 The system path is ``$prefix/share/geany``, where ``$prefix`` is the
3884 path where Geany is installed (see `Installation prefix`_).
3886 The user configuration directory is normally:
3887 ``/home/username/.config/geany``
3891 The system path is the ``data`` subfolder of the installation path
3894 The user configuration directory might vary, but on Windows XP it's:
3895 ``C:\Documents and Settings\UserName\Application Data\geany``
3896 On Windows 7 and above you most likely will find it at:
3897 ``C:\users\UserName\Roaming\geany``
3902 There's a *Configuration files* submenu in the *Tools* menu that
3903 contains items for some of the available user configuration files.
3904 Clicking on one opens it in the editor for you to update. Geany will
3905 reload the file after you have saved it.
3908 Other configuration files not shown here will need to be opened
3909 manually, and will not be automatically reloaded when saved.
3910 (see *Reload Configuration* below).
3912 There's also a *Reload Configuration* item which can be used if you
3913 updated one of the other configuration files, or modified or added
3916 *Reload Configuration* is also necessary to update syntax highlighting colors.
3919 Syntax highlighting colors aren't updated in open documents after
3920 saving filetypes.common as this may take a significant
3924 Global configuration file
3925 -------------------------
3927 System administrators can add a global configuration file for Geany
3928 which will be used when starting Geany and a user configuration file
3931 The global configuration file is read from ``geany.conf`` in the
3932 system configuration path - see `Configuration file paths`_. It can
3933 contain any settings which are found in the usual configuration file
3934 created by Geany, but does not have to contain all settings.
3937 This feature is mainly intended for package maintainers or system
3938 admins who want to set up Geany in a multi user environment and
3939 set some sane default values for this environment. Usually users won't
3944 Filetype definition files
3945 -------------------------
3947 All color definitions and other filetype specific settings are
3948 stored in the filetype definition files. Those settings are colors
3949 for syntax highlighting, general settings like comment characters or
3950 word delimiter characters as well as compiler and linker settings.
3952 See also `Configuration file paths`_.
3956 Each filetype has a corresponding filetype definition file. The format
3957 for built-in filetype `Foo` is::
3961 The extension is normally just the filetype name in lower case.
3963 However there are some exceptions:
3965 =============== =========
3967 =============== =========
3971 Matlab/Octave matlab
3972 =============== =========
3974 There is also the `special file filetypes.common`_.
3976 For `custom filetypes`_, the filename for `Foo` is different::
3980 See the link for details.
3984 The system-wide filetype configuration files can be found in the
3985 system configuration path and are called ``filetypes.$ext``,
3986 where $ext is the name of the filetype. For every
3987 filetype there is a corresponding definition file. There is one
3988 exception: ``filetypes.common`` -- this file is for general settings,
3989 which are not specific to a certain filetype.
3992 It is not recommended that users edit the system-wide files,
3993 because they will be overridden when Geany is updated.
3997 To change the settings, copy a file from the system configuration
3998 path to the subdirectory ``filedefs`` in your user configuration
3999 directory. Then you can edit the file and the changes will still be
4000 available after an update of Geany.
4002 Alternatively, you can create the file yourself and add only the
4003 settings you want to change. All missing settings will be read from
4004 the corresponding system configuration file.
4008 At startup Geany looks for ``filetypes.*.conf`` files in the system and
4009 user filetype paths, adding any filetypes found with the name matching
4010 the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
4012 Custom filetypes are not as powerful as built-in filetypes, but
4013 support for the following has been implemented:
4015 * Recognizing and setting the filetype (after the user has manually updated
4016 the `filetype extensions`_ file).
4017 * `Filetype group membership`_.
4018 * Reading filetype settings in the ``[settings]`` section, including:
4019 * Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
4020 * Using an existing tags parser (`tag_parser`_ key).
4021 * Build commands (``[build-menu]`` section).
4022 * Loading global tags files (sharing the ``tag_parser`` filetype's namespace).
4024 See `Filetype configuration`_ for details on each setting.
4026 Creating a custom filetype from an existing filetype
4027 ````````````````````````````````````````````````````
4028 Because most filetype settings will relate to the syntax
4029 highlighting (e.g. styling, keywords, ``lexer_properties``
4030 sections), it is best to copy an existing filetype file that uses
4031 the lexer you wish to use as the basis of a custom filetype, using
4032 the correct filename extension format shown above, e.g.::
4034 cp filetypes.foo filetypes.Bar.conf
4036 Then add the ``lexer_filetype=Foo`` setting (if not already present)
4037 and add/adjust other settings.
4040 The ``[styling]`` and ``[keywords]`` sections have key names
4041 specific to each filetype/lexer. You must follow the same
4042 names - in particular, some lexers only support one keyword
4046 Filetype configuration
4047 ^^^^^^^^^^^^^^^^^^^^^^
4049 As well as the sections listed below, each filetype file can contain
4050 a [build-menu] section as described in `[build-menu] section`_.
4055 In this section the colors for syntax highlighting are defined. The
4058 * ``key=foreground_color;background_color;bold_flag;italic_flag``
4060 Colors have to be specified as RGB hex values prefixed by
4061 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4062 are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
4063 values are case-insensitive but it is a good idea to use lower-case.
4064 Note that you can also use *named colors* as well by substituting the
4065 color value with the name of a color as defined in the ``[named_colors]``
4066 section, see the `[named_colors] Section`_ for more information.
4068 Bold and italic are flags and should only be "true" or "false". If their
4069 value is something other than "true" or "false", "false" is assumed.
4071 You can omit fields to use the values from the style named ``"default"``.
4073 E.g. ``key=0xff0000;;true``
4075 This makes the key style have red foreground text, default background
4076 color text and bold emphasis.
4080 The second format uses a *named style* name to reference a style
4081 defined in filetypes.common.
4083 * ``key=named_style``
4084 * ``key2=named_style2,bold,italic``
4086 The bold and italic parts are optional, and if present are used to
4087 toggle the bold or italic flags to the opposite of the named style's
4088 flags. In contrast to style definition booleans, they are a literal
4089 ",bold,italic" and commas are used instead of semi-colons.
4091 E.g. ``key=comment,italic``
4093 This makes the key style match the ``"comment"`` named style, but with
4096 To define named styles, see the filetypes.common `[named_styles]
4099 Reading styles from another filetype
4100 ************************************
4101 You can automatically copy all of the styles from another filetype
4102 definition file by using the following syntax for the ``[styling]``
4107 Where Foo is a filetype name. The corresponding ``[styling]``
4108 section from ``filetypes.foo`` will be read.
4110 This is useful when the same lexer is being used for multiple
4111 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4112 styling the same as the C styling, you would put the following in
4121 This section contains keys for different keyword lists specific to
4122 the filetype. Some filetypes do not support keywords, so adding a
4123 new key will not work. You can only add or remove keywords to/from
4127 The keywords list must be in one line without line ending characters.
4130 [lexer_properties] section
4131 ``````````````````````````
4132 Here any special properties for the Scintilla lexer can be set in the
4133 format ``key.name.field=some.value``.
4135 Properties Geany uses are listed in the system filetype files. To find
4136 other properties you need Geany's source code::
4138 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
4145 This is the default file extension used when saving files, not
4146 including the period character (``.``). The extension used should
4147 match one of the patterns associated with that filetype (see
4148 `Filetype extensions`_).
4150 *Example:* ``extension=cxx``
4153 These characters define word boundaries when making selections
4154 and searching using word matching options.
4156 *Example:* (look at system filetypes.\* files)
4159 This overrides the *wordchars* filetypes.common setting, and
4160 has precedence over the *whitespace_chars* setting.
4163 A character or string which is used to comment code. If you want to use
4164 multiline comments only, don't set this but rather comment_open and
4167 Single-line comments are used in priority over multiline comments to
4168 comment a line, e.g. with the `Comment/Uncomment line` command.
4170 *Example:* ``comment_single=//``
4173 A character or string which is used to comment code. You need to also
4174 set comment_close to really use multiline comments. If you want to use
4175 single-line comments, prefer setting comment_single.
4177 Multiline comments are used in priority over single-line comments to
4178 comment a block, e.g. template comments.
4180 *Example:* ``comment_open=/*``
4183 If multiline comments are used, this is the character or string to
4186 *Example:* ``comment_close=*/``
4189 Set this to false if a comment character or string should start at
4190 column 0 of a line. If set to true it uses any indentation of the
4193 Note: Comment indentation
4195 ``comment_use_indent=true`` would generate this if a line is
4196 commented (e.g. with Ctrl-D)::
4200 ``comment_use_indent=false`` would generate this if a line is
4201 commented (e.g. with Ctrl-D)::
4203 # command_example();
4206 Note: This setting only works for single line comments (like '//',
4209 *Example:* ``comment_use_indent=true``
4212 A command which can be executed on the current word or the current
4215 Example usage: Open the API documentation for the
4216 current function call at the cursor position.
4219 be set for every filetype or if not set, a global command will
4220 be used. The command itself can be specified without the full
4221 path, then it is searched in $PATH. But for security reasons,
4222 it is recommended to specify the full path to the command. The
4223 wildcard %s will be replaced by the current word at the cursor
4224 position or by the current selection.
4226 Hint: for PHP files the following could be quite useful:
4227 context_action_cmd=firefox "http://www.php.net/%s"
4229 *Example:* ``context_action_cmd=devhelp -s "%s"``
4234 The TagManager language name, e.g. "C". Usually the same as the
4240 A filetype name to setup syntax highlighting from another filetype.
4241 This must not be recursive, i.e. it should be a filetype name that
4242 doesn't use the *lexer_filetype* key itself, e.g.::
4247 The second line is wrong, because ``filetypes.cpp`` itself uses
4248 ``lexer_filetype=C``, which would be recursive.
4250 symbol_list_sort_mode
4251 What the default symbol list sort order should be.
4253 ===== ========================================
4255 ===== ========================================
4256 0 Sort symbols by name
4257 1 Sort symbols by appearance (line number)
4258 ===== ========================================
4260 .. _xml_indent_tags:
4263 If this setting is set to *true*, a new line after a line ending with an
4264 unclosed XML/HTML tag will be automatically indented. This only applies
4265 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4266 this setting in their system configuration files.
4269 The MIME type for this file type, e.g. "text/x-csrc". This is used
4270 for example to chose the icon to display for this file type.
4273 [indentation] section
4274 `````````````````````
4276 This section allows definition of default indentation settings specific to
4277 the file type, overriding the ones configured in the preferences. This can
4278 be useful for file types requiring specific indentation settings (e.g. tabs
4279 only for Makefile). These settings don't override auto-detection if activated.
4282 The forced indentation width.
4285 The forced indentation type.
4287 ===== =======================
4288 Value Indentation type
4289 ===== =======================
4292 2 Mixed (tabs and spaces)
4293 ===== =======================
4296 [build-menu] filetype section
4297 `````````````````````````````
4298 This supports the same keys as the ``geany.conf`` `[build-menu] section`_.
4303 FT_00_CM=gcc -c "%f"
4306 FT_01_CM=gcc -o "%e" "%f"
4311 error_regex=^([^:]+):([0-9]+):
4313 [build_settings] section
4314 ````````````````````````
4315 As of Geany 0.19 this section is for legacy support.
4316 Values that are set in the [build-menu] section will override those in this section.
4318 If any build menu item settings have been configured in the `Set Build Commands dialog`_ (or the *Build* tab of the `Project Properties`_ dialog), then these
4319 settings are stored in the [build-menu] section and will override the settings in
4320 this section for that item.
4323 See the [build-menu] section for details.
4328 This item specifies the command to compile source code files. But
4329 it is also possible to use it with interpreted languages like Perl
4330 or Python. With these filetypes you can use this option as a kind of
4331 syntax parser, which sends output to the compiler message window.
4333 You should quote the filename to also support filenames with
4334 spaces. The following wildcards for filenames are available:
4336 * %f -- complete filename without path
4337 * %e -- filename without path and without extension
4339 *Example:* ``compiler=gcc -Wall -c "%f"``
4342 This item specifies the command to link the file. If the file is not
4343 already compiled, it will be compiled while linking. The -o option
4344 is automatically added by Geany. This item works well with GNU gcc,
4345 but may be problematic with other compilers (esp. with the linker).
4347 *Example:* ``linker=gcc -Wall "%f"``
4350 Use this item to execute your file. It has to have been built
4351 already. Use the %e wildcard to have only the name of the executable
4352 (i.e. without extension) or use the %f wildcard if you need the
4353 complete filename, e.g. for shell scripts.
4355 *Example:* ``run_cmd="./%e"``
4358 Special file filetypes.common
4359 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4361 There is a special filetype definition file called
4362 filetypes.common. This file defines some general non-filetype-specific
4365 You can open the user filetypes.common with the
4366 *Tools->Configuration Files->filetypes.common* menu item. This adds
4367 the default settings to the user file if the file doesn't exist.
4368 Alternatively the file can be created manually, adding only the
4369 settings you want to change. All missing settings will be read from
4373 See the `Filetype configuration`_ section for how to define styles.
4376 [named_styles] section
4377 ``````````````````````
4378 Named styles declared here can be used in the [styling] section of any
4383 *In filetypes.common*::
4386 foo=0xc00000;0xffffff;false;true
4394 This saves copying and pasting the whole style definition into several
4398 You can define aliases for named styles, as shown with the ``bar``
4399 entry in the above example, but they must be declared after the
4403 [named_colors] section
4404 ``````````````````````
4405 Named colors declared here can be used in the ``[styling]`` or
4406 ``[named_styles]`` section of any filetypes.* file or color scheme.
4411 my_red_color=#FF0000
4412 my_blue_color=#0000FF
4415 foo=my_red_color;my_blue_color;false;true
4417 This allows to define a color palette by name so that to change a color
4418 scheme-wide only involves changing the hex value in a single location.
4423 This is the default style. It is used for styling files without a
4426 *Example:* ``default=0x000000;0xffffff;false;false``
4429 The style for coloring selected text. The format is:
4433 * Use foreground color
4434 * Use background color
4436 The colors are only set if the 3rd or 4th argument is true. When
4437 the colors are not overridden, the default is a dark grey
4438 background with syntax highlighted foreground text.
4440 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
4443 The style for brace highlighting when a matching brace was found.
4445 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
4448 The style for brace highlighting when no matching brace was found.
4450 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
4453 The style for coloring the caret(the blinking cursor). Only first
4454 and third argument is interpreted.
4455 Set the third argument to true to change the caret into a block caret.
4457 *Example:* ``caret=0x000000;0x0;false;false``
4460 The width for the caret(the blinking cursor). Only the first
4461 argument is interpreted. The width is specified in pixels with
4462 a maximum of three pixel. Use the width 0 to make the caret
4465 *Example:* ``caret_width=3``
4468 The style for coloring the background of the current line. Only
4469 the second and third arguments are interpreted. The second argument
4470 is the background color. Use the third argument to enable or
4471 disable background highlighting for the current line (has to be
4474 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
4477 The style for coloring the indentation guides. Only the first and
4478 second arguments are interpreted.
4480 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
4483 The style for coloring the white space if it is shown. The first
4484 both arguments define the foreground and background colors, the
4485 third argument sets whether to use the defined foreground color
4486 or to use the color defined by each filetype for the white space.
4487 The fourth argument defines whether to use the background color.
4489 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
4492 Line number margin foreground and background colors.
4494 .. _Folding Settings:
4497 Fold margin foreground and background colors.
4499 fold_symbol_highlight
4500 Highlight color of folding symbols.
4503 The style of folding icons. Only first and second arguments are
4506 Valid values for the first argument are:
4513 Valid values for the second argument are:
4516 * 1 -- for straight lines
4517 * 2 -- for curved lines
4519 *Default:* ``folding_style=1;1;``
4521 *Arrows:* ``folding_style=3;0;``
4524 Draw a thin horizontal line at the line where text is folded. Only
4525 first argument is used.
4527 Valid values for the first argument are:
4529 * 0 -- disable, do not draw a line
4530 * 1 -- draw the line above folded text
4531 * 2 -- draw the line below folded text
4533 *Example:* ``folding_horiz_line=0;0;false;false``
4536 First argument: drawing of visual flags to indicate a line is wrapped.
4537 This is a bitmask of the values:
4539 * 0 -- No visual flags
4540 * 1 -- Visual flag at end of subline of a wrapped line
4541 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
4542 indented by at least 1 to make room for the flag.
4544 Second argument: wether the visual flags to indicate a line is wrapped
4545 are drawn near the border or near the text. This is a bitmask of the values:
4547 * 0 -- Visual flags drawn near border
4548 * 1 -- Visual flag at end of subline drawn near text
4549 * 2 -- Visual flag at begin of subline drawn near text
4551 Only first and second arguments are interpreted.
4553 *Example:* ``line_wrap_visuals=3;0;false;false``
4556 First argument: sets the size of indentation of sublines for wrapped lines
4557 in terms of the width of a space, only used when the second argument is ``0``.
4559 Second argument: wrapped sublines can be indented to the position of their
4560 first subline or one more indent level. Possible values:
4562 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4563 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4564 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4566 Only first and second arguments are interpreted.
4568 *Example:* ``line_wrap_indent=0;1;false;false``
4571 Translucency for the current line (first argument) and the selection
4572 (second argument). Values between 0 and 256 are accepted.
4574 Note for Windows 95, 98 and ME users:
4575 keep this value at 256 to disable translucency otherwise Geany might crash.
4577 Only the first and second arguments are interpreted.
4579 *Example:* ``translucency=256;256;false;false``
4582 The style for a highlighted line (e.g when using Goto line or goto symbol).
4583 The foreground color (first argument) is only used when the Markers margin
4584 is enabled (see View menu).
4586 Only the first and second arguments are interpreted.
4588 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4591 The style for a marked search results (when using "Mark" in Search dialogs).
4592 The second argument sets the background color for the drawn rectangle.
4594 Only the second argument is interpreted.
4596 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4599 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4600 (Ctrl-M)). The foreground color (first argument) is only used
4601 when the Markers margin is enabled (see View menu).
4603 Only the first and second arguments are interpreted.
4605 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4608 Translucency for the line marker (first argument) and the search marker
4609 (second argument). Values between 0 and 256 are accepted.
4611 Note for Windows 95, 98 and ME users:
4612 keep this value at 256 to disable translucency otherwise Geany might crash.
4614 Only the first and second arguments are interpreted.
4616 *Example:* ``marker_translucency=256;256;false;false``
4619 Amount of space to be drawn above and below the line's baseline.
4620 The first argument defines the amount of space to be drawn above the line, the second
4621 argument defines the amount of space to be drawn below.
4623 Only the first and second arguments are interpreted.
4625 *Example:* ``line_height=0;0;false;false``
4628 The style for coloring the calltips. The first two arguments
4629 define the foreground and background colors, the third and fourth
4630 arguments set whether to use the defined colors.
4632 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4635 The color of the error indicator.
4637 Only the first argument (foreground color) is used.
4639 *Example:* ``indicator_error=0xff0000``
4645 Characters to treat as whitespace. These characters are ignored
4646 when moving, selecting and deleting across word boundaries
4647 (see `Scintilla keyboard commands`_).
4649 This should include space (\\s) and tab (\\t).
4651 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4654 These characters define word boundaries when making selections
4655 and searching using word matching options.
4657 *Example:* ``wordchars=_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``
4660 This has precedence over the *whitespace_chars* setting.
4668 To change the default filetype extension used when saving a new file,
4669 see `Filetype definition files`_.
4671 You can override the list of file extensions that Geany uses to detect
4672 filetypes using the user ``filetype_extensions.conf`` file. Use the
4673 *Tools->Configuration Files->filetype_extensions.conf* menu item. See
4674 also `Configuration file paths`_.
4676 You should only list lines for filetype extensions that you want to
4677 override in the user configuration file and remove or comment out
4678 others. The patterns are listed after the ``=`` sign, using a
4679 semi-colon separated list of patterns which should be matched for
4682 For example, to override the filetype extensions for Make, the file
4686 Make=Makefile*;*.mk;Buildfile;
4688 Filetype group membership
4689 ^^^^^^^^^^^^^^^^^^^^^^^^^
4690 Filetype groups are used in the `Document->Set Filetype` menu.
4692 Group membership is also stored in ``filetype_extensions.conf``. This
4693 file is used to store information Geany needs at startup, whereas the
4694 separate filetype definition files hold information only needed when
4695 a document with their filetype is used.
4697 The format looks like::
4706 The key names cannot be configured.
4709 Group membership is only read at startup.
4712 You can make commonly used filetypes appear in the top-level of the
4713 filetype menu by adding them to the `None` group, e.g.
4716 Preferences file format
4717 -----------------------
4719 The user preferences file ``geany.conf`` holds settings for all the items configured
4720 in the preferences dialog. This file should not be edited while Geany is running
4721 as the file will be overwritten when the preferences in Geany are changed or Geany
4725 [build-menu] section
4726 ^^^^^^^^^^^^^^^^^^^^
4728 The [build-menu] section contains the configuration of the build menu.
4729 This section can occur in filetype, preferences and project files and
4730 always has the format described here. Different menu items are loaded
4731 from different files, see the table in the `Build Menu Configuration`_
4732 section for details. All the settings can be configured from the dialogs
4733 except the execute command in filetype files and filetype definitions in
4734 the project file, so these are the only ones which need hand editing.
4738 The build-menu section stores one entry for each setting for each menu item that
4739 is configured. The keys for these settings have the format:
4745 * GG - is the menu item group,
4747 - FT for filetype build
4748 - NF for independent (non-filetype) build
4751 * NN - is a two decimal digit number of the item within the group,
4753 * FF - is the field,
4757 - WD for working directory
4759 See `[build-menu] filetype section`_ for an example.
4761 Error regular expression
4762 ````````````````````````
4764 This is a Perl-compatible regular expression (PCRE) to parse a filename
4765 (absolute or relative) and line number from the build output.
4766 If undefined, Geany will fall back to its default error message parsing.
4768 Only the first two match groups will be read by Geany. These groups can
4769 occur in any order: the match group consisting of only digits will be used
4770 as the line number, and the other group as the filename. In no group
4771 consists of only digits, the match will fail.
4773 *Example:* ``error_regex=^(.+):([0-9]+):[0-9]+``
4775 This will parse a message such as:
4776 ``test.py:7:24: E202 whitespace before ']'``
4782 The project file contains project related settings and possibly a
4783 record of the current session files.
4786 [build-menu] additions
4787 ^^^^^^^^^^^^^^^^^^^^^^
4789 The project file also can have extra fields in the [build-menu] section
4790 in addition to those listed in `[build-menu] section`_ above.
4792 When filetype menu items are configured for the project they are stored
4793 in the project file.
4795 The ``filetypes`` entry is a list of the filetypes which exist in the
4798 For each filetype the entries for that filetype have the format defined in
4799 `[build-menu] section`_ but the key is prefixed by the name of the filetype
4800 as it appears in the ``filetypes`` entry, eg the entry for the label of
4801 filetype menu item 0 for the C filetype would be
4809 Geany supports the following templates:
4813 * Function description
4818 To use these templates, just open the Edit menu or open the popup menu
4819 by right-clicking in the editor widget, and choose "Insert Comments"
4820 and insert templates as you want.
4822 Some templates (like File header or ChangeLog entry) will always be
4823 inserted at the top of the file.
4825 To insert a function description, the cursor must be inside
4826 of the function, so that the function name can be determined
4827 automatically. The description will be positioned correctly one line
4828 above the function, just check it out. If the cursor is not inside
4829 of a function or the function name cannot be determined, the inserted
4830 function description won't contain the correct function name but "unknown"
4834 Geany automatically reloads template information when it notices you
4835 save a file in the user's template configuration directory. You can
4836 also force this by selecting *Tools->Reload Configuration*.
4842 Meta data can be used with all templates, but by default user set
4843 meta data is only used for the ChangeLog and File header templates.
4845 In the configuration dialog you can find a tab "Templates" (see
4846 `Template preferences`_). You can define the default values
4847 which will be inserted in the templates.
4853 File templates are templates used as the basis of a new file. To
4854 use them, choose the *New (with Template)* menu item from the *File*
4857 By default, file templates are installed for some filetypes. Custom
4858 file templates can be added by creating the appropriate template file. You can
4859 also edit the default file templates.
4861 The file's contents are just the text to place in the document, with
4862 optional template wildcards like ``{fileheader}``. The fileheader
4863 wildcard can be placed anywhere, but it's usually put on the first
4864 line of the file, followed by a blank line.
4866 Adding file templates
4867 `````````````````````
4869 File templates are read from ``templates/files`` under the
4870 `Configuration file paths`_.
4872 The filetype to use is detected from the template file's extension, if
4873 any. For example, creating a file ``module.c`` would add a menu item
4874 which created a new document with the filetype set to 'C'.
4876 The template file is read from disk when the corresponding menu item is
4880 Customizing templates
4881 ^^^^^^^^^^^^^^^^^^^^^
4883 Each template can be customized to your needs. The templates are
4884 stored in the ``~/.config/geany/templates/`` directory (see the section called
4885 `Command line options`_ for further information about the configuration
4886 directory). Just open the desired template with an editor (ideally,
4887 Geany ;-) ) and edit the template to your needs. There are some
4888 wildcards which will be automatically replaced by Geany at startup.
4894 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4896 **Wildcards for character escaping**
4898 ============== ============================================= =======================================
4899 Wildcard Description Available in
4900 ============== ============================================= =======================================
4901 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4902 wildcards being expanded).
4903 cb } Closing Brace. file templates, file header, snippets.
4904 pc \% Percent (used to escape e.g. %block% in
4905 snippets). snippets.
4906 ============== ============================================= =======================================
4908 **Global wildcards**
4910 These are configurable, see `Template preferences`_.
4912 ============== ============================================= =======================================
4913 Wildcard Description Available in
4914 ============== ============================================= =======================================
4915 developer The name of the developer. file templates, file header,
4916 function description, ChangeLog entry,
4919 initial The developer's initials, e.g. "ET" for file templates, file header,
4920 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4923 mail The email address of the developer. file templates, file header,
4924 function description, ChangeLog entry,
4927 company The company the developer is working for. file templates, file header,
4928 function description, ChangeLog entry,
4931 version The initial version of a new file. file templates, file header,
4932 function description, ChangeLog entry,
4934 ============== ============================================= =======================================
4936 **Date & time wildcards**
4938 The format for these wildcards can be changed in the preferences
4939 dialog, see `Template preferences`_. You can use any conversion
4940 specifiers which can be used with the ANSI C strftime function.
4941 For details please see http://man.cx/strftime.
4943 ============== ============================================= =======================================
4944 Wildcard Description Available in
4945 ============== ============================================= =======================================
4946 year The current year. Default format is: YYYY. file templates, file header,
4947 function description, ChangeLog entry,
4950 date The current date. Default format: file templates, file header,
4951 YYYY-MM-DD. function description, ChangeLog entry,
4954 datetime The current date and time. Default format: file templates, file header,
4955 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4957 ============== ============================================= =======================================
4959 **Dynamic wildcards**
4961 ============== ============================================= =======================================
4962 Wildcard Description Available in
4963 ============== ============================================= =======================================
4964 untitled The string "untitled" (this will be file templates, file header,
4965 translated to your locale), used in function description, ChangeLog entry,
4966 file templates. bsd, gpl, snippets.
4968 geanyversion The actual Geany version, e.g. file templates, file header,
4969 "Geany |(version)|". function description, ChangeLog entry,
4972 filename The filename of the current file. file header, snippets, file
4973 For new files, it's only replaced when templates.
4974 first saving if found on the first 4 lines
4977 project The current project's name, if any. file header, snippets, file templates.
4979 description The current project's description, if any. file header, snippets, file templates.
4981 functionname The function name of the function at the function description.
4982 cursor position. This wildcard will only be
4983 replaced in the function description
4986 command:path Executes the specified command and replace file templates, file header,
4987 the wildcard with the command's standard function description, ChangeLog entry,
4988 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
4990 ============== ============================================= =======================================
4992 **Template insertion wildcards**
4994 ============== ============================================= =======================================
4995 Wildcard Description Available in
4996 ============== ============================================= =======================================
4997 gpl This wildcard inserts a short GPL notice. file header.
4999 bsd This wildcard inserts a BSD licence notice. file header.
5001 fileheader The file header template. This wildcard snippets, file templates.
5002 will only be replaced in file templates.
5003 ============== ============================================= =======================================
5006 Special {command:} wildcard
5007 ***************************
5009 The {command:} wildcard is a special one because it can execute
5010 a specified command and put the command's output (stdout) into
5019 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
5021 Using this wildcard you can insert nearly any arbitrary text into the
5024 In the environment of the executed command the variables
5025 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
5026 The value of these variables is filled in only if Geany knows about it.
5027 For example, ``GEANY_FUNCNAME`` is only filled within the function
5028 description template. However, these variables are ``always`` set,
5029 just maybe with an empty value.
5030 You can easily access them e.g. within an executed shell script using::
5036 If the specified command could not be found or not executed, the wildcard is substituted
5037 by an empty string. In such cases, you can find the occurred error message on Geany's
5038 standard error and in the Help->Debug Messages dialog.
5041 Customizing the toolbar
5042 -----------------------
5044 You can add, remove and reorder the elements in the toolbar by using
5045 the toolbar editor, or by manually editing the configuration file
5048 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5049 by right-clicking on the toolbar itself and choosing it from the menu.
5051 Manually editing the toolbar layout
5052 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5054 To override the system-wide configuration file, copy it to your user
5055 configuration directory (see `Configuration file paths`_).
5059 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5061 Then edit it and add any of the available elements listed in the file or remove
5062 any of the existing elements. Of course, you can also reorder the elements as
5063 you wish and add or remove additional separators.
5064 This file must be valid XML, otherwise the global toolbar UI definition
5065 will be used instead.
5067 Your changes are applied once you save the file.
5070 (1) You cannot add new actions which are not listed below.
5071 (2) Everything you add or change must be inside the /ui/toolbar/ path.
5074 Available toolbar elements
5075 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5077 ================== ==============================================================================
5078 Element name Description
5079 ================== ==============================================================================
5080 New Create a new file
5081 Open Open an existing file
5082 Save Save the current file
5083 SaveAll Save all open files
5084 Reload Reload the current file from disk
5085 Close Close the current file
5086 CloseAll Close all open files
5087 Print Print the current file
5088 Cut Cut the current selection
5089 Copy Copy the current selection
5090 Paste Paste the contents of the clipboard
5091 Delete Delete the current selection
5092 Undo Undo the last modification
5093 Redo Redo the last modification
5094 NavBack Navigate back a location
5095 NavFor Navigate forward a location
5096 Compile Compile the current file
5097 Build Build the current file, includes a submenu for Make commands. Geany
5098 remembers the last chosen action from the submenu and uses this as default
5099 action when the button itself is clicked.
5100 Run Run or view the current file
5101 Color Open a color chooser dialog, to interactively pick colors from a palette
5102 ZoomIn Zoom in the text
5103 ZoomOut Zoom out the text
5104 UnIndent Decrease indentation
5105 Indent Increase indentation
5106 Replace Replace text in the current document
5107 SearchEntry The search field belonging to the 'Search' element (can be used alone)
5108 Search Find the entered text in the current file (only useful if you also
5110 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
5111 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
5112 Preferences Show the preferences dialog
5114 ================== ==============================================================================
5118 Plugin documentation
5119 ====================
5124 The HTML Characters plugin helps when working with special
5125 characters in XML/HTML, e.g. German Umlauts ü and ä.
5128 Insert entity dialog
5129 ^^^^^^^^^^^^^^^^^^^^
5131 When the plugin is enabled, you can insert special character
5132 entities using *Tools->Insert Special HTML Characters*.
5134 This opens up a dialog where you can find a huge amount of special
5135 characters sorted by category that you might like to use inside your
5136 document. You can expand and collapse the categories by clicking on
5137 the little arrow on the left hand side. Once you have found the
5138 desired character click on it and choose "Insert". This will insert
5139 the entity for the character at the current cursor position. You
5140 might also like to double click the chosen entity instead.
5143 Replace special chars by its entity
5144 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5146 To help make a XML/HTML document valid the plugin supports
5147 replacement of special chars known by the plugin. Both bulk
5148 replacement and immediate replacement during typing are supported.
5150 A few characters will not be replaced. These are
5161 You can activate/deactivate this feature using the *Tools->HTML
5162 Replacement->Auto-replace Special Characters* menu item. If it's
5163 activated, all special characters (beside the given exceptions from
5164 above) known by the plugin will be replaced by their entities.
5166 You could also set a keybinding for the plugin to toggle the status
5173 After inserting a huge amount of text, e.g. by using copy & paste, the
5174 plugin allows bulk replacement of all known characters (beside the
5175 mentioned exceptions). You can find the function under the same
5176 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
5177 configure a keybinding for the plugin.
5186 This plugin provides an option to automatically save documents.
5187 You can choose to save the current document, or all of your documents, at
5194 You can save the current document when the editor's focus goes out.
5195 Every pop-up, menu dialogs, or anything else that can make the editor lose the focus,
5196 will make the current document to be saved.
5201 This plugin sets on every new file (*File->New* or *File->New (with template)*)
5202 a randomly chosen filename and set its filetype appropriate to the used template
5203 or when no template was used, to a configurable default filetype.
5204 This enables you to quickly compile, build and/or run the new file without the
5205 need to give it an explicit filename using the Save As dialog. This might be
5206 useful when you often create new files just for testing some code or something
5213 This plugin creates a backup copy of the current file in Geany when it is
5214 saved. You can specify the directory where the backup copy is saved and
5215 you can configure the automatically added extension in the configure dialog
5216 in Geany's plugin manager.
5218 After the plugin was loaded in Geany's plugin manager, every file is
5219 copied into the configured backup directory *after* the file has been saved
5222 The created backup copy file permissions are set to read-write only for
5223 the user. This should help to not create world-readable files on possibly
5224 unsecure destination directories like /tmp (especially useful
5225 on multi-user systems).
5226 This applies only to non-Windows systems. On Windows, no explicit file
5227 permissions are set.
5230 Additionally, you can define how many levels of the original file's
5231 directory structure should be replicated in the backup copy path.
5232 For example, setting the option
5233 *Directory levels to include in the backup destination* to *2*
5234 cause the plugin to create the last two components of the original
5235 file's path in the backup copy path and place the new file there.
5238 Contributing to this document
5239 =============================
5241 This document (``geany.txt``) is written in `reStructuredText`__
5242 (or "reST"). The source file for it is located in Geany's ``doc``
5243 subdirectory. If you intend on making changes, you should grab the
5244 source right from Git to make sure you've got the newest version.
5245 First, you need to configure the build system to generate the HTML
5246 documentation passing the *--enable-html-docs* option to the *configure*
5247 script. Then after editing the file, run ``make`` (from the root build
5248 directory or from the *doc* subdirectory) to build the HTML documentation
5249 and see how your changes look. This regenerates the ``geany.html`` file
5250 inside the *doc* subdirectory. To generate a PDF file, configure with
5251 *--enable-pdf-docs* and run ``make`` as for the HTML version. The generated
5252 PDF file is named geany-|(version)|.pdf and is located inside the *doc*
5255 __ http://docutils.sourceforge.net/rst.html
5257 After you are happy with your changes, create a patch e.g. by using::
5259 % git diff geany.txt > foo.patch
5261 or even better, by creating a Git-formatted patch which will keep authoring
5262 and description data, by first committing your changes (doing so in a fresh
5263 new branch is recommended for `master` not to diverge from upstream) and then
5264 using git format-patch::
5266 % git checkout -b my-documentation-changes # create a fresh branch
5267 % git commit geany.txt
5268 Write a good commit message...
5269 % git format-patch HEAD^
5270 % git checkout master # go back to master
5272 and then submit that file to the mailing list for review.
5274 Also you can clone the Geany repository at GitHub and send a pull request.
5276 Note, you will need the Python docutils software package installed
5277 to build the docs. The package is named ``python-docutils`` on Debian
5283 Scintilla keyboard commands
5284 ===========================
5286 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
5288 This appendix is distributed under the terms of the License for
5289 Scintilla and SciTE. A copy of this license can be found in the file
5290 ``scintilla/License.txt`` included with the source code of this
5291 program and in the appendix of this document. See `License for
5292 Scintilla and SciTE`_.
5301 Keyboard commands for Scintilla mostly follow common Windows and GTK+
5302 conventions. All move keys (arrows, page up/down, home and end)
5303 allows to extend or reduce the stream selection when holding the
5304 Shift key, and the rectangular selection when holding the
5305 appropriate keys (see `Column mode editing (rectangular selections)`_).
5307 Some keys may not be available with some national keyboards
5308 or because they are taken by the system such as by a window manager
5309 or GTK. Keyboard equivalents of menu commands are listed in the
5310 menus. Some less common commands with no menu equivalent are:
5312 ============================================= ======================
5314 ============================================= ======================
5315 Magnify text size. Ctrl-Keypad+
5316 Reduce text size. Ctrl-Keypad-
5317 Restore text size to normal. Ctrl-Keypad/
5319 Dedent block. Shift-Tab
5320 Delete to start of word. Ctrl-BackSpace
5321 Delete to end of word. Ctrl-Delete
5322 Delete to start of line. Ctrl-Shift-BackSpace
5323 Go to start of document. Ctrl-Home
5324 Extend selection to start of document. Ctrl-Shift-Home
5325 Go to start of display line. Alt-Home
5326 Extend selection to start of display line. Alt-Shift-Home
5327 Go to end of document. Ctrl-End
5328 Extend selection to end of document. Ctrl-Shift-End
5329 Extend selection to end of display line. Alt-Shift-End
5330 Previous paragraph. Shift extends selection. Ctrl-Up
5331 Next paragraph. Shift extends selection. Ctrl-Down
5332 Previous word. Shift extends selection. Ctrl-Left
5333 Next word. Shift extends selection. Ctrl-Right
5334 ============================================= ======================
5345 * Double-click on empty space in the notebook tab bar to open a
5347 * Middle-click on a document's notebook tab to close the document.
5348 * Hold `Ctrl` and click on any notebook tab to switch to the last used
5350 * Double-click on a document's notebook tab to toggle all additional
5351 widgets (to show them again use the View menu or the keyboard
5352 shortcut). The interface pref must be enabled for this to work.
5357 * Alt-scroll wheel moves up/down a page.
5358 * Ctrl-scroll wheel zooms in/out.
5359 * Shift-scroll wheel scrolls 8 characters right/left.
5360 * Ctrl-click on a word in a document to perform *Go to Symbol Definition*.
5361 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
5366 * Double-click on a symbol-list group to expand or compact it.
5371 * Scrolling the mouse wheel over a notebook tab bar will switch
5374 The following are derived from X-Windows features (but GTK still supports
5377 * Middle-click pastes the last selected text.
5378 * Middle-click on a scrollbar moves the scrollbar to that
5379 position without having to drag it.
5383 Compile-time options
5384 ====================
5386 There are some options which can only be changed at compile time,
5387 and some options which are used as the default for configurable
5388 options. To change these options, edit the appropriate source file
5389 in the ``src`` subdirectory. Look for a block of lines starting with
5390 ``#define GEANY_*``. Any definitions which are not listed here should
5394 Most users should not need to change these options.
5399 ============================== ============================================ ==================
5400 Option Description Default
5401 ============================== ============================================ ==================
5402 GEANY_STRING_UNTITLED A string used as the default name for new untitled
5403 files. Be aware that the string can be
5404 translated, so change it only if you know
5406 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
5407 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
5408 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
5410 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
5412 **Windows specific**
5413 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
5414 Windows file open and save dialogs instead
5415 GTK's file open and save dialogs. The
5416 default Windows file dialogs are missing
5417 some nice features like choosing a filetype
5418 or an encoding. *Do not touch this setting
5419 when building on a non-Win32 system.*
5420 ============================== ============================================ ==================
5425 ============================== ============================================ ==================
5426 Option Description Default
5427 ============================== ============================================ ==================
5428 GEANY_PROJECT_EXT The default filename extension for Geany geany
5429 project files. It is used when creating new
5430 projects and as filter mask for the project
5432 ============================== ============================================ ==================
5437 ============================== ============================================ ==================
5438 Option Description Default
5439 ============================== ============================================ ==================
5440 GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
5441 filetype with the extract filetype regex.
5442 ============================== ============================================ ==================
5447 ============================== ============================================ ==================
5448 Option Description Default
5449 ============================== ============================================ ==================
5450 GEANY_WORDCHARS These characters define word boundaries when a string with:
5451 making selections and searching using word a-z, A-Z, 0-9 and
5452 matching options. underscore.
5453 ============================== ============================================ ==================
5458 These are default settings that can be overridden in the `Preferences`_ dialog.
5460 ============================== ============================================ ==================
5461 Option Description Default
5462 ============================== ============================================ ==================
5463 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
5464 trigger the autocompletion list.
5465 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
5467 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
5468 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator command, see See below.
5469 `Terminal emulators`_.
5470 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
5471 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
5472 and process plain text files. This can also
5474 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
5475 GNU grep. This can also include a path.
5476 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
5477 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
5479 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
5480 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
5481 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
5483 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
5485 GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
5487 ============================== ============================================ ==================
5491 The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
5493 The GEANY_DEFAULT_TOOLS_TERMINAL default value on Windows is::
5497 and on any non-Windows system is::
5499 xterm -e "/bin/sh %c"
5505 ============================== ============================================ ==================
5506 Option Description Default
5507 ============================== ============================================ ==================
5508 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
5509 be shown in the editor window.
5510 This affects the special coloring
5511 when Geany detects a compiler output line as
5512 an error message and then highlights the
5513 corresponding line in the source code.
5514 Usually only the first few messages are
5515 interesting because following errors are
5517 All errors in the Compiler window are parsed
5518 and unaffected by this value.
5519 PRINTBUILDCMDS Every time a build menu item priority FALSE
5520 calculation is run, print the state of the
5521 menu item table in the form of the table
5522 in `Build Menu Configuration`_. May be
5523 useful to debug configuration file
5524 overloading. Warning produces a lot of
5525 output. Can also be enabled/disabled by the
5526 debugger by setting printbuildcmds to 1/0
5527 overriding the compile setting.
5528 ============================== ============================================ ==================
5532 GNU General Public License
5533 ==========================
5537 GNU GENERAL PUBLIC LICENSE
5538 Version 2, June 1991
5540 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5541 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5542 Everyone is permitted to copy and distribute verbatim copies
5543 of this license document, but changing it is not allowed.
5547 The licenses for most software are designed to take away your
5548 freedom to share and change it. By contrast, the GNU General Public
5549 License is intended to guarantee your freedom to share and change free
5550 software--to make sure the software is free for all its users. This
5551 General Public License applies to most of the Free Software
5552 Foundation's software and to any other program whose authors commit to
5553 using it. (Some other Free Software Foundation software is covered by
5554 the GNU Library General Public License instead.) You can apply it to
5557 When we speak of free software, we are referring to freedom, not
5558 price. Our General Public Licenses are designed to make sure that you
5559 have the freedom to distribute copies of free software (and charge for
5560 this service if you wish), that you receive source code or can get it
5561 if you want it, that you can change the software or use pieces of it
5562 in new free programs; and that you know you can do these things.
5564 To protect your rights, we need to make restrictions that forbid
5565 anyone to deny you these rights or to ask you to surrender the rights.
5566 These restrictions translate to certain responsibilities for you if you
5567 distribute copies of the software, or if you modify it.
5569 For example, if you distribute copies of such a program, whether
5570 gratis or for a fee, you must give the recipients all the rights that
5571 you have. You must make sure that they, too, receive or can get the
5572 source code. And you must show them these terms so they know their
5575 We protect your rights with two steps: (1) copyright the software, and
5576 (2) offer you this license which gives you legal permission to copy,
5577 distribute and/or modify the software.
5579 Also, for each author's protection and ours, we want to make certain
5580 that everyone understands that there is no warranty for this free
5581 software. If the software is modified by someone else and passed on, we
5582 want its recipients to know that what they have is not the original, so
5583 that any problems introduced by others will not reflect on the original
5584 authors' reputations.
5586 Finally, any free program is threatened constantly by software
5587 patents. We wish to avoid the danger that redistributors of a free
5588 program will individually obtain patent licenses, in effect making the
5589 program proprietary. To prevent this, we have made it clear that any
5590 patent must be licensed for everyone's free use or not licensed at all.
5592 The precise terms and conditions for copying, distribution and
5593 modification follow.
5595 GNU GENERAL PUBLIC LICENSE
5596 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5598 0. This License applies to any program or other work which contains
5599 a notice placed by the copyright holder saying it may be distributed
5600 under the terms of this General Public License. The "Program", below,
5601 refers to any such program or work, and a "work based on the Program"
5602 means either the Program or any derivative work under copyright law:
5603 that is to say, a work containing the Program or a portion of it,
5604 either verbatim or with modifications and/or translated into another
5605 language. (Hereinafter, translation is included without limitation in
5606 the term "modification".) Each licensee is addressed as "you".
5608 Activities other than copying, distribution and modification are not
5609 covered by this License; they are outside its scope. The act of
5610 running the Program is not restricted, and the output from the Program
5611 is covered only if its contents constitute a work based on the
5612 Program (independent of having been made by running the Program).
5613 Whether that is true depends on what the Program does.
5615 1. You may copy and distribute verbatim copies of the Program's
5616 source code as you receive it, in any medium, provided that you
5617 conspicuously and appropriately publish on each copy an appropriate
5618 copyright notice and disclaimer of warranty; keep intact all the
5619 notices that refer to this License and to the absence of any warranty;
5620 and give any other recipients of the Program a copy of this License
5621 along with the Program.
5623 You may charge a fee for the physical act of transferring a copy, and
5624 you may at your option offer warranty protection in exchange for a fee.
5626 2. You may modify your copy or copies of the Program or any portion
5627 of it, thus forming a work based on the Program, and copy and
5628 distribute such modifications or work under the terms of Section 1
5629 above, provided that you also meet all of these conditions:
5631 a) You must cause the modified files to carry prominent notices
5632 stating that you changed the files and the date of any change.
5634 b) You must cause any work that you distribute or publish, that in
5635 whole or in part contains or is derived from the Program or any
5636 part thereof, to be licensed as a whole at no charge to all third
5637 parties under the terms of this License.
5639 c) If the modified program normally reads commands interactively
5640 when run, you must cause it, when started running for such
5641 interactive use in the most ordinary way, to print or display an
5642 announcement including an appropriate copyright notice and a
5643 notice that there is no warranty (or else, saying that you provide
5644 a warranty) and that users may redistribute the program under
5645 these conditions, and telling the user how to view a copy of this
5646 License. (Exception: if the Program itself is interactive but
5647 does not normally print such an announcement, your work based on
5648 the Program is not required to print an announcement.)
5650 These requirements apply to the modified work as a whole. If
5651 identifiable sections of that work are not derived from the Program,
5652 and can be reasonably considered independent and separate works in
5653 themselves, then this License, and its terms, do not apply to those
5654 sections when you distribute them as separate works. But when you
5655 distribute the same sections as part of a whole which is a work based
5656 on the Program, the distribution of the whole must be on the terms of
5657 this License, whose permissions for other licensees extend to the
5658 entire whole, and thus to each and every part regardless of who wrote it.
5660 Thus, it is not the intent of this section to claim rights or contest
5661 your rights to work written entirely by you; rather, the intent is to
5662 exercise the right to control the distribution of derivative or
5663 collective works based on the Program.
5665 In addition, mere aggregation of another work not based on the Program
5666 with the Program (or with a work based on the Program) on a volume of
5667 a storage or distribution medium does not bring the other work under
5668 the scope of this License.
5670 3. You may copy and distribute the Program (or a work based on it,
5671 under Section 2) in object code or executable form under the terms of
5672 Sections 1 and 2 above provided that you also do one of the following:
5674 a) Accompany it with the complete corresponding machine-readable
5675 source code, which must be distributed under the terms of Sections
5676 1 and 2 above on a medium customarily used for software interchange; or,
5678 b) Accompany it with a written offer, valid for at least three
5679 years, to give any third party, for a charge no more than your
5680 cost of physically performing source distribution, a complete
5681 machine-readable copy of the corresponding source code, to be
5682 distributed under the terms of Sections 1 and 2 above on a medium
5683 customarily used for software interchange; or,
5685 c) Accompany it with the information you received as to the offer
5686 to distribute corresponding source code. (This alternative is
5687 allowed only for noncommercial distribution and only if you
5688 received the program in object code or executable form with such
5689 an offer, in accord with Subsection b above.)
5691 The source code for a work means the preferred form of the work for
5692 making modifications to it. For an executable work, complete source
5693 code means all the source code for all modules it contains, plus any
5694 associated interface definition files, plus the scripts used to
5695 control compilation and installation of the executable. However, as a
5696 special exception, the source code distributed need not include
5697 anything that is normally distributed (in either source or binary
5698 form) with the major components (compiler, kernel, and so on) of the
5699 operating system on which the executable runs, unless that component
5700 itself accompanies the executable.
5702 If distribution of executable or object code is made by offering
5703 access to copy from a designated place, then offering equivalent
5704 access to copy the source code from the same place counts as
5705 distribution of the source code, even though third parties are not
5706 compelled to copy the source along with the object code.
5708 4. You may not copy, modify, sublicense, or distribute the Program
5709 except as expressly provided under this License. Any attempt
5710 otherwise to copy, modify, sublicense or distribute the Program is
5711 void, and will automatically terminate your rights under this License.
5712 However, parties who have received copies, or rights, from you under
5713 this License will not have their licenses terminated so long as such
5714 parties remain in full compliance.
5716 5. You are not required to accept this License, since you have not
5717 signed it. However, nothing else grants you permission to modify or
5718 distribute the Program or its derivative works. These actions are
5719 prohibited by law if you do not accept this License. Therefore, by
5720 modifying or distributing the Program (or any work based on the
5721 Program), you indicate your acceptance of this License to do so, and
5722 all its terms and conditions for copying, distributing or modifying
5723 the Program or works based on it.
5725 6. Each time you redistribute the Program (or any work based on the
5726 Program), the recipient automatically receives a license from the
5727 original licensor to copy, distribute or modify the Program subject to
5728 these terms and conditions. You may not impose any further
5729 restrictions on the recipients' exercise of the rights granted herein.
5730 You are not responsible for enforcing compliance by third parties to
5733 7. If, as a consequence of a court judgment or allegation of patent
5734 infringement or for any other reason (not limited to patent issues),
5735 conditions are imposed on you (whether by court order, agreement or
5736 otherwise) that contradict the conditions of this License, they do not
5737 excuse you from the conditions of this License. If you cannot
5738 distribute so as to satisfy simultaneously your obligations under this
5739 License and any other pertinent obligations, then as a consequence you
5740 may not distribute the Program at all. For example, if a patent
5741 license would not permit royalty-free redistribution of the Program by
5742 all those who receive copies directly or indirectly through you, then
5743 the only way you could satisfy both it and this License would be to
5744 refrain entirely from distribution of the Program.
5746 If any portion of this section is held invalid or unenforceable under
5747 any particular circumstance, the balance of the section is intended to
5748 apply and the section as a whole is intended to apply in other
5751 It is not the purpose of this section to induce you to infringe any
5752 patents or other property right claims or to contest validity of any
5753 such claims; this section has the sole purpose of protecting the
5754 integrity of the free software distribution system, which is
5755 implemented by public license practices. Many people have made
5756 generous contributions to the wide range of software distributed
5757 through that system in reliance on consistent application of that
5758 system; it is up to the author/donor to decide if he or she is willing
5759 to distribute software through any other system and a licensee cannot
5762 This section is intended to make thoroughly clear what is believed to
5763 be a consequence of the rest of this License.
5765 8. If the distribution and/or use of the Program is restricted in
5766 certain countries either by patents or by copyrighted interfaces, the
5767 original copyright holder who places the Program under this License
5768 may add an explicit geographical distribution limitation excluding
5769 those countries, so that distribution is permitted only in or among
5770 countries not thus excluded. In such case, this License incorporates
5771 the limitation as if written in the body of this License.
5773 9. The Free Software Foundation may publish revised and/or new versions
5774 of the General Public License from time to time. Such new versions will
5775 be similar in spirit to the present version, but may differ in detail to
5776 address new problems or concerns.
5778 Each version is given a distinguishing version number. If the Program
5779 specifies a version number of this License which applies to it and "any
5780 later version", you have the option of following the terms and conditions
5781 either of that version or of any later version published by the Free
5782 Software Foundation. If the Program does not specify a version number of
5783 this License, you may choose any version ever published by the Free Software
5786 10. If you wish to incorporate parts of the Program into other free
5787 programs whose distribution conditions are different, write to the author
5788 to ask for permission. For software which is copyrighted by the Free
5789 Software Foundation, write to the Free Software Foundation; we sometimes
5790 make exceptions for this. Our decision will be guided by the two goals
5791 of preserving the free status of all derivatives of our free software and
5792 of promoting the sharing and reuse of software generally.
5796 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5797 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5798 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5799 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5800 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5801 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5802 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5803 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5804 REPAIR OR CORRECTION.
5806 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5807 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5808 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5809 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5810 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5811 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5812 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5813 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5814 POSSIBILITY OF SUCH DAMAGES.
5816 END OF TERMS AND CONDITIONS
5818 How to Apply These Terms to Your New Programs
5820 If you develop a new program, and you want it to be of the greatest
5821 possible use to the public, the best way to achieve this is to make it
5822 free software which everyone can redistribute and change under these terms.
5824 To do so, attach the following notices to the program. It is safest
5825 to attach them to the start of each source file to most effectively
5826 convey the exclusion of warranty; and each file should have at least
5827 the "copyright" line and a pointer to where the full notice is found.
5829 <one line to give the program's name and a brief idea of what it does.>
5830 Copyright (C) <year> <name of author>
5832 This program is free software; you can redistribute it and/or modify
5833 it under the terms of the GNU General Public License as published by
5834 the Free Software Foundation; either version 2 of the License, or
5835 (at your option) any later version.
5837 This program is distributed in the hope that it will be useful,
5838 but WITHOUT ANY WARRANTY; without even the implied warranty of
5839 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5840 GNU General Public License for more details.
5842 You should have received a copy of the GNU General Public License along
5843 with this program; if not, write to the Free Software Foundation, Inc.,
5844 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5847 Also add information on how to contact you by electronic and paper mail.
5849 If the program is interactive, make it output a short notice like this
5850 when it starts in an interactive mode:
5852 Gnomovision version 69, Copyright (C) year name of author
5853 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5854 This is free software, and you are welcome to redistribute it
5855 under certain conditions; type `show c' for details.
5857 The hypothetical commands `show w' and `show c' should show the appropriate
5858 parts of the General Public License. Of course, the commands you use may
5859 be called something other than `show w' and `show c'; they could even be
5860 mouse-clicks or menu items--whatever suits your program.
5862 You should also get your employer (if you work as a programmer) or your
5863 school, if any, to sign a "copyright disclaimer" for the program, if
5864 necessary. Here is a sample; alter the names:
5866 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5867 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5869 <signature of Ty Coon>, 1 April 1989
5870 Ty Coon, President of Vice
5872 This General Public License does not permit incorporating your program into
5873 proprietary programs. If your program is a subroutine library, you may
5874 consider it more useful to permit linking proprietary applications with the
5875 library. If this is what you want to do, use the GNU Library General
5876 Public License instead of this License.
5881 License for Scintilla and SciTE
5882 ===============================
5884 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5888 Permission to use, copy, modify, and distribute this software and
5889 its documentation for any purpose and without fee is hereby granted,
5890 provided that the above copyright notice appear in all copies and
5891 that both that copyright notice and this permission notice appear in
5892 supporting documentation.
5894 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5895 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5896 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5897 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5898 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5899 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5900 USE OR PERFORMANCE OF THIS SOFTWARE.