1 .. |(version)| replace:: 1.39
2 .. -*- reStructuredText -*-
8 -------------------------
9 A fast, light, GTK+ IDE
10 -------------------------
12 :Authors: Enrico Tröger,
20 Copyright © 2005 The Geany contributors
22 This document is distributed under the terms of the GNU General Public
23 License as published by the Free Software Foundation; either version 2
24 of the License, or (at your option) any later version. A copy of this
25 license can be found in the file COPYING included with the source code
26 of this program, and also in the chapter `GNU General Public License`_.
40 Geany is a small and lightweight Integrated Development Environment. It
41 was developed to provide a small and fast IDE, which has only a few
42 dependencies on other packages. Another goal was to be as independent
43 as possible from a particular Desktop Environment like KDE or GNOME -
44 Geany only requires the GTK+ runtime libraries.
46 Some basic features of Geany:
50 * Autocompletion of symbols/words
51 * Construct completion/snippets
52 * Auto-closing of XML and HTML tags
54 * Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
58 * Build system to compile and execute your code
59 * Simple project management
67 You can obtain Geany from https://www.geany.org/ or perhaps also from
68 your distribution. For a list of available packages, please see
69 https://www.geany.org/Download/ThirdPartyPackages.
76 Geany is distributed under the terms of the GNU General Public License
77 as published by the Free Software Foundation; either version 2 of
78 the License, or (at your option) any later version. A copy of this
79 license can be found in the file COPYING included with the source
80 code of this program and in the chapter, `GNU General Public License`_.
82 The included Scintilla library (found in the subdirectory
83 ``scintilla/``) has its own license, which can be found in the chapter,
84 `License for Scintilla and SciTE`_.
91 This documentation is available in HTML and text formats.
92 The latest version can always be found at https://www.geany.org/.
94 If you want to contribute to it, see `Contributing to this document`_.
106 You will need the GTK (>= 2.24) libraries and their dependencies
107 (Pango, GLib and ATK). Your distro should provide packages for these,
108 usually installed by default. For Windows, you can download an installer
109 from the website which bundles these libraries.
115 There are many binary packages available. For an up-to-date but maybe
116 incomplete list see https://www.geany.org/Download/ThirdPartyPackages.
122 Compiling Geany is quite easy.
123 To do so, you need the GTK (>= 2.24) libraries and header files.
124 You also need the Pango, GLib and ATK libraries and header files.
125 All these files are available at http://www.gtk.org, but very often
126 your distro will provide development packages to save the trouble of
127 building these yourself.
129 Furthermore you need, of course, a C and C++ compiler. The GNU versions
130 of these tools are recommended.
132 Autotools based build system
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135 To compile Geany yourself, you just need the Make tool, preferably GNU Make.
137 Then run the following commands::
152 The configure script supports several common options, for a detailed
158 You may also want to read the INSTALL file for advanced installation
161 * See also `Compile-time options`_.
163 Dynamic linking loader support and VTE
164 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
165 In the case that your system lacks dynamic linking loader support, you
166 probably want to pass the option ``--disable-vte`` to the ``configure``
167 script. This prevents compiling Geany with dynamic linking loader
168 support for automatically loading ``libvte.so.4`` if available.
172 If there are any errors during compilation, check your build
173 environment and try to find the error, otherwise contact the mailing
174 list or one the authors. Sometimes you might need to ask for specific
175 help from your distribution.
180 If you want to find Geany's system files after installation you may
181 want to know the installation prefix.
183 Pass the ``--print-prefix`` option to Geany to check this - see
184 `Command line options`_. The first path is the prefix.
186 On Unix-like systems this is commonly ``/usr`` if you installed from
187 a binary package, or ``/usr/local`` if you build from source.
190 Editing system files is not necessary as you should use the
191 per-user configuration files instead, which don't need root
192 permissions. See `Configuration files`_.
202 You can start Geany in the following ways:
204 * From the Desktop Environment menu:
206 Choose in your application menu of your used Desktop Environment:
207 Development --> Geany.
209 At Windows-systems you will find Geany after installation inside
210 the application menu within its special folder.
212 * From the command line:
214 To start Geany from a command line, type the following and press
222 The Geany window is shown in the following figure:
224 .. image:: ./images/main_window.png
226 The workspace has the following parts:
229 * An optional toolbar.
230 * An optional sidebar that can show the following tabs:
232 * Documents - A `document list <#document-list-views>`_.
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 <#virtual-terminal-emulator-widget-vte>`_.
246 Most of these can be configured in the `Interface preferences`_, the
247 `View menu`_, or the popup menu for the relevant area.
249 Additional tabs may be added to the sidebar and message window by plugins.
251 The position of the tabs can be selected in the interface preferences.
253 The sizes of the sidebar and message window can be adjusted by
254 dragging the dividers.
259 The sidebar has a right click menu that can control what is visible and
260 has actions specific to the tab (other tabs added by plugins are
261 described by that plugin documentation):
265 * expand/collapse the tree
266 * control sorting order
267 * control whether to group symbols by their type
268 * locate the symbol in documents
270 The symbols tab can also be filtered by typing a string into
271 the entry at the top of the tab. All symbols that contain the entered
272 string as a substring will be shown in the tree. Multiple filters can
273 be separated by a space.
277 * expand/collapse the tree
278 * save to or reload from files
279 * search tree based at selected file
280 * show or hide the document paths
285 ============ ======================= =================================================
286 Short option Long option Function
287 ============ ======================= =================================================
288 *none* +number Set initial line number for the first opened file
289 (same as --line, do not put a space between the + sign
290 and the number). E.g. "geany +7 foo.bar" will open the
291 file foo.bar and place the cursor in line 7.
293 *none* --column Set initial column number for the first opened file.
295 -c dir_name --config=directory_name Use an alternate configuration directory. The default
296 configuration directory is ``~/.config/geany/`` and that
297 is where ``geany.conf`` and other configuration files
300 *none* --ft-names Print a list of Geany's internal filetype names (useful
301 for snippets configuration).
303 -g --generate-tags Generate a global tags file (see
304 `Generating a global tags file`_).
306 -P --no-preprocessing Don't preprocess C/C++ files when generating tags file.
308 -i --new-instance Do not open files in a running instance, force opening
309 a new instance. Only available if Geany was compiled
310 with support for Sockets.
312 -l --line Set initial line number for the first opened file.
314 *none* --list-documents Return a list of open documents in a running Geany
316 This can be used to read the currently opened documents in
317 Geany from an external script or tool. The returned list
318 is separated by newlines (LF) and consists of the full,
319 UTF-8 encoded filenames of the documents.
320 Only available if Geany was compiled with support for
323 -m --no-msgwin Do not show the message window. Use this option if you
324 do not need compiler messages or VTE support.
326 -n --no-ctags Do not load symbol completion and call tip data. Use this
327 option if you do not want to use them.
329 -p --no-plugins Do not load plugins or plugin support.
331 *none* --print-prefix Print installation prefix, the data directory, the lib
332 directory and the locale directory (in that order) to
333 stdout, one line each. This is mainly intended for plugin
334 authors to detect installation paths.
336 -r --read-only Open all files given on the command line in read-only mode.
337 This only applies to files opened explicitly from the command
338 line, so files from previous sessions or project files are
341 -s --no-session Do not load the previous session's files.
343 -t --no-terminal Do not load terminal support. Use this option if you do
344 not want to load the virtual terminal emulator widget
345 at startup. If you do not have ``libvte.so.4`` installed,
346 then terminal-support is automatically disabled. Only
347 available if Geany was compiled with support for VTE.
349 *none* --socket-file Use this socket filename for communication with a
350 running Geany instance. This can be used with the following
351 command to execute Geany on the current workspace::
353 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
355 *none* --vte-lib Specify explicitly the path including filename or only
356 the filename to the VTE library, e.g.
357 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
358 only needed when the auto-detection does not work. Only
359 available if Geany was compiled with support for VTE.
361 -v --verbose Be verbose (print useful status messages).
363 -V --version Show version information and exit.
365 -? --help Show help information and exit.
367 *none* *files ...* Open all given filenames at startup.
368 If a running instance is detected, pass filenames
369 *file:line ...* to it instead.
371 *file:line:col ...* Geany also recognizes line and column information when
372 appended to the filename with colons, e.g.
373 ``geany foo.bar:10:5`` will open the file ``foo.bar`` and
374 place the cursor in line 10 at column 5.
376 If a filename does not exist, create a new document
377 with the desired filename if the
378 *Open new files from the command-line*
379 `file pref <#files-preferences>`_ is set.
381 A project can also be opened, but the project filename (\*.geany)
382 must be the first non-option argument. Any other
383 project filenames will be opened as text files.
384 ============ ======================= =================================================
386 Geany also supports all generic GTK options, a list is available on the
396 At startup, Geany loads all files from the last time Geany was
397 launched. You can disable this feature in the preferences dialog
398 (see `General Startup preferences`_).
400 You can start several instances of Geany, but only the first will
401 load files from the last session. In the subsequent instances, you
402 can find these files in the file menu under the *Recent files* item.
403 By default this contains the last 10 recently opened files. You can
404 change the number of recently opened files in the
405 `Files tab <#files-preferences>`_ of the preferences dialog.
407 To run a second instance of Geany, do not specify any filenames on
408 the command-line, or disable opening files in a running instance
409 using the ``-i`` `command line option <#command-line-options>`_.
417 The *File->Open* command will show a dialog to choose one or more text
418 files to open. There is a list of file filters on the right with the
421 * All files (default)
422 * All source - a combination of all the patterns for each filetype (see
423 `Filetype extensions`_)
424 * Individual filetypes
426 Clicking *More options* will reveal controls to open files with a
427 specific filetype and/or encoding (see `Character sets and Unicode
428 Byte-Order-Mark (BOM)`_).
431 Opening files from the command-line in a running instance
432 `````````````````````````````````````````````````````````
434 Geany detects if there is an instance of itself already running and opens files
435 from the command-line in that instance. So, Geany can
436 be used to view and edit files by opening them from other programs
437 such as a file manager.
439 You can also pass line number and column number information, e.g.::
441 geany some_file.foo:55:4
443 This would open the file ``some_file.foo`` with the cursor on line 55,
446 If you do not like this for some reason, you can disable using the first
447 instance by using the appropriate command line option -- see the section
448 called `Command line options`_.
451 Virtual terminal emulator widget (VTE)
452 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
454 If you have installed ``libvte.so`` on your system, it is loaded
455 automatically by Geany, and you will have a terminal widget in the
456 notebook at the bottom.
458 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
459 will not be loaded. So there is no need to install the package containing
460 this file in order to run Geany. Additionally, you can disable the use
461 of the terminal widget by command line option, for more information
462 see the section called `Command line options`_.
464 You can use this terminal (from now on called VTE) much as you would
465 a terminal program like xterm. There is basic clipboard support. You
466 can paste the contents of the clipboard by pressing the right mouse
467 button to open the popup menu, and choosing Paste. To copy text from
468 the VTE, just select the desired text and then press the right mouse
469 button and choose Copy from the popup menu. On systems running the
470 X Window System you can paste the last selected text by pressing the
471 middle mouse button in the VTE (on 2-button mice, the middle button
472 can often be simulated by pressing both mouse buttons together).
474 In the preferences dialog you can specify a shell which should be
475 started in the VTE. To make the specified shell a login shell just
476 use the appropriate command line options for the shell. These options
477 should be found in the manual page of the shell. For zsh and bash
478 you can use the argument ``--login``.
481 Geany tries to load ``libvte.so``. If this fails, it tries to load
482 some other filenames. If this fails too, you should check whether you
483 installed libvte correctly. Again note, Geany will run without this
486 It could be, that the library is called something else than
487 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
488 please set a link to the correct file (as root)::
490 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
492 Obviously, you have to adjust the paths and set X to the number of your
495 You can also specify the filename of the VTE library to use on the command
496 line (see the section called `Command line options`_) or at compile time
497 by specifying the command line option ``--with-vte-module-path`` to
504 Switching between documents
505 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
507 The documents list and the editor tabs are two different ways
508 to switch between documents using the mouse. When you hit the key
509 combination to move between tabs, the order is determined by the tab
510 order. It is not alphabetical as shown in the documents list
511 (regardless of whether or not editor tabs are visible).
513 See the `Notebook tab keybindings`_ section for useful
514 shortcuts including for Most-Recently-Used document switching.
519 There are three different ways to display documents on the sidebar if *Show
520 documents list* is active. To switch between views press the right mouse button
521 on the documents list and select one of these items:
524 Show only file names of open documents in sorted order.
526 .. image:: ./images/sidebar_documents_only.png
529 Show open documents as a two-level tree in which first level is the paths
530 of directories containing open files and the second level is the file names of
531 the documents open in that path. All documents with the same path are grouped
532 together under the same first level item. Paths are in sorted order and
533 documents are sorted within each group.
535 .. image:: ./images/sidebar_show_paths.png
538 Show paths as above, but as a multiple level partial tree. The tree is only
539 expanded at positions where two or more directory paths to open documents
540 share the same prefix. The common prefix is shown as a parent level, and
541 the remainder of those paths are shown as child levels. This applies
542 recursively down the paths making a tree to the file names of open documents,
543 which are grouped in sorted order as an additional level below the last path
546 For convenience two common file locations are handled specially, open
547 files below the users home directory and open files below an open project
548 base path. Each of these is moved to its own top level tree instead of
549 being in place in the normal tree. The top level of these trees are each
550 labelled differently. For the home directory tree the path of the home
551 directory is shown as ``~``, and for the project tree the path to the project
552 base path is shown simply as the project name.
554 .. image:: ./images/sidebar_show_tree.png
556 In all cases paths and file names that do not fit in the width available are ellipsised.
560 The `Document->Clone` menu item copies the current document's text,
561 cursor position and properties into a new untitled document. If
562 there is a selection, only the selected text is copied. This can be
563 useful when making temporary copies of text or for creating
564 documents with similar or identical contents.
566 Automatic filename insertion on `Save As...`
567 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
568 If a document is saved via `Document->Save As...` then the filename is
569 automatically inserted into the comment header replacing text like
570 `untitled.ext` in the first 3 lines of the file. E.g. if a new ``.c``
571 file is created using `File->New (with Template)` then the text `untitled.c`
572 in line 2 would be replaced with the choosen file name on `Save As...`
573 (this example assumes the default file templates being used).
576 Character sets and Unicode Byte-Order-Mark (BOM)
577 ------------------------------------------------
583 Geany provides support for detecting and converting character sets. So
584 you can open and save files in different character sets, and even
585 convert a file from one character set to another. To do this,
586 Geany uses the character conversion capabilities of the GLib library.
588 Only text files are supported, i.e. opening files which contain
589 NULL-bytes may fail. Geany will try to open the file anyway but it is
590 likely that the file will be truncated because it can only be read up
591 to the first occurrence of a NULL-byte. All characters after this
592 position are lost and are not written when you save the file.
594 Geany tries to detect the encoding of a file while opening it, but
595 auto-detecting the encoding of a file is not easy and sometimes an
596 encoding might not be detected correctly. In this case you have to
597 set the encoding of the file manually in order to display it
598 correctly. You can this in the file open dialog by selecting an
599 encoding in the drop down box or by reloading the file with the
600 file menu item "Reload as". The auto-detection works well for most
601 encodings but there are also some encodings where it is known that
602 auto-detection has problems.
604 There are different ways to set different encodings in Geany:
606 * Using the file open dialog
608 This opens the file with the encoding specified in the encoding drop
609 down box. If the encoding is set to "Detect from file" auto-detection
610 will be used. If the encoding is set to "Without encoding (None)" the
611 file will be opened without any character conversion and Geany will
612 not try to auto-detect the encoding (see below for more information).
614 * Using the "Reload as" menu item
616 This item reloads the current file with the specified encoding. It can
617 help if you opened a file and found out that the wrong encoding was used.
619 * Using the "Set encoding" menu item
621 Contrary to the above two options, this will not change or reload
622 the current file unless you save it. It is useful when you want to
623 change the encoding of the file.
625 * Specifying the encoding in the file itself
627 As mentioned above, auto-detecting the encoding of a file may fail on
628 some encodings. If you know that Geany doesn't open a certain file,
629 you can add the specification line, described in the next section,
630 to the beginning of the file to force Geany to use a specific
631 encoding when opening the file.
634 In-file encoding specification
635 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
637 Geany detects meta tags of HTML files which contain charset information
640 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
642 and the specified charset is used when opening the file. This is useful if the
643 encoding of the file cannot be detected properly.
644 For non-HTML files you can also define a line like::
646 /* geany_encoding=ISO-8859-15 */
650 # geany_encoding=ISO-8859-15 #
652 to force an encoding to be used. The #, /\* and \*/ are examples
653 of filetype-specific comment characters. It doesn't matter which
654 characters are around the string " geany_encoding=ISO-8859-15 " as long
655 as there is at least one whitespace character before and after this
656 string. Whitespace characters are in this case a space or tab character.
657 An example to use this could be you have a file with ISO-8859-15
658 encoding but Geany constantly detects the file encoding as ISO-8859-1.
659 Then you simply add such a line to the file and Geany will open it
660 correctly the next time.
662 Since Geany 0.15 you can also use lines which match the
663 regular expression used to find the encoding string:
664 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
667 These specifications must be in the first 512 bytes of the file.
668 Anything after the first 512 bytes will not be recognized.
672 # encoding = ISO-8859-15
676 # coding: ISO-8859-15
678 Special encoding "None"
679 ^^^^^^^^^^^^^^^^^^^^^^^
681 There is a special encoding "None" which uses no
682 encoding. It is useful when you know that Geany cannot auto-detect
683 the encoding of a file and it is not displayed correctly. Especially
684 when the file contains NULL-bytes this can be useful to skip auto
685 detection and open the file properly at least until the occurrence
686 of the first NULL-byte. Using this encoding opens the file as it is
687 without any character conversion.
690 Unicode Byte-Order-Mark (BOM)
691 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
693 Furthermore, Geany detects a Unicode Byte Order Mark (see
694 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
695 this feature is only available if the opened file is in a Unicode
696 encoding. The Byte Order Mark helps to detect the encoding of a file,
697 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
698 using a Byte Order Mark could cause some problems for programs not
699 expecting it, e.g. the compiler gcc stops
700 with stray errors, PHP does not parse a script containing a BOM and
701 script files starting with a she-bang maybe cannot be started. In the
702 status bar you can easily see whether the file starts with a BOM or
705 If you want to set a BOM for a file or if you want to remove it
706 from a file, just use the document menu and toggle the checkbox.
709 If you are unsure what a BOM is or if you do not understand where
710 to use it, then it is probably not important for you and you can
722 Geany provides basic code folding support. Folding means the ability to
723 show and hide parts of the text in the current file. You can hide
724 unimportant code sections and concentrate on the parts you are working on
725 and later you can show hidden sections again. In the editor window there is
726 a small grey margin on the left side with [+] and [-] symbols which
727 show hidden parts and hide parts of the file respectively. By
728 clicking on these icons you can simply show and hide sections which are
729 marked by vertical lines within this margin. For many filetypes nested
730 folding is supported, so there may be several fold points within other
734 You can customize the folding icon and line styles - see the
735 filetypes.common `Folding Settings`_.
737 If you don't like it or don't need it at all, you can simply disable
738 folding support completely in the preferences dialog.
740 The folding behaviour can be changed with the "Fold/Unfold all children of
741 a fold point" option in the preference dialog. If activated, Geany will
742 unfold all nested fold points below the current one if they are already
743 folded (when clicking on a [+] symbol).
744 When clicking on a [-] symbol, Geany will fold all nested fold points
745 below the current one if they are unfolded.
747 This option can be inverted by pressing the Shift
748 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
749 children of a fold point" option is enabled, pressing Shift will disable
750 it for this click and vice versa.
753 Column mode editing (rectangular selections)
754 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
756 There is basic support for column mode editing. To use it, create a
757 rectangular selection by holding down the Control and Shift keys
758 (or Alt and Shift on Windows) while selecting some text.
759 Once a rectangular selection exists you can start editing the text within
760 this selection and the modifications will be done for every line in the
763 It is also possible to create a zero-column selection - this is
764 useful to insert text on multiple lines.
766 Drag and drop of text
767 ^^^^^^^^^^^^^^^^^^^^^
769 If you drag selected text in the editor widget of Geany the text is
770 moved to the position where the mouse pointer is when releasing the
771 mouse button. Holding Control when releasing the mouse button will
772 copy the text instead. This behaviour was changed in Geany 0.11 -
773 before the selected text was copied to the new position.
779 Geany allows each document to indent either with a tab character,
780 multiple spaces or a combination of both.
782 The *Tabs* setting indents with one tab character per indent level, and
783 displays tabs as the indent width.
785 The *Spaces* setting indents with the number of spaces set in the indent
786 width for each level.
788 The *Tabs and Spaces* setting indents with spaces as above, then converts
789 as many spaces as it can to tab characters at the rate of one tab for
790 each multiple of the `Various preference` setting
791 *indent_hard_tab_width* (default 8) and displays tabs as the
792 *indent_hard_tab_width* value.
794 The default indent settings are set in `Editor Indentation
795 preferences`_ (see the link for more information).
797 The default settings can be overridden per-document using the
798 Document menu. They can also be overridden by projects - see
799 `Project management`_.
801 The indent mode for the current document is shown on the status bar
805 Indent with Tab characters.
809 Indent with tabs and spaces, depending on how much indentation is
812 Applying new indentation settings
813 `````````````````````````````````
814 After changing the default settings you may wish to apply the new
815 settings to every document in the current session. To do this use the
816 *Project->Apply Default Indentation* menu item.
818 Detecting indent type
819 `````````````````````
820 The *Detect from file* indentation preference can be used to
821 scan each file as it's opened and set the indent type based on
822 how many lines start with a tab vs. 2 or more spaces.
828 When enabled, auto-indentation happens when pressing *Enter* in the
829 Editor. It adds a certain amount of indentation to the new line so the
830 user doesn't always have to indent each line manually.
832 Geany has four types of auto-indentation:
835 Disables auto-indentation completely.
837 Adds the same amount of whitespace on a new line as on the previous line.
838 For the *Tabs* and the *Spaces* indent types the indentation will use the
839 same combination of characters as the previous line. The
840 *Tabs and Spaces* indentation type converts as explained above.
842 Does the same as *Basic* but also indents a new line after an opening
843 brace '{', and de-indents when typing a closing brace '}'. For Python,
844 a new line will be indented after typing ':' at the end of the
847 Similar to *Current chars* but the closing brace will be aligned to
848 match the indentation of the line with the opening brace. This
849 requires the filetype to be one where Geany knows that the Scintilla
850 lexer understands matching braces (C, C++, D, HTML, Pascal, Bash,
853 There is also XML-tag auto-indentation. This is enabled when the
854 mode is more than just Basic, and is also controlled by a filetype
855 setting - see `xml_indent_tags`_.
861 Geany provides a handy bookmarking feature that lets you mark one
862 or more lines in a document, and return the cursor to them using a
865 To place a mark on a line, either left-mouse-click in the left margin
866 of the editor window, or else use Ctrl-m. This will
867 produce a small green plus symbol in the margin. You can have as many
868 marks in a document as you like. Click again (or use Ctrl-m again)
869 to remove the bookmark. To remove all the marks in a given document,
870 use "Remove Markers" in the Document menu.
872 To navigate down your document, jumping from one mark to the next,
873 use Ctrl-. (control period). To go in the opposite direction on
874 the page, use Ctrl-, (control comma). Using the bookmarking feature
875 together with the commands to switch from one editor tab to another
876 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
877 navigate around multiple files.
880 Code navigation history
881 ^^^^^^^^^^^^^^^^^^^^^^^
883 To ease navigation in source files and especially between
884 different files, Geany lets you jump between different navigation
885 points. Currently, this works for the following:
887 * `Go to symbol declaration`_
888 * `Go to symbol definition`_
893 When using one of these actions, Geany remembers your current position
894 and jumps to the new one. If you decide to go back to your previous
895 position in the file, just use "Navigate back a location". To
896 get back to the new position again, just use "Navigate forward a
897 location". This makes it easier to navigate in e.g. foreign code
898 and between different files.
901 Sending text through custom commands
902 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
904 You can define several custom commands in Geany and send the current
905 selection to one of these commands using the *Edit->Format->Send
906 Selection to* menu or keybindings. The output of the command will be
907 used to replace the current selection. This makes it possible to use
908 text formatting tools with Geany in a general way.
910 The selected text will be sent to the standard input of the executed
911 command, so the command should be able to read from it and it should
912 print all results to its standard output which will be read by
913 Geany. To help finding errors in executing the command, the output
914 of the program's standard error will be printed on Geany's standard
917 If there is no selection, the whole current line is used instead.
919 To add a custom command, use the *Send Selection to->Set Custom
920 Commands* menu item. Click on *Add* to get a new item and type the
921 command. You can also specify some command line options. Empty
922 commands are not saved.
924 Normal shell quoting is supported, so you can do things like:
926 * ``sed 's/\./(dot)/g'``
928 The above example would normally be done with the `Replace all`_
929 function, but it can be handy to have common commands already set up.
931 Note that the command is not run in a shell, so if you want to use
932 shell features like pipes and command chains, you need to explicitly
933 launch the shell and pass it your command:
935 * ``sh -c 'sort | uniq'``
941 You can execute the context action command on the current word at the
942 cursor position or the available selection. This word or selection
943 can be used as an argument to the command.
944 The context action is invoked by a menu entry in the popup menu of the
945 editor and also a keyboard shortcut (see the section called
948 The command can be specified in the preferences dialog and also for
949 each filetype (see "context_action_cmd" in the section called
950 `Filetype configuration`_). When the context action is invoked, the filetype
951 specific command is used if available, otherwise the command
952 specified in the preferences dialog is executed.
954 The current word or selection can be referred with the wildcard "%s"
955 in the command, it will be replaced by the current word or
956 selection before the command is executed.
958 For example a context action can be used to open API documentation
959 in a browser window, the command to open the PHP API documentation
962 firefox "http://www.php.net/%s"
964 when executing the command, the %s is substituted by the word near
965 the cursor position or by the current selection. If the cursor is at
966 the word "echo", a browser window will open(assumed your browser is
967 called firefox) and it will open the address: http://www.php.net/echo.
973 Geany can offer a list of possible completions for symbols defined in the
974 tags files and for all words in open documents.
976 The autocompletion list for symbols is presented when the first few
977 characters of the symbol are typed (configurable, see `Editor Completions
978 preferences`_, default 4) or when the *Complete word*
979 keybinding is pressed (configurable, see `Editor keybindings`_,
982 For some languages the autocompletion list is ordered by heuristics to
983 attempt to show names that are more likely to be what the user wants
984 close to the top of the list.
986 When the defined keybinding is typed and the *Autocomplete all words in
987 document* preference (in `Editor Completions preferences`_)
988 is selected then the autocompletion list will show all matching words
989 in the document, if there are no matching symbols.
991 If you don't want to use autocompletion it can be dismissed until
992 the next symbol by pressing Escape. The autocompletion list is updated
993 as more characters are typed so that it only shows completions that start
994 with the characters typed so far. If no symbols begin with the sequence,
995 the autocompletion window is closed.
997 The up and down arrows will move the selected item. The highlighted
998 item on the autocompletion list can be chosen from the list by pressing
999 Enter/Return. You can also double-click to select an item. The sequence
1000 will be completed to match the chosen item, and if the *Drop rest of
1001 word on completion* preference is set (in `Editor Completions
1002 preferences`_) then any characters after the cursor that match
1003 a symbol or word are deleted.
1005 Word part completion
1006 ````````````````````
1007 By default, pressing Tab will complete the selected item by word part;
1008 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
1013 * gtk_combo_box_<e><TAB>
1014 * gtk_combo_box_entry_<s><ENTER>
1015 * gtk_combo_box_entry_set_text_column
1017 The key combination can be changed from Tab - See `Editor keybindings`_.
1018 If you clear/change the key combination for word part completion, Tab
1019 will complete the whole word instead, like Enter.
1021 Scope autocompletion
1022 ````````````````````
1031 When you type ``foo.`` it will show an autocompletion list with 'i' and
1034 It only works for languages that set parent scope names for e.g. struct
1035 members. Most languages only parse global definitions and so scope
1036 autocompletion will not work for names declared in local scope
1037 (e.g. inside functions). A few languages parse both local and global
1038 symbols (e.g. C/C++ parsers) and for these parsers scope autocompletion
1039 works also for local variables.
1044 A handy tooltip is shown when typing ``(`` after a symbol name when the
1045 symbol has a parameter list. The tag parser for the filetype must support
1046 parsing parameter lists.
1047 Calltips can also be shown with a `keybinding <#editor-keybindings>`_.
1049 When there is more than one matching symbol, arrows are shown which can
1050 be clicked to cycle through the signatures.
1053 User-definable snippets
1054 ^^^^^^^^^^^^^^^^^^^^^^^
1056 Snippets are small strings or code constructs which can be replaced or
1057 completed to a more complex string. So you can save a lot of time when
1058 typing common strings and letting Geany do the work for you.
1059 To know what to complete or replace Geany reads a configuration file
1060 called ``snippets.conf`` at startup.
1062 Maybe you need to often type your name, so define a snippet like this::
1065 myname=Enrico Tröger
1067 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
1068 with "Enrico Tröger". The key to start autocompletion can be changed
1069 in the preferences dialog, by default it is TAB. The corresponding keybinding
1070 is called `Complete snippet`.
1074 You can override the default snippets using the user
1075 ``snippets.conf`` file. Use the *Tools->Configuration
1076 Files->snippets.conf* menu item. See also `Configuration file paths`_.
1078 This adds the default settings to the user file if the file doesn't
1079 exist. Alternatively the file can be created manually, adding only
1080 the settings you want to change. All missing settings will be read
1081 from the system snippets file.
1085 The file ``snippets.conf`` contains sections defining snippets that
1086 are available for particular filetypes and in general.
1088 The two sections "Default" and "Special" apply to all filetypes.
1089 "Default" contains all snippets which are available for every
1090 filetype and "Special" contains snippets which can only be used in
1091 other snippets. So you can define often used parts of snippets and
1092 just use the special snippet as a placeholder (see the
1093 ``snippets.conf`` for details).
1095 You can define sections with the name of a filetype eg "C++". The
1096 snippets in that section are only available for use in files with that
1097 filetype. Snippets in filetype sections will hide snippets with the
1098 same name in the "Default" section when used in a file of that
1101 **Substitution sequences for snippets**
1103 To define snippets you can use several special character sequences which
1104 will be replaced when using the snippet:
1106 ================ =========================================================
1107 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1108 char(s): LF, CR/LF, or CR).
1110 \\t or %ws% Insert an indentation step, it will be replaced according
1111 to the current document's indent mode.
1113 \\s \\s to force whitespace at beginning or end of a value
1114 ('key= value' won't work, use 'key=\\svalue')
1116 %cursor% Place the cursor at this position after completion has
1117 been done. You can define multiple %cursor% wildcards
1118 and use the keybinding `Move cursor in snippet` to jump
1119 to the next defined cursor position in the completed
1122 %...% "..." means the name of a key in the "Special" section.
1123 If you have defined a key "brace_open" in the "Special"
1124 section you can use %brace_open% in any other snippet.
1125 ================ =========================================================
1127 Snippet names must not contain spaces otherwise they won't
1128 work correctly. But beside that you can define almost any
1129 string as a snippet and use it later in Geany. It is not limited
1130 to existing constructs of certain programming languages(like ``if``,
1131 ``for``, ``switch``). Define whatever you need.
1133 **Template wildcards**
1135 Since Geany 0.15 you can also use most of the available templates wildcards
1136 listed in `Template wildcards`_. All wildcards which are listed as
1137 `available in snippets` can be used. For instance to improve the above example::
1140 myname=My name is {developer}
1141 mysystem=My system: {command:uname -a}
1143 this will replace ``myname`` with "My name is " and the value of the template
1144 preference ``developer``.
1148 You can change the way Geany recognizes the word to complete,
1149 that is how the start and end of a word is recognised when the
1150 snippet completion is requested. The section "Special" may
1151 contain a key "wordchars" which lists all characters a string may contain
1152 to be recognized as a word for completion. Leave it commented to use
1153 default characters or define it to add or remove characters to fit your
1159 Normally you would type the snippet name and press Tab. However, you
1160 can define keybindings for snippets under the *Keybindings* group in
1165 block_cursor=<Ctrl>8
1168 Snippet keybindings may be overridden by Geany's configurable
1172 Inserting Unicode characters
1173 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1175 You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1176 Ctrl-Shift, type some hex digits representing the code point for the character
1177 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1178 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1179 insertion is completed, but the typed character is also entered. In the case
1180 of Enter/Return, it is a newline, as you might expect.
1183 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1184 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1185 or restart Geany. Note that it works slightly differently from other GTK
1186 applications, in that you'll need to continue to hold down the Ctrl and Shift
1187 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1190 Inserting color values
1191 ^^^^^^^^^^^^^^^^^^^^^^
1193 You can insert a color value by selecting *Tools->Color Chooser* from the menu.
1194 A dialog appears to select the wanted color. If the cursor is placed inside a
1195 *#RRGGBB* format color value then the dialog will show that color after opening.
1196 On clicking on *Apply* or *Select* the code for the chosen color will be inserted
1197 in the format *#RRGGBB*. If text is selected, then it will be replaced with the
1198 color code on the first click on *Apply* or *Select*. If no text is selected or
1199 on subsequent clicks the color code is inserted at the current cursor position.
1202 Search, replace and go to
1203 -------------------------
1205 This section describes search-related commands from the Search menu
1206 and the editor window's popup menu:
1213 * Go to symbol definition
1214 * Go to symbol declaration
1217 See also `Search`_ preferences.
1221 There are also two toolbar entries:
1226 There are keybindings to focus each of these - see `Focus
1227 keybindings`_. Pressing Escape will then focus the editor.
1231 The quickest way to find some text is to use the search bar entry in
1232 the toolbar. This performs a case-insensitive search in the current
1233 document whilst you type. Pressing Enter will search again, and pressing
1234 Shift-Enter will search backwards.
1239 The Find dialog is used for finding text in one or more open documents.
1241 .. image:: ./images/find_dialog.png
1247 The syntax for the *Use regular expressions* option is shown in
1248 `Regular expressions`_.
1251 *Use escape sequences* is implied for regular expressions.
1253 The *Use multi-line matching* option enables multi-line regular
1254 expressions instead of single-line ones. See `Regular expressions`_ for
1255 more details on the differences between the two modes.
1257 The *Use escape sequences* option will transform any escaped characters
1258 into their UTF-8 equivalent. For example, \\t will be transformed into
1259 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1260 (Unicode characters).
1266 To find all matches, click on the Find All expander. This will reveal
1273 Find All In Document will show a list of matching lines in the
1274 current document in the Messages tab of the Message Window. *Find All
1275 In Session* does the same for all open documents.
1277 Mark will highlight all matches in the current document with a
1278 colored box. These markers can be removed by selecting the
1279 Remove Markers command from the Document menu.
1282 Change font in search dialog text fields
1283 ````````````````````````````````````````
1285 All search related dialogs use a Monospace font for the text input fields to
1286 increase the readability of input text. This is useful when you are
1287 typing input such as regular expressions with spaces, periods and commas which
1288 might be hard to read with a proportional font.
1290 If you want to change the font, you can do this easily by using the following
1291 custom CSS snippet, see `Customizing Geany's appearance using GTK+ CSS`_::
1293 #GeanyDialogSearch GtkEntry /* GTK < 3.20 */,
1294 #GeanyDialogSearch entry /* GTK >= 3.20 */ {
1295 font: 8pt monospace;
1301 The *Find Next/Previous Selection* commands perform a search for the
1302 current selected text. If nothing is selected, by default the current
1303 word is used instead. This can be customized by the
1304 *find_selection_type* preference - see `Various preferences`_.
1306 ===== =============================================
1307 Value *find_selection_type* behaviour
1308 ===== =============================================
1309 0 Use the current word (default).
1310 1 Try the X selection first, then current word.
1311 2 Repeat last search.
1312 ===== =============================================
1318 *Find Usage* searches all open files. It is similar to the *Find All In
1319 Session* option in the Find dialog.
1321 If there is a selection, then it is used as the search text; otherwise
1322 the current word is used. The current word is either taken from the
1323 word nearest the edit cursor, or the word underneath the popup menu
1324 click position when the popup menu is used. The search results are
1325 shown in the Messages tab of the Message Window.
1328 You can also use Find Usage for symbol list items from the popup
1335 *Find in Files* is a more powerful version of *Find Usage* that searches
1336 all files in a certain directory using the Grep tool. The Grep tool
1337 must be correctly set in Preferences to the path of the system's Grep
1338 utility. GNU Grep is recommended (see note below).
1340 .. image:: ./images/find_in_files_dialog.png
1342 The *Search* field is initially set to the current word in the editor
1343 (depending on `Search`_ preferences).
1345 The *Files* setting allows to choose which files are included in the
1346 search, depending on the mode:
1349 Search in all files;
1351 Use the current project's patterns, see `Project properties`_;
1353 Use custom patterns.
1355 Both project and custom patterns use a glob-style syntax, each
1356 pattern separated by a space. To search all ``.c`` and ``.h`` files,
1358 Note that an empty pattern list searches in all files rather
1361 The *Directory* field is initially set to the current document's directory,
1362 unless this field has already been edited and the current document has
1363 not changed. Otherwise, the current document's directory is prepended to
1364 the drop-down history. This can be disabled - see `Search`_ preferences.
1366 The *Encoding* field can be used to define the encoding of the files
1367 to be searched. The entered search text is converted to the chosen encoding
1368 and the search results are converted back to UTF-8.
1370 The *Extra options* field is used to pass any additional arguments to
1374 The *Files* setting uses ``--include=`` when searching recursively,
1375 *Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
1376 not work with other Grep implementations.
1379 Filtering out version control files
1380 ```````````````````````````````````
1382 When using the *Recurse in subfolders* option with a directory that's
1383 under version control, you can set the *Extra options* field to filter
1384 out version control files.
1386 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1387 argument to filter out CVS and hidden directories like ``.svn``.
1389 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1391 If you have an older Grep, you can try using the ``--exclude`` flag
1392 to filter out filenames.
1394 SVN Example: ``--exclude=*.svn-base``
1396 The --exclude argument only matches the file name part, not the path.
1402 The Replace dialog is used for replacing text in one or more open
1405 .. image:: ./images/replace_dialog.png
1407 The Replace dialog has the same options for matching text as the Find
1408 dialog. See the section `Matching options`_.
1410 The *Use regular expressions* option allows regular expressions to
1411 be used in the search string and back references in the replacement
1412 text -- see the entry for '\\n' in `Regular expressions`_.
1417 To replace several matches, click on the *Replace All* expander. This
1418 will reveal several options:
1424 *Replace All In Document* will replace all matching text in the
1425 current document. *Replace All In Session* does the same for all open
1426 documents. *Replace All In Selection* will replace all matching text
1427 in the current selection of the current document.
1430 Go to symbol definition
1431 ^^^^^^^^^^^^^^^^^^^^^^^
1433 If the current word or selection is the name of a symbol definition
1434 (e.g. a function name) and the file containing the symbol definition is
1435 open, this command will switch to that file and go to the
1436 corresponding line number. The current word is either the word
1437 nearest the edit cursor, or the word underneath the popup menu click
1438 position when the popup menu is used.
1440 If there are more symbols with the same name to which the goto can be performed,
1441 a pop up is shown with a list of all the occurrences. After selecting a symbol
1442 from the list Geany jumps to the corresponding symbol location. Geany tries to
1443 suggest the nearest symbol (symbol from the current file, other open documents
1444 or current directory) as the best candidate for the goto and places this symbol
1445 at the beginning of the list typed in boldface.
1448 If the corresponding symbol is on the current line, Geany will first
1449 look for a symbol declaration instead, as this is more useful.
1450 Likewise *Go to symbol declaration* will search for a symbol definition
1451 first in this case also.
1454 Go to symbol declaration
1455 ^^^^^^^^^^^^^^^^^^^^^^^^
1457 Like *Go to symbol definition*, but for a forward declaration such as a
1458 C function prototype or ``extern`` declaration instead of a function
1465 Go to a particular line number in the current file.
1471 You can use regular expressions in the Find and Replace dialogs
1472 by selecting the *Use regular expressions* check box (see `Matching
1473 options`_). The syntax is Perl compatible. Basic syntax is described
1474 in the table below. For full details, see
1475 https://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
1477 By default regular expressions are matched on a line-by-line basis.
1478 If you are interested in multi-line regular expressions, matched against
1479 the whole buffer at once, see the section `Multi-line regular expressions`_
1483 1. The *Use escape sequences* dialog option always applies for regular
1485 2. Searching backwards with regular expressions is not supported.
1486 3. The *Use multi-line matching* dialog option to select single or
1487 multi-line matching.
1489 **In a regular expression, the following characters are interpreted:**
1491 ======= ============================================================
1492 . Matches any character.
1494 ( This marks the start of a region for tagging a match.
1496 ) This marks the end of a tagged region.
1498 \\n Where n is 1 through 9 refers to the first through ninth tagged
1499 region when searching or replacing.
1501 Searching for (Wiki)\\1 matches WikiWiki.
1503 If the search string was Fred([1-9])XXX and the
1504 replace string was Sam\\1YYY, when applied to Fred2XXX this
1505 would generate Sam2YYY.
1507 \\0 When replacing, the whole matching text.
1509 \\b This matches a word boundary.
1511 \\c A backslash followed by d, D, s, S, w or W, becomes a
1512 character class (both inside and outside sets []).
1515 * D: any char except decimal digits
1516 * s: whitespace (space, \\t \\n \\r \\f \\v)
1517 * S: any char except whitespace (see above)
1518 * w: alphanumeric & underscore
1519 * W: any char except alphanumeric & underscore
1521 \\x This allows you to use a character x that would otherwise have
1522 a special meaning. For example, \\[ would be interpreted as [
1523 and not as the start of a character set. Use \\\\ for a literal
1526 [...] Matches one of the characters in the set. If the first
1527 character in the set is ^, it matches the characters NOT in
1528 the set, i.e. complements the set. A shorthand S-E (start
1529 dash end) is used to specify a set of characters S up to E,
1532 The special characters ] and - have no special
1533 meaning if they appear first in the set. - can also be last
1534 in the set. To include both, put ] first: []A-Z-].
1538 []|-] matches these 3 chars
1539 []-|] matches from ] to | chars
1540 [a-z] any lowercase alpha
1541 [^]-] any char except - and ]
1542 [^A-Z] any char except uppercase alpha
1545 ^ This matches the start of a line (unless used inside a set, see
1548 $ This matches the end of a line.
1550 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1551 Saam, Saaam and so on.
1553 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1554 Saam, Saaam and so on.
1556 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1557 ======= ============================================================
1560 This table is adapted from Scintilla and SciTE documentation,
1561 distributed under the `License for Scintilla and SciTE`_.
1564 Multi-line regular expressions
1565 ``````````````````````````````
1568 The *Use multi-line matching* dialog option enables multi-line
1569 regular expressions.
1571 Multi-line regular expressions work just like single-line ones but a
1572 match can span several lines.
1574 While the syntax is the same, a few practical differences applies:
1576 ======= ============================================================
1577 . Matches any character but newlines. This behavior can be changed
1578 to also match newlines using the (?s) option, see
1579 https://www.geany.org/manual/gtk/glib/glib-regex-syntax.html#idp5671632
1581 [^...] A negative range (see above) *will* match newlines if they are
1582 not explicitly listed in that negative range. For example, range
1583 [^a-z] will match newlines, while range [^a-z\\r\\n] won't.
1584 While this is the expected behavior, it can lead to tricky
1585 problems if one doesn't think about it when writing an expression.
1586 ======= ============================================================
1591 The View menu allows various elements of the main window to be shown
1592 or hidden, and also provides various display-related editor options.
1594 Color schemes dialog
1595 ^^^^^^^^^^^^^^^^^^^^
1596 The Color Schemes dialog is available under the *View->Change Color Scheme*
1597 menu item. It lists various color schemes for editor highlighting
1598 styles, including the default scheme first. Other items are available
1599 based on what color scheme files Geany found at startup.
1601 Color scheme files are read from the `Configuration file paths`_ under
1602 the ``colorschemes`` subdirectory. They should have the extension
1603 ``.conf``. The default color scheme
1604 is read from ``filetypes.common``.
1606 The `[named_styles] section`_ and `[named_colors] section`_ are the
1607 same as for ``filetypes.common``.
1609 The ``[theme_info]`` section can contain information about the
1610 theme. The ``name`` and ``description`` keys are read to set the
1611 menu item text and tooltip, respectively. These keys can have
1612 translations, e.g.::
1618 Symbols and tags files
1619 ----------------------
1621 Upon opening, files of supported filetypes are parsed to extract the symbol
1622 information (aka "workspace symbols"). You can also have Geany automatically
1623 load external files containing the symbol information (aka "global
1624 tags files") upon startup, or manually using *Tools --> Load Tags File*.
1626 Geany uses its own tags file format, similar to what ``ctags`` uses
1627 (but is incompatible with ctags). You use Geany to generate global
1628 tags files, as described below.
1634 Each document is parsed for symbols whenever a file is loaded, saved or
1635 modified (see *Symbol list update frequency* preference in the `Editor
1636 Completions preferences`_). These are shown in the Symbol list in the
1637 Sidebar. These symbols are also used for autocompletion and calltips
1638 for all documents open in the current session that have the same filetype.
1640 The *Go to Symbol* commands can be used with all workspace symbols. See
1641 `Go to symbol definition`_.
1647 Global tags files are used to provide symbols for autocompletion and calltips
1648 without having to open the source files containing these symbols. This is intended
1649 for library APIs, as the tags file only has to be updated when you upgrade
1652 You can load a custom global tags file in two ways:
1654 * Using the *Load Tags File* command in the Tools menu.
1655 * By moving or symlinking tags files to the ``tags`` subdirectory of
1656 one of the `configuration file paths`_ before starting Geany.
1658 You can either download these files or generate your own. They have
1663 *lang_ext* is one of the extensions set for the filetype associated
1664 with the tags parser. See the section called `Filetype extensions`_ for
1668 Default global tags files
1669 `````````````````````````
1671 Some global tags files are distributed with Geany and will be loaded
1672 automatically when the corresponding filetype is first used. Currently
1673 this includes global tags files for these languages:
1678 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1683 Global tags file format
1684 ```````````````````````
1686 Global tags files can have three different formats:
1689 * Pipe-separated format
1692 The first line of global tags files should be a comment, introduced
1693 by ``#`` followed by a space and a string like ``format=pipe``,
1694 ``format=ctags`` or ``format=tagmanager`` respectively, these are
1695 case-sensitive. This helps Geany to read the file properly. If this
1696 line is missing, Geany tries to auto-detect the used format but this
1700 The Tagmanager format is a bit more complex and is used for files
1701 created by the ``geany -g`` command. There is one symbol per line.
1702 Different symbol attributes like the return value or the argument list
1703 are separated with different characters indicating the type of the
1704 following argument. This is the more complete and recommended tags file
1707 Pipe-separated format
1708 *********************
1709 The Pipe-separated format is easier to read and write.
1710 There is one symbol per line and different symbol attributes are separated
1711 by the pipe character (``|``). A line looks like::
1713 basename|string|(string path [, string suffix])|
1715 | The first field is the symbol name (usually a function name).
1716 | The second field is the type of the return value.
1717 | The third field is the argument list for this symbol.
1718 | The fourth field is the description for this symbol but
1719 currently unused and should be left empty.
1721 Except for the first field (symbol name), all other field can be left
1722 empty but the pipe separator must appear for them.
1724 You can easily write your own global tags files using this format.
1725 Just save them in your tags directory, as described earlier in the
1726 section `Global tags files`_.
1730 This is the format that ctags generates, and that is used by Vim.
1731 This format is compatible with the format historically used by Vi.
1733 The format is described at http://ctags.sourceforge.net/FORMAT, but
1734 for the full list of existing extensions please refer to ctags.
1735 However, note that Geany may actually only honor a subset of the
1736 existing extensions.
1738 Generating a global tags file
1739 `````````````````````````````
1741 You can generate your own global tags files by parsing a list of
1742 source files. The command is::
1744 geany -g [-P] <Tags File> <File list>
1746 * Tags File filename should be in the format described earlier --
1747 see the section called `Global tags files`_.
1748 * File list is a list of filenames, each with a full path (unless
1749 you are generating C/C++ tags files and have set the CFLAGS environment
1750 variable appropriately).
1751 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1752 to process ``#include`` directives for C/C++ source files. Use this
1753 option if you want to specify each source file on the command-line
1754 instead of using a 'master' header file. Also can be useful if you
1755 don't want to specify the CFLAGS environment variable.
1757 Example for the wxD library for the D programming language::
1759 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1762 Generating C/C++ tags files
1763 ***************************
1764 You may need to first setup the `C ignore.tags`_ file.
1766 For C/C++ tags files gcc is required by default, so that header files
1767 can be preprocessed to include any other headers they depend upon. If
1768 you do not want this, use the ``-P`` option described above.
1770 For preprocessing, the environment variable CFLAGS should be set with
1771 appropriate ``-I/path`` include paths. The following example works with
1772 the bash shell, generating a tags file for the GnomeUI library::
1774 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1775 /usr/include/libgnomeui-2.0/gnome.h
1777 You can adapt this command to use CFLAGS and header files appropriate
1778 for whichever libraries you want.
1781 Generating tags files on Windows
1782 ********************************
1783 This works basically the same as on other platforms::
1785 "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
1791 You can ignore certain symbols for C-based languages if they would lead
1792 to wrong parsing of the code. Use the *Tools->Configuration
1793 Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
1794 See also `Configuration file paths`_.
1796 List all symbol names you want to ignore in this file, separated by spaces
1801 G_GNUC_NULL_TERMINATED
1803 G_GNUC_WARN_UNUSED_RESULT
1806 This will ignore the above macros and will correctly detect 'Foo' as a type
1807 instead of 'BAR' in the following code:
1809 ``struct Foo BAR { int i; };``
1811 In addition, it is possible to specify macro definition similarly to the
1814 <macro>=<definition>
1815 Defines a C preprocessor <macro>. This emulates the behavior of
1816 the corresponding gcc option. All types of macros are supported,
1817 including the ones with parameters and variable arguments.
1818 Stringification, token pasting and recursive macro expansion are
1821 For even more detailed information please read the manual page of
1828 You may adjust Geany's settings using the Edit --> Preferences
1829 dialog. Any changes you make there can be applied by hitting either
1830 the Apply or the OK button. These settings will persist between Geany
1831 sessions. Note that most settings here have descriptive popup bubble
1832 help -- just hover the mouse over the item in question to get help
1835 You may also adjust some View settings (under the View menu) that
1836 persist between Geany sessions. The settings under the Document menu,
1837 however, are only for the current document and revert to defaults
1838 when restarting Geany.
1841 In the paragraphs that follow, the text describing a dialog tab
1842 comes after the screenshot of that tab.
1845 General Startup preferences
1846 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1848 .. image:: ./images/pref_dialog_gen_startup.png
1853 Load files from the last session
1854 On startup, load the same files you had open the last time you
1857 Load virtual terminal support
1858 Load the library for running a terminal in the message window area.
1860 Enable plugin support
1861 Allow plugins to be used in Geany.
1865 Save window position and geometry
1866 Save the current position and size of the main window so next time
1867 you open Geany it's in the same location.
1870 Have a dialog pop up to confirm that you really want to quit Geany.
1876 Path to start in when opening or saving files.
1877 It must be an absolute path.
1880 Path to start in when opening project files.
1883 By default Geany looks in the system installation and the user
1884 configuration - see `Plugins`_. In addition the path entered here will be
1886 Usually you do not need to set an additional path to search for
1887 plugins. It might be useful when Geany is installed on a multi-user machine
1888 and additional plugins are available in a common location for all users.
1889 Leave blank to not set an additional lookup path.
1892 General Miscellaneous preferences
1893 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1895 .. image:: ./images/pref_dialog_gen_misc.png
1900 Beep on errors when compilation has finished
1901 Have the computer make a beeping sound when compilation of your program
1902 has completed or any errors occurred.
1904 Switch status message list at new message
1905 Switch to the status message tab (in the notebook window at the bottom)
1906 once a new status message arrives.
1908 Suppress status messages in the status bar
1909 Remove all messages from the status bar. The messages are still displayed
1910 in the status messages window.
1913 Another option is to use the *Switch to Editor* keybinding - it
1914 reshows the document statistics on the status bar. See `Focus
1917 Auto-focus widgets (focus follows mouse)
1918 Give the focus automatically to widgets below the mouse cursor.
1919 This works for the main editor widget, the scribble, the toolbar search field
1920 go to line fields and the VTE.
1926 Always wrap search around the document when finding a match.
1928 Hide the Find dialog
1929 Hide the `Find`_ dialog after clicking Find Next/Previous.
1931 Use the current word under the cursor for Find dialogs
1932 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1933 there is no selection. When this option is disabled, the search term last used in the
1934 appropriate Find dialog is used.
1936 Use the current file's directory for Find in Files
1937 When opening the Find in Files dialog, set the directory to search to the directory of the current
1938 active file. When this option is disabled, the directory of the last use of the Find in Files
1939 dialog is used. See `Find in Files`_ for details.
1944 Use project-based session files
1945 Save your current session when closing projects. You will be able to
1946 resume different project sessions, automatically opening the files
1947 you had open previously.
1949 Store project file inside the project base directory
1950 When creating new projects, the default path for the project file contains
1951 the project base path. Without this option enabled, the default project file
1952 path is one level above the project base path.
1953 In either case, you can easily set the final project file path in the
1954 *New Project* dialog. This option provides the more common
1955 defaults automatically for convenience.
1958 Interface preferences
1959 ^^^^^^^^^^^^^^^^^^^^^
1961 .. image:: ./images/pref_dialog_interface_interface.png
1967 Whether to show the sidebar at all.
1970 Show the list of functions, variables, and other information in the
1971 current document you are editing.
1974 Show all the documents you have open currently. This can be used to
1975 change between documents (see `Switching between documents`_) and
1976 to perform some common operations such as saving, closing and reloading.
1979 Whether to place the sidebar on the left or right of the editor window.
1985 Whether to place the message window on the bottom or right of the editor window.
1991 Change the font used to display documents.
1994 Change the font used for the Symbols sidebar tab.
1997 Change the font used for the message window area.
2003 Show the status bar at the bottom of the main window. It gives information about
2004 the file you are editing like the line and column you are on, whether any
2005 modifications were done, the file encoding, the filetype and other information.
2007 Interface Notebook tab preferences
2008 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2010 .. image:: ./images/pref_dialog_interface_notebook.png
2016 Show a notebook tab for all documents so you can switch between them
2017 using the mouse (instead of using the Documents window).
2020 Make each tab show a close button so you can easily close open
2023 Placement of new file tabs
2024 Whether to create a document with its notebook tab to the left or
2025 right of all existing tabs.
2028 Whether to place file tabs next to the current tab
2029 rather than at the edges of the notebook.
2031 Double-clicking hides all additional widgets
2032 Whether to call the View->Toggle All Additional Widgets command
2033 when double-clicking on a notebook tab.
2036 If filenames are long, set the number of characters that should be
2037 visible on each tab's label.
2043 Set the positioning of the editor's notebook tabs to the right,
2044 left, top, or bottom of the editing window.
2047 Set the positioning of the sidebar's notebook tabs to the right,
2048 left, top, or bottom of the sidebar window.
2051 Set the positioning of the message window's notebook tabs to the
2052 right, left, top, or bottom of the message window.
2055 Interface Toolbar preferences
2056 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2058 Affects the main toolbar underneath the menu bar.
2060 .. image:: ./images/pref_dialog_interface_toolbar.png
2066 Whether to show the toolbar.
2068 Append Toolbar to the Menu
2069 Allows to append the toolbar to the main menu bar instead of placing it below.
2070 This is useful to save vertical space.
2073 See `Customizing the toolbar`_.
2079 Select the toolbar icon style to use - either icons and text, just
2081 The choice System default uses whatever icon style is set by GTK.
2084 Select the size of the icons you see (large, small or very small).
2085 The choice System default uses whatever icon size is set by GTK.
2088 Editor Features preferences
2089 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2091 .. image:: ./images/pref_dialog_edit_features.png
2097 Show long lines wrapped around to new display lines.
2102 Whether to move the cursor to the first non-whitespace character
2103 on the line when you hit the home key on your keyboard. Pressing it
2104 again will go to the very start of the line.
2106 Disable Drag and Drop
2107 Do not allow the dragging and dropping of selected text in documents.
2110 Allow groups of lines in a document to be collapsed for easier
2113 Fold/Unfold all children of a fold point
2114 Whether to fold/unfold all child fold points when a parent line
2117 Use indicators to show compile errors
2118 Underline lines with compile errors using red squiggles to indicate
2119 them in the editor area.
2121 Newline strips trailing spaces
2122 Remove any whitespace at the end of the line when you hit the
2123 Enter/Return key. See also `Strip trailing spaces`_. Note
2124 auto indentation is calculated before stripping, so although this
2125 setting will clear a blank line, it will not set the next line
2126 indentation back to zero.
2128 Line breaking column
2129 The editor column number to insert a newline at when Line Breaking
2130 is enabled for the current document.
2132 Comment toggle marker
2133 A string which is added when toggling a line comment in a source file.
2134 It is used to mark the comment as toggled.
2137 Editor Indentation preferences
2138 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2140 .. image:: ./images/pref_dialog_edit_indentation.png
2145 See `Indentation`_ for more information.
2148 The width of a single indent size in spaces. By default the indent
2149 size is equivalent to 4 spaces.
2151 Detect width from file
2152 Try to detect and set the indent width based on file content, when
2156 When Geany inserts indentation, whether to use:
2160 * Tabs and Spaces, depending on how much indentation is on a line
2162 The *Tabs and Spaces* indent type is also known as *Soft tab
2163 support* in some other editors.
2165 Detect type from file
2166 Try to detect and set the indent type based on file content, when
2170 The type of auto-indentation you wish to use after pressing Enter,
2174 Just add the indentation of the previous line.
2176 Add indentation based on the current filetype and any characters at
2177 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
2179 Like *Current chars* but for C-like languages, make a closing
2180 ``}`` brace line up with the matching opening brace.
2183 If set, pressing tab will indent the current line or selection, and
2184 unindent when pressing Shift-tab. Otherwise, the tab key will
2185 insert a tab character into the document (which can be different
2186 from indentation, depending on the indent type).
2189 There are also separate configurable keybindings for indent &
2190 unindent, but this preference allows the tab key to have different
2191 meanings in different contexts - e.g. for snippet completion.
2193 Backspace key unindents
2194 If set, pressing backspace while the cursor is in leading whitespace
2195 will reduce the indentation level, unless the indentation mode is tabs.
2196 Otherwise, the backspace key will delete the character before the cursor.
2198 Editor Completions preferences
2199 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2201 .. image:: ./images/pref_dialog_edit_completions.png
2207 Whether to replace special keywords after typing Tab into a
2208 pre-defined text snippet.
2209 See `User-definable snippets`_.
2211 XML/HTML tag auto-closing
2212 When you open an XML/HTML tag automatically generate its
2215 Automatic continuation multi-line comments
2216 Continue automatically multi-line comments in languages like C, C++
2217 and Java when a new line is entered inside such a comment.
2218 With this option enabled, Geany will insert a ``*`` on every new line
2219 inside a multi-line comment, for example when you press return in the
2223 * This is a C multi-line comment, press <Return>
2225 then Geany would insert::
2229 on the next line with the correct indentation based on the previous line,
2230 as long as the multi-line is not closed by ``*/``. If the previous line
2231 has no ``*`` prefix, no ``*`` will be added to the new line.
2233 Autocomplete symbols
2234 When you start to type a symbol name, look for the full string to
2235 allow it to be completed for you.
2237 Autocomplete all words in document
2238 When you start to type a word, Geany will search the whole document for
2239 words starting with the typed part to complete it, assuming there
2240 are no symbol names to show.
2242 Drop rest of word on completion
2243 Remove any word part to the right of the cursor when choosing a
2244 completion list item.
2246 Characters to type for autocompletion
2247 Number of characters of a word to type before autocompletion is
2250 Completion list height
2251 The number of rows to display for the autocompletion window.
2253 Max. symbol name suggestions
2254 The maximum number of items in the autocompletion list.
2256 Symbol list update frequency
2257 The minimum delay (in milliseconds) between two symbol list updates.
2259 This option determines how frequently the symbol list is updated for the
2260 current document. The smaller the delay, the more up-to-date the symbol
2261 list (and then the completions); but rebuilding the symbol list has a
2262 cost in performance, especially with large files.
2264 The default value is 250ms, which means the symbol list will be updated
2265 at most four times per second, even if the document changes continuously.
2267 A value of 0 disables automatic updates, so the symbol list will only be
2268 updated upon document saving.
2271 Auto-close quotes and brackets
2272 ``````````````````````````````
2274 Geany can automatically insert a closing bracket and quote characters when
2275 you open them. For instance, you type a ``(`` and Geany will automatically
2276 insert ``)``. With the following options, you can define for which
2277 characters this should work.
2280 Auto-close parenthesis when typing an opening one
2283 Auto-close curly brackets (braces) when typing an opening one
2286 Auto-close square brackets when typing an opening one
2289 Auto-close single quotes when typing an opening one
2292 Auto-close double quotes when typing an opening one
2295 Editor Display preferences
2296 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2298 This is for visual elements displayed in the editor window.
2300 .. image:: ./images/pref_dialog_edit_display.png
2305 Invert syntax highlighting colors
2306 Invert all colors, by default this makes white text on a black
2309 Show indendation guides
2310 Show vertical lines to help show how much leading indentation there
2314 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2315 show which kinds of whitespace are used.
2318 Display a symbol everywhere that a carriage return or line feed
2321 Show only non-default line endings
2322 Shows line ending characters only when they differ from the
2323 file default line ending character.
2326 Show or hide the Line Number margin.
2329 Show or hide the small margin right of the line numbers, which is used
2332 Stop scrolling at last line
2333 When enabled Geany stops scrolling when at the last line of the document.
2334 Otherwise you can scroll one more page even if there are no real lines.
2336 Lines visible around the cursor
2337 The number of lines to maintain between the cursor and the top and bottom
2338 edges of the view. This allows some lines of context around the cursor to
2339 always be visible. If *Stop scrolling at last line* is disabled, the cursor
2340 will never reach the bottom edge when this value is greater than 0.
2346 The long line marker helps to indicate overly-long lines, or as a hint
2347 to the user for when to break the line.
2351 Show a thin vertical line in the editor window at the given column
2354 Change the background color of characters after the given column
2355 position to the color set below. (This is recommended over the
2356 *Line* setting if you use proportional fonts).
2358 Don't mark long lines at all.
2361 Set this value to a value greater than zero to specify the column
2362 where it should appear.
2364 Long line marker color
2365 Set the color of the long line marker.
2371 Virtual space is space beyond the end of each line.
2372 The cursor may be moved into virtual space but no real space will be
2373 added to the document until there is some text typed or some other
2374 text insertion command is used.
2377 Do not show virtual spaces
2379 Only for rectangular selections
2380 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2383 Always show virtual spaces beyond the end of lines
2389 .. image:: ./images/pref_dialog_files.png
2394 Open new documents from the command-line
2395 Whether to create new documents when passing filenames that don't
2396 exist from the command-line.
2398 Default encoding (new files)
2399 The type of file encoding you wish to use when creating files.
2401 Used fixed encoding when opening files
2402 Assume all files you are opening are using the type of encoding specified below.
2404 Default encoding (existing files)
2405 Opens all files with the specified encoding instead of auto-detecting it.
2406 Use this option when it's not possible for Geany to detect the exact encoding.
2408 Default end of line characters
2409 The end of line characters to which should be used for new files.
2410 On Windows systems, you generally want to use CR/LF which are the common
2411 characters to mark line breaks.
2412 On Unix-like systems, LF is default and CR is used on MAC systems.
2416 Perform formatting operations when a document is saved. These
2417 can each be undone with the Undo command.
2419 Ensure newline at file end
2420 Add a newline at the end of the document if one is missing.
2422 Ensure consistent line endings
2423 Ensures that newline characters always get converted before
2424 saving, avoiding mixed line endings in the same file.
2426 .. _Strip trailing spaces:
2428 Strip trailing spaces
2429 Remove any whitespace at the end of each document line.
2432 This does not apply to Diff documents, e.g. patch files.
2434 Replace tabs with spaces
2435 Replace all tabs in the document with the equivalent number of spaces.
2438 It is better to use spaces to indent than use this preference - see
2444 Recent files list length
2445 The number of files to remember in the recently used files list.
2448 The number of seconds to periodically check the current document's
2449 file on disk in case it has changed. Setting it to 0 will disable
2453 These checks are only performed on local files. Remote files are
2454 not checked for changes due to performance issues
2455 (remote files are files in ``~/.gvfs/``).
2461 .. image:: ./images/pref_dialog_tools.png
2467 The command to execute a script in a terminal. Occurrences of %c
2468 in the command are substituted with the run script name, see
2469 `Terminal emulators`_.
2472 The location of your web browser executable.
2475 The location of the grep executable.
2478 For Windows users: at the time of writing it is recommended to use
2479 the grep.exe from the UnxUtils project
2480 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2481 Mingw project for instance might not work with Geany at the moment.
2487 Set this to a command to execute on the current word.
2488 You can use the "%s" wildcard to pass the current word below the cursor
2489 to the specified command.
2492 Template preferences
2493 ^^^^^^^^^^^^^^^^^^^^
2496 This data is used as meta data for various template text to insert into
2497 a document, such as the file header. You only need to set fields that
2498 you want to use in your template files.
2500 .. image:: ./images/pref_dialog_templ.png
2504 See `Template meta data`_.
2507 The name of the developer who will be creating files.
2510 The initials of the developer.
2513 The email address of the developer.
2516 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2519 The company the developer is working for.
2522 The initial version of files you will be creating.
2525 Specify a format for the ``{year}`` wildcard.
2528 Specify a format for the ``{date}`` wildcard.
2531 Specify a format for the ``{datetime}`` wildcard.
2533 See `Date & time wildcards`_ for more information.
2536 Keybinding preferences
2537 ^^^^^^^^^^^^^^^^^^^^^^
2539 .. image:: ./images/pref_dialog_keys.png
2541 There are some commands listed in the keybinding dialog that are not, by default,
2542 bound to a key combination, and may not be available as a menu item.
2545 For more information see the section `Keybindings`_.
2548 Printing preferences
2549 ^^^^^^^^^^^^^^^^^^^^
2551 .. image:: ./images/pref_dialog_printing.png
2553 Use external command for printing
2554 Use a system command to print your file out.
2556 Use native GTK printing
2557 Let the GTK GUI toolkit handle your print request.
2560 Print the line numbers on the left of your paper.
2563 Print the page number on the bottom right of your paper.
2566 Print a header on every page that is sent to the printer.
2568 Use base name of the printed file
2569 Don't use the entire path for the header, only the filename.
2572 How the date should be printed. For a list of available conversion
2573 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
2579 .. image:: ./images/pref_dialog_various.png
2581 Rarely used preferences, explained in the table below. A few of them require
2582 restart to take effect, and a few other will only affect newly opened or created
2583 documents before restart.
2585 ================================ =========================================== ========== ===========
2586 Key Description Default Applies
2587 ================================ =========================================== ========== ===========
2588 **``editor`` group**
2589 use_gtk_word_boundaries Whether to look for the end of a word true to new
2590 when using word-boundary related documents
2591 Scintilla commands (see `Scintilla
2592 keyboard commands`_).
2593 brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
2594 complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
2595 when editing an existing line (i.e. there
2596 is some text after the current cursor
2597 position on the line). Only used when the
2598 keybinding `Complete snippet` is set to
2600 show_editor_scrollbars Whether to display scrollbars. If set to true immediately
2601 false, the horizontal and vertical
2602 scrollbars are hidden completely.
2603 indent_hard_tab_width The size of a tab character. Don't change 8 immediately
2604 it unless you really need to; use the
2605 indentation settings instead.
2606 editor_ime_interaction Input method editor (IME)'s candidate 0 to new
2607 window behaviour. May be 0 (windowed) or documents
2609 **``interface`` group**
2610 show_symbol_list_expanders Whether to show or hide the small true to new
2611 expander icons on the symbol list documents
2613 compiler_tab_autoscroll Whether to automatically scroll to the true immediately
2614 last line of the output in the Compiler
2616 statusbar_template The status bar statistics line format. See below. immediately
2617 (See `Statusbar Templates`_ for details).
2618 new_document_after_close Whether to open a new document after all false immediately
2619 documents have been closed.
2620 msgwin_status_visible Whether to show the Status tab in the true immediately
2622 msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
2624 msgwin_messages_visible Whether to show the Messages tab in the true immediately
2626 msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
2628 warn_on_project_close Whether to show a warning when opening true immediately
2629 a project while one is already open.
2630 **``terminal`` group**
2631 send_selection_unsafe By default, Geany strips any trailing false immediately
2632 newline characters from the current
2633 selection before sending it to the terminal
2634 to not execute arbitrary code. This is
2635 mainly a security feature.
2636 If, for whatever reasons, you really want
2637 it to be executed directly, set this option
2639 send_cmd_prefix String with which prefix the commands sent Empty immediately
2640 to the shell. This may be used to tell
2641 some shells (BASH with ``HISTCONTROL`` set
2642 to ``ignorespace``, ZSH with
2643 ``HIST_IGNORE_SPACE`` enabled, etc.) from
2644 putting these commands in their history by
2645 setting this to a space. Note that leading
2646 spaces must be escaped using `\s` in the
2649 allow_always_save Whether files can be saved always, even false immediately
2650 if they don't have any changes.
2651 By default, the Save button and menu
2652 item are disabled when a file is
2653 unchanged. When setting this option to
2654 true, the Save button and menu item are
2655 always active and files can be saved.
2656 use_atomic_file_saving Defines the mode how Geany saves files to false immediately
2657 disk. If disabled, Geany directly writes
2658 the content of the document to disk. This
2659 might cause loss of data when there is
2660 no more free space on disk to save the
2661 file. When set to true, Geany first saves
2662 the contents into a temporary file and if
2663 this succeeded, the temporary file is
2664 moved to the real file to save.
2665 This gives better error checking in case of
2666 no more free disk space. But it also
2667 destroys hard links of the original file
2668 and its permissions (e.g. executable flags
2669 are reset). Use this with care as it can
2670 break things seriously.
2671 The better approach would be to ensure your
2672 disk won't run out of free space.
2673 use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
2674 saving backend. It is better on most
2675 situations but is known not to work
2676 correctly on some complex setups.
2677 gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
2678 saving. Backup is named `filename~`.
2679 keep_edit_history_on_reload Whether to maintain the edit history when true immediately
2680 reloading a file, and allow the operation
2682 reload_clean_doc_on_file_change Whether to automatically reload documents false immediately
2683 that have no changes but which have changed
2685 If unsaved changes exist then the user is
2686 prompted to reload manually.
2687 save_config_on_file_change Automatically save Geany's configuration true immediately
2688 to disk once the document list changes
2689 (i.e. new documents are opened, saved or
2690 closed). This helps to prevent accidentally
2691 losing the session file list or other
2692 changed settings when Geany is not shut
2693 down cleanly. Disable this option if your
2694 configuration directory is on a slow drive,
2695 network share or similar and you experience
2697 extract_filetype_regex Regex to extract filetype name from file See link immediately
2698 via capture group one.
2699 See `ft_regex`_ for default.
2700 **``search`` group**
2701 find_selection_type See `Find selection`_. 0 immediately
2702 replace_and_find_by_default Set ``Replace & Find`` button as default so true immediately
2703 it will be activated when the Enter key is
2704 pressed while one of the text fields has
2707 number_ft_menu_items The maximum number of menu items in the 2 on restart
2708 filetype build section of the Build menu.
2709 number_non_ft_menu_items The maximum number of menu items in the 3 on restart
2710 independent build section.
2711 number_exec_menu_items The maximum number of menu items in the 2 on restart
2712 execute section of the Build menu.
2713 **``socket`` group**
2714 socket_remote_cmd_port TCP port number to be used for inter 2 on restart
2715 process communication (i.e. with other
2716 Geany instances, e.g. "Open with Geany").
2717 Only available on Windows, valid port
2718 range: 1024 to 65535.
2719 ================================ =========================================== ========== ===========
2724 The default statusbar template is (note ``\t`` = tab):
2726 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mEOL: %M encoding: %e filetype: %f scope: %S``
2728 Settings the preference to an empty string will also cause Geany to use this
2731 The following format characters are available for the statusbar template:
2733 ============ ===========================================================
2734 Placeholder Description
2735 ============ ===========================================================
2736 ``%l`` The current line number starting at 1
2737 ``%L`` The total number of lines
2738 ``%c`` The current column number starting at 0, including virtual
2740 ``%C`` The current column number starting at 1, including virtual
2742 ``%s`` The number of selected characters or if only whole lines
2743 selected, the number of selected lines.
2744 ``%n`` The number of selected characters, even if only whole lines
2746 ``%w`` Shows ``RO`` when the document is in read-only mode,
2747 otherwise shows whether the editor is in overtype (OVR)
2748 or insert (INS) mode.
2749 ``%t`` Shows the indentation mode, either tabs (TAB),
2750 spaces (SP) or both (T/S).
2751 ``%m`` Shows whether the document is modified (MOD) or nothing.
2752 ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
2753 ``%e`` The name of the document's encoding (ex. UTF-8).
2754 ``%f`` The filetype of the document (ex. None, Python, C, etc).
2755 ``%S`` The name of the scope where the caret is located.
2756 ``%p`` The caret position in the entire document starting at 0.
2757 ``%r`` Shows whether the document is read-only (RO) or nothing.
2758 ``%Y`` The Scintilla style number at the caret position. This is
2759 useful if you're debugging color schemes or related code.
2760 ============ ===========================================================
2762 Terminal (VTE) preferences
2763 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2765 See also: `Virtual terminal emulator widget (VTE)`_.
2767 .. image:: ./images/pref_dialog_vte.png
2773 Select the font that will be used in the terminal emulation control.
2776 Select the font color.
2779 Select the background color of the terminal.
2782 Select the background image to show behind the terminal's text.
2785 The number of lines buffered so that you can scroll though the history.
2788 The location of the shell on your system.
2791 Scroll the terminal to the prompt line when pressing a key.
2794 Scroll the output down.
2797 Let the terminal cursor blink.
2799 Override Geany keybindings
2800 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2802 Disable menu shortcut key (F10 by default)
2803 Disable the menu shortcut when you are in the virtual terminal.
2805 Follow path of the current file
2806 Make the path of the terminal change according to the path of the
2809 Execute programs in VTE
2810 Execute programs in the virtual terminal instead of using the external
2811 terminal tool. Note that if you run multiple execute commands at once
2812 the output may become mixed together in the VTE.
2814 Don't use run script
2815 Don't use the simple run script which is usually used to display
2816 the exit status of the executed program.
2817 This can be useful if you already have a program running in the VTE
2818 like a Python console (e.g. ipython). Use this with care.
2824 Project management is optional in Geany. Currently it can be used for:
2826 * Storing and opening session files on a project basis.
2827 * Overriding default settings with project equivalents.
2828 * Configuring the Build menu on a project basis.
2830 A list of session files can be stored and opened with the project
2831 when the *Use project-based session files* preference is enabled,
2832 in the `Projects`_ group of the `General Miscellaneous preferences`_ tab
2833 of the `Preferences`_ dialog.
2835 As long as a project is open, the Build menu will use
2836 the items defined in project's settings, instead of the defaults.
2837 See `Build Menu Configuration`_ for information on configuring the menu.
2839 The current project's settings are saved when it is closed, or when
2840 Geany is shutdown. When restarting Geany, the previously opened project
2841 file that was in use at the end of the last session will be reopened.
2843 The project menu items are detailed below.
2849 There are two ways of creating new projects, either by using
2850 *Project->New* menu item or by using *Project->New from Folder* menu
2854 This method is more suitable for creating new, empty projects from
2855 scratch at the default location without having any existing sources.
2857 To create a new project, fill in the *Name* field. By default this
2858 will setup a new project file ``~/projects/name/name.geany``.
2860 The *Base path* text field is setup to use ``~/projects/name``. This
2861 can safely be set to any existing path -- it will not touch the file
2862 structure contained in it.
2865 This method is more suitable when there is already some folder
2866 containing source files for which you want to create a new project.
2868 When using this method, Geany first opens a directory selection
2869 dialog to select the folder containing the sources, and the
2870 *Base path* field is set to that value.
2872 Afterwards, Geany shows the same dialog as the *Project->New*
2873 method but already pre-filled with the values based on the
2874 *Base path* selection. The *Name* field is filled with the folder
2875 name, the *Filename* field is filled with
2876 ``base_path/name.geany`` and the *Base path* field is filled with
2877 the path specified in the previous dialog.
2883 You can set an optional description for the project. Currently it's
2884 only used for the ``{description}}`` template wildcard - see `Dynamic wildcards`_.
2886 The *Base path* field is used as the directory to run the Build menu commands.
2887 The specified path can be an absolute path or it is considered to be
2888 relative to the project's file name.
2890 The *File patterns* field allows to specify a list of file patterns for the
2891 project, which can be used in the `Find in files`_ dialog.
2893 The *Indentation* tab allows you to override the default
2894 `Indentation`_ settings.
2900 The Open command displays a standard file chooser, starting in
2901 ``~/projects``. Choose a project file named with the ``.geany``
2904 When project session support is enabled, Geany will close the currently
2905 open files and open the session files associated with the project.
2911 Project file settings are saved when the project is closed.
2913 When project session support is enabled, Geany will close the project
2914 session files and open any previously closed default session files.
2919 After editing code with Geany, the next step is to compile, link, build,
2920 interpret, run etc. As Geany supports many languages each with a different
2921 approach to such operations, and as there are also many language independent
2922 software building systems, Geany does not have a built-in build system, nor
2923 does it limit which system you can use. Instead the build menu provides
2924 a configurable and flexible means of running any external commands to
2925 execute your preferred build system.
2927 This section provides a description of the default configuration of the
2928 build menu and then covers how to configure it, and where the defaults fit in.
2930 Running the commands from within Geany has two benefits:
2932 * The current file is automatically saved before the command is run.
2933 * The output is captured in the Compiler notebook tab and parsed for
2936 Warnings and errors that can be parsed for line numbers will be shown in
2937 red in the Compiler tab and you can click on them to switch to the relevant
2938 source file (or open it) and mark the line number. Also lines with
2939 warnings or errors are marked in the source, see `Indicators`_ below.
2942 If Geany's default error message parsing does not parse errors for
2943 the tool you're using, you can set a custom regex in the
2944 `Set Build Commands dialog`_, see `Build Menu Configuration`_.
2949 Indicators are red squiggly underlines which are used to highlight
2950 errors which occurred while compiling the current file. So you can
2951 easily see where your code failed to compile. You can remove them by
2952 selecting *Remove Error Indicators* in the Document menu.
2954 If you do not like this feature, you can disable it - see `Editor Features
2958 Default build menu items
2959 ^^^^^^^^^^^^^^^^^^^^^^^^
2960 Depending on the current file's filetype, the default Build menu will contain
2961 the following items:
2967 * Make Custom Target
2972 * Set Build Menu Commands
2978 The Compile command has different uses for different kinds of files.
2980 For compilable languages such as C and C++, the Compile command is
2981 set up to compile the current source file into a binary object file.
2983 Java source files will be compiled to class file bytecode.
2985 Interpreted languages such as Perl, Python, Ruby will compile to
2986 bytecode if the language supports it, or will run a syntax check,
2987 or if that is not available will run the file in its language interpreter.
2992 For compilable languages such as C and C++, the Build command will link
2993 the current source file's equivalent object file into an executable. If
2994 the object file does not exist, the source will be compiled and linked
2995 in one step, producing just the executable binary.
2997 Interpreted languages do not use the Build command.
3000 If you need complex settings for your build system, or several
3001 different settings, then writing a Makefile and using the Make
3002 commands is recommended; this will also make it easier for users to
3003 build your software.
3008 Source code linters are often used to find code that doesn't correspond to
3009 certain style guidelines: non-portable code, common or hard to find
3010 errors, code "smells", variables used before being set, unused functions,
3011 division by zero, constant conditions, etc. Linters inspect the code and
3012 issue warnings much like the compilers do. This is formally referred to as
3013 static code analysis.
3015 Some common linters are pre-configured for you in the Build menu (``pep8``
3016 for Python, ``cppcheck`` for C/C++, JSHint for JavaScript, ``xmllint`` for
3017 XML, ``hlint`` for Haskell, ``shellcheck`` for shell code, ...), but all
3018 these are standalone tools you need to obtain before using.
3023 This runs "make" in the same directory as the
3029 This is similar to running 'Make' but you will be prompted for
3030 the make target name to be passed to the Make tool. For example,
3031 typing 'clean' in the dialog prompt will run "make clean".
3037 Make object will run "make current_file.o" in the same directory as
3038 the current file, using the filename for 'current_file'. It is useful
3039 for building just the current file without building the whole project.
3044 The next error item will move to the next detected error in the file.
3048 The previous error item will move to the previous detected error in the file.
3053 Execute will run the corresponding executable file, shell script or
3054 interpreted script in a terminal window. The command set in the
3055 `Set Build Commands dialog`_ is run in a script to ensure the terminal
3056 stays open after execution completes. Note: see `Terminal emulators`_
3057 below for the command format. Alternatively the built-in VTE can be used
3058 if it is available - see `Virtual terminal emulator widget (VTE)`_.
3060 After your program or script has finished executing, the run script will
3061 prompt you to press the return key. This allows you to review any text
3062 output from the program before the terminal window is closed.
3065 The execute command output is not parsed for errors.
3068 Stopping running processes
3069 ``````````````````````````
3071 When there is a running program, the Execute menu item in the menu and
3072 the Run button in the toolbar
3073 each become a stop button so you can stop the current running program (and
3074 any child processes). This works by sending the SIGQUIT signal to the process.
3076 Depending on the process you started it is possible that the process
3077 cannot be stopped. For example this can happen when the process creates
3078 more than one child process.
3084 The Terminal field of the tools preferences tab requires a command to
3085 execute the terminal program and to pass it the name of the Geany run
3086 script that it should execute in a Bourne compatible shell (eg /bin/sh).
3087 The marker "%c" is substituted with the name of the Geany run script,
3088 which is created in the temporary directory and which changes the working
3089 directory to the directory set in the `Set Build Commands dialog`_.
3091 As an example the default (Linux) command is::
3093 xterm -e "/bin/sh %c"
3099 By default Compile, Build and Execute are fairly basic commands. You
3100 may wish to customise them using *Set Build Commands*.
3102 E.g. for C you can add any include paths and compile flags for the
3103 compiler, any library names and paths for the linker, and any
3104 arguments you want to use when running Execute.
3106 Build menu configuration
3107 ^^^^^^^^^^^^^^^^^^^^^^^^
3109 The build menu has considerable flexibility and configurability, allowing
3110 menu labels, the commands they execute and the directory they execute
3111 in to be configured. For example, if you change one of the default make
3112 commands to run say 'waf' you can also change the label to match.
3113 These settings are saved automatically when Geany is shut down.
3115 The build menu is divided into four groups of items each with different
3118 * Filetype build commands - are configurable and depend on the filetype of the
3119 current document; they capture output in the compiler tab and parse it for
3121 * Independent build commands - are configurable and mostly don't depend on the
3122 filetype of the current document; they also capture output in the
3123 compiler tab and parse it for errors.
3124 * Execute commands - are configurable and intended for executing your
3125 program or other long running programs. The output is not parsed for
3126 errors and is directed to the terminal command selected in `Tools
3128 * Fixed commands - these perform built-in actions:
3130 * Go to the next error.
3131 * Go to the previous error.
3132 * Show the build menu commands dialog.
3134 The maximum numbers of items in each of the configurable groups can be
3135 configured in `Various preferences`_. Even though the maximum number of
3136 items may have been increased, only those menu items that have commands
3137 configured are shown in the menu.
3139 The groups of menu items obtain their configuration from four potential
3140 sources. The highest priority source that has the menu item defined will
3141 be used. The sources in decreasing priority are:
3143 * A project file if open
3144 * The user preferences
3145 * The system filetype definitions
3148 The detailed relationships between sources and the configurable menu item groups
3149 is shown in the following table:
3151 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3152 | Group | Project File | Preferences | System Filetype | Defaults |
3153 +==============+=====================+==========================+===================+===============================+
3154 | Filetype | Loads From: project | Loads From: | Loads From: | None |
3155 | Build | file | filetypes.xxx file in | filetypes.xxx in | |
3156 | | | ~/.config/geany/filedefs | Geany install | |
3157 | | Saves To: project | | | |
3158 | | file | Saves to: as above, | Saves to: as user | |
3159 | | | creating if needed. | preferences left. | |
3160 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3161 | Independent | Loads From: project | Loads From: | Loads From: | 1: |
3162 | Build | file | geany.conf file in | filetypes.xxx in | Label: _Make |
3163 | | | ~/.config/geany | Geany install | Command: make |
3164 | | Saves To: project | | | |
3165 | | file | Saves to: as above, | Saves to: as user | 2: |
3166 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
3167 | | | | | Command: make |
3170 | | | | | Label: Make _Object |
3171 | | | | | Command: make %e.o |
3172 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3173 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
3174 | | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
3175 | | filetype defined in | ~/.config/geany or else | Geany install | |
3176 | | project file | filetypes.xxx file in | | |
3177 | | | ~/.config/geany/filedefs | Saves To: as user | |
3178 | | Saves To: | | preferences left. | |
3179 | | project file | Saves To: | | |
3180 | | | filetypes.xxx file in | | |
3181 | | | ~/.config/geany/filedefs | | |
3182 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3184 The following notes on the table may reference cells by coordinate as *(group, source)*:
3186 * Filetype filenames - for filetypes.xxx substitute the appropriate extension for
3187 the filetype of the current document for xxx - see `filenames`_.
3189 * System Filetypes - Labels loaded from these sources are locale sensitive
3190 and can contain translations.
3192 * *(Filetype build, Project and Preferences)* - preferences use a full
3193 filetype file so that users can configure all other filetype preferences
3194 as well. Projects can only configure menu items per filetype. Saving
3195 in the project file means that there is only one file per project not
3198 * *(Filetype-Independent build, System Filetype)* - although conceptually strange, defining
3199 filetype-independent commands in a filetype file, this provides the ability to
3200 define filetype dependent default menu items.
3202 * *(Execute, Project and Preferences)* - the project independent
3203 execute and preferences independent execute commands can only be set by hand
3204 editing the appropriate file, see `Preferences file format`_ and `Project file
3207 Set Build Commands dialog
3208 ^^^^^^^^^^^^^^^^^^^^^^^^^
3210 Most of the configuration of the build menu is done through the `Set
3211 Build Commands dialog`_. When no project is open, you can edit the
3212 configuration sourced from user preferences using the *Build->Set Build
3213 Commands* menu item. You can edit the configuration sourced from a
3214 project in the *Build* tab of the `Project Properties`_ dialog. The
3215 former menu item also shows the project dialog when a project is open.
3216 Both use the same form shown below.
3218 .. image:: ./images/build_menu_commands_dialog.png
3220 The dialog is divided into three sections:
3222 * Filetype build commands (selected based on the current document's filetype).
3223 * Independent build commands (available regardless of filetype).
3224 * Filetype execute commands.
3226 The filetype and independent build sections also each contain a field for the regular
3227 expression used for parsing command output for error and warning messages.
3229 The columns in the first three sections allow setting of the label, command,
3230 and working directory to run the command in. An item with an empty
3231 label will not be shown in the menu. An empty working directory will
3232 default to the directory of the current document.
3234 If there is no current document then the command will not run.
3236 The dialog will always show the command selected by priority, not just the
3237 commands configured in this configuration source. This ensures that you always
3238 see what the menu item is going to do if activated.
3240 If the current source of the menu item is higher priority than the
3241 configuration source you are editing then the command will be shown
3242 in the dialog but will be insensitive (greyed out). This can't happen
3243 with the project source but can with the preferences source dialog.
3245 The clear buttons remove the definition from the configuration source you are editing.
3246 When you do this the command from the next lower priority source will be shown.
3247 To hide lower priority menu items without having anything show in the menu,
3248 configure with nothing in the label but at least one character in the command.
3250 Substitutions in commands and working directories
3251 `````````````````````````````````````````````````
3253 Before the command is run, the first occurrence of each of the following
3254 two character sequences in each of the command and working directory
3255 fields is substituted by the items specified below:
3257 * %d - the absolute path to the directory of the current file.
3258 * %e - the name of the current file without the extension or path.
3259 * %f - the name of the current file without the path.
3260 * %p - if a project is open, the base path from the project.
3261 * %l - the line number at the current cursor position.
3264 If the base path set in `Project Properties`_ is not an absolute path, then it is
3265 taken as relative to the directory of the project file. This allows a project file
3266 stored in the source tree to specify all commands and working directories relative
3267 to the tree itself, so that the whole tree including the project file, can be moved
3268 and even checked into and out of version control without having to re-configure the
3271 Build menu keyboard shortcuts
3272 `````````````````````````````
3274 Keyboard shortcuts can be defined for:
3276 * the first two filetype build menu items
3277 * the first three independent build menu items
3278 * the first execute menu item
3279 * the fixed menu items (Next/Previous Error, Set Commands)
3281 In the keybindings configuration dialog (see `Keybinding preferences`_)
3282 these items are identified by the default labels shown in the `Build Menu`_ section above.
3284 It is currently not possible to bind keyboard shortcuts to more than these menu items.
3285 You can also use underlines in the labels to set mnemonic characters.
3289 The configurable Build Menu capability was introduced in Geany 0.19 and
3290 required a new section to be added to the configuration files (See
3291 `Preferences file format`_). Geany will still load older format project,
3292 preferences and filetype file settings and will attempt to map them into the new
3293 configuration format. There is not a simple clean mapping between the formats.
3294 The mapping used produces the most sensible results for the majority of cases.
3295 However, if they do not map the way you want, you may have to manually
3296 configure some settings using the `Set Build Commands dialog`_.
3298 Any setting configured in either of these dialogs will override settings mapped from
3299 older format configuration files.
3304 Since Geany 0.13 there has been printing support using GTK's printing API.
3305 The printed page(s) will look nearly the same as on your screen in Geany.
3306 Additionally, there are some options to modify the printed page(s).
3309 The background text color is set to white, except for text with
3310 a white foreground. This allows dark color schemes to save ink
3313 You can define whether to print line numbers, page numbers at the bottom of
3314 each page and whether to print a page header on each page. This header
3315 contains the filename of the printed document, the current page number and
3316 the date and time of printing. By default, the file name of the document
3317 with full path information is added to the header. If you prefer to add
3318 only the basename of the file(without any path information) you can set it
3319 in the preferences dialog. You can also adjust the format of the date and
3320 time added to the page header. For a list of available conversion
3321 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
3323 All of these settings can also be changed in the print dialog just before
3324 actual printing is done.
3325 On Unix-like systems the provided print dialog offers a print preview. The
3326 preview file is opened with a PDF viewer and by default GTK uses ``evince``
3327 for print preview. If you have not installed evince or just want to use
3328 another PDF viewer, you can change the program to use in the file
3329 ``settings.ini`` (usually found in ``~/.config/gtk-3.0``, see the
3330 `GTK documentation`_). For example, use::
3333 gtk-print-preview-command = epdfview %f
3335 Of course, you can also use xpdf, kpdf or whatever as the print preview
3336 command. That command should ideally delete the temporary file referenced by
3337 ``%f``. See the `GTK documentation for the setting`_ for more details.
3339 .. _GTK documentation: https://developer.gnome.org/gtk3/stable/GtkSettings.html#GtkSettings.description
3340 .. _GTK documentation for the setting: https://developer.gnome.org/gtk3/stable/GtkSettings.html#GtkSettings--gtk-print-preview-command
3343 Geany also provides an alternative basic printing support using a custom
3344 print command. However, the printed document contains no syntax highlighting.
3345 You can adjust the command to which the filename is passed in the preferences
3346 dialog. The default command is::
3350 ``%f`` will be substituted by the filename of the current file. Geany
3351 will not show errors from the command itself, so you should make
3352 sure that it works before(e.g. by trying to execute it from the
3355 A nicer example, which many prefer is::
3357 % a2ps -1 --medium=A4 -o - %f | xfprint4
3359 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3360 gtklp or similar programs can be used.
3367 Plugins are loaded at startup, if the *Enable plugin support*
3368 general preference is set. There is also a command-line option,
3369 ``-p``, which prevents plugins being loaded. Plugins are scanned in
3370 the following directories:
3372 * ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
3373 * The ``lib`` subfolder of the installation path on Windows.
3374 * The ``plugins`` subfolder of the user configuration directory - see
3375 `Configuration file paths`_.
3376 * The `Extra plugin path` preference (usually blank) - see `Paths`_.
3378 Most plugins add menu items to the *Tools* menu when they are loaded.
3380 See also `Plugin documentation`_ for information about single plugins
3381 which are included in Geany.
3385 The Plugin Manager dialog lets you choose which plugins
3386 should be loaded at startup. You can also load and unload plugins on the
3387 fly using this dialog. Once you click the checkbox for a specific plugin
3388 in the dialog, it is loaded or unloaded according to its previous state.
3389 By default, no plugins are loaded at startup until you select some.
3390 You can also configure some plugin specific options if the plugin
3397 Geany supports the default keyboard shortcuts for the Scintilla
3398 editing widget. For a list of these commands, see `Scintilla
3399 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
3400 by any custom keybindings with the same keyboard shortcut.
3406 There are some non-configurable bindings to switch between documents,
3407 listed below. These can also be overridden by custom keybindings.
3409 =============== ==================================
3411 =============== ==================================
3412 Alt-[1-9] Select left-most tab, from 1 to 9.
3413 Alt-0 Select right-most tab.
3414 =============== ==================================
3416 See also `Notebook tab keybindings`_.
3419 Configurable keybindings
3420 ^^^^^^^^^^^^^^^^^^^^^^^^
3422 For all actions listed below you can define your own keybindings. Open
3423 the Preferences dialog, select the desired action and click on
3424 change. In the resulting dialog you can press the key combination you
3425 want to assign to the action and it will be saved when you press OK.
3426 You can define only one key combination for each action and each key
3427 combination can only be defined for one action.
3429 The following tables list all customizable keyboard shortcuts, those
3430 which are common to many applications are marked with (C) after the
3435 =============================== ========================= ==================================================
3436 Action Default shortcut Description
3437 =============================== ========================= ==================================================
3438 New Ctrl-N (C) Creates a new file.
3440 Open Ctrl-O (C) Opens a file.
3442 Open selected file Ctrl-Shift-O Opens the selected filename.
3444 Re-open last closed tab Re-opens the last closed document tab.
3446 Save Ctrl-S (C) Saves the current file.
3448 Save As Saves the current file under a new name.
3450 Save all Ctrl-Shift-S Saves all open files.
3452 Close all Ctrl-Shift-W Closes all open files.
3454 Close Ctrl-W (C) Closes the current file.
3456 Reload file Ctrl-R (C) Reloads the current file.
3458 Reload all Reloads all open files. If the reload will not be 'undo'-able and changes that will be lost are detected (unsaved or saved) the reload will be confirmed, otherwise the reload will proceed without confirmation.
3460 Print Ctrl-P (C) Prints the current file.
3462 Quit Ctrl-Q (C) Quits Geany.
3463 =============================== ========================= ==================================================
3468 =============================== ========================= ==================================================
3469 Action Default shortcut Description
3470 =============================== ========================= ==================================================
3471 Undo Ctrl-Z (C) Un-does the last action.
3473 Redo Ctrl-Y Re-does the last action.
3475 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3478 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3479 end of the current line.
3481 Delete to line start Ctrl-Shift-BackSpace Deletes from the beginning of the line to the
3482 current caret position.
3484 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3486 Transpose current line Transposes the current line with the previous one.
3488 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3489 view. The cursor position and or an existing
3490 selection will not be changed.
3492 Scroll up by one line Alt-Up Scrolls the view.
3494 Scroll down by one line Alt-Down Scrolls the view.
3496 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3497 symbol completion, it shows document word completion
3498 instead, even if it is not enabled for automatic
3499 completion. Likewise if no symbol suggestions are
3500 available, it shows document word completion.
3502 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3505 Complete snippet Tab If you type a keyword like ``if`` or ``for`` and press
3506 this key, it will be completed with a matching
3507 template - see `User-definable snippets`_.
3509 Suppress snippet completion If you type a construct like ``if`` or ``for`` and press
3510 this key, it will not be completed, and a space or
3511 tab will be inserted, depending on what the
3512 construct completion keybinding is set to. For
3513 example, if you have set the construct completion
3514 keybinding to a space, then setting this to
3515 Shift+space will prevent construct completion and
3518 Context Action Executes a command and passes the current word
3519 (near the cursor position) or selection as an
3520 argument. See the section called `Context
3523 Move cursor in snippet Jumps to the next defined cursor positions in a
3524 completed snippets if multiple cursor positions
3527 Word part completion Tab When the autocompletion list is visible, complete
3528 the currently selected item up to the next word
3531 Move line(s) up Alt-PageUp Move the current line or selected lines up by
3534 Move line(s) down Alt-PageDown Move the current line or selected lines down by
3536 =============================== ========================= ==================================================
3539 Clipboard keybindings
3540 `````````````````````
3541 =============================== ========================= ==================================================
3542 Action Default shortcut Description
3543 =============================== ========================= ==================================================
3544 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3546 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3548 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3550 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3551 selection) to the clipboard.
3553 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3554 selection) to the clipboard.
3555 =============================== ========================= ==================================================
3560 =============================== ========================= ==================================================
3561 Action Default shortcut Description
3562 =============================== ========================= ==================================================
3563 Select all Ctrl-A (C) Makes a selection of all text in the current
3566 Select current word Alt-Shift-W Selects the current word under the cursor.
3568 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3569 which is defined by two empty lines around it.
3571 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3572 partially selected lines).
3574 Select to previous word part (Extend) selection to previous word part boundary.
3576 Select to next word part (Extend) selection to next word part boundary.
3577 =============================== ========================= ==================================================
3582 =============================== ========================= ==================================================
3583 Action Default shortcut Description
3584 =============================== ========================= ==================================================
3585 Insert date Shift-Alt-D Inserts a customisable date.
3587 Insert alternative whitespace Inserts a tab character when spaces should
3588 be used for indentation and inserts space
3589 characters of the amount of a tab width when
3590 tabs should be used for indentation.
3592 Insert New Line Before Current Inserts a new line with indentation.
3594 Insert New Line After Current Inserts a new line with indentation.
3595 =============================== ========================= ==================================================
3600 =============================== ========================= ==================================================
3601 Action Default shortcut Description
3602 =============================== ========================= ==================================================
3603 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3604 selection will be changed into uppercase and vice
3605 versa. If the selection contains lower- and
3606 uppercase characters, all will be converted to
3609 Comment line Comments current line or selection.
3611 Uncomment line Uncomments current line or selection.
3613 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3614 a comment if the line is commented.
3616 Increase indent Ctrl-I Indents the current line or selection by one tab
3617 or with spaces in the amount of the tab width
3620 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3621 the tab width setting from the indentation of the
3622 current line or selection.
3624 Increase indent by one space Indents the current line or selection by one
3627 Decrease indent by one space Deindents the current line or selection by one
3630 Smart line indent Indents the current line or all selected lines
3631 with the same indentation as the previous line.
3633 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3634 external command (available for the first
3635 9 configured commands, see
3636 `Sending text through custom commands`_ for
3639 Send Selection to Terminal Sends the current selection or the current
3640 line (if there is no selection) to the
3641 embedded Terminal (VTE).
3643 Reflow lines/block Reformat selected lines or current
3644 (indented) text block,
3645 breaking lines at the long line marker or the
3646 line breaking column if line breaking is
3647 enabled for the current document.
3649 Join Lines Replace line endings and following indentation
3650 with a single space throughout the selection
3651 or current (indented) text block.
3652 =============================== ========================= ==================================================
3655 Settings keybindings
3656 ````````````````````
3657 =============================== ========================= ==================================================
3658 Action Default shortcut Description
3659 =============================== ========================= ==================================================
3660 Preferences Ctrl-Alt-P Opens preferences dialog.
3662 Plugin Preferences Opens plugin preferences dialog.
3663 =============================== ========================= ==================================================
3668 =============================== ========================= ==================================================
3669 Action Default shortcut Description
3670 =============================== ========================= ==================================================
3671 Find Ctrl-F (C) Opens the Find dialog.
3673 Find Next Ctrl-G Finds next result.
3675 Find Previous Ctrl-Shift-G Finds previous result.
3677 Find Next Selection Finds next occurrence of selected text.
3679 Find Previous Selection Finds previous occurrence of selected text.
3681 Replace Ctrl-H (C) Opens the Replace dialog.
3683 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3685 Next message Jumps to the line with the next message in
3686 the Messages window.
3688 Previous message Jumps to the line with the previous message
3689 in the Messages window.
3691 Find Usage Ctrl-Shift-E Finds all occurrences of the current word
3692 or selection (see note below) in all open
3693 documents and displays them in the messages
3696 Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word
3697 or selection (see note below) in the current
3698 document and displays them in the messages
3701 Mark All Ctrl-Shift-M Highlight all matches of the current
3702 word/selection (see note below) in the current
3703 document with a colored box. If there's nothing
3704 to find, or the cursor is next to an existing
3705 match, the highlighted matches will be cleared.
3706 =============================== ========================= ==================================================
3709 The keybindings marked "see note below" work like this: if no text is
3710 selected, the word under cursor is used, and *it has to match fully*
3711 (like when `Match only a whole word` is enabled in the Search dialog).
3712 However if some text is selected, then it is matched regardless of
3718 =============================== ========================= ==================================================
3719 Action Default shortcut Description
3720 =============================== ========================= ==================================================
3721 Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
3722 history. See the section called `Code Navigation
3725 Navigate back a location Alt-Left (C) Switches to the previous location in the
3726 navigation history. See the section called
3727 `Code navigation history`_.
3729 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3730 shows the Go to line dialog.
3732 Go to matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3733 is moved to the brace which belongs to the current
3734 one. If this keyboard shortcut is pressed again,
3735 the cursor is moved back to the first brace.
3737 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3738 marker if there already is one.
3740 Go to next marker Ctrl-. Go to the next marker in the current document.
3742 Go to previous marker Ctrl-, Go to the previous marker in the current document.
3744 Go to symbol definition Ctrl-T Jump to the definition of the current word or
3745 selection. See `Go to symbol definition`_.
3747 Go to symbol declaration Ctrl-Shift-T Jump to the declaration of the current word or
3748 selection. See `Go to symbol declaration`_.
3750 Go to Start of Line Home Move the caret to the start of the line.
3751 Behaves differently if smart_home_key_ is set.
3753 Go to End of Line End Move the caret to the end of the line.
3755 Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
3756 This is useful when you use line wrapping and
3757 want to jump to the start of the wrapped, virtual
3758 line, not the real start of the whole line.
3759 If the line is not wrapped, it behaves like
3760 `Go to Start of Line`.
3762 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3763 If the line is not wrapped, it behaves like
3764 `Go to End of Line`.
3766 Go to Previous Word Part Ctrl-/ Go to the previous part of the current word.
3768 Go to Next Word Part Ctrl-\\ Go to the next part of the current word.
3769 =============================== ========================= ==================================================
3773 =============================== ========================= ==================================================
3774 Action Default shortcut Description
3775 =============================== ========================= ==================================================
3776 Fullscreen F11 (C) Switches to fullscreen mode.
3778 Toggle Messages Window Toggles the message window (status and compiler
3779 messages) on and off.
3781 Toggle Sidebar Shows or hides the sidebar.
3783 Toggle all additional widgets Hide and show all additional widgets like the
3784 notebook tabs, the toolbar, the messages window
3787 Zoom In Ctrl-+ (C) Zooms in the text.
3789 Zoom Out Ctrl-- (C) Zooms out the text.
3791 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3792 =============================== ========================= ==================================================
3796 ================================ ========================= ==================================================
3797 Action Default shortcut Description
3798 ================================ ========================= ==================================================
3799 Switch to Editor F2 Switches to editor widget.
3800 Also reshows the document statistics line
3801 (after a short timeout).
3803 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3806 Switch to Message Window Focus the Message Window's current tab.
3808 Switch to Compiler Focus the Compiler message window tab.
3810 Switch to Messages Focus the Messages message window tab.
3812 Switch to Scribble F6 Switches to scribble widget.
3814 Switch to VTE F4 Switches to VTE widget.
3816 Switch to Sidebar Focus the Sidebar.
3818 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3821 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3823 ================================ ========================= ==================================================
3826 Notebook tab keybindings
3827 ````````````````````````
3828 =============================== ========================= ==================================================
3829 Action Default shortcut Description
3830 =============================== ========================= ==================================================
3831 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3833 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3835 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3837 Holding Ctrl (or another modifier if the keybinding
3838 has been changed) will show a dialog, then repeated
3839 presses of the keybinding will switch to the 2nd-last
3840 used document, 3rd-last, etc. Also known as
3841 Most-Recently-Used documents switching.
3843 Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
3846 Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
3849 Move document first Moves the current document to the first position.
3851 Move document last Moves the current document to the last position.
3852 =============================== ========================= ==================================================
3855 Document keybindings
3856 ````````````````````
3857 ==================================== ==================== ==================================================
3858 Action Default shortcut Description
3859 ==================================== ==================== ==================================================
3860 Clone See `Cloning documents`_.
3862 Replace tabs with space Replaces all tabs with the right amount of spaces
3863 in the whole document, or the current selection.
3865 Replace spaces with tabs Replaces leading spaces with tab characters in the
3866 whole document, or the current selection.
3868 Toggle current fold Toggles the folding state of the current code block.
3870 Fold all Folds all contractible code blocks.
3872 Unfold all Unfolds all contracted code blocks.
3874 Reload symbol list Ctrl-Shift-R Reloads the symbol list.
3876 Toggle Line wrapping Enables or disables wrapping of long lines.
3878 Toggle Line breaking Enables or disables automatic breaking of long
3879 lines at a configurable column.
3881 Remove Markers Remove any markers on lines or words which
3882 were set by using 'Mark All' in the
3883 search dialog or by manually marking lines.
3885 Remove Error Indicators Remove any error indicators in the
3888 Remove Markers and Error Indicators Combines ``Remove Markers`` and
3889 ``Remove Error Indicators``.
3890 ==================================== ==================== ==================================================
3895 =============================== ========================= ==================================================
3896 Action Default shortcut Description
3897 =============================== ========================= ==================================================
3898 New Create a new project.
3899 Open Opens a project file.
3900 Properties Shows project properties.
3901 Close Close the current project.
3902 =============================== ========================= ==================================================
3907 =============================== ========================= ==================================================
3908 Action Default shortcut Description
3909 =============================== ========================= ==================================================
3910 Compile F8 Compiles the current file.
3912 Build F9 Builds (compiles if necessary and links) the
3915 Make all Shift-F9 Builds the current file with the Make tool.
3917 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3920 Make object Shift-F8 Compiles the current file with the Make tool.
3922 Next error Jumps to the line with the next error from the
3925 Previous error Jumps to the line with the previous error from
3926 the last build process.
3928 Run F5 Executes the current file in a terminal emulation.
3930 Set Build Commands Opens the build commands dialog.
3931 =============================== ========================= ==================================================
3936 =============================== ========================= ==================================================
3937 Action Default shortcut Description
3938 =============================== ========================= ==================================================
3939 Show Color Chooser Opens the Color Chooser dialog.
3940 =============================== ========================= ==================================================
3945 =============================== ========================= ==================================================
3946 Action Default shortcut Description
3947 =============================== ========================= ==================================================
3948 Help F1 (C) Opens the manual.
3949 =============================== ========================= ==================================================
3957 You must use UTF-8 encoding *without BOM* for configuration files.
3960 Configuration file paths
3961 ------------------------
3962 Geany has default configuration files installed for the system and
3963 also per-user configuration files.
3965 The system files should not normally be edited because they will be
3966 overwritten when upgrading Geany.
3968 The user configuration directory can be overridden with the ``-c``
3969 switch, but this is not normally done. See `Command line options`_.
3972 Any missing subdirectories in the user configuration directory
3973 will be created when Geany starts.
3975 You can check the paths Geany is using with *Help->Debug Messages*.
3976 Near the top there should be 2 lines with something like::
3978 Geany-INFO: System data dir: /usr/share/geany
3979 Geany-INFO: User config dir: /home/username/.config/geany
3982 Paths on Unix-like systems
3983 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3984 The system path is ``$prefix/share/geany``, where ``$prefix`` is the
3985 path where Geany is installed (see `Installation prefix`_).
3987 The user configuration directory is normally:
3988 ``/home/username/.config/geany``
3992 The system path is the ``data`` subfolder of the installation path
3995 The user configuration directory might vary, but on Windows XP it's:
3996 ``C:\Documents and Settings\UserName\Application Data\geany``
3997 On Windows 7 and above you most likely will find it at:
3998 ``C:\users\UserName\Roaming\geany``
4003 There's a *Configuration files* submenu in the *Tools* menu that
4004 contains items for some of the available user configuration files.
4005 Clicking on one opens it in the editor for you to update. Geany will
4006 reload the file after you have saved it.
4009 Other configuration files not shown here will need to be opened
4010 manually, and will not be automatically reloaded when saved.
4011 (see *Reload Configuration* below).
4013 There's also a *Reload Configuration* item which can be used if you
4014 updated one of the other configuration files, or modified or added
4017 *Reload Configuration* is also necessary to update syntax highlighting colors.
4020 Syntax highlighting colors aren't updated in open documents after
4021 saving filetypes.common as this may take a significant
4025 Customizing Geany's appearance using GTK+ CSS
4026 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4028 To override GTK+ CSS styles, you can use traditional mechanisms or you
4029 can use the *Tools->Configuration files* menu to open a file named
4030 ``geany.css`` which will be loaded after other CSS styles
4031 are applied to allow overriding the default styles.
4033 Geany offers a number of CSS IDs which can be used to taylor its
4034 appearance. Among the more interesting include:
4036 * ``geany-compiler-context`` - the style used for build command output surrounding errors
4037 * ``geany-compiler-error`` - the style used for build command errors
4038 * ``geany-compiler-message`` - the style other output encountered while running build command
4039 * ``geany-document-status-changed`` - the style for document tab labels when the document is changed
4040 * ``geany-document-status-disk-changed`` - the style for document tab labels when the file on disk has changed
4041 * ``geany-document-status-readyonly``` - the style for document tab labels when the document is read-only
4042 * ``geany-search-entry-no-match`` - the style of find/replace dialog entries when no match is found
4043 * ``geany-terminal-dirty`` - the style for the message window Terminal tab label when the terminal output has changed.
4046 Global configuration file
4047 -------------------------
4049 System administrators can add a global configuration file for Geany
4050 which will be used when starting Geany and a user configuration file
4053 The global configuration file is read from ``geany.conf`` in the
4054 system configuration path - see `Configuration file paths`_. It can
4055 contain any settings which are found in the usual configuration file
4056 created by Geany, but does not have to contain all settings.
4059 This feature is mainly intended for package maintainers or system
4060 admins who want to set up Geany in a multi user environment and
4061 set some sane default values for this environment. Usually users won't
4066 Filetype definition files
4067 -------------------------
4069 All color definitions and other filetype specific settings are
4070 stored in the filetype definition files. Those settings are colors
4071 for syntax highlighting, general settings like comment characters or
4072 word delimiter characters as well as compiler and linker settings.
4074 See also `Configuration file paths`_.
4078 Each filetype has a corresponding filetype definition file. The format
4079 for built-in filetype `Foo` is::
4083 The extension is normally just the filetype name in lower case.
4085 However there are some exceptions:
4087 =============== =========
4089 =============== =========
4093 Matlab/Octave matlab
4094 =============== =========
4096 There is also the `special file filetypes.common`_.
4098 For `custom filetypes`_, the filename for `Foo` is different::
4102 See the link for details.
4106 The system-wide filetype configuration files can be found in the
4107 system configuration path and are called ``filetypes.$ext``,
4108 where $ext is the name of the filetype. For every
4109 filetype there is a corresponding definition file. There is one
4110 exception: ``filetypes.common`` -- this file is for general settings,
4111 which are not specific to a certain filetype.
4114 It is not recommended that users edit the system-wide files,
4115 because they will be overridden when Geany is updated.
4119 To change the settings, copy a file from the system configuration
4120 path to the subdirectory ``filedefs`` in your user configuration
4121 directory. Then you can edit the file and the changes will still be
4122 available after an update of Geany.
4124 Alternatively, you can create the file yourself and add only the
4125 settings you want to change. All missing settings will be read from
4126 the corresponding system configuration file.
4130 At startup Geany looks for ``filetypes.*.conf`` files in the system and
4131 user filetype paths, adding any filetypes found with the name matching
4132 the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
4134 Custom filetypes are not as powerful as built-in filetypes, but
4135 support for the following has been implemented:
4137 * Recognizing and setting the filetype (after the user has manually updated
4138 the `filetype extensions`_ file).
4139 * `Filetype group membership`_.
4140 * Reading filetype settings in the ``[settings]`` section, including:
4141 * Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
4142 * Using an existing tags parser (`tag_parser`_ key).
4143 * Build commands (``[build-menu]`` section).
4144 * Loading global tags files (sharing the ``tag_parser`` filetype's namespace).
4146 See `Filetype configuration`_ for details on each setting.
4148 Creating a custom filetype from an existing filetype
4149 ````````````````````````````````````````````````````
4150 Because most filetype settings will relate to the syntax
4151 highlighting (e.g. styling, keywords, ``lexer_properties``
4152 sections), it is best to copy an existing filetype file that uses
4153 the lexer you wish to use as the basis of a custom filetype, using
4154 the correct filename extension format shown above, e.g.::
4156 cp filetypes.foo filetypes.Bar.conf
4158 Then add the ``lexer_filetype=Foo`` setting (if not already present)
4159 and add/adjust other settings.
4162 The ``[styling]`` and ``[keywords]`` sections have key names
4163 specific to each filetype/lexer. You must follow the same
4164 names - in particular, some lexers only support one keyword
4168 Filetype configuration
4169 ^^^^^^^^^^^^^^^^^^^^^^
4171 As well as the sections listed below, each filetype file can contain
4172 a [build-menu] section as described in `[build-menu] section`_.
4177 In this section the colors for syntax highlighting are defined. The
4180 * ``key=foreground_color;background_color;bold_flag;italic_flag``
4182 Colors have to be specified as RGB hex values prefixed by
4183 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4184 are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
4185 values are case-insensitive but it is a good idea to use lower-case.
4186 Note that you can also use *named colors* as well by substituting the
4187 color value with the name of a color as defined in the ``[named_colors]``
4188 section, see the `[named_colors] Section`_ for more information.
4190 Bold and italic are flags and should only be "true" or "false". If their
4191 value is something other than "true" or "false", "false" is assumed.
4193 You can omit fields to use the values from the style named ``"default"``.
4195 E.g. ``key=0xff0000;;true``
4197 This makes the key style have red foreground text, default background
4198 color text and bold emphasis.
4202 The second format uses a *named style* name to reference a style
4203 defined in filetypes.common.
4205 * ``key=named_style``
4206 * ``key2=named_style2,bold,italic``
4208 The bold and italic parts are optional, and if present are used to
4209 toggle the bold or italic flags to the opposite of the named style's
4210 flags. In contrast to style definition booleans, they are a literal
4211 ",bold,italic" and commas are used instead of semi-colons.
4213 E.g. ``key=comment,italic``
4215 This makes the key style match the ``"comment"`` named style, but with
4218 To define named styles, see the filetypes.common `[named_styles]
4221 Reading styles from another filetype
4222 ************************************
4223 You can automatically copy all of the styles from another filetype
4224 definition file by using the following syntax for the ``[styling]``
4229 Where Foo is a filetype name. The corresponding ``[styling]``
4230 section from ``filetypes.foo`` will be read.
4232 This is useful when the same lexer is being used for multiple
4233 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4234 styling the same as the C styling, you would put the following in
4243 This section contains keys for different keyword lists specific to
4244 the filetype. Some filetypes do not support keywords, so adding a
4245 new key will not work. You can only add or remove keywords to/from
4249 The keywords list must be in one line without line ending characters.
4252 [lexer_properties] section
4253 ``````````````````````````
4254 Here any special properties for the Scintilla lexer can be set in the
4255 format ``key.name.field=some.value``.
4257 Properties Geany uses are listed in the system filetype files. To find
4258 other properties you need Geany's source code::
4260 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
4267 This is the default file extension used when saving files, not
4268 including the period character (``.``). The extension used should
4269 match one of the patterns associated with that filetype (see
4270 `Filetype extensions`_).
4272 *Example:* ``extension=cxx``
4275 These characters define word boundaries when making selections
4276 and searching using word matching options.
4278 *Example:* (look at system filetypes.\* files)
4281 This overrides the *wordchars* filetypes.common setting, and
4282 has precedence over the *whitespace_chars* setting.
4285 A character or string which is used to comment code. If you want to use
4286 multiline comments only, don't set this but rather comment_open and
4289 Single-line comments are used in priority over multiline comments to
4290 comment a line, e.g. with the `Comment/Uncomment line` command.
4292 *Example:* ``comment_single=//``
4295 A character or string which is used to comment code. You need to also
4296 set comment_close to really use multiline comments. If you want to use
4297 single-line comments, prefer setting comment_single.
4299 Multiline comments are used in priority over single-line comments to
4300 comment a block, e.g. template comments.
4302 *Example:* ``comment_open=/*``
4305 If multiline comments are used, this is the character or string to
4308 *Example:* ``comment_close=*/``
4311 Set this to false if a comment character or string should start at
4312 column 0 of a line. If set to true it uses any indentation of the
4315 Note: Comment indentation
4317 ``comment_use_indent=true`` would generate this if a line is
4318 commented (e.g. with Ctrl-D)::
4322 ``comment_use_indent=false`` would generate this if a line is
4323 commented (e.g. with Ctrl-D)::
4325 # command_example();
4328 Note: This setting only works for single line comments (like '//',
4331 *Example:* ``comment_use_indent=true``
4334 A command which can be executed on the current word or the current
4337 Example usage: Open the API documentation for the
4338 current function call at the cursor position.
4341 be set for every filetype or if not set, a global command will
4342 be used. The command itself can be specified without the full
4343 path, then it is searched in $PATH. But for security reasons,
4344 it is recommended to specify the full path to the command. The
4345 wildcard %s will be replaced by the current word at the cursor
4346 position or by the current selection.
4348 Hint: for PHP files the following could be quite useful:
4349 context_action_cmd=firefox "http://www.php.net/%s"
4351 *Example:* ``context_action_cmd=devhelp -s "%s"``
4356 The TagManager language name, e.g. "C". Usually the same as the
4362 A filetype name to setup syntax highlighting from another filetype.
4363 This must not be recursive, i.e. it should be a filetype name that
4364 doesn't use the *lexer_filetype* key itself, e.g.::
4369 The second line is wrong, because ``filetypes.cpp`` itself uses
4370 ``lexer_filetype=C``, which would be recursive.
4372 symbol_list_sort_mode
4373 What the default symbol list sort order should be.
4375 ===== ========================================
4377 ===== ========================================
4378 0 Sort symbols by name
4379 1 Sort symbols by appearance (line number)
4380 ===== ========================================
4382 .. _xml_indent_tags:
4385 If this setting is set to *true*, a new line after a line ending with an
4386 unclosed XML/HTML tag will be automatically indented. This only applies
4387 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4388 this setting in their system configuration files.
4391 The MIME type for this file type, e.g. "text/x-csrc". This is used
4392 for example to chose the icon to display for this file type.
4395 [indentation] section
4396 `````````````````````
4398 This section allows definition of default indentation settings specific to
4399 the file type, overriding the ones configured in the preferences. This can
4400 be useful for file types requiring specific indentation settings (e.g. tabs
4401 only for Makefile). These settings don't override auto-detection if activated.
4404 The forced indentation width.
4407 The forced indentation type.
4409 ===== =======================
4410 Value Indentation type
4411 ===== =======================
4414 2 Mixed (tabs and spaces)
4415 ===== =======================
4418 [build-menu] filetype section
4419 `````````````````````````````
4420 This supports the same keys as the ``geany.conf`` `[build-menu] section`_.
4425 FT_00_CM=gcc -c "%f"
4428 FT_01_CM=gcc -o "%e" "%f"
4433 error_regex=^([^:]+):([0-9]+):
4435 [build_settings] section
4436 ````````````````````````
4437 As of Geany 0.19 this section is for legacy support.
4438 Values that are set in the [build-menu] section will override those in this section.
4440 If any build menu item settings have been configured in the
4441 `Set Build Commands dialog`_ (or the *Build* tab of the
4442 `Project Properties`_ dialog), then these settings are stored in the
4443 [build-menu] section and will override the settings in this section for
4447 See the [build-menu] section for details.
4452 This item specifies the command to compile source code files. But
4453 it is also possible to use it with interpreted languages like Perl
4454 or Python. With these filetypes you can use this option as a kind of
4455 syntax parser, which sends output to the compiler message window.
4457 You should quote the filename to also support filenames with
4458 spaces. The following wildcards for filenames are available:
4460 * %f -- complete filename without path
4461 * %e -- filename without path and without extension
4463 *Example:* ``compiler=gcc -Wall -c "%f"``
4466 This item specifies the command to link the file. If the file is not
4467 already compiled, it will be compiled while linking. The -o option
4468 is automatically added by Geany. This item works well with GNU gcc,
4469 but may be problematic with other compilers (esp. with the linker).
4471 *Example:* ``linker=gcc -Wall "%f"``
4474 Use this item to execute your file. It has to have been built
4475 already. Use the %e wildcard to have only the name of the executable
4476 (i.e. without extension) or use the %f wildcard if you need the
4477 complete filename, e.g. for shell scripts.
4479 *Example:* ``run_cmd="./%e"``
4482 Special file filetypes.common
4483 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4485 There is a special filetype definition file called
4486 filetypes.common. This file defines some general non-filetype-specific
4489 You can open the user filetypes.common with the
4490 *Tools->Configuration Files->filetypes.common* menu item. This adds
4491 the default settings to the user file if the file doesn't exist.
4492 Alternatively the file can be created manually, adding only the
4493 settings you want to change. All missing settings will be read from
4497 See the `Filetype configuration`_ section for how to define styles.
4500 [named_styles] section
4501 ``````````````````````
4502 Named styles declared here can be used in the [styling] section of any
4507 *In filetypes.common*::
4510 foo=0xc00000;0xffffff;false;true
4518 This saves copying and pasting the whole style definition into several
4522 You can define aliases for named styles, as shown with the ``bar``
4523 entry in the above example, but they must be declared after the
4527 [named_colors] section
4528 ``````````````````````
4529 Named colors declared here can be used in the ``[styling]`` or
4530 ``[named_styles]`` section of any filetypes.* file or color scheme.
4535 my_red_color=#FF0000
4536 my_blue_color=#0000FF
4539 foo=my_red_color;my_blue_color;false;true
4541 This allows to define a color palette by name so that to change a color
4542 scheme-wide only involves changing the hex value in a single location.
4547 This is the default style. It is used for styling files without a
4550 *Example:* ``default=0x000000;0xffffff;false;false``
4553 The style for coloring selected text. The format is:
4557 * Use foreground color
4558 * Use background color
4560 The colors are only set if the 3rd or 4th argument is true. When
4561 the colors are not overridden, the default is a dark grey
4562 background with syntax highlighted foreground text.
4564 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
4567 The style for brace highlighting when a matching brace was found.
4569 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
4572 The style for brace highlighting when no matching brace was found.
4574 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
4577 The style for coloring the caret(the blinking cursor). Only first
4578 and third argument is interpreted.
4579 Set the third argument to true to change the caret into a block caret.
4581 *Example:* ``caret=0x000000;0x0;false;false``
4584 The width for the caret(the blinking cursor). Only the first
4585 argument is interpreted. The width is specified in pixels with
4586 a maximum of three pixel. Use the width 0 to make the caret
4589 *Example:* ``caret_width=3``
4592 The style for coloring the background of the current line. Only
4593 the second and third arguments are interpreted. The second argument
4594 is the background color. Use the third argument to enable or
4595 disable background highlighting for the current line (has to be
4598 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
4601 The style for coloring the indentation guides. Only the first and
4602 second arguments are interpreted.
4604 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
4607 The style for coloring the white space if it is shown. The first
4608 both arguments define the foreground and background colors, the
4609 third argument sets whether to use the defined foreground color
4610 or to use the color defined by each filetype for the white space.
4611 The fourth argument defines whether to use the background color.
4613 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
4616 Line number margin foreground and background colors.
4618 .. _Folding Settings:
4621 Fold margin foreground and background colors.
4623 fold_symbol_highlight
4624 Highlight color of folding symbols.
4627 The style of folding icons. Only first and second arguments are
4630 Valid values for the first argument are:
4637 Valid values for the second argument are:
4640 * 1 -- for straight lines
4641 * 2 -- for curved lines
4643 *Default:* ``folding_style=1;1;``
4645 *Arrows:* ``folding_style=3;0;``
4648 Draw a thin horizontal line at the line where text is folded. Only
4649 first argument is used.
4651 Valid values for the first argument are:
4653 * 0 -- disable, do not draw a line
4654 * 1 -- draw the line above folded text
4655 * 2 -- draw the line below folded text
4657 *Example:* ``folding_horiz_line=0;0;false;false``
4660 First argument: drawing of visual flags to indicate a line is wrapped.
4661 This is a bitmask of the values:
4663 * 0 -- No visual flags
4664 * 1 -- Visual flag at end of subline of a wrapped line
4665 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
4666 indented by at least 1 to make room for the flag.
4668 Second argument: wether the visual flags to indicate a line is wrapped
4669 are drawn near the border or near the text. This is a bitmask of the values:
4671 * 0 -- Visual flags drawn near border
4672 * 1 -- Visual flag at end of subline drawn near text
4673 * 2 -- Visual flag at begin of subline drawn near text
4675 Only first and second arguments are interpreted.
4677 *Example:* ``line_wrap_visuals=3;0;false;false``
4680 First argument: sets the size of indentation of sublines for wrapped lines
4681 in terms of the width of a space, only used when the second argument is ``0``.
4683 Second argument: wrapped sublines can be indented to the position of their
4684 first subline or one more indent level. Possible values:
4686 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4687 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4688 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4690 Only first and second arguments are interpreted.
4692 *Example:* ``line_wrap_indent=0;1;false;false``
4695 Translucency for the current line (first argument) and the selection
4696 (second argument). Values between 0 and 256 are accepted.
4698 Note for Windows 95, 98 and ME users:
4699 keep this value at 256 to disable translucency otherwise Geany might crash.
4701 Only the first and second arguments are interpreted.
4703 *Example:* ``translucency=256;256;false;false``
4706 The style for a highlighted line (e.g when using Goto line or goto symbol).
4707 The foreground color (first argument) is only used when the Markers margin
4708 is enabled (see View menu).
4710 Only the first and second arguments are interpreted.
4712 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4715 The style for a marked search results (when using "Mark" in Search dialogs).
4716 The second argument sets the background color for the drawn rectangle.
4718 Only the second argument is interpreted.
4720 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4723 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4724 (Ctrl-M)). The foreground color (first argument) is only used
4725 when the Markers margin is enabled (see View menu).
4727 Only the first and second arguments are interpreted.
4729 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4732 Translucency for the line marker (first argument) and the search marker
4733 (second argument). Values between 0 and 256 are accepted.
4735 Note for Windows 95, 98 and ME users:
4736 keep this value at 256 to disable translucency otherwise Geany might crash.
4738 Only the first and second arguments are interpreted.
4740 *Example:* ``marker_translucency=256;256;false;false``
4743 Amount of space to be drawn above and below the line's baseline.
4744 The first argument defines the amount of space to be drawn above the line, the second
4745 argument defines the amount of space to be drawn below.
4747 Only the first and second arguments are interpreted.
4749 *Example:* ``line_height=0;0;false;false``
4752 The style for coloring the calltips. The first two arguments
4753 define the foreground and background colors, the third and fourth
4754 arguments set whether to use the defined colors.
4756 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4759 The color of the error indicator.
4761 Only the first argument (foreground color) is used.
4763 *Example:* ``indicator_error=0xff0000``
4769 Characters to treat as whitespace. These characters are ignored
4770 when moving, selecting and deleting across word boundaries
4771 (see `Scintilla keyboard commands`_).
4773 This should include space (\\s) and tab (\\t).
4775 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4778 These characters define word boundaries when making selections
4779 and searching using word matching options.
4781 *Example:* ``wordchars=_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``
4784 This has precedence over the *whitespace_chars* setting.
4792 To change the default filetype extension used when saving a new file,
4793 see `Filetype definition files`_.
4795 You can override the list of file extensions that Geany uses to detect
4796 filetypes using the user ``filetype_extensions.conf`` file. Use the
4797 *Tools->Configuration Files->filetype_extensions.conf* menu item. See
4798 also `Configuration file paths`_.
4800 You should only list lines for filetype extensions that you want to
4801 override in the user configuration file and remove or comment out
4802 others. The patterns are listed after the ``=`` sign, using a
4803 semi-colon separated list of patterns which should be matched for
4806 For example, to override the filetype extensions for Make, the file
4810 Make=Makefile*;*.mk;Buildfile;
4812 Filetype group membership
4813 ^^^^^^^^^^^^^^^^^^^^^^^^^
4814 Filetype groups are used in the `Document->Set Filetype` menu.
4816 Group membership is also stored in ``filetype_extensions.conf``. This
4817 file is used to store information Geany needs at startup, whereas the
4818 separate filetype definition files hold information only needed when
4819 a document with their filetype is used.
4821 The format looks like::
4830 The key names cannot be configured.
4833 Group membership is only read at startup.
4836 You can make commonly used filetypes appear in the top-level of the
4837 filetype menu by adding them to the `None` group, e.g.
4840 Preferences file format
4841 -----------------------
4843 The user preferences file ``geany.conf`` holds settings for all the items configured
4844 in the preferences dialog. This file should not be edited while Geany is running
4845 as the file will be overwritten when the preferences in Geany are changed or Geany
4849 [build-menu] section
4850 ^^^^^^^^^^^^^^^^^^^^
4852 The [build-menu] section contains the configuration of the build menu.
4853 This section can occur in filetype, preferences and project files and
4854 always has the format described here. Different menu items are loaded
4855 from different files, see the table in the `Build Menu Configuration`_
4856 section for details. All the settings can be configured from the dialogs
4857 except the execute command in filetype files and filetype definitions in
4858 the project file, so these are the only ones which need hand editing.
4862 The build-menu section stores one entry for each setting for each menu item that
4863 is configured. The keys for these settings have the format:
4869 * GG - is the menu item group,
4871 - FT for filetype build
4872 - NF for independent (non-filetype) build
4875 * NN - is a two decimal digit number of the item within the group,
4877 * FF - is the field,
4881 - WD for working directory
4883 See `[build-menu] filetype section`_ for an example.
4885 Error regular expression
4886 ````````````````````````
4888 This is a Perl-compatible regular expression (PCRE) to parse a filename
4889 (absolute or relative) and line number from the build output.
4890 If undefined, Geany will fall back to its default error message parsing.
4892 Only the first two match groups will be read by Geany. These groups can
4893 occur in any order: the match group consisting of only digits will be used
4894 as the line number, and the other group as the filename. In no group
4895 consists of only digits, the match will fail.
4897 *Example:* ``error_regex=^(.+):([0-9]+):[0-9]+``
4899 This will parse a message such as:
4900 ``test.py:7:24: E202 whitespace before ']'``
4906 The project file contains project related settings and possibly a
4907 record of the current session files.
4910 [build-menu] additions
4911 ^^^^^^^^^^^^^^^^^^^^^^
4913 The project file also can have extra fields in the [build-menu] section
4914 in addition to those listed in `[build-menu] section`_ above.
4916 When filetype menu items are configured for the project they are stored
4917 in the project file.
4919 The ``filetypes`` entry is a list of the filetypes which exist in the
4922 For each filetype the entries for that filetype have the format defined in
4923 `[build-menu] section`_ but the key is prefixed by the name of the filetype
4924 as it appears in the ``filetypes`` entry, eg the entry for the label of
4925 filetype menu item 0 for the C filetype would be
4933 Geany supports the following templates:
4937 * Function description
4942 To use these templates, just open the Edit menu or open the popup menu
4943 by right-clicking in the editor widget, and choose "Insert Comments"
4944 and insert templates as you want.
4946 Some templates (like File header or ChangeLog entry) will always be
4947 inserted at the top of the file.
4949 To insert a function description, the cursor must be inside
4950 of the function, so that the function name can be determined
4951 automatically. The description will be positioned correctly one line
4952 above the function, just check it out. If the cursor is not inside
4953 of a function or the function name cannot be determined, the inserted
4954 function description won't contain the correct function name but "unknown"
4958 Geany automatically reloads template information when it notices you
4959 save a file in the user's template configuration directory. You can
4960 also force this by selecting *Tools->Reload Configuration*.
4966 Meta data can be used with all templates, but by default user set
4967 meta data is only used for the ChangeLog and File header templates.
4969 In the configuration dialog you can find a tab "Templates" (see
4970 `Template preferences`_). You can define the default values
4971 which will be inserted in the templates.
4977 File templates are templates used as the basis of a new file. To
4978 use them, choose the *New (with Template)* menu item from the *File*
4979 menu. If there is more than one template for a filetype then they
4980 will be grouped in a submenu.
4982 By default, file templates are installed for some filetypes. Custom
4983 file templates can be added by creating the appropriate template file. You can
4984 also edit the default file templates.
4986 The file's contents are just the text to place in the document, with
4987 optional template wildcards like ``{fileheader}``. The fileheader
4988 wildcard can be placed anywhere, but it's usually put on the first
4989 line of the file, followed by a blank line.
4991 Adding file templates
4992 `````````````````````
4994 File templates are read from ``templates/files`` under the
4995 `Configuration file paths`_.
4997 The filetype to use is detected from the template file's extension, if
4998 any. For example, creating a file ``module.c`` would add a menu item
4999 which created a new document with the filetype set to 'C'.
5001 The template file is read from disk when the corresponding menu item is
5005 Customizing templates
5006 ^^^^^^^^^^^^^^^^^^^^^
5008 Each template can be customized to your needs. The templates are
5009 stored in the ``~/.config/geany/templates/`` directory (see the section called
5010 `Command line options`_ for further information about the configuration
5011 directory). Just open the desired template with an editor (ideally,
5012 Geany ;-) ) and edit the template to your needs. There are some
5013 wildcards which will be automatically replaced by Geany at startup.
5019 All wildcards must be enclosed by "{" and "}", e.g. {date}.
5021 **Wildcards for character escaping**
5023 ============== ============================================= =======================================
5024 Wildcard Description Available in
5025 ============== ============================================= =======================================
5026 ob { Opening Brace (used to prevent other file templates, file header, snippets.
5027 wildcards being expanded).
5028 cb } Closing Brace. file templates, file header, snippets.
5029 pc \% Percent (used to escape e.g. ``%block%``
5030 in snippets). snippets.
5031 ============== ============================================= =======================================
5036 These are configurable, see `Template preferences`_.
5038 ============== ============================================= =======================================
5039 Wildcard Description Available in
5040 ============== ============================================= =======================================
5041 developer The name of the developer. file templates, file header,
5042 function description, ChangeLog entry,
5045 initial The developer's initials, e.g. "ET" for file templates, file header,
5046 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
5049 mail The email address of the developer. file templates, file header,
5050 function description, ChangeLog entry,
5053 company The company the developer is working for. file templates, file header,
5054 function description, ChangeLog entry,
5057 version The initial version of a new file. file templates, file header,
5058 function description, ChangeLog entry,
5060 ============== ============================================= =======================================
5062 Date & time wildcards
5063 *********************
5065 The format for these wildcards can be changed in the preferences
5066 dialog, see `Template preferences`_. For a list of available conversion
5067 specifiers see https://docs.gtk.org/glib/method.DateTime.format.html.
5069 ============== ============================================= =======================================
5070 Wildcard Description Available in
5071 ============== ============================================= =======================================
5072 year The current year. Default format is: YYYY. file templates, file header,
5073 function description, ChangeLog entry,
5076 date The current date. Default format: file templates, file header,
5077 YYYY-MM-DD. function description, ChangeLog entry,
5080 datetime The current date and time. Default format: file templates, file header,
5081 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
5083 ============== ============================================= =======================================
5088 ============== ============================================= =======================================
5089 Wildcard Description Available in
5090 ============== ============================================= =======================================
5091 untitled The string "untitled" (this will be file templates, file header,
5092 translated to your locale), used in function description, ChangeLog entry,
5093 file templates. bsd, gpl, snippets.
5095 geanyversion The actual Geany version, e.g. file templates, file header,
5096 "Geany |(version)|". function description, ChangeLog entry,
5099 filename The filename of the current file. file header, snippets, file
5100 For new files, it's only replaced when templates.
5101 first saving if found on the first 4 lines
5104 project The current project's name, if any. file header, snippets, file templates.
5106 description The current project's description, if any. file header, snippets, file templates.
5108 functionname The function name of the function at the function description.
5109 cursor position. This wildcard will only be
5110 replaced in the function description
5113 command:path Executes the specified command and replace file templates, file header,
5114 the wildcard with the command's standard function description, ChangeLog entry,
5115 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
5117 ============== ============================================= =======================================
5119 Template insertion wildcards
5120 ****************************
5122 ============== ============================================= =======================================
5123 Wildcard Description Available in
5124 ============== ============================================= =======================================
5125 gpl This wildcard inserts a short GPL notice. file header.
5127 bsd This wildcard inserts a BSD licence notice. file header.
5129 fileheader The file header template. This wildcard snippets, file templates.
5130 will only be replaced in file templates.
5131 ============== ============================================= =======================================
5134 Special {command:} wildcard
5135 ***************************
5137 The ``{command:}`` wildcard is a special one because it can execute
5138 a specified command and put the command's output (stdout) into
5147 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
5149 Using this wildcard you can insert nearly any arbitrary text into the
5152 In the environment of the executed command the variables
5153 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
5154 The value of these variables is filled in only if Geany knows about it.
5155 For example, ``GEANY_FUNCNAME`` is only filled within the function
5156 description template. However, these variables are *always* set,
5157 just maybe with an empty value.
5158 You can easily access them e.g. within an executed shell script using::
5164 If the specified command could not be found or not executed, the wildcard is substituted
5165 by an empty string. In such cases, you can find the occurred error message on Geany's
5166 standard error and in the *Help->Debug Messages* dialog.
5169 Customizing the toolbar
5170 -----------------------
5172 You can add, remove and reorder the elements in the toolbar by using
5173 the toolbar editor, or by manually editing the configuration file
5176 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5177 by right-clicking on the toolbar itself and choosing it from the menu.
5179 Manually editing the toolbar layout
5180 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5182 To override the system-wide configuration file, copy it to your user
5183 configuration directory (see `Configuration file paths`_).
5187 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5189 Then edit it and add any of the available elements listed in the file or remove
5190 any of the existing elements. Of course, you can also reorder the elements as
5191 you wish and add or remove additional separators.
5192 This file must be valid XML, otherwise the global toolbar UI definition
5193 will be used instead.
5195 Your changes are applied once you save the file.
5198 (1) You cannot add new actions which are not listed below.
5199 (2) Everything you add or change must be inside the /ui/toolbar/ path.
5202 Available toolbar elements
5203 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5205 ================== ==============================================================================
5206 Element name Description
5207 ================== ==============================================================================
5208 New Create a new file
5209 Open Open an existing file
5210 Save Save the current file
5211 SaveAll Save all open files
5212 Reload Reload the current file from disk
5213 Close Close the current file
5214 CloseAll Close all open files
5215 Print Print the current file
5216 Cut Cut the current selection
5217 Copy Copy the current selection
5218 Paste Paste the contents of the clipboard
5219 Delete Delete the current selection
5220 Undo Undo the last modification
5221 Redo Redo the last modification
5222 NavBack Navigate back a location
5223 NavFor Navigate forward a location
5224 Compile Compile the current file
5225 Build Build the current file, includes a submenu for Make commands. Geany
5226 remembers the last chosen action from the submenu and uses this as default
5227 action when the button itself is clicked.
5228 Run Run or view the current file
5229 Color Open a color chooser dialog, to interactively pick colors from a palette
5230 ZoomIn Zoom in the text
5231 ZoomOut Zoom out the text
5232 UnIndent Decrease indentation
5233 Indent Increase indentation
5234 Replace Replace text in the current document
5235 SearchEntry The search field belonging to the 'Search' element (can be used alone)
5236 Search Find the entered text in the current file (only useful if you also
5238 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
5239 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
5240 Preferences Show the preferences dialog
5242 ================== ==============================================================================
5246 Plugin documentation
5247 ====================
5252 The HTML Characters plugin helps when working with special
5253 characters in XML/HTML, e.g. German Umlauts ü and ä.
5256 Insert entity dialog
5257 ^^^^^^^^^^^^^^^^^^^^
5259 When the plugin is enabled, you can insert special character
5260 entities using *Tools->Insert Special HTML Characters*.
5262 This opens up a dialog where you can find a huge amount of special
5263 characters sorted by category that you might like to use inside your
5264 document. You can expand and collapse the categories by clicking on
5265 the little arrow on the left hand side. Once you have found the
5266 desired character click on it and choose "Insert". This will insert
5267 the entity for the character at the current cursor position. You
5268 might also like to double click the chosen entity instead.
5271 Replace special chars by its entity
5272 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5274 To help make a XML/HTML document valid the plugin supports
5275 replacement of special chars known by the plugin. Both bulk
5276 replacement and immediate replacement during typing are supported.
5278 A few characters will not be replaced. These are
5289 You can activate/deactivate this feature using the *Tools->HTML
5290 Replacement->Auto-replace Special Characters* menu item. If it's
5291 activated, all special characters (beside the given exceptions from
5292 above) known by the plugin will be replaced by their entities.
5294 You could also set a keybinding for the plugin to toggle the status
5301 After inserting a huge amount of text, e.g. by using copy & paste, the
5302 plugin allows bulk replacement of all known characters (beside the
5303 mentioned exceptions). You can find the function under the same
5304 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
5305 configure a keybinding for the plugin.
5314 This plugin provides an option to automatically save documents.
5315 You can choose to save the current document, or all of your documents, at
5322 You can save the current document when the editor's focus goes out.
5323 Every pop-up, menu dialogs, or anything else that can make the editor lose the focus,
5324 will make the current document to be saved.
5329 This plugin sets on every new file (*File->New* or *File->New (with template)*)
5330 a randomly chosen filename and set its filetype appropriate to the used template
5331 or when no template was used, to a configurable default filetype.
5332 This enables you to quickly compile, build and/or run the new file without the
5333 need to give it an explicit filename using the Save As dialog. This might be
5334 useful when you often create new files just for testing some code or something
5341 This plugin creates a backup copy of the current file in Geany when it is
5342 saved. You can specify the directory where the backup copy is saved and
5343 you can configure the automatically added extension in the configure dialog
5344 in Geany's plugin manager.
5346 After the plugin was loaded in Geany's plugin manager, every file is
5347 copied into the configured backup directory *after* the file has been saved
5350 The created backup copy file permissions are set to read-write only for
5351 the user. This should help to not create world-readable files on possibly
5352 unsecure destination directories like /tmp (especially useful
5353 on multi-user systems).
5354 This applies only to non-Windows systems. On Windows, no explicit file
5355 permissions are set.
5358 Additionally, you can define how many levels of the original file's
5359 directory structure should be replicated in the backup copy path.
5360 For example, setting the option
5361 *Directory levels to include in the backup destination* to *2*
5362 cause the plugin to create the last two components of the original
5363 file's path in the backup copy path and place the new file there.
5366 Contributing to this document
5367 =============================
5369 This document (``geany.txt``) is written in `reStructuredText`__
5370 (or "reST"). The source file for it is located in Geany's ``doc``
5371 subdirectory. If you intend on making changes, you should grab the
5372 source right from Git to make sure you've got the newest version.
5373 First, you need to configure the build system to generate the HTML
5374 documentation passing the *--enable-html-docs* option to the *configure*
5375 script. Then after editing the file, run ``make`` (from the root build
5376 directory or from the *doc* subdirectory) to build the HTML documentation
5377 and see how your changes look. This regenerates the ``geany.html`` file
5378 inside the *doc* subdirectory. To generate a PDF file, configure with
5379 *--enable-pdf-docs* and run ``make`` as for the HTML version. The generated
5380 PDF file is named geany-|(version)|.pdf and is located inside the *doc*
5383 __ http://docutils.sourceforge.net/rst.html
5385 After you are happy with your changes, create a patch e.g. by using::
5387 % git diff geany.txt > foo.patch
5389 or even better, by creating a Git-formatted patch which will keep authoring
5390 and description data, by first committing your changes (doing so in a fresh
5391 new branch is recommended for `master` not to diverge from upstream) and then
5392 using git format-patch::
5394 % git checkout -b my-documentation-changes # create a fresh branch
5395 % git commit geany.txt
5396 Write a good commit message...
5397 % git format-patch HEAD^
5398 % git checkout master # go back to master
5400 and then submit that file to the mailing list for review.
5402 Also you can clone the Geany repository at GitHub and send a pull request.
5404 Note, you will need the Python docutils software package installed
5405 to build the docs. The package is named ``python-docutils`` on Debian
5411 Scintilla keyboard commands
5412 ===========================
5414 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
5416 This appendix is distributed under the terms of the License for
5417 Scintilla and SciTE. A copy of this license can be found in the file
5418 ``scintilla/License.txt`` included with the source code of this
5419 program and in the appendix of this document. See `License for
5420 Scintilla and SciTE`_.
5429 Keyboard commands for Scintilla mostly follow common Windows and GTK+
5430 conventions. All move keys (arrows, page up/down, home and end)
5431 allows to extend or reduce the stream selection when holding the
5432 Shift key, and the rectangular selection when holding the
5433 appropriate keys (see `Column mode editing (rectangular selections)`_).
5435 Some keys may not be available with some national keyboards
5436 or because they are taken by the system such as by a window manager
5437 or GTK. Keyboard equivalents of menu commands are listed in the
5438 menus. Some less common commands with no menu equivalent are:
5440 ============================================= ======================
5442 ============================================= ======================
5443 Magnify text size. Ctrl-Keypad+
5444 Reduce text size. Ctrl-Keypad-
5445 Restore text size to normal. Ctrl-Keypad/
5447 Dedent block. Shift-Tab
5448 Delete to start of word. Ctrl-BackSpace
5449 Delete to end of word. Ctrl-Delete
5450 Delete to start of line. Ctrl-Shift-BackSpace
5451 Go to start of document. Ctrl-Home
5452 Extend selection to start of document. Ctrl-Shift-Home
5453 Go to start of display line. Alt-Home
5454 Extend selection to start of display line. Alt-Shift-Home
5455 Go to end of document. Ctrl-End
5456 Extend selection to end of document. Ctrl-Shift-End
5457 Extend selection to end of display line. Alt-Shift-End
5458 Previous paragraph. Shift extends selection. Ctrl-Up
5459 Next paragraph. Shift extends selection. Ctrl-Down
5460 Previous word. Shift extends selection. Ctrl-Left
5461 Next word. Shift extends selection. Ctrl-Right
5462 ============================================= ======================
5473 * Double-click on empty space in the notebook tab bar to open a
5475 * Middle-click on a document's notebook tab to close the document.
5476 * Hold `Ctrl` and click on any notebook tab to switch to the last used
5478 * Double-click on a document's notebook tab to toggle all additional
5479 widgets (to show them again use the View menu or the keyboard
5480 shortcut). The interface pref must be enabled for this to work.
5485 * Alt-scroll wheel moves up/down a page.
5486 * Ctrl-scroll wheel zooms in/out.
5487 * Shift-scroll wheel scrolls 8 characters right/left.
5488 * Ctrl-click on a word in a document to perform *Go to Symbol Definition*.
5489 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
5494 * Double-click on a symbol-list group to expand or compact it.
5499 * Scrolling the mouse wheel over a notebook tab bar will switch
5502 The following are derived from X-Windows features (but GTK still supports
5505 * Middle-click pastes the last selected text.
5506 * Middle-click on a scrollbar moves the scrollbar to that
5507 position without having to drag it.
5511 Compile-time options
5512 ====================
5514 There are some options which can only be changed at compile time,
5515 and some options which are used as the default for configurable
5516 options. To change these options, edit the appropriate source file
5517 in the ``src`` subdirectory. Look for a block of lines starting with
5518 ``#define GEANY_*``. Any definitions which are not listed here should
5522 Most users should not need to change these options.
5527 ============================== ============================================ ==================
5528 Option Description Default
5529 ============================== ============================================ ==================
5530 GEANY_STRING_UNTITLED A string used as the default name for new untitled
5531 files. Be aware that the string can be
5532 translated, so change it only if you know
5534 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
5535 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
5536 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
5538 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
5540 **Windows specific**
5541 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
5542 Windows file open and save dialogs instead
5543 GTK's file open and save dialogs. The
5544 default Windows file dialogs are missing
5545 some nice features like choosing a filetype
5546 or an encoding. *Do not touch this setting
5547 when building on a non-Win32 system.*
5548 ============================== ============================================ ==================
5553 ============================== ============================================ ==================
5554 Option Description Default
5555 ============================== ============================================ ==================
5556 GEANY_PROJECT_EXT The default filename extension for Geany geany
5557 project files. It is used when creating new
5558 projects and as filter mask for the project
5560 ============================== ============================================ ==================
5565 ============================== ============================================ ==================
5566 Option Description Default
5567 ============================== ============================================ ==================
5568 GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
5569 filetype with the extract filetype regex.
5570 ============================== ============================================ ==================
5575 ============================== ============================================ ==================
5576 Option Description Default
5577 ============================== ============================================ ==================
5578 GEANY_WORDCHARS These characters define word boundaries when a string with:
5579 making selections and searching using word a-z, A-Z, 0-9 and
5580 matching options. underscore.
5581 ============================== ============================================ ==================
5586 These are default settings that can be overridden in the `Preferences`_ dialog.
5588 ============================== ============================================ ==================
5589 Option Description Default
5590 ============================== ============================================ ==================
5591 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
5592 trigger the autocompletion list.
5593 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
5595 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
5596 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator command, see See below.
5597 `Terminal emulators`_.
5598 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
5599 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
5600 and process plain text files. This can also
5602 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
5603 GNU grep. This can also include a path.
5604 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
5605 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
5607 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
5608 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
5609 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
5611 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
5613 GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
5615 ============================== ============================================ ==================
5619 The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
5621 The GEANY_DEFAULT_TOOLS_TERMINAL default value on Windows is::
5625 and on any non-Windows system is::
5627 xterm -e "/bin/sh %c"
5633 ============================== ============================================ ==================
5634 Option Description Default
5635 ============================== ============================================ ==================
5636 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
5637 be shown in the editor window.
5638 This affects the special coloring
5639 when Geany detects a compiler output line as
5640 an error message and then highlights the
5641 corresponding line in the source code.
5642 Usually only the first few messages are
5643 interesting because following errors are
5645 All errors in the Compiler window are parsed
5646 and unaffected by this value.
5647 PRINTBUILDCMDS Every time a build menu item priority FALSE
5648 calculation is run, print the state of the
5649 menu item table in the form of the table
5650 in `Build Menu Configuration`_. May be
5651 useful to debug configuration file
5652 overloading. Warning produces a lot of
5653 output. Can also be enabled/disabled by the
5654 debugger by setting printbuildcmds to 1/0
5655 overriding the compile setting.
5656 ============================== ============================================ ==================
5660 GNU General Public License
5661 ==========================
5665 GNU GENERAL PUBLIC LICENSE
5666 Version 2, June 1991
5668 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5669 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5670 Everyone is permitted to copy and distribute verbatim copies
5671 of this license document, but changing it is not allowed.
5675 The licenses for most software are designed to take away your
5676 freedom to share and change it. By contrast, the GNU General Public
5677 License is intended to guarantee your freedom to share and change free
5678 software--to make sure the software is free for all its users. This
5679 General Public License applies to most of the Free Software
5680 Foundation's software and to any other program whose authors commit to
5681 using it. (Some other Free Software Foundation software is covered by
5682 the GNU Library General Public License instead.) You can apply it to
5685 When we speak of free software, we are referring to freedom, not
5686 price. Our General Public Licenses are designed to make sure that you
5687 have the freedom to distribute copies of free software (and charge for
5688 this service if you wish), that you receive source code or can get it
5689 if you want it, that you can change the software or use pieces of it
5690 in new free programs; and that you know you can do these things.
5692 To protect your rights, we need to make restrictions that forbid
5693 anyone to deny you these rights or to ask you to surrender the rights.
5694 These restrictions translate to certain responsibilities for you if you
5695 distribute copies of the software, or if you modify it.
5697 For example, if you distribute copies of such a program, whether
5698 gratis or for a fee, you must give the recipients all the rights that
5699 you have. You must make sure that they, too, receive or can get the
5700 source code. And you must show them these terms so they know their
5703 We protect your rights with two steps: (1) copyright the software, and
5704 (2) offer you this license which gives you legal permission to copy,
5705 distribute and/or modify the software.
5707 Also, for each author's protection and ours, we want to make certain
5708 that everyone understands that there is no warranty for this free
5709 software. If the software is modified by someone else and passed on, we
5710 want its recipients to know that what they have is not the original, so
5711 that any problems introduced by others will not reflect on the original
5712 authors' reputations.
5714 Finally, any free program is threatened constantly by software
5715 patents. We wish to avoid the danger that redistributors of a free
5716 program will individually obtain patent licenses, in effect making the
5717 program proprietary. To prevent this, we have made it clear that any
5718 patent must be licensed for everyone's free use or not licensed at all.
5720 The precise terms and conditions for copying, distribution and
5721 modification follow.
5723 GNU GENERAL PUBLIC LICENSE
5724 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5726 0. This License applies to any program or other work which contains
5727 a notice placed by the copyright holder saying it may be distributed
5728 under the terms of this General Public License. The "Program", below,
5729 refers to any such program or work, and a "work based on the Program"
5730 means either the Program or any derivative work under copyright law:
5731 that is to say, a work containing the Program or a portion of it,
5732 either verbatim or with modifications and/or translated into another
5733 language. (Hereinafter, translation is included without limitation in
5734 the term "modification".) Each licensee is addressed as "you".
5736 Activities other than copying, distribution and modification are not
5737 covered by this License; they are outside its scope. The act of
5738 running the Program is not restricted, and the output from the Program
5739 is covered only if its contents constitute a work based on the
5740 Program (independent of having been made by running the Program).
5741 Whether that is true depends on what the Program does.
5743 1. You may copy and distribute verbatim copies of the Program's
5744 source code as you receive it, in any medium, provided that you
5745 conspicuously and appropriately publish on each copy an appropriate
5746 copyright notice and disclaimer of warranty; keep intact all the
5747 notices that refer to this License and to the absence of any warranty;
5748 and give any other recipients of the Program a copy of this License
5749 along with the Program.
5751 You may charge a fee for the physical act of transferring a copy, and
5752 you may at your option offer warranty protection in exchange for a fee.
5754 2. You may modify your copy or copies of the Program or any portion
5755 of it, thus forming a work based on the Program, and copy and
5756 distribute such modifications or work under the terms of Section 1
5757 above, provided that you also meet all of these conditions:
5759 a) You must cause the modified files to carry prominent notices
5760 stating that you changed the files and the date of any change.
5762 b) You must cause any work that you distribute or publish, that in
5763 whole or in part contains or is derived from the Program or any
5764 part thereof, to be licensed as a whole at no charge to all third
5765 parties under the terms of this License.
5767 c) If the modified program normally reads commands interactively
5768 when run, you must cause it, when started running for such
5769 interactive use in the most ordinary way, to print or display an
5770 announcement including an appropriate copyright notice and a
5771 notice that there is no warranty (or else, saying that you provide
5772 a warranty) and that users may redistribute the program under
5773 these conditions, and telling the user how to view a copy of this
5774 License. (Exception: if the Program itself is interactive but
5775 does not normally print such an announcement, your work based on
5776 the Program is not required to print an announcement.)
5778 These requirements apply to the modified work as a whole. If
5779 identifiable sections of that work are not derived from the Program,
5780 and can be reasonably considered independent and separate works in
5781 themselves, then this License, and its terms, do not apply to those
5782 sections when you distribute them as separate works. But when you
5783 distribute the same sections as part of a whole which is a work based
5784 on the Program, the distribution of the whole must be on the terms of
5785 this License, whose permissions for other licensees extend to the
5786 entire whole, and thus to each and every part regardless of who wrote it.
5788 Thus, it is not the intent of this section to claim rights or contest
5789 your rights to work written entirely by you; rather, the intent is to
5790 exercise the right to control the distribution of derivative or
5791 collective works based on the Program.
5793 In addition, mere aggregation of another work not based on the Program
5794 with the Program (or with a work based on the Program) on a volume of
5795 a storage or distribution medium does not bring the other work under
5796 the scope of this License.
5798 3. You may copy and distribute the Program (or a work based on it,
5799 under Section 2) in object code or executable form under the terms of
5800 Sections 1 and 2 above provided that you also do one of the following:
5802 a) Accompany it with the complete corresponding machine-readable
5803 source code, which must be distributed under the terms of Sections
5804 1 and 2 above on a medium customarily used for software interchange; or,
5806 b) Accompany it with a written offer, valid for at least three
5807 years, to give any third party, for a charge no more than your
5808 cost of physically performing source distribution, a complete
5809 machine-readable copy of the corresponding source code, to be
5810 distributed under the terms of Sections 1 and 2 above on a medium
5811 customarily used for software interchange; or,
5813 c) Accompany it with the information you received as to the offer
5814 to distribute corresponding source code. (This alternative is
5815 allowed only for noncommercial distribution and only if you
5816 received the program in object code or executable form with such
5817 an offer, in accord with Subsection b above.)
5819 The source code for a work means the preferred form of the work for
5820 making modifications to it. For an executable work, complete source
5821 code means all the source code for all modules it contains, plus any
5822 associated interface definition files, plus the scripts used to
5823 control compilation and installation of the executable. However, as a
5824 special exception, the source code distributed need not include
5825 anything that is normally distributed (in either source or binary
5826 form) with the major components (compiler, kernel, and so on) of the
5827 operating system on which the executable runs, unless that component
5828 itself accompanies the executable.
5830 If distribution of executable or object code is made by offering
5831 access to copy from a designated place, then offering equivalent
5832 access to copy the source code from the same place counts as
5833 distribution of the source code, even though third parties are not
5834 compelled to copy the source along with the object code.
5836 4. You may not copy, modify, sublicense, or distribute the Program
5837 except as expressly provided under this License. Any attempt
5838 otherwise to copy, modify, sublicense or distribute the Program is
5839 void, and will automatically terminate your rights under this License.
5840 However, parties who have received copies, or rights, from you under
5841 this License will not have their licenses terminated so long as such
5842 parties remain in full compliance.
5844 5. You are not required to accept this License, since you have not
5845 signed it. However, nothing else grants you permission to modify or
5846 distribute the Program or its derivative works. These actions are
5847 prohibited by law if you do not accept this License. Therefore, by
5848 modifying or distributing the Program (or any work based on the
5849 Program), you indicate your acceptance of this License to do so, and
5850 all its terms and conditions for copying, distributing or modifying
5851 the Program or works based on it.
5853 6. Each time you redistribute the Program (or any work based on the
5854 Program), the recipient automatically receives a license from the
5855 original licensor to copy, distribute or modify the Program subject to
5856 these terms and conditions. You may not impose any further
5857 restrictions on the recipients' exercise of the rights granted herein.
5858 You are not responsible for enforcing compliance by third parties to
5861 7. If, as a consequence of a court judgment or allegation of patent
5862 infringement or for any other reason (not limited to patent issues),
5863 conditions are imposed on you (whether by court order, agreement or
5864 otherwise) that contradict the conditions of this License, they do not
5865 excuse you from the conditions of this License. If you cannot
5866 distribute so as to satisfy simultaneously your obligations under this
5867 License and any other pertinent obligations, then as a consequence you
5868 may not distribute the Program at all. For example, if a patent
5869 license would not permit royalty-free redistribution of the Program by
5870 all those who receive copies directly or indirectly through you, then
5871 the only way you could satisfy both it and this License would be to
5872 refrain entirely from distribution of the Program.
5874 If any portion of this section is held invalid or unenforceable under
5875 any particular circumstance, the balance of the section is intended to
5876 apply and the section as a whole is intended to apply in other
5879 It is not the purpose of this section to induce you to infringe any
5880 patents or other property right claims or to contest validity of any
5881 such claims; this section has the sole purpose of protecting the
5882 integrity of the free software distribution system, which is
5883 implemented by public license practices. Many people have made
5884 generous contributions to the wide range of software distributed
5885 through that system in reliance on consistent application of that
5886 system; it is up to the author/donor to decide if he or she is willing
5887 to distribute software through any other system and a licensee cannot
5890 This section is intended to make thoroughly clear what is believed to
5891 be a consequence of the rest of this License.
5893 8. If the distribution and/or use of the Program is restricted in
5894 certain countries either by patents or by copyrighted interfaces, the
5895 original copyright holder who places the Program under this License
5896 may add an explicit geographical distribution limitation excluding
5897 those countries, so that distribution is permitted only in or among
5898 countries not thus excluded. In such case, this License incorporates
5899 the limitation as if written in the body of this License.
5901 9. The Free Software Foundation may publish revised and/or new versions
5902 of the General Public License from time to time. Such new versions will
5903 be similar in spirit to the present version, but may differ in detail to
5904 address new problems or concerns.
5906 Each version is given a distinguishing version number. If the Program
5907 specifies a version number of this License which applies to it and "any
5908 later version", you have the option of following the terms and conditions
5909 either of that version or of any later version published by the Free
5910 Software Foundation. If the Program does not specify a version number of
5911 this License, you may choose any version ever published by the Free Software
5914 10. If you wish to incorporate parts of the Program into other free
5915 programs whose distribution conditions are different, write to the author
5916 to ask for permission. For software which is copyrighted by the Free
5917 Software Foundation, write to the Free Software Foundation; we sometimes
5918 make exceptions for this. Our decision will be guided by the two goals
5919 of preserving the free status of all derivatives of our free software and
5920 of promoting the sharing and reuse of software generally.
5924 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5925 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5926 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5927 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5928 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5929 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5930 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5931 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5932 REPAIR OR CORRECTION.
5934 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5935 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5936 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5937 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5938 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5939 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5940 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5941 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5942 POSSIBILITY OF SUCH DAMAGES.
5944 END OF TERMS AND CONDITIONS
5946 How to Apply These Terms to Your New Programs
5948 If you develop a new program, and you want it to be of the greatest
5949 possible use to the public, the best way to achieve this is to make it
5950 free software which everyone can redistribute and change under these terms.
5952 To do so, attach the following notices to the program. It is safest
5953 to attach them to the start of each source file to most effectively
5954 convey the exclusion of warranty; and each file should have at least
5955 the "copyright" line and a pointer to where the full notice is found.
5957 <one line to give the program's name and a brief idea of what it does.>
5958 Copyright (C) <year> <name of author>
5960 This program is free software; you can redistribute it and/or modify
5961 it under the terms of the GNU General Public License as published by
5962 the Free Software Foundation; either version 2 of the License, or
5963 (at your option) any later version.
5965 This program is distributed in the hope that it will be useful,
5966 but WITHOUT ANY WARRANTY; without even the implied warranty of
5967 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5968 GNU General Public License for more details.
5970 You should have received a copy of the GNU General Public License along
5971 with this program; if not, write to the Free Software Foundation, Inc.,
5972 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5975 Also add information on how to contact you by electronic and paper mail.
5977 If the program is interactive, make it output a short notice like this
5978 when it starts in an interactive mode:
5980 Gnomovision version 69, Copyright (C) year name of author
5981 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5982 This is free software, and you are welcome to redistribute it
5983 under certain conditions; type `show c' for details.
5985 The hypothetical commands `show w' and `show c' should show the appropriate
5986 parts of the General Public License. Of course, the commands you use may
5987 be called something other than `show w' and `show c'; they could even be
5988 mouse-clicks or menu items--whatever suits your program.
5990 You should also get your employer (if you work as a programmer) or your
5991 school, if any, to sign a "copyright disclaimer" for the program, if
5992 necessary. Here is a sample; alter the names:
5994 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5995 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5997 <signature of Ty Coon>, 1 April 1989
5998 Ty Coon, President of Vice
6000 This General Public License does not permit incorporating your program into
6001 proprietary programs. If your program is a subroutine library, you may
6002 consider it more useful to permit linking proprietary applications with the
6003 library. If this is what you want to do, use the GNU Library General
6004 Public License instead of this License.
6009 License for Scintilla and SciTE
6010 ===============================
6012 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
6016 Permission to use, copy, modify, and distribute this software and
6017 its documentation for any purpose and without fee is hereby granted,
6018 provided that the above copyright notice appear in all copies and
6019 that both that copyright notice and this permission notice appear in
6020 supporting documentation.
6022 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
6023 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
6024 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
6025 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
6026 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
6027 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
6028 USE OR PERFORMANCE OF THIS SOFTWARE.