1 .. |(version)| replace:: 1.26
2 .. -*- reStructuredText -*-
8 -------------------------
9 A fast, light, GTK+ IDE
10 -------------------------
12 :Authors: Enrico Tröger,
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 http://www.geany.org/ or perhaps also from
68 your distribution. For a list of available packages, please see
69 http://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 http://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 http://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 The Autotools based build system is very mature and has been well tested.
136 To use it, you just need the Make tool, preferably GNU Make.
138 Then run the following commands::
151 Waf based build system
152 ^^^^^^^^^^^^^^^^^^^^^^
154 The Waf build system is still quite young and under heavy development but already in a
155 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
156 to install Python on your system.
157 The advantage of the Waf build system over the Autotools based build system is that the whole
158 build process might be a bit faster. Especially when you use the Waf
159 cache feature for repetitive builds (e.g. when changing only a few source files
160 to test something) will become much faster since Waf will cache and re-use the
161 unchanged built files and only compile the changed code again. See `Waf Cache`_ for details.
162 To build Geany with Waf as run::
174 The Waf build system has a nice and interesting feature which can help to avoid
175 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
176 or trying to debug something in Geany.
177 Waf is able to store and retrieve the object files from a cache. This cache is declared
178 using the environment variable ``WAFCACHE``.
179 A possible location of the cache directory could be ``~/.cache/waf``. In order to make use of
180 this, you first need to create this directory::
182 $ mkdir -p ~/.cache/waf
184 then add the environment variable to your shell configuration (the following example is for
185 Bash and should be adjusted to your used shell)::
187 export WAFCACHE=/home/username/.cache/waf
189 Remember to replace ``username`` with your actual username.
191 More information about the Waf cache feature are available at
192 http://code.google.com/p/waf/wiki/CacheObjectFiles.
196 You should be careful about the size of the cache directory as it may
197 grow rapidly over time.
198 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
200 An easy way to keep it clean is to run the following command regularly to remove old
203 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
205 This will delete all files in the cache directory which are older than 14 days.
207 For details about the ``find`` command and its options, check its manual page.
212 The configure script supports several common options, for a detailed
221 (depending on which build system you use).
223 You may also want to read the INSTALL file for advanced installation
226 * See also `Compile-time options`_.
228 Dynamic linking loader support and VTE
229 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
230 In the case that your system lacks dynamic linking loader support, you
231 probably want to pass the option ``--disable-vte`` to the ``configure``
232 script. This prevents compiling Geany with dynamic linking loader
233 support for automatically loading ``libvte.so.4`` if available.
237 If there are any errors during compilation, check your build
238 environment and try to find the error, otherwise contact the mailing
239 list or one the authors. Sometimes you might need to ask for specific
240 help from your distribution.
245 If you want to find Geany's system files after installation you may
246 want to know the installation prefix.
248 Pass the ``--print-prefix`` option to Geany to check this - see
249 `Command line options`_. The first path is the prefix.
251 On Unix-like systems this is commonly ``/usr`` if you installed from
252 a binary package, or ``/usr/local`` if you build from source.
255 Editing system files is not necessary as you should use the
256 per-user configuration files instead, which don't need root
257 permissions. See `Configuration files`_.
267 You can start Geany in the following ways:
269 * From the Desktop Environment menu:
271 Choose in your application menu of your used Desktop Environment:
272 Development --> Geany.
274 At Windows-systems you will find Geany after installation inside
275 the application menu within its special folder.
277 * From the command line:
279 To start Geany from a command line, type the following and press
287 The Geany window is shown in the following figure:
289 .. image:: ./images/main_window.png
291 The workspace has the following parts:
294 * An optional toolbar.
295 * An optional sidebar that can show the following tabs:
297 * Documents - A document list, and
298 * Symbols - A list of symbols in your code.
300 * The main editor window.
301 * An optional message window which can show the following tabs:
303 * Status - A list of status messages.
304 * Compiler - The output of compiling or building programs.
305 * Messages - Results of 'Find Usage', 'Find in Files' and other actions
306 * Scribble - A text scratchpad for any use.
307 * Terminal - An optional terminal window.
311 Most of these can be configured in the `Interface preferences`_, the
312 `View menu`_, or the popup menu for the relevant area.
314 Additional tabs may be added to the sidebar and message window by plugins.
316 The position of the tabs can be selected in the interface preferences.
318 The sizes of the sidebar and message window can be adjusted by
319 dragging the dividers.
324 ============ ======================= =================================================
325 Short option Long option Function
326 ============ ======================= =================================================
327 *none* +number Set initial line number for the first opened file
328 (same as --line, do not put a space between the + sign
329 and the number). E.g. "geany +7 foo.bar" will open the
330 file foo.bar and place the cursor in line 7.
332 *none* --column Set initial column number for the first opened file.
334 -c dir_name --config=directory_name Use an alternate configuration directory. The default
335 configuration directory is ``~/.config/geany/`` and that
336 is where ``geany.conf`` and other configuration files
339 *none* --ft-names Print a list of Geany's internal filetype names (useful
340 for snippets configuration).
342 -g --generate-tags Generate a global tags file (see
343 `Generating a global tags file`_).
345 -P --no-preprocessing Don't preprocess C/C++ files when generating tags.
347 -i --new-instance Do not open files in a running instance, force opening
348 a new instance. Only available if Geany was compiled
349 with support for Sockets.
351 -l --line Set initial line number for the first opened file.
353 *none* --list-documents Return a list of open documents in a running Geany
355 This can be used to read the currently opened documents in
356 Geany from an external script or tool. The returned list
357 is separated by newlines (LF) and consists of the full,
358 UTF-8 encoded filenames of the documents.
359 Only available if Geany was compiled with support for
362 -m --no-msgwin Do not show the message window. Use this option if you
363 do not need compiler messages or VTE support.
365 -n --no-ctags Do not load symbol completion and call tip data. Use this
366 option if you do not want to use them.
368 -p --no-plugins Do not load plugins or plugin support.
370 *none* --print-prefix Print installation prefix, the data directory, the lib
371 directory and the locale directory (in that order) to
372 stdout, one line each. This is mainly intended for plugin
373 authors to detect installation paths.
375 -r --read-only Open all files given on the command line in read-only mode.
376 This only applies to files opened explicitly from the command
377 line, so files from previous sessions or project files are
380 -s --no-session Do not load the previous session's files.
382 -t --no-terminal Do not load terminal support. Use this option if you do
383 not want to load the virtual terminal emulator widget
384 at startup. If you do not have ``libvte.so.4`` installed,
385 then terminal-support is automatically disabled. Only
386 available if Geany was compiled with support for VTE.
388 *none* --socket-file Use this socket filename for communication with a
389 running Geany instance. This can be used with the following
390 command to execute Geany on the current workspace::
392 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
394 *none* --vte-lib Specify explicitly the path including filename or only
395 the filename to the VTE library, e.g.
396 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
397 only needed when the auto-detection does not work. Only
398 available if Geany was compiled with support for VTE.
400 -v --verbose Be verbose (print useful status messages).
402 -V --version Show version information and exit.
404 -? --help Show help information and exit.
406 *none* [files ...] Open all given files at startup. This option causes
407 Geany to ignore loading stored files from the last
408 session (if enabled).
409 Geany also recognizes line and column information when
410 appended to the filename with colons, e.g.
411 "geany foo.bar:10:5" will open the file foo.bar and
412 place the cursor in line 10 at column 5.
414 Projects can also be opened but a project file (\*.geany)
415 must be the first non-option argument. All additionally
416 given files are ignored.
417 ============ ======================= =================================================
419 You can also pass line number and column number information, e.g.::
421 geany some_file.foo:55:4
423 Geany supports all generic GTK options, a list is available on the
435 At startup, Geany loads all files from the last time Geany was
436 launched. You can disable this feature in the preferences dialog
437 (see `General Startup preferences`_).
439 You can start several instances of Geany, but only the first will
440 load files from the last session. In the subsequent instances, you
441 can find these files in the file menu under the "Recent files" item.
442 By default this contains the last 10 recently opened files. You can
443 change the number of recently opened files in the preferences dialog.
445 To run a second instance of Geany, do not specify any filenames on
446 the command-line, or disable opening files in a running instance
447 using the appropriate command line option.
450 Opening files from the command-line in a running instance
451 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
453 Geany detects if there is an instance of itself already running and opens files
454 from the command-line in that instance. So, Geany can
455 be used to view and edit files by opening them from other programs
456 such as a file manager.
458 You can also pass line number and column number information, e.g.::
460 geany some_file.foo:55:4
462 This would open the file ``some_file.foo`` with the cursor on line 55,
465 If you do not like this for some reason, you can disable using the first
466 instance by using the appropriate command line option -- see the section
467 called `Command line options`_.
470 Virtual terminal emulator widget (VTE)
471 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
473 If you have installed ``libvte.so`` on your system, it is loaded
474 automatically by Geany, and you will have a terminal widget in the
475 notebook at the bottom.
477 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
478 will not be loaded. So there is no need to install the package containing
479 this file in order to run Geany. Additionally, you can disable the use
480 of the terminal widget by command line option, for more information
481 see the section called `Command line options`_.
483 You can use this terminal (from now on called VTE) much as you would
484 a terminal program like xterm. There is basic clipboard support. You
485 can paste the contents of the clipboard by pressing the right mouse
486 button to open the popup menu, and choosing Paste. To copy text from
487 the VTE, just select the desired text and then press the right mouse
488 button and choose Copy from the popup menu. On systems running the
489 X Window System you can paste the last selected text by pressing the
490 middle mouse button in the VTE (on 2-button mice, the middle button
491 can often be simulated by pressing both mouse buttons together).
493 In the preferences dialog you can specify a shell which should be
494 started in the VTE. To make the specified shell a login shell just
495 use the appropriate command line options for the shell. These options
496 should be found in the manual page of the shell. For zsh and bash
497 you can use the argument ``--login``.
500 Geany tries to load ``libvte.so``. If this fails, it tries to load
501 some other filenames. If this fails too, you should check whether you
502 installed libvte correctly. Again note, Geany will run without this
505 It could be, that the library is called something else than
506 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
507 please set a link to the correct file (as root)::
509 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
511 Obviously, you have to adjust the paths and set X to the number of your
514 You can also specify the filename of the VTE library to use on the command
515 line (see the section called `Command line options`_) or at compile time
516 by specifying the command line option ``--with-vte-module-path`` to
520 Defining own widget styles using .gtkrc-2.0
521 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
523 You can define your widget style for many of Geany's GUI parts. To
524 do this, just edit your ``.gtkrc-2.0`` (usually found in your home
525 directory on UNIX-like systems and in the etc subdirectory of your
526 Geany installation on Windows).
528 To have a defined style used by Geany you must assign it to
529 at least one of Geany's widgets. For example use the following line::
531 widget "Geany*" style "geanyStyle"
533 This would assign your style "geany_style" to all Geany
534 widgets. You can also assign styles only to specific widgets. At the
535 moment you can use the following widgets:
547 An example of a simple ``.gtkrc-2.0``::
553 widget "GeanyMainWindow" style "geanyStyle"
559 widget "GeanyPrefsDialog" style "geanyStyle"
565 Switching between documents
566 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
568 The documents list and the editor tabs are two different ways
569 to switch between documents using the mouse. When you hit the key
570 combination to move between tabs, the order is determined by the tab
571 order. It is not alphabetical as shown in the documents list
572 (regardless of whether or not editor tabs are visible).
574 See the `Notebook tab keybindings`_ section for useful
575 shortcuts including for Most-Recently-Used document switching.
579 The `Document->Clone` menu item copies the current document's text,
580 cursor position and properties into a new untitled document. If
581 there is a selection, only the selected text is copied. This can be
582 useful when making temporary copies of text or for creating
583 documents with similar or identical contents.
586 Character sets and Unicode Byte-Order-Mark (BOM)
587 ------------------------------------------------
593 Geany provides support for detecting and converting character sets. So
594 you can open and save files in different character sets, and even
595 convert a file from one character set to another. To do this,
596 Geany uses the character conversion capabilities of the GLib library.
598 Only text files are supported, i.e. opening files which contain
599 NULL-bytes may fail. Geany will try to open the file anyway but it is
600 likely that the file will be truncated because it can only be read up
601 to the first occurrence of a NULL-byte. All characters after this
602 position are lost and are not written when you save the file.
604 Geany tries to detect the encoding of a file while opening it, but
605 auto-detecting the encoding of a file is not easy and sometimes an
606 encoding might not be detected correctly. In this case you have to
607 set the encoding of the file manually in order to display it
608 correctly. You can this in the file open dialog by selecting an
609 encoding in the drop down box or by reloading the file with the
610 file menu item "Reload as". The auto-detection works well for most
611 encodings but there are also some encodings where it is known that
612 auto-detection has problems.
614 There are different ways to set different encodings in Geany:
616 * Using the file open dialog
618 This opens the file with the encoding specified in the encoding drop
619 down box. If the encoding is set to "Detect from file" auto-detection
620 will be used. If the encoding is set to "Without encoding (None)" the
621 file will be opened without any character conversion and Geany will
622 not try to auto-detect the encoding (see below for more information).
624 * Using the "Reload as" menu item
626 This item reloads the current file with the specified encoding. It can
627 help if you opened a file and found out that the wrong encoding was used.
629 * Using the "Set encoding" menu item
631 Contrary to the above two options, this will not change or reload
632 the current file unless you save it. It is useful when you want to
633 change the encoding of the file.
635 * Specifying the encoding in the file itself
637 As mentioned above, auto-detecting the encoding of a file may fail on
638 some encodings. If you know that Geany doesn't open a certain file,
639 you can add the specification line, described in the next section,
640 to the beginning of the file to force Geany to use a specific
641 encoding when opening the file.
644 In-file encoding specification
645 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
647 Geany detects meta tags of HTML files which contain charset information
650 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
652 and the specified charset is used when opening the file. This is useful if the
653 encoding of the file cannot be detected properly.
654 For non-HTML files you can also define a line like::
656 /* geany_encoding=ISO-8859-15 */
660 # geany_encoding=ISO-8859-15 #
662 to force an encoding to be used. The #, /\* and \*/ are examples
663 of filetype-specific comment characters. It doesn't matter which
664 characters are around the string " geany_encoding=ISO-8859-15 " as long
665 as there is at least one whitespace character before and after this
666 string. Whitespace characters are in this case a space or tab character.
667 An example to use this could be you have a file with ISO-8859-15
668 encoding but Geany constantly detects the file encoding as ISO-8859-1.
669 Then you simply add such a line to the file and Geany will open it
670 correctly the next time.
672 Since Geany 0.15 you can also use lines which match the
673 regular expression used to find the encoding string:
674 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
677 These specifications must be in the first 512 bytes of the file.
678 Anything after the first 512 bytes will not be recognized.
682 # encoding = ISO-8859-15
686 # coding: ISO-8859-15
688 Special encoding "None"
689 ^^^^^^^^^^^^^^^^^^^^^^^
691 There is a special encoding "None" which uses no
692 encoding. It is useful when you know that Geany cannot auto-detect
693 the encoding of a file and it is not displayed correctly. Especially
694 when the file contains NULL-bytes this can be useful to skip auto
695 detection and open the file properly at least until the occurrence
696 of the first NULL-byte. Using this encoding opens the file as it is
697 without any character conversion.
700 Unicode Byte-Order-Mark (BOM)
701 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
703 Furthermore, Geany detects a Unicode Byte Order Mark (see
704 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
705 this feature is only available if the opened file is in a Unicode
706 encoding. The Byte Order Mark helps to detect the encoding of a file,
707 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
708 using a Byte Order Mark could cause some problems for programs not
709 expecting it, e.g. the compiler gcc stops
710 with stray errors, PHP does not parse a script containing a BOM and
711 script files starting with a she-bang maybe cannot be started. In the
712 status bar you can easily see whether the file starts with a BOM or
715 If you want to set a BOM for a file or if you want to remove it
716 from a file, just use the document menu and toggle the checkbox.
719 If you are unsure what a BOM is or if you do not understand where
720 to use it, then it is probably not important for you and you can
732 Geany provides basic code folding support. Folding means the ability to
733 show and hide parts of the text in the current file. You can hide
734 unimportant code sections and concentrate on the parts you are working on
735 and later you can show hidden sections again. In the editor window there is
736 a small grey margin on the left side with [+] and [-] symbols which
737 show hidden parts and hide parts of the file respectively. By
738 clicking on these icons you can simply show and hide sections which are
739 marked by vertical lines within this margin. For many filetypes nested
740 folding is supported, so there may be several fold points within other
744 You can customize the folding icon and line styles - see the
745 filetypes.common `Folding Settings`_.
747 If you don't like it or don't need it at all, you can simply disable
748 folding support completely in the preferences dialog.
750 The folding behaviour can be changed with the "Fold/Unfold all children of
751 a fold point" option in the preference dialog. If activated, Geany will
752 unfold all nested fold points below the current one if they are already
753 folded (when clicking on a [+] symbol).
754 When clicking on a [-] symbol, Geany will fold all nested fold points
755 below the current one if they are unfolded.
757 This option can be inverted by pressing the Shift
758 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
759 children of a fold point" option is enabled, pressing Shift will disable
760 it for this click and vice versa.
763 Column mode editing (rectangular selections)
764 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
766 There is basic support for column mode editing. To use it, create a
767 rectangular selection by holding down the Control and Shift keys
768 (or Alt and Shift on Windows) while selecting some text.
769 Once a rectangular selection exists you can start editing the text within
770 this selection and the modifications will be done for every line in the
773 It is also possible to create a zero-column selection - this is
774 useful to insert text on multiple lines.
776 Drag and drop of text
777 ^^^^^^^^^^^^^^^^^^^^^
779 If you drag selected text in the editor widget of Geany the text is
780 moved to the position where the mouse pointer is when releasing the
781 mouse button. Holding Control when releasing the mouse button will
782 copy the text instead. This behaviour was changed in Geany 0.11 -
783 before the selected text was copied to the new position.
789 Geany allows each document to indent either with a tab character,
790 multiple spaces or a combination of both.
792 The *Tabs* setting indents with one tab character per indent level, and
793 displays tabs as the indent width.
795 The *Spaces* setting indents with the number of spaces set in the indent
796 width for each level.
798 The *Tabs and Spaces* setting indents with spaces as above, then converts
799 as many spaces as it can to tab characters at the rate of one tab for
800 each multiple of the `Various preference` setting
801 *indent_hard_tab_width* (default 8) and displays tabs as the
802 *indent_hard_tab_width* value.
804 The default indent settings are set in `Editor Indentation
805 preferences`_ (see the link for more information).
807 The default settings can be overridden per-document using the
808 Document menu. They can also be overridden by projects - see
809 `Project management`_.
811 The indent mode for the current document is shown on the status bar
815 Indent with Tab characters.
819 Indent with tabs and spaces, depending on how much indentation is
822 Applying new indentation settings
823 `````````````````````````````````
824 After changing the default settings you may wish to apply the new
825 settings to every document in the current session. To do this use the
826 *Project->Apply Default Indentation* menu item.
828 Detecting indent type
829 `````````````````````
830 The *Detect from file* indentation preference can be used to
831 scan each file as it's opened and set the indent type based on
832 how many lines start with a tab vs. 2 or more spaces.
838 When enabled, auto-indentation happens when pressing *Enter* in the
839 Editor. It adds a certain amount of indentation to the new line so the
840 user doesn't always have to indent each line manually.
842 Geany has four types of auto-indentation:
845 Disables auto-indentation completely.
847 Adds the same amount of whitespace on a new line as on the previous line.
848 For the *Tabs* and the *Spaces* indent types the indentation will use the
849 same combination of characters as the previous line. The
850 *Tabs and Spaces* indentation type converts as explained above.
852 Does the same as *Basic* but also indents a new line after an opening
853 brace '{', and de-indents when typing a closing brace '}'. For Python,
854 a new line will be indented after typing ':' at the end of the
857 Similar to *Current chars* but the closing brace will be aligned to
858 match the indentation of the line with the opening brace. This
859 requires the filetype to be one where Geany knows that the Scintilla
860 lexer understands matching braces (C, C++, D, HTML, Pascal, Bash,
863 There is also XML-tag auto-indentation. This is enabled when the
864 mode is more than just Basic, and is also controlled by a filetype
865 setting - see `xml_indent_tags`_.
871 Geany provides a handy bookmarking feature that lets you mark one
872 or more lines in a document, and return the cursor to them using a
875 To place a mark on a line, either left-mouse-click in the left margin
876 of the editor window, or else use Ctrl-m. This will
877 produce a small green plus symbol in the margin. You can have as many
878 marks in a document as you like. Click again (or use Ctrl-m again)
879 to remove the bookmark. To remove all the marks in a given document,
880 use "Remove Markers" in the Document menu.
882 To navigate down your document, jumping from one mark to the next,
883 use Ctrl-. (control period). To go in the opposite direction on
884 the page, use Ctrl-, (control comma). Using the bookmarking feature
885 together with the commands to switch from one editor tab to another
886 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
887 navigate around multiple files.
890 Code navigation history
891 ^^^^^^^^^^^^^^^^^^^^^^^
893 To ease navigation in source files and especially between
894 different files, Geany lets you jump between different navigation
895 points. Currently, this works for the following:
897 * `Go to tag declaration`_
898 * `Go to tag definition`_
903 When using one of these actions, Geany remembers your current position
904 and jumps to the new one. If you decide to go back to your previous
905 position in the file, just use "Navigate back a location". To
906 get back to the new position again, just use "Navigate forward a
907 location". This makes it easier to navigate in e.g. foreign code
908 and between different files.
911 Sending text through custom commands
912 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
914 You can define several custom commands in Geany and send the current
915 selection to one of these commands using the *Edit->Format->Send
916 Selection to* menu or keybindings. The output of the command will be
917 used to replace the current selection. This makes it possible to use
918 text formatting tools with Geany in a general way.
920 The selected text will be sent to the standard input of the executed
921 command, so the command should be able to read from it and it should
922 print all results to its standard output which will be read by
923 Geany. To help finding errors in executing the command, the output
924 of the program's standard error will be printed on Geany's standard
927 If there is no selection, the whole current line is used instead.
929 To add a custom command, use the *Send Selection to->Set Custom
930 Commands* menu item. Click on *Add* to get a new item and type the
931 command. You can also specify some command line options. Empty
932 commands are not saved.
934 Normal shell quoting is supported, so you can do things like:
936 * ``sed 's/\./(dot)/g'``
938 The above example would normally be done with the `Replace all`_
939 function, but it can be handy to have common commands already set up.
941 Note that the command is not run in a shell, so if you want to use
942 shell features like pipes and command chains, you need to explicitly
943 launch the shell and pass it your command:
945 * ``sh -c 'sort | uniq'``
951 You can execute the context action command on the current word at the
952 cursor position or the available selection. This word or selection
953 can be used as an argument to the command.
954 The context action is invoked by a menu entry in the popup menu of the
955 editor and also a keyboard shortcut (see the section called
958 The command can be specified in the preferences dialog and also for
959 each filetype (see "context_action_cmd" in the section called
960 `Filetype configuration`_). When the context action is invoked, the filetype
961 specific command is used if available, otherwise the command
962 specified in the preferences dialog is executed.
964 The current word or selection can be referred with the wildcard "%s"
965 in the command, it will be replaced by the current word or
966 selection before the command is executed.
968 For example a context action can be used to open API documentation
969 in a browser window, the command to open the PHP API documentation
972 firefox "http://www.php.net/%s"
974 when executing the command, the %s is substituted by the word near
975 the cursor position or by the current selection. If the cursor is at
976 the word "echo", a browser window will open(assumed your browser is
977 called firefox) and it will open the address: http://www.php.net/echo.
983 Geany can offer a list of possible completions for symbols defined in the
984 tags and for all words in a document.
986 The autocompletion list for symbols is presented when the first few
987 characters of the symbol are typed (configurable, see `Editor Completions
988 preferences`_, default 4) or when the *Complete word*
989 keybinding is pressed (configurable, see `Editor keybindings`_,
992 When the defined keybinding is typed and the *Autocomplete all words in
993 document* preference (in `Editor Completions preferences`_)
994 is selected then the autocompletion list will show all matching words
995 in the document, if there are no matching symbols.
997 If you don't want to use autocompletion it can be dismissed until
998 the next symbol by pressing Escape. The autocompletion list is updated
999 as more characters are typed so that it only shows completions that start
1000 with the characters typed so far. If no symbols begin with the sequence,
1001 the autocompletion window is closed.
1003 The up and down arrows will move the selected item. The highlighted
1004 item on the autocompletion list can be chosen from the list by pressing
1005 Enter/Return. You can also double-click to select an item. The sequence
1006 will be completed to match the chosen item, and if the *Drop rest of
1007 word on completion* preference is set (in `Editor Completions
1008 preferences`_) then any characters after the cursor that match
1009 a symbol or word are deleted.
1011 Word part completion
1012 ````````````````````
1013 By default, pressing Tab will complete the selected item by word part;
1014 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
1019 * gtk_combo_box_<e><TAB>
1020 * gtk_combo_box_entry_<s><ENTER>
1021 * gtk_combo_box_entry_set_text_column
1023 The key combination can be changed from Tab - See `Editor keybindings`_.
1024 If you clear/change the key combination for word part completion, Tab
1025 will complete the whole word instead, like Enter.
1027 Scope autocompletion
1028 ````````````````````
1037 When you type ``foo.`` it will show an autocompletion list with 'i' and
1040 It only works for languages that set parent scope names for e.g. struct
1041 members. Currently this means C-like languages. The C tag parser only
1042 parses global scopes, so this won't work for structs or objects declared
1046 User-definable snippets
1047 ^^^^^^^^^^^^^^^^^^^^^^^
1049 Snippets are small strings or code constructs which can be replaced or
1050 completed to a more complex string. So you can save a lot of time when
1051 typing common strings and letting Geany do the work for you.
1052 To know what to complete or replace Geany reads a configuration file
1053 called ``snippets.conf`` at startup.
1055 Maybe you need to often type your name, so define a snippet like this::
1058 myname=Enrico Tröger
1060 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
1061 with "Enrico Tröger". The key to start autocompletion can be changed
1062 in the preferences dialog, by default it is TAB. The corresponding keybinding
1063 is called `Complete snippet`.
1067 You can override the default snippets using the user
1068 ``snippets.conf`` file. Use the *Tools->Configuration
1069 Files->snippets.conf* menu item. See also `Configuration file paths`_.
1071 This adds the default settings to the user file if the file doesn't
1072 exist. Alternatively the file can be created manually, adding only
1073 the settings you want to change. All missing settings will be read
1074 from the system snippets file.
1078 The file ``snippets.conf`` contains sections defining snippets that
1079 are available for particular filetypes and in general.
1081 The two sections "Default" and "Special" apply to all filetypes.
1082 "Default" contains all snippets which are available for every
1083 filetype and "Special" contains snippets which can only be used in
1084 other snippets. So you can define often used parts of snippets and
1085 just use the special snippet as a placeholder (see the
1086 ``snippets.conf`` for details).
1088 You can define sections with the name of a filetype eg "C++". The
1089 snippets in that section are only available for use in files with that
1090 filetype. Snippets in filetype sections will hide snippets with the
1091 same name in the "Default" section when used in a file of that
1094 **Substitution sequences for snippets**
1096 To define snippets you can use several special character sequences which
1097 will be replaced when using the snippet:
1099 ================ =========================================================
1100 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1101 char(s): LF, CR/LF, or CR).
1103 \\t or %ws% Insert an indentation step, it will be replaced according
1104 to the current document's indent mode.
1106 \\s \\s to force whitespace at beginning or end of a value
1107 ('key= value' won't work, use 'key=\\svalue')
1109 %cursor% Place the cursor at this position after completion has
1110 been done. You can define multiple %cursor% wildcards
1111 and use the keybinding `Move cursor in snippet` to jump
1112 to the next defined cursor position in the completed
1115 %...% "..." means the name of a key in the "Special" section.
1116 If you have defined a key "brace_open" in the "Special"
1117 section you can use %brace_open% in any other snippet.
1118 ================ =========================================================
1120 Snippet names must not contain spaces otherwise they won't
1121 work correctly. But beside that you can define almost any
1122 string as a snippet and use it later in Geany. It is not limited
1123 to existing contructs of certain programming languages(like ``if``,
1124 ``for``, ``switch``). Define whatever you need.
1126 **Template wildcards**
1128 Since Geany 0.15 you can also use most of the available templates wildcards
1129 listed in `Template wildcards`_. All wildcards which are listed as
1130 `available in snippets` can be used. For instance to improve the above example::
1133 myname=My name is {developer}
1134 mysystem=My system: {command:uname -a}
1136 this will replace ``myname`` with "My name is " and the value of the template
1137 preference ``developer``.
1141 You can change the way Geany recognizes the word to complete,
1142 that is how the start and end of a word is recognised when the
1143 snippet completion is requested. The section "Special" may
1144 contain a key "wordchars" which lists all characters a string may contain
1145 to be recognized as a word for completion. Leave it commented to use
1146 default characters or define it to add or remove characters to fit your
1152 Normally you would type the snippet name and press Tab. However, you
1153 can define keybindings for snippets under the *Keybindings* group in
1158 block_cursor=<Ctrl>8
1161 Snippet keybindings may be overridden by Geany's configurable
1165 Inserting Unicode characters
1166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1168 You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1169 Ctrl-Shift, type some hex digits representing the code point for the character
1170 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1171 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1172 insertion is completed, but the typed character is also entered. In the case
1173 of Enter/Return, it is a newline, as you might expect.
1176 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1177 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1178 or restart Geany. Note that it works slightly differently from other GTK
1179 applications, in that you'll need to continue to hold down the Ctrl and Shift
1180 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1183 Search, replace and go to
1184 -------------------------
1186 This section describes search-related commands from the Search menu
1187 and the editor window's popup menu:
1194 * Go to tag definition
1195 * Go to tag declaration
1198 See also `Search`_ preferences.
1202 There are also two toolbar entries:
1207 There are keybindings to focus each of these - see `Focus
1208 keybindings`_. Pressing Escape will then focus the editor.
1212 The quickest way to find some text is to use the search bar entry in
1213 the toolbar. This performs a case-insensitive search in the current
1214 document whilst you type. Pressing Enter will search again, and pressing
1215 Shift-Enter will search backwards.
1220 The Find dialog is used for finding text in one or more open documents.
1222 .. image:: ./images/find_dialog.png
1228 The syntax for the *Use regular expressions* option is shown in
1229 `Regular expressions`_.
1232 *Use escape sequences* is implied for regular expressions.
1234 The *Use multi-line matching* option enables multi-line regular
1235 expressions instead of single-line ones. See `Regular expressions`_ for
1236 more details on the differences between the two modes.
1238 The *Use escape sequences* option will transform any escaped characters
1239 into their UTF-8 equivalent. For example, \\t will be transformed into
1240 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1241 (Unicode characters).
1247 To find all matches, click on the Find All expander. This will reveal
1254 Find All In Document will show a list of matching lines in the
1255 current document in the Messages tab of the Message Window. *Find All
1256 In Session* does the same for all open documents.
1258 Mark will highlight all matches in the current document with a
1259 colored box. These markers can be removed by selecting the
1260 Remove Markers command from the Document menu.
1263 Change font in search dialog text fields
1264 ````````````````````````````````````````
1266 All search related dialogs use a Monospace for the text input fields to
1267 increase the readability of input text. This is useful when you are
1268 typing input such as regular expressions with spaces, periods and commas which
1269 might it hard to read with a proportional font.
1271 If you want to change the font, you can do this easily
1272 by inserting the following style into your ``.gtkrc-2.0``
1273 (usually found in your home directory on UNIX-like systems and in the
1274 etc subdirectory of your Geany installation on Windows)::
1276 style "search_style"
1278 font_name="Monospace 8"
1280 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1282 Please note the addition of ":highest" in the last line which sets the priority
1283 of this style to the highest available. Otherwise, the style is ignored
1284 for the search dialogs.
1289 The *Find Next/Previous Selection* commands perform a search for the
1290 current selected text. If nothing is selected, by default the current
1291 word is used instead. This can be customized by the
1292 *find_selection_type* preference - see `Various preferences`_.
1294 ===== =============================================
1295 Value *find_selection_type* behaviour
1296 ===== =============================================
1297 0 Use the current word (default).
1298 1 Try the X selection first, then current word.
1299 2 Repeat last search.
1300 ===== =============================================
1306 *Find Usage* searches all open files. It is similar to the *Find All In
1307 Session* option in the Find dialog.
1309 If there is a selection, then it is used as the search text; otherwise
1310 the current word is used. The current word is either taken from the
1311 word nearest the edit cursor, or the word underneath the popup menu
1312 click position when the popup menu is used. The search results are
1313 shown in the Messages tab of the Message Window.
1316 You can also use Find Usage for symbol list items from the popup
1323 *Find in Files* is a more powerful version of *Find Usage* that searches
1324 all files in a certain directory using the Grep tool. The Grep tool
1325 must be correctly set in Preferences to the path of the system's Grep
1326 utility. GNU Grep is recommended (see note below).
1328 .. image:: ./images/find_in_files_dialog.png
1330 The *Search* field is initially set to the current word in the editor
1331 (depending on `Search`_ preferences).
1333 The *Files* setting allows to choose which files are included in the
1334 search, depending on the mode:
1337 Search in all files;
1339 Use the current project's patterns, see `Project properties`_;
1341 Use custom patterns.
1343 Both project and custom patterns use a glob-style syntax, each
1344 pattern separated by a space. To search all ``.c`` and ``.h`` files,
1346 Note that an empty pattern list searches in all files rather
1349 The *Directory* field is initially set to the current document's directory,
1350 unless this field has already been edited and the current document has
1351 not changed. Otherwise, the current document's directory is prepended to
1352 the drop-down history. This can be disabled - see `Search`_ preferences.
1354 The *Encoding* field can be used to define the encoding of the files
1355 to be searched. The entered search text is converted to the chosen encoding
1356 and the search results are converted back to UTF-8.
1358 The *Extra options* field is used to pass any additional arguments to
1362 The *Files* setting uses ``--include=`` when searching recursively,
1363 *Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
1364 not work with other Grep implementations.
1367 Filtering out version control files
1368 ```````````````````````````````````
1370 When using the *Recurse in subfolders* option with a directory that's
1371 under version control, you can set the *Extra options* field to filter
1372 out version control files.
1374 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1375 argument to filter out CVS and hidden directories like ``.svn``.
1377 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1379 If you have an older Grep, you can try using the ``--exclude`` flag
1380 to filter out filenames.
1382 SVN Example: ``--exclude=*.svn-base``
1384 The --exclude argument only matches the file name part, not the path.
1390 The Replace dialog is used for replacing text in one or more open
1393 .. image:: ./images/replace_dialog.png
1395 The Replace dialog has the same options for matching text as the Find
1396 dialog. See the section `Matching options`_.
1398 The *Use regular expressions* option allows regular expressions to
1399 be used in the search string and back references in the replacement
1400 text -- see the entry for '\\n' in `Regular expressions`_.
1405 To replace several matches, click on the *Replace All* expander. This
1406 will reveal several options:
1412 *Replace All In Document* will replace all matching text in the
1413 current document. *Replace All In Session* does the same for all open
1414 documents. *Replace All In Selection* will replace all matching text
1415 in the current selection of the current document.
1418 Go to tag definition
1419 ^^^^^^^^^^^^^^^^^^^^
1421 If the current word or selection is the name of a tag definition
1422 (e.g. a function name) and the file containing the tag definition is
1423 open, this command will switch to that file and go to the
1424 corresponding line number. The current word is either the word
1425 nearest the edit cursor, or the word underneath the popup menu click
1426 position when the popup menu is used.
1429 If the corresponding tag is on the current line, Geany will first
1430 look for a tag declaration instead, as this is more useful.
1431 Likewise *Go to tag declaration* will search for a tag definition
1432 first in this case also.
1435 Go to tag declaration
1436 ^^^^^^^^^^^^^^^^^^^^^
1438 Like *Go to tag definition*, but for a forward declaration such as a
1439 C function prototype or ``extern`` declaration instead of a function
1446 Go to a particular line number in the current file.
1452 You can use regular expressions in the Find and Replace dialogs
1453 by selecting the *Use regular expressions* check box (see `Matching
1454 options`_). The syntax is Perl compatible. Basic syntax is described
1455 in the table below. For full details, see
1456 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
1458 By default regular expressions are matched on a line-by-line basis.
1459 If you are interested in multi-line regular expressions, matched against
1460 the whole buffer at once, see the section `Multi-line regular expressions`_
1464 1. The *Use escape sequences* dialog option always applies for regular
1466 2. Searching backwards with regular expressions is not supported.
1467 3. The *Use multi-line matching* dialog option to select single or
1468 multi-line matching.
1470 **In a regular expression, the following characters are interpreted:**
1472 ======= ============================================================
1473 . Matches any character.
1475 ( This marks the start of a region for tagging a match.
1477 ) This marks the end of a tagged region.
1479 \\n Where n is 1 through 9 refers to the first through ninth tagged
1480 region when searching or replacing.
1482 Searching for (Wiki)\\1 matches WikiWiki.
1484 If the search string was Fred([1-9])XXX and the
1485 replace string was Sam\\1YYY, when applied to Fred2XXX this
1486 would generate Sam2YYY.
1488 \\0 When replacing, the whole matching text.
1490 \\b This matches a word boundary.
1492 \\c A backslash followed by d, D, s, S, w or W, becomes a
1493 character class (both inside and outside sets []).
1496 * D: any char except decimal digits
1497 * s: whitespace (space, \\t \\n \\r \\f \\v)
1498 * S: any char except whitespace (see above)
1499 * w: alphanumeric & underscore
1500 * W: any char except alphanumeric & underscore
1502 \\x This allows you to use a character x that would otherwise have
1503 a special meaning. For example, \\[ would be interpreted as [
1504 and not as the start of a character set. Use \\\\ for a literal
1507 [...] Matches one of the characters in the set. If the first
1508 character in the set is ^, it matches the characters NOT in
1509 the set, i.e. complements the set. A shorthand S-E (start
1510 dash end) is used to specify a set of characters S up to E,
1513 The special characters ] and - have no special
1514 meaning if they appear first in the set. - can also be last
1515 in the set. To include both, put ] first: []A-Z-].
1519 []|-] matches these 3 chars
1520 []-|] matches from ] to | chars
1521 [a-z] any lowercase alpha
1522 [^]-] any char except - and ]
1523 [^A-Z] any char except uppercase alpha
1526 ^ This matches the start of a line (unless used inside a set, see
1529 $ This matches the end of a line.
1531 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1532 Saam, Saaam and so on.
1534 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1535 Saam, Saaam and so on.
1537 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1538 ======= ============================================================
1541 This table is adapted from Scintilla and SciTE documentation,
1542 distributed under the `License for Scintilla and SciTE`_.
1545 Multi-line regular expressions
1546 ``````````````````````````````
1549 The *Use multi-line matching* dialog option enables multi-line
1550 regular expressions.
1552 Multi-line regular expressions work just like single-line ones but a
1553 match can span several lines.
1555 While the syntax is the same, a few practical differences applies:
1557 ======= ============================================================
1558 . Matches any character but newlines. This behavior can be changed
1559 to also match newlines using the (?s) option, see
1560 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html#idp5671632
1562 [^...] A negative range (see above) *will* match newlines if they are
1563 not explicitly listed in that negative range. For example, range
1564 [^a-z] will match newlines, while range [^a-z\\r\\n] won't.
1565 While this is the expected behavior, it can lead to tricky
1566 problems if one doesn't think about it when writing an expression.
1567 ======= ============================================================
1572 The View menu allows various elements of the main window to be shown
1573 or hidden, and also provides various display-related editor options.
1577 The Color schemes menu is available under the *View->Editor* submenu.
1578 It lists various color schemes for editor highlighting styles,
1579 including the default scheme first. Other items are available based
1580 on what color scheme files Geany found at startup.
1582 Color scheme files are read from the `Configuration file paths`_ under
1583 the ``colorschemes`` subdirectory. They should have the extension
1584 ``.conf``. The default color scheme
1585 is read from ``filetypes.common``.
1587 The `[named_styles] section`_ and `[named_colors] section`_ are the
1588 same as for ``filetypes.common``.
1590 The ``[theme_info]`` section can contain information about the
1591 theme. The ``name`` and ``description`` keys are read to set the
1592 menu item text and tooltip, respectively. These keys can have
1593 translations, e.g.::
1602 Tags are information that relates symbols in a program with the
1603 source file location of the declaration and definition.
1605 Geany has built-in functionality for generating tag information (aka
1606 "workspace tags") for supported filetypes when you open a file. You
1607 can also have Geany automatically load external tag files (aka "global
1608 tags files") upon startup, or manually using *Tools --> Load Tags*.
1610 Geany uses its own tag file format, similar to what ``ctags`` uses
1611 (but is incompatible with ctags). You use Geany to generate global
1612 tags files, as described below.
1618 Tags for each document are parsed whenever a file is loaded, saved or
1619 modified (see *Symbol list update frequency* preference in the `Editor
1620 Completions preferences`_). These are shown in the Symbol list in the
1621 Sidebar. These tags are also used for autocompletion of symbols and calltips
1622 for all documents open in the current session that have the same filetype.
1624 The *Go to Tag* commands can be used with all workspace tags. See
1625 `Go to tag definition`_.
1631 Global tags are used to provide autocompletion of symbols and calltips
1632 without having to open the corresponding source files. This is intended
1633 for library APIs, as the tags file only has to be updated when you upgrade
1636 You can load a custom global tags file in two ways:
1638 * Using the *Load Tags* command in the Tools menu.
1639 * By moving or symlinking tags files to the ``tags`` subdirectory of
1640 one of the `configuration file paths`_ before starting Geany.
1642 You can either download these files or generate your own. They have
1647 *lang_ext* is one of the extensions set for the filetype associated
1648 with the tags. See the section called `Filetype extensions`_ for
1652 Default global tags files
1653 `````````````````````````
1655 For some languages, a list of global tags is loaded when the
1656 corresponding filetype is first used. Currently these are for:
1661 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1666 Global tags file format
1667 ```````````````````````
1669 Global tags files can have three different formats:
1672 * Pipe-separated format
1675 The first line of global tags files should be a comment, introduced
1676 by ``#`` followed by a space and a string like ``format=pipe``,
1677 ``format=ctags`` or ``format=tagmanager`` respectively, these are
1678 case-sensitive. This helps Geany to read the file properly. If this
1679 line is missing, Geany tries to auto-detect the used format but this
1683 The Tagmanager format is a bit more complex and is used for files
1684 created by the ``geany -g`` command. There is one tag per line.
1685 Different tag attributes like the return value or the argument list
1686 are separated with different characters indicating the type of the
1687 following argument. This is the more complete and recommended tag
1690 Pipe-separated format
1691 *********************
1692 The Pipe-separated format is easier to read and write.
1693 There is one tag per line and different tag attributes are separated
1694 by the pipe character (``|``). A line looks like::
1696 basename|string|(string path [, string suffix])|
1698 | The first field is the tag name (usually a function name).
1699 | The second field is the type of the return value.
1700 | The third field is the argument list for this tag.
1701 | The fourth field is the description for this tag but
1702 currently unused and should be left empty.
1704 Except for the first field (tag name), all other field can be left
1705 empty but the pipe separator must appear for them.
1707 You can easily write your own global tag files using this format.
1708 Just save them in your tags directory, as described earlier in the
1709 section `Global tags`_.
1713 This is the format that ctags generates, and that is used by Vim.
1714 This format is compatible with the format historically used by Vi.
1716 The format is described at http://ctags.sourceforge.net/FORMAT, but
1717 for the full list of existing extensions please refer to ctags.
1718 However, note that Geany may actually only honor a subset of the
1719 existing extensions.
1721 Generating a global tags file
1722 `````````````````````````````
1724 You can generate your own global tags files by parsing a list of
1725 source files. The command is::
1727 geany -g [-P] <Tag File> <File list>
1729 * Tag File filename should be in the format described earlier --
1730 see the section called `Global tags`_.
1731 * File list is a list of filenames, each with a full path (unless
1732 you are generating C/C++ tags and have set the CFLAGS environment
1733 variable appropriately).
1734 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1735 to process ``#include`` directives for C/C++ source files. Use this
1736 option if you want to specify each source file on the command-line
1737 instead of using a 'master' header file. Also can be useful if you
1738 don't want to specify the CFLAGS environment variable.
1740 Example for the wxD library for the D programming language::
1742 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1745 Generating C/C++ tag files
1746 **************************
1747 You may need to first setup the `C ignore.tags`_ file.
1749 For C/C++ tag files gcc is required by default, so that header files
1750 can be preprocessed to include any other headers they depend upon. If
1751 you do not want this, use the ``-P`` option described above.
1753 For preprocessing, the environment variable CFLAGS should be set with
1754 appropriate ``-I/path`` include paths. The following example works with
1755 the bash shell, generating tags for the GnomeUI library::
1757 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1758 /usr/include/libgnomeui-2.0/gnome.h
1760 You can adapt this command to use CFLAGS and header files appropriate
1761 for whichever libraries you want.
1764 Generating tag files on Windows
1765 *******************************
1766 This works basically the same as on other platforms::
1768 "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
1774 You can ignore certain tags for C-based languages if they would lead
1775 to wrong parsing of the code. Use the *Tools->Configuration
1776 Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
1777 See also `Configuration file paths`_.
1779 List all tag names you want to ignore in this file, separated by spaces
1784 G_GNUC_NULL_TERMINATED
1786 G_GNUC_WARN_UNUSED_RESULT
1788 This will parse code like:
1790 ``gchar **utils_strv_new(const gchar *first, ...)
1791 G_GNUC_NULL_TERMINATED;``
1793 More detailed information about ignore tags usage from the Exuberant Ctags
1796 Specifies a list of identifiers which are to be specially handled
1797 while parsing C and C++ source files. This option is specifically
1798 provided to handle special cases arising through the use of
1799 pre-processor macros. When the identifiers listed are simple identifiers,
1800 these identifiers will be ignored during parsing of the source files.
1801 If an identifier is suffixed with a '+' character, ctags will also
1802 ignore any parenthesis-enclosed argument list which may immediately
1803 follow the identifier in the source files.
1804 If two identifiers are separated with the '=' character, the first
1805 identifiers is replaced by the second identifiers for parsing purposes.
1807 For even more detailed information please read the manual page of
1810 Geany extends Ctags with a '*' character suffix - this means use
1811 prefix matching, e.g. G_GNUC_* will match G_GNUC_NULL_TERMINATED, etc.
1812 Note that prefix match items should be put after other items to ensure
1813 that items like G_GNUC_PRINTF+ get parsed correctly.
1819 You may adjust Geany's settings using the Edit --> Preferences
1820 dialog. Any changes you make there can be applied by hitting either
1821 the Apply or the OK button. These settings will persist between Geany
1822 sessions. Note that most settings here have descriptive popup bubble
1823 help -- just hover the mouse over the item in question to get help
1826 You may also adjust some View settings (under the View menu) that
1827 persist between Geany sessions. The settings under the Document menu,
1828 however, are only for the current document and revert to defaults
1829 when restarting Geany.
1832 In the paragraphs that follow, the text describing a dialog tab
1833 comes after the screenshot of that tab.
1836 General Startup preferences
1837 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1839 .. image:: ./images/pref_dialog_gen_startup.png
1844 Load files from the last session
1845 On startup, load the same files you had open the last time you
1848 Load virtual terminal support
1849 Load the library for running a terminal in the message window area.
1851 Enable plugin support
1852 Allow plugins to be used in Geany.
1856 Save window position and geometry
1857 Save the current position and size of the main window so next time
1858 you open Geany it's in the same location.
1861 Have a dialog pop up to confirm that you really want to quit Geany.
1867 Path to start in when opening or saving files.
1868 It must be an absolute path.
1871 Path to start in when opening project files.
1874 By default Geany looks in the system installation and the user
1875 configuration - see `Plugins`_. In addition the path entered here will be
1877 Usually you do not need to set an additional path to search for
1878 plugins. It might be useful when Geany is installed on a multi-user machine
1879 and additional plugins are available in a common location for all users.
1880 Leave blank to not set an additional lookup path.
1883 General Miscellaneous preferences
1884 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1886 .. image:: ./images/pref_dialog_gen_misc.png
1891 Beep on errors when compilation has finished
1892 Have the computer make a beeping sound when compilation of your program
1893 has completed or any errors occurred.
1895 Switch status message list at new message
1896 Switch to the status message tab (in the notebook window at the bottom)
1897 once a new status message arrives.
1899 Suppress status messages in the status bar
1900 Remove all messages from the status bar. The messages are still displayed
1901 in the status messages window.
1904 Another option is to use the *Switch to Editor* keybinding - it
1905 reshows the document statistics on the status bar. See `Focus
1908 Use Windows File Open/Save dialogs
1909 Defines whether to use the native Windows File Open/Save dialogs or
1910 whether to use the GTK default dialogs.
1912 Auto-focus widgets (focus follows mouse)
1913 Give the focus automatically to widgets below the mouse cursor.
1914 This works for the main editor widget, the scribble, the toolbar search field
1915 goto line fields and the VTE.
1921 Always wrap search around the document when finding a match.
1923 Hide the Find dialog
1924 Hide the `Find`_ dialog after clicking Find Next/Previous.
1926 Use the current word under the cursor for Find dialogs
1927 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1928 there is no selection. When this option is disabled, the search term last used in the
1929 appropriate Find dialog is used.
1931 Use the current file's directory for Find in Files
1932 When opening the Find in Files dialog, set the directory to search to the directory of the current
1933 active file. When this option is disabled, the directory of the last use of the Find in Files
1934 dialog is used. See `Find in Files`_ for details.
1939 Use project-based session files
1940 Save your current session when closing projects. You will be able to
1941 resume different project sessions, automatically opening the files
1942 you had open previously.
1944 Store project file inside the project base directory
1945 When creating new projects, the default path for the project file contains
1946 the project base path. Without this option enabled, the default project file
1947 path is one level above the project base path.
1948 In either case, you can easily set the final project file path in the
1949 *New Project* dialog. This option provides the more common
1950 defaults automatically for convenience.
1953 Interface preferences
1954 ^^^^^^^^^^^^^^^^^^^^^
1956 .. image:: ./images/pref_dialog_interface_interface.png
1962 Whether to show the sidebar at all.
1965 Show the list of functions, variables, and other information in the
1966 current document you are editing.
1969 Show all the documents you have open currently. This can be used to
1970 change between documents (see `Switching between documents`_) and
1971 to perform some common operations such as saving, closing and reloading.
1974 Whether to place the sidebar on the left or right of the editor window.
1980 Whether to place the message window on the bottom or right of the editor window.
1986 Change the font used to display documents.
1989 Change the font used for the Symbols sidebar tab.
1992 Change the font used for the message window area.
1998 Show the status bar at the bottom of the main window. It gives information about
1999 the file you are editing like the line and column you are on, whether any
2000 modifications were done, the file encoding, the filetype and other information.
2002 Interface Notebook tab preferences
2003 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2005 .. image:: ./images/pref_dialog_interface_notebook.png
2011 Show a notebook tab for all documents so you can switch between them
2012 using the mouse (instead of using the Documents window).
2015 Make each tab show a close button so you can easily close open
2018 Placement of new file tabs
2019 Whether to create a document with its notebook tab to the left or
2020 right of all existing tabs.
2023 Whether to place file tabs next to the current tab
2024 rather than at the edges of the notebook.
2026 Double-clicking hides all additional widgets
2027 Whether to call the View->Toggle All Additional Widgets command
2028 when double-clicking on a notebook tab.
2034 Set the positioning of the editor's notebook tabs to the right,
2035 left, top, or bottom of the editing window.
2038 Set the positioning of the sidebar's notebook tabs to the right,
2039 left, top, or bottom of the sidebar window.
2042 Set the positioning of the message window's notebook tabs to the
2043 right, left, top, or bottom of the message window.
2046 Interface Toolbar preferences
2047 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2049 Affects the main toolbar underneath the menu bar.
2051 .. image:: ./images/pref_dialog_interface_toolbar.png
2057 Whether to show the toolbar.
2059 Append Toolbar to the Menu
2060 Allows to append the toolbar to the main menu bar instead of placing it below.
2061 This is useful to save vertical space.
2064 See `Customizing the toolbar`_.
2070 Select the toolbar icon style to use - either icons and text, just
2072 The choice System default uses whatever icon style is set by GTK.
2075 Select the size of the icons you see (large, small or very small).
2076 The choice System default uses whatever icon size is set by GTK.
2079 Editor Features preferences
2080 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2082 .. image:: ./images/pref_dialog_edit_features.png
2088 Show long lines wrapped around to new display lines.
2093 Whether to move the cursor to the first non-whitespace character
2094 on the line when you hit the home key on your keyboard. Pressing it
2095 again will go to the very start of the line.
2097 Disable Drag and Drop
2098 Do not allow the dragging and dropping of selected text in documents.
2101 Allow groups of lines in a document to be collapsed for easier
2104 Fold/Unfold all children of a fold point
2105 Whether to fold/unfold all child fold points when a parent line
2108 Use indicators to show compile errors
2109 Underline lines with compile errors using red squiggles to indicate
2110 them in the editor area.
2112 Newline strips trailing spaces
2113 Remove any whitespace at the end of the line when you hit the
2114 Enter/Return key. See also `Strip trailing spaces`_. Note
2115 auto indentation is calculated before stripping, so although this
2116 setting will clear a blank line, it will not set the next line
2117 indentation back to zero.
2119 Line breaking column
2120 The editor column number to insert a newline at when Line Breaking
2121 is enabled for the current document.
2123 Comment toggle marker
2124 A string which is added when toggling a line comment in a source file.
2125 It is used to mark the comment as toggled.
2128 Editor Indentation preferences
2129 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2131 .. image:: ./images/pref_dialog_edit_indentation.png
2136 See `Indentation`_ for more information.
2139 The width of a single indent size in spaces. By default the indent
2140 size is equivalent to 4 spaces.
2142 Detect width from file
2143 Try to detect and set the indent width based on file content, when
2147 When Geany inserts indentation, whether to use:
2151 * Tabs and Spaces, depending on how much indentation is on a line
2153 The *Tabs and Spaces* indent type is also known as *Soft tab
2154 support* in some other editors.
2156 Detect type from file
2157 Try to detect and set the indent type based on file content, when
2161 The type of auto-indentation you wish to use after pressing Enter,
2165 Just add the indentation of the previous line.
2167 Add indentation based on the current filetype and any characters at
2168 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
2170 Like *Current chars* but for C-like languages, make a closing
2171 ``}`` brace line up with the matching opening brace.
2174 If set, pressing tab will indent the current line or selection, and
2175 unindent when pressing Shift-tab. Otherwise, the tab key will
2176 insert a tab character into the document (which can be different
2177 from indentation, depending on the indent type).
2180 There are also separate configurable keybindings for indent &
2181 unindent, but this preference allows the tab key to have different
2182 meanings in different contexts - e.g. for snippet completion.
2184 Editor Completions preferences
2185 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2187 .. image:: ./images/pref_dialog_edit_completions.png
2193 Whether to replace special keywords after typing Tab into a
2194 pre-defined text snippet.
2195 See `User-definable snippets`_.
2197 XML/HTML tag auto-closing
2198 When you open an XML/HTML tag automatically generate its
2201 Automatic continuation multi-line comments
2202 Continue automatically multi-line comments in languages like C, C++
2203 and Java when a new line is entered inside such a comment.
2204 With this option enabled, Geany will insert a ``*`` on every new line
2205 inside a multi-line comment, for example when you press return in the
2209 * This is a C multi-line comment, press <Return>
2211 then Geany would insert::
2215 on the next line with the correct indentation based on the previous line,
2216 as long as the multi-line is not closed by ``*/``.
2218 Autocomplete symbols
2219 When you start to type a symbol name, look for the full string to
2220 allow it to be completed for you.
2222 Autocomplete all words in document
2223 When you start to type a word, Geany will search the whole document for
2224 words starting with the typed part to complete it, assuming there
2225 are no tag names to show.
2227 Drop rest of word on completion
2228 Remove any word part to the right of the cursor when choosing a
2229 completion list item.
2231 Characters to type for autocompletion
2232 Number of characters of a word to type before autocompletion is
2235 Completion list height
2236 The number of rows to display for the autocompletion window.
2238 Max. symbol name suggestions
2239 The maximum number of items in the autocompletion list.
2241 Symbol list update frequency
2242 The minimum delay (in milliseconds) between two symbol list updates.
2244 This option determines how frequently the tag list is updated for the
2245 current document. The smaller the delay, the more up-to-date the symbol
2246 list (and then the completions); but rebuilding the symbol list has a
2247 cost in performance, especially with large files.
2249 The default value is 250ms, which means the symbol list will be updated
2250 at most four times per second, even if the document changes continuously.
2252 A value of 0 disables automatic updates, so the symbol list will only be
2253 updated upon document saving.
2256 Auto-close quotes and brackets
2257 ``````````````````````````````
2259 Geany can automatically insert a closing bracket and quote characters when
2260 you open them. For instance, you type a ``(`` and Geany will automatically
2261 insert ``)``. With the following options, you can define for which
2262 characters this should work.
2265 Auto-close parenthesis when typing an opening one
2268 Auto-close curly brackets (braces) when typing an opening one
2271 Auto-close square brackets when typing an opening one
2274 Auto-close single quotes when typing an opening one
2277 Auto-close double quotes when typing an opening one
2280 Editor Display preferences
2281 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2283 This is for visual elements displayed in the editor window.
2285 .. image:: ./images/pref_dialog_edit_display.png
2290 Invert syntax highlighting colors
2291 Invert all colors, by default this makes white text on a black
2294 Show indendation guides
2295 Show vertical lines to help show how much leading indentation there
2299 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2300 show which kinds of whitespace are used.
2303 Display a symbol everywhere that a carriage return or line feed
2307 Show or hide the Line Number margin.
2310 Show or hide the small margin right of the line numbers, which is used
2313 Stop scrolling at last line
2314 When enabled Geany stops scrolling when at the last line of the document.
2315 Otherwise you can scroll one more page even if there are no real lines.
2321 The long line marker helps to indicate overly-long lines, or as a hint
2322 to the user for when to break the line.
2326 Show a thin vertical line in the editor window at the given column
2329 Change the background color of characters after the given column
2330 position to the color set below. (This is recommended over the
2331 *Line* setting if you use proportional fonts).
2333 Don't mark long lines at all.
2336 Set this value to a value greater than zero to specify the column
2337 where it should appear.
2339 Long line marker color
2340 Set the color of the long line marker.
2346 Virtual space is space beyond the end of each line.
2347 The cursor may be moved into virtual space but no real space will be
2348 added to the document until there is some text typed or some other
2349 text insertion command is used.
2352 Do not show virtual spaces
2354 Only for rectangular selections
2355 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2358 Always show virtual spaces beyond the end of lines
2364 .. image:: ./images/pref_dialog_files.png
2369 Open new documents from the command-line
2370 Whether to create new documents when passing filenames that don't
2371 exist from the command-line.
2373 Default encoding (new files)
2374 The type of file encoding you wish to use when creating files.
2376 Used fixed encoding when opening files
2377 Assume all files you are opening are using the type of encoding specified below.
2379 Default encoding (existing files)
2380 Opens all files with the specified encoding instead of auto-detecting it.
2381 Use this option when it's not possible for Geany to detect the exact encoding.
2383 Default end of line characters
2384 The end of line characters to which should be used for new files.
2385 On Windows systems, you generally want to use CR/LF which are the common
2386 characters to mark line breaks.
2387 On Unix-like systems, LF is default and CR is used on MAC systems.
2391 Perform formatting operations when a document is saved. These
2392 can each be undone with the Undo command.
2394 Ensure newline at file end
2395 Add a newline at the end of the document if one is missing.
2397 Ensure consistent line endings
2398 Ensures that newline characters always get converted before
2399 saving, avoiding mixed line endings in the same file.
2401 .. _Strip trailing spaces:
2403 Strip trailing spaces
2404 Remove any whitespace at the end of each document line.
2407 This does not apply to Diff documents, e.g. patch files.
2409 Replace tabs with spaces
2410 Replace all tabs in the document with the equivalent number of spaces.
2413 It is better to use spaces to indent than use this preference - see
2419 Recent files list length
2420 The number of files to remember in the recently used files list.
2423 The number of seconds to periodically check the current document's
2424 file on disk in case it has changed. Setting it to 0 will disable
2428 These checks are only performed on local files. Remote files are
2429 not checked for changes due to performance issues
2430 (remote files are files in ``~/.gvfs/``).
2436 .. image:: ./images/pref_dialog_tools.png
2442 The command to execute a script in a terminal. Occurrences of %c
2443 in the command are substituted with the run script name, see
2444 `Terminal emulators`_.
2447 The location of your web browser executable.
2450 The location of the grep executable.
2453 For Windows users: at the time of writing it is recommended to use
2454 the grep.exe from the UnxUtils project
2455 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2456 Mingw project for instance might not work with Geany at the moment.
2462 Set this to a command to execute on the current word.
2463 You can use the "%s" wildcard to pass the current word below the cursor
2464 to the specified command.
2467 Template preferences
2468 ^^^^^^^^^^^^^^^^^^^^
2470 This data is used as meta data for various template text to insert into
2471 a document, such as the file header. You only need to set fields that
2472 you want to use in your template files.
2474 .. image:: ./images/pref_dialog_templ.png
2480 The name of the developer who will be creating files.
2483 The initials of the developer.
2486 The email address of the developer.
2489 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2492 The company the developer is working for.
2495 The initial version of files you will be creating.
2498 Specify a format for the {year} wildcard. You can use any conversion specifiers
2499 which can be used with the ANSI C strftime function. For details please see
2500 http://man.cx/strftime.
2503 Specify a format for the {date} wildcard. You can use any conversion specifiers
2504 which can be used with the ANSI C strftime function. For details please see
2505 http://man.cx/strftime.
2508 Specify a format for the {datetime} wildcard. You can use any conversion specifiers
2509 which can be used with the ANSI C strftime function. For details please see
2510 http://man.cx/strftime.
2513 Keybinding preferences
2514 ^^^^^^^^^^^^^^^^^^^^^^
2516 .. image:: ./images/pref_dialog_keys.png
2518 There are some commands listed in the keybinding dialog that are not, by default,
2519 bound to a key combination, and may not be available as a menu item.
2522 For more information see the section `Keybindings`_.
2525 Printing preferences
2526 ^^^^^^^^^^^^^^^^^^^^
2528 .. image:: ./images/pref_dialog_printing.png
2530 Use external command for printing
2531 Use a system command to print your file out.
2533 Use native GTK printing
2534 Let the GTK GUI toolkit handle your print request.
2537 Print the line numbers on the left of your paper.
2540 Print the page number on the bottom right of your paper.
2543 Print a header on every page that is sent to the printer.
2545 Use base name of the printed file
2546 Don't use the entire path for the header, only the filename.
2549 How the date should be printed. You can use the same format
2550 specifiers as in the ANSI C function strftime(). For details please
2551 see http://man.cx/strftime.
2557 .. image:: ./images/pref_dialog_various.png
2559 Rarely used preferences, explained in the table below. A few of them require
2560 restart to take effect, and a few other will only affect newly opened or created
2561 documents before restart.
2563 ================================ =========================================== ========== ===========
2564 Key Description Default Applies
2565 ================================ =========================================== ========== ===========
2567 use_gtk_word_boundaries Whether to look for the end of a word true to new
2568 when using word-boundary related documents
2569 Scintilla commands (see `Scintilla
2570 keyboard commands`_).
2571 brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
2572 complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
2573 when editing an existing line (i.e. there
2574 is some text after the current cursor
2575 position on the line). Only used when the
2576 keybinding `Complete snippet` is set to
2578 show_editor_scrollbars Whether to display scrollbars. If set to true immediately
2579 false, the horizontal and vertical
2580 scrollbars are hidden completely.
2581 indent_hard_tab_width The size of a tab character. Don't change 8 immediately
2582 it unless you really need to; use the
2583 indentation settings instead.
2584 **Interface related**
2585 show_symbol_list_expanders Whether to show or hide the small true to new
2586 expander icons on the symbol list documents
2588 allow_always_save Whether files can be saved always, even false immediately
2589 if they don't have any changes.
2590 By default, the Save button and menu
2591 item are disabled when a file is
2592 unchanged. When setting this option to
2593 true, the Save button and menu item are
2594 always active and files can be saved.
2595 compiler_tab_autoscroll Whether to automatically scroll to the true immediately
2596 last line of the output in the Compiler
2598 statusbar_template The status bar statistics line format. See below. immediately
2599 (See `Statusbar Templates`_ for details).
2600 new_document_after_close Whether to open a new document after all false immediately
2601 documents have been closed.
2602 msgwin_status_visible Whether to show the Status tab in the true immediately
2604 msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
2606 msgwin_messages_visible Whether to show the Messages tab in the true immediately
2608 msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
2611 emulation Terminal emulation mode. Only change this xterm immediately
2612 if you have VTE termcap files other than
2613 ``vte/termcap/xterm``.
2614 send_selection_unsafe By default, Geany strips any trailing false immediately
2615 newline characters from the current
2616 selection before sending it to the terminal
2617 to not execute arbitrary code. This is
2618 mainly a security feature.
2619 If, for whatever reasons, you really want
2620 it to be executed directly, set this option
2622 send_cmd_prefix String with which prefix the commands sent Empty immediately
2623 to the shell. This may be used to tell
2624 some shells (BASH with ``HISTCONTROL`` set
2625 to ``ignorespace``, ZSH with
2626 ``HIST_IGNORE_SPACE`` enabled, etc.) from
2627 putting these commands in their history by
2628 setting this to a space. Note that leading
2629 spaces must be escaped using `\s` in the
2632 use_atomic_file_saving Defines the mode how Geany saves files to false immediately
2633 disk. If disabled, Geany directly writes
2634 the content of the document to disk. This
2635 might cause loss of data when there is
2636 no more free space on disk to save the
2637 file. When set to true, Geany first saves
2638 the contents into a temporary file and if
2639 this succeeded, the temporary file is
2640 moved to the real file to save.
2641 This gives better error checking in case of
2642 no more free disk space. But it also
2643 destroys hard links of the original file
2644 and its permissions (e.g. executable flags
2645 are reset). Use this with care as it can
2646 break things seriously.
2647 The better approach would be to ensure your
2648 disk won't run out of free space.
2649 use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
2650 saving backend. It is better on most
2651 situations but is known not to work
2652 correctly on some complex setups.
2653 gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
2654 saving. Backup is named `filename~`.
2655 keep_edit_history_on_reload_125 Whether to maintain the edit history when false immediately
2656 reloading a file, and allow the operation
2658 **Filetype related**
2659 extract_filetype_regex Regex to extract filetype name from file See below. immediately
2660 via capture group one.
2662 find_selection_type See `Find selection`_. 0 immediately
2664 replace_and_find_by_default Set ``Replace & Find`` button as default so true immediately
2665 it will be activated when the Enter key is
2666 pressed while one of the text fields has
2668 **Build Menu related**
2669 number_ft_menu_items The maximum number of menu items in the 2 on restart
2670 filetype section of the Build menu.
2671 number_non_ft_menu_items The maximum number of menu items in the 3 on restart
2672 independent section of the Build menu.
2673 number_exec_menu_items The maximum number of menu items in the 2 on restart
2674 execute section of the Build menu.
2675 ================================ =========================================== ========== ===========
2677 The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX.
2682 The default statusbar template is (note ``\t`` = tab):
2684 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
2686 Settings the preference to an empty string will also cause Geany to use this
2689 The following format characters are available for the statusbar template:
2691 ============ ===========================================================
2692 Placeholder Description
2693 ============ ===========================================================
2694 ``%l`` The current line number starting at 1
2695 ``%L`` The total number of lines
2696 ``%c`` The current column number starting at 0, including virtual
2698 ``%C`` The current column number starting at 1, including virtual
2700 ``%s`` The number of selected characters or if only whole lines
2701 selected, the number of selected lines.
2702 ``%n`` The number of selected characters, even if only whole lines
2704 ``%w`` Shows ``RO`` when the document is in read-only mode,
2705 otherwise shows whether the editor is in overtype (OVR)
2706 or insert (INS) mode.
2707 ``%t`` Shows the indentation mode, either tabs (TAB),
2708 spaces (SP) or both (T/S).
2709 ``%m`` Shows whether the document is modified (MOD) or nothing.
2710 ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
2711 ``%e`` The name of the document's encoding (ex. UTF-8).
2712 ``%f`` The filetype of the document (ex. None, Python, C, etc).
2713 ``%S`` The name of the scope where the caret is located.
2714 ``%p`` The caret position in the entire document starting at 0.
2715 ``%r`` Shows whether the document is read-only (RO) or nothing.
2716 ``%Y`` The Scintilla style number at the caret position. This is
2717 useful if you're debugging color schemes or related code.
2718 ============ ===========================================================
2720 Terminal (VTE) preferences
2721 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2723 See also: `Virtual terminal emulator widget (VTE)`_.
2725 .. image:: ./images/pref_dialog_vte.png
2731 Select the font that will be used in the terminal emulation control.
2734 Select the font color.
2737 Select the background color of the terminal.
2740 Select the background image to show behind the terminal's text.
2743 The number of lines buffered so that you can scroll though the history.
2746 The location of the shell on your system.
2749 Scroll the terminal to the prompt line when pressing a key.
2752 Scroll the output down.
2755 Let the terminal cursor blink.
2757 Override Geany keybindings
2758 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2760 Disable menu shortcut key (F10 by default)
2761 Disable the menu shortcut when you are in the virtual terminal.
2763 Follow path of the current file
2764 Make the path of the terminal change according to the path of the
2767 Execute programs in VTE
2768 Execute programs in the virtual terminal instead of using the external
2769 terminal tool. Note that if you run multiple execute commands at once
2770 the output may become mixed together in the VTE.
2772 Don't use run script
2773 Don't use the simple run script which is usually used to display
2774 the exit status of the executed program.
2775 This can be useful if you already have a program running in the VTE
2776 like a Python console (e.g. ipython). Use this with care.
2782 Project management is optional in Geany. Currently it can be used for:
2784 * Storing and opening session files on a project basis.
2785 * Overriding default settings with project equivalents.
2786 * Configuring the Build menu on a project basis.
2788 A list of session files can be stored and opened with the project
2789 when the *Use project-based session files* preference is enabled,
2790 in the `Projects`_ group of the `General Miscellaneous preferences`_ tab
2791 of the `Preferences`_ dialog.
2793 As long as a project is open, the Build menu will use
2794 the items defined in project's settings, instead of the defaults.
2795 See `Build Menu Configuration`_ for information on configuring the menu.
2797 The current project's settings are saved when it is closed, or when
2798 Geany is shutdown. When restarting Geany, the previously opened project
2799 file that was in use at the end of the last session will be reopened.
2801 The project menu items are detailed below.
2807 To create a new project, fill in the *Name* field. By default this
2808 will setup a new project file ``~/projects/name.geany``. Usually it's
2809 best to store all your project files in the same directory (they are
2810 independent of any source directory trees).
2812 The Base path text field is setup to use ``~/projects/name``. This
2813 can safely be set to any existing path -- it will not touch the file
2814 structure contained in it.
2820 You can set an optional description for the project. Currently it's
2821 only used for a template wildcard - see `Template wildcards`_.
2823 The *Base path* field is used as the directory to run the Build menu commands.
2824 The specified path can be an absolute path or it is considered to be
2825 relative to the project's file name.
2827 The *File patterns* field allows to specify a list of file patterns for the
2828 project, which can be used in the `Find in files`_ dialog.
2830 The *Indentation* tab allows you to override the default
2831 `Indentation`_ settings.
2837 The Open command displays a standard file chooser, starting in
2838 ``~/projects``. Choose a project file named with the ``.geany``
2841 When project session support is enabled, Geany will close the currently
2842 open files and open the session files associated with the project.
2848 Project file settings are saved when the project is closed.
2850 When project session support is enabled, Geany will close the project
2851 session files and open any previously closed default session files.
2856 After editing code with Geany, the next step is to compile, link, build,
2857 interpret, run etc. As Geany supports many languages each with a different
2858 approach to such operations, and as there are also many language independent
2859 software building systems, Geany does not have a built-in build system, nor
2860 does it limit which system you can use. Instead the build menu provides
2861 a configurable and flexible means of running any external commands to
2862 execute your preferred build system.
2864 This section provides a description of the default configuration of the
2865 build menu and then covers how to configure it, and where the defaults fit in.
2867 Running the commands from within Geany has two benefits:
2869 * The current file is automatically saved before the command is run.
2870 * The output is captured in the Compiler notebook tab and parsed for
2873 Warnings and errors that can be parsed for line numbers will be shown in
2874 red in the Compiler tab and you can click on them to switch to the relevant
2875 source file (or open it) and mark the line number. Also lines with
2876 warnings or errors are marked in the source, see `Indicators`_ below.
2879 If Geany's default error message parsing does not parse errors for
2880 the tool you're using, you can set a custom regex in the Build Commands
2881 Dialog, see `Build Menu Configuration`_.
2886 Indicators are red squiggly underlines which are used to highlight
2887 errors which occurred while compiling the current file. So you can
2888 easily see where your code failed to compile. You can remove them by
2889 selecting *Remove Error Indicators* in the Document menu.
2891 If you do not like this feature, you can disable it - see `Editor Features
2895 Default build menu items
2896 ^^^^^^^^^^^^^^^^^^^^^^^^
2897 Depending on the current file's filetype, the default Build menu will contain
2898 the following items:
2904 * Make Custom Target
2909 * Set Build Menu Commands
2915 The Compile command has different uses for different kinds of files.
2917 For compilable languages such as C and C++, the Compile command is
2918 set up to compile the current source file into a binary object file.
2920 Java source files will be compiled to class file bytecode.
2922 Interpreted languages such as Perl, Python, Ruby will compile to
2923 bytecode if the language supports it, or will run a syntax check,
2924 or if that is not available will run the file in its language interpreter.
2929 For compilable languages such as C and C++, the Build command will link
2930 the current source file's equivalent object file into an executable. If
2931 the object file does not exist, the source will be compiled and linked
2932 in one step, producing just the executable binary.
2934 Interpreted languages do not use the Build command.
2937 If you need complex settings for your build system, or several
2938 different settings, then writing a Makefile and using the Make
2939 commands is recommended; this will also make it easier for users to
2940 build your software.
2945 Source code linters are often used to find code that doesn't correspond to
2946 certain style guidelines: non-portable code, common or hard to find
2947 errors, code "smells", variables used before being set, unused functions,
2948 division by zero, constant conditions, etc. Linters inspect the code and
2949 issue warnings much like the compilers do. This is formally referred to as
2950 static code analysis.
2952 Some common linters are pre-configured for you in the Build menu (``pep8``
2953 for Python, ``cppcheck`` for C/C++, JSHint for JavaScript, ``xmllint`` for
2954 XML, ``hlint`` for Haskell, ``shellcheck`` for shell code, ...), but all
2955 these are standalone tools you need to obtain before using.
2960 This runs "make" in the same directory as the
2966 This is similar to running 'Make' but you will be prompted for
2967 the make target name to be passed to the Make tool. For example,
2968 typing 'clean' in the dialog prompt will run "make clean".
2974 Make object will run "make current_file.o" in the same directory as
2975 the current file, using the filename for 'current_file'. It is useful
2976 for building just the current file without building the whole project.
2981 The next error item will move to the next detected error in the file.
2985 The previous error item will move to the previous detected error in the file.
2990 Execute will run the corresponding executable file, shell script or
2991 interpreted script in a terminal window. The command set in the
2992 "Set Build Commands" dialog is run in a script to ensure the terminal
2993 stays open after execution completes. Note: see `Terminal emulators`_
2994 below for the command format. Alternatively the built-in VTE can be used
2995 if it is available - see `Virtual terminal emulator widget (VTE)`_.
2997 After your program or script has finished executing, the run script will
2998 prompt you to press the return key. This allows you to review any text
2999 output from the program before the terminal window is closed.
3002 The execute command output is not parsed for errors.
3005 Stopping running processes
3006 ``````````````````````````
3008 When there is a running program, the Execute menu item in the menu and
3009 the Run button in the toolbar
3010 each become a stop button so you can stop the current running program (and
3011 any child processes). This works by sending the SIGQUIT signal to the process.
3013 Depending on the process you started it is possible that the process
3014 cannot be stopped. For example this can happen when the process creates
3015 more than one child process.
3021 The Terminal field of the tools preferences tab requires a command to
3022 execute the terminal program and to pass it the name of the Geany run
3023 script that it should execute in a Bourne compatible shell (eg /bin/sh).
3024 The marker "%c" is substituted with the name of the Geany run script,
3025 which is created in the temporary directory and which changes the working
3026 directory to the directory set in the Build commands dialog, see
3027 `Build menu commands dialog`_ for details.
3029 As an example the default (Linux) command is::
3031 xterm -e "/bin/sh %c"
3037 By default Compile, Build and Execute are fairly basic commands. You
3038 may wish to customise them using *Set Build Commands*.
3040 E.g. for C you can add any include paths and compile flags for the
3041 compiler, any library names and paths for the linker, and any
3042 arguments you want to use when running Execute.
3044 Build menu configuration
3045 ^^^^^^^^^^^^^^^^^^^^^^^^
3047 The build menu has considerable flexibility and configurability, allowing
3048 both menu labels the commands they execute and the directory they execute
3049 in to be configured.
3051 For example, if you change one of the default make commands to run say 'waf'
3052 you can also change the label to match.
3054 These settings are saved automatically when Geany is shut down.
3056 The build menu is divided into four groups of items each with different
3059 * Filetype build commands - are configurable and depend on the filetype of the
3060 current document; they capture output in the compiler tab and parse it for
3062 * Independent build commands - are configurable and mostly don't depend on the
3063 filetype of the current document; they also capture output in the
3064 compiler tab and parse it for errors.
3065 * Execute commands - are configurable and intended for executing your
3066 program or other long running programs. The output is not parsed for errors
3067 and is directed to the terminal command selected in preferences.
3068 * Fixed commands - these perform built-in actions:
3070 * Go to the next error.
3071 * Go to the previous error.
3072 * Show the build menu commands dialog.
3074 The maximum numbers of items in each of the configurable groups can be
3075 configured in the `Various preferences`_. Even though the maximum number of
3076 items may have been increased, only those menu items that have values
3077 configured are shown in the menu.
3079 The groups of menu items obtain their configuration from four potential
3080 sources. The highest priority source that has the menu item defined will
3081 be used. The sources in decreasing priority are:
3083 * A project file if open
3084 * The user preferences
3085 * The system filetype definitions
3088 The detailed relationships between sources and the configurable menu item groups
3089 is shown in the following table.
3091 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3092 | Group | Project File | Preferences | System Filetype | Defaults |
3093 +==============+=====================+==========================+===================+===============================+
3094 | Filetype | Loads From: project | Loads From: | Loads From: | None |
3095 | | file | filetypes.xxx file in | filetypes.xxx in | |
3096 | | | ~/.config/geany/filedefs | Geany install | |
3097 | | Saves To: project | | | |
3098 | | file | Saves to: as above, | Saves to: as user | |
3099 | | | creating if needed. | preferences left. | |
3100 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3101 | Filetype | Loads From: project | Loads From: | Loads From: | 1: |
3102 | Independent | file | geany.conf file in | filetypes.xxx in | Label: _Make |
3103 | | | ~/.config/geany | Geany install | Command: make |
3104 | | Saves To: project | | | |
3105 | | file | Saves to: as above, | Saves to: as user | 2: |
3106 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
3107 | | | | | Command: make |
3110 | | | | | Label: Make _Object |
3111 | | | | | Command: make %e.o |
3112 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3113 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
3114 | | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
3115 | | filetype defined in | ~/.config/geany or else | Geany install | |
3116 | | project file | filetypes.xxx file in | | |
3117 | | | ~/.config/geany/filedefs | Saves To: as user | |
3118 | | Saves To: | | preferences left. | |
3119 | | project file | Saves To: | | |
3120 | | | filetypes.xxx file in | | |
3121 | | | ~/.config/geany/filedefs | | |
3122 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3124 The following notes on the table reference cells by coordinate as (group,source):
3126 * General - for filetypes.xxx substitute the appropriate extension for
3127 the filetype of the current document for xxx - see `filenames`_.
3129 * System Filetypes - Labels loaded from these sources are locale sensitive
3130 and can contain translations.
3132 * (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
3133 filetype file so that users can configure all other filetype preferences
3134 as well. Projects can only configure menu items per filetype. Saving
3135 in the project file means that there is only one file per project not
3138 * (Filetype-Independent, System Filetype) - although conceptually strange, defining
3139 filetype-independent commands in a filetype file, this provides the ability to
3140 define filetype dependent default menu items.
3142 * (Execute, Project File) and (Execute, Preferences) - the project independent
3143 execute and preferences independent execute commands can only be set by hand
3144 editing the appropriate file, see `Preferences file format`_ and `Project file
3147 Build menu commands dialog
3148 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3150 Most of the configuration of the build menu is done through the Build Menu
3151 Commands Dialog. You edit the configuration sourced from preferences in the
3152 dialog opened from the Build->Build Menu Commands item and you edit the
3153 configuration from the project in the build tab of the project preferences
3154 dialog. Both use the same form shown below.
3156 .. image:: ./images/build_menu_commands_dialog.png
3158 The dialog is divided into three sections:
3160 * Filetype build commands (selected based on the current document's filetype).
3161 * Independent build commands (available regardless of filetype).
3162 * Filetype execute commands.
3164 The filetype and independent sections also each contain a field for the regular
3165 expression used for parsing command output for error and warning messages.
3167 The columns in the first three sections allow setting of the label, command,
3168 and working directory to run the command in.
3170 An item with an empty label will not be shown in the menu.
3172 An empty working directory will default to the directory of the current document.
3173 If there is no current document then the command will not run.
3175 The dialog will always show the command selected by priority, not just the
3176 commands configured in this configuration source. This ensures that you always
3177 see what the menu item is going to do if activated.
3179 If the current source of the menu item is higher priority than the
3180 configuration source you are editing then the command will be shown
3181 in the dialog but will be insensitive (greyed out). This can't happen
3182 with the project source but can with the preferences source dialog.
3184 The clear buttons remove the definition from the configuration source you are editing.
3185 When you do this the command from the next lower priority source will be shown.
3186 To hide lower priority menu items without having anything show in the menu
3187 configure with a nothing in the label but at least one character in the command.
3189 Substitutions in commands and working directories
3190 `````````````````````````````````````````````````
3192 The first occurence of each of the following character sequences in each of the
3193 command and working directory fields is substituted by the items specified below
3194 before the command is run.
3196 * %d - substituted by the absolute path to the directory of the current file.
3197 * %e - substituted by the name of the current file without the extension or path.
3198 * %f - substituted by the name of the current file without the path.
3199 * %p - if a project is open, substituted by the base path from the project.
3200 * %l - substituted by the line number at the current cursor position.
3203 If the basepath set in the project preferences is not an absolute path , then it is
3204 taken as relative to the directory of the project file. This allows a project file
3205 stored in the source tree to specify all commands and working directories relative
3206 to the tree itself, so that the whole tree including the project file, can be moved
3207 and even checked into and out of version control without having to re-configure the
3210 Build menu keyboard shortcuts
3211 `````````````````````````````
3213 Keyboard shortcuts can be defined for the first two filetype menu items, the first three
3214 independent menu items, the first execute menu item and the fixed menu items.
3215 In the keybindings configuration dialog (see `Keybinding preferences`_)
3216 these items are identified by the default labels shown in the `Build Menu`_ section above.
3218 It is currently not possible to bind keyboard shortcuts to more than these menu items.
3220 You can also use underlines in the labels to set mnemonic characters.
3225 The configurable Build Menu capability was introduced in Geany 0.19 and
3226 required a new section to be added to the configuration files (See
3227 `Preferences file format`_). Geany will still load older format project,
3228 preferences and filetype file settings and will attempt to map them into the new
3229 configuration format. There is not a simple clean mapping between the formats.
3230 The mapping used produces the most sensible results for the majority of cases.
3231 However, if they do not map the way you want, you may have to manually
3232 configure some settings using the Build Commands
3233 Dialog or the Build tab of the project preferences dialog.
3235 Any setting configured in either of these dialogs will override settings mapped from
3236 older format configuration files.
3241 Since Geany 0.13 there has been printing support using GTK's printing API.
3242 The printed page(s) will look nearly the same as on your screen in Geany.
3243 Additionally, there are some options to modify the printed page(s).
3246 The background text color is set to white, except for text with
3247 a white foreground. This allows dark color schemes to save ink
3250 You can define whether to print line numbers, page numbers at the bottom of
3251 each page and whether to print a page header on each page. This header
3252 contains the filename of the printed document, the current page number and
3253 the date and time of printing. By default, the file name of the document
3254 with full path information is added to the header. If you prefer to add
3255 only the basename of the file(without any path information) you can set it
3256 in the preferences dialog. You can also adjust the format of the date and
3257 time added to the page header. The available conversion specifiers are the
3258 same as the ones which can be used with the ANSI C strftime function.
3260 All of these settings can also be changed in the print dialog just before
3261 actual printing is done.
3262 On Unix-like systems the provided print dialog offers a print preview. The
3263 preview file is opened with a PDF viewer and by default GTK uses ``evince``
3264 for print preview. If you have not installed evince or just want to use
3265 another PDF viewer, you can change the program to use in the file
3266 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
3269 gtk-print-preview-command = "epdfview %f"
3271 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3272 as the print preview command.
3274 Geany also provides an alternative basic printing support using a custom
3275 print command. However, the printed document contains no syntax highlighting.
3276 You can adjust the command to which the filename is passed in the preferences
3277 dialog. The default command is::
3281 ``%f`` will be substituted by the filename of the current file. Geany
3282 will not show errors from the command itself, so you should make
3283 sure that it works before(e.g. by trying to execute it from the
3286 A nicer example, which many prefer is::
3288 % a2ps -1 --medium=A4 -o - %f | xfprint4
3290 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3291 gtklp or similar programs can be used.
3298 Plugins are loaded at startup, if the *Enable plugin support*
3299 general preference is set. There is also a command-line option,
3300 ``-p``, which prevents plugins being loaded. Plugins are scanned in
3301 the following directories:
3303 * ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
3304 * The ``lib`` subfolder of the installation path on Windows.
3305 * The ``plugins`` subfolder of the user configuration directory - see
3306 `Configuration file paths`_.
3307 * The `Extra plugin path` preference (usually blank) - see `Paths`_.
3309 Most plugins add menu items to the *Tools* menu when they are loaded.
3311 See also `Plugin documentation`_ for information about single plugins
3312 which are included in Geany.
3316 The Plugin Manager dialog lets you choose which plugins
3317 should be loaded at startup. You can also load and unload plugins on the
3318 fly using this dialog. Once you click the checkbox for a specific plugin
3319 in the dialog, it is loaded or unloaded according to its previous state.
3320 By default, no plugins are loaded at startup until you select some.
3321 You can also configure some plugin specific options if the plugin
3328 Geany supports the default keyboard shortcuts for the Scintilla
3329 editing widget. For a list of these commands, see `Scintilla
3330 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
3331 by any custom keybindings with the same keyboard shortcut.
3337 There are some non-configurable bindings to switch between documents,
3338 listed below. These can also be overridden by custom keybindings.
3340 =============== ==================================
3342 =============== ==================================
3343 Alt-[1-9] Select left-most tab, from 1 to 9.
3344 Alt-0 Select right-most tab.
3345 =============== ==================================
3347 See also `Notebook tab keybindings`_.
3350 Configurable keybindings
3351 ^^^^^^^^^^^^^^^^^^^^^^^^
3353 For all actions listed below you can define your own keybindings. Open
3354 the Preferences dialog, select the desired action and click on
3355 change. In the resulting dialog you can press the key combination you
3356 want to assign to the action and it will be saved when you press OK.
3357 You can define only one key combination for each action and each key
3358 combination can only be defined for one action.
3360 The following tables list all customizable keyboard shortcuts, those
3361 which are common to many applications are marked with (C) after the
3366 =============================== ========================= ==================================================
3367 Action Default shortcut Description
3368 =============================== ========================= ==================================================
3369 New Ctrl-N (C) Creates a new file.
3371 Open Ctrl-O (C) Opens a file.
3373 Open selected file Ctrl-Shift-O Opens the selected filename.
3375 Re-open last closed tab Re-opens the last closed document tab.
3377 Save Ctrl-S (C) Saves the current file.
3379 Save As Saves the current file under a new name.
3381 Save all Ctrl-Shift-S Saves all open files.
3383 Close all Ctrl-Shift-W Closes all open files.
3385 Close Ctrl-W (C) Closes the current file.
3387 Reload file Ctrl-R (C) Reloads the current file.
3389 Print Ctrl-P (C) Prints the current file.
3391 Quit Ctrl-Q (C) Quits Geany.
3392 =============================== ========================= ==================================================
3397 =============================== ========================= ==================================================
3398 Action Default shortcut Description
3399 =============================== ========================= ==================================================
3400 Undo Ctrl-Z (C) Un-does the last action.
3402 Redo Ctrl-Y Re-does the last action.
3404 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3407 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3408 end of the current line.
3410 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3412 Transpose current line Transposes the current line with the previous one.
3414 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3415 view. The cursor position and or an existing
3416 selection will not be changed.
3418 Scroll up by one line Alt-Up Scrolls the view.
3420 Scroll down by one line Alt-Down Scrolls the view.
3422 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3423 tag completion, it shows document word completion
3424 instead, even if it is not enabled for automatic
3425 completion. Likewise if no tag suggestions are
3426 available, it shows document word completion.
3428 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3431 Complete snippet Tab If you type a construct like if or for and press
3432 this key, it will be completed with a matching
3435 Suppress snippet completion If you type a construct like if or for and press
3436 this key, it will not be completed, and a space or
3437 tab will be inserted, depending on what the
3438 construct completion keybinding is set to. For
3439 example, if you have set the construct completion
3440 keybinding to space, then setting this to
3441 Shift+space will prevent construct completion and
3444 Context Action Executes a command and passes the current word
3445 (near the cursor position) or selection as an
3446 argument. See the section called `Context
3449 Move cursor in snippet Jumps to the next defined cursor positions in a
3450 completed snippets if multiple cursor positions
3453 Word part completion Tab When the autocompletion list is visible, complete
3454 the currently selected item up to the next word
3457 Move line(s) up Alt-PageUp Move the current line or selected lines up by
3460 Move line(s) down Alt-PageDown Move the current line or selected lines down by
3462 =============================== ========================= ==================================================
3465 Clipboard keybindings
3466 `````````````````````
3467 =============================== ========================= ==================================================
3468 Action Default shortcut Description
3469 =============================== ========================= ==================================================
3470 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3472 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3474 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3476 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3477 selection) to the clipboard.
3479 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3480 selection) to the clipboard.
3481 =============================== ========================= ==================================================
3486 =============================== ========================= ==================================================
3487 Action Default shortcut Description
3488 =============================== ========================= ==================================================
3489 Select all Ctrl-A (C) Makes a selection of all text in the current
3492 Select current word Alt-Shift-W Selects the current word under the cursor.
3494 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3495 which is defined by two empty lines around it.
3497 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3498 partially selected lines).
3500 Select to previous word part (Extend) selection to previous word part boundary.
3502 Select to next word part (Extend) selection to next word part boundary.
3503 =============================== ========================= ==================================================
3508 =============================== ========================= ==================================================
3509 Action Default shortcut Description
3510 =============================== ========================= ==================================================
3511 Insert date Shift-Alt-D Inserts a customisable date.
3513 Insert alternative whitespace Inserts a tab character when spaces should
3514 be used for indentation and inserts space
3515 characters of the amount of a tab width when
3516 tabs should be used for indentation.
3518 Insert New Line Before Current Inserts a new line with indentation.
3520 Insert New Line After Current Inserts a new line with indentation.
3521 =============================== ========================= ==================================================
3526 =============================== ========================= ==================================================
3527 Action Default shortcut Description
3528 =============================== ========================= ==================================================
3529 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3530 selection will be changed into uppercase and vice
3531 versa. If the selection contains lower- and
3532 uppercase characters, all will be converted to
3535 Comment line Comments current line or selection.
3537 Uncomment line Uncomments current line or selection.
3539 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3540 a comment if the line is commented.
3542 Increase indent Ctrl-I Indents the current line or selection by one tab
3543 or with spaces in the amount of the tab width
3546 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3547 the tab width setting from the indentation of the
3548 current line or selection.
3550 Increase indent by one space Indents the current line or selection by one
3553 Decrease indent by one space Deindents the current line or selection by one
3556 Smart line indent Indents the current line or all selected lines
3557 with the same indentation as the previous line.
3559 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3560 external command (available for the first
3561 three configured commands, see
3562 `Sending text through custom commands`_ for
3565 Send Selection to Terminal Sends the current selection or the current
3566 line (if there is no selection) to the
3567 embedded Terminal (VTE).
3569 Reflow lines/block Reformat selected lines or current
3570 (indented) text block,
3571 breaking lines at the long line marker or the
3572 line breaking column if line breaking is
3573 enabled for the current document.
3574 =============================== ========================= ==================================================
3577 Settings keybindings
3578 ````````````````````
3579 =============================== ========================= ==================================================
3580 Action Default shortcut Description
3581 =============================== ========================= ==================================================
3582 Preferences Ctrl-Alt-P Opens preferences dialog.
3584 Plugin Preferences Opens plugin preferences dialog.
3585 =============================== ========================= ==================================================
3590 =============================== ========================= ==================================================
3591 Action Default shortcut Description
3592 =============================== ========================= ==================================================
3593 Find Ctrl-F (C) Opens the Find dialog.
3595 Find Next Ctrl-G Finds next result.
3597 Find Previous Ctrl-Shift-G Finds previous result.
3599 Find Next Selection Finds next occurence of selected text.
3601 Find Previous Selection Finds previous occurence of selected text.
3603 Replace Ctrl-H (C) Opens the Replace dialog.
3605 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3607 Next message Jumps to the line with the next message in
3608 the Messages window.
3610 Previous message Jumps to the line with the previous message
3611 in the Messages window.
3613 Find Usage Ctrl-Shift-E Finds all occurrences of the current word (near
3614 the keyboard cursor) or selection in all open
3615 documents and displays them in the messages
3618 Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word (near
3619 the keyboard cursor) or selection in the current
3620 document and displays them in the messages
3623 Mark All Ctrl-Shift-M Highlight all matches of the current
3624 word/selection in the current document
3625 with a colored box. If there's nothing to
3626 find, or the cursor is next to an existing match,
3627 the highlighted matches will be cleared.
3628 =============================== ========================= ==================================================
3633 =============================== ========================= ==================================================
3634 Action Default shortcut Description
3635 =============================== ========================= ==================================================
3636 Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
3637 history. See the section called `Code Navigation
3640 Navigate back a location Alt-Left (C) Switches to the previous location in the
3641 navigation history. See the section called
3642 `Code navigation history`_.
3644 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3645 shows the Go to line dialog.
3647 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3648 is moved to the brace which belongs to the current
3649 one. If this keyboard shortcut is pressed again,
3650 the cursor is moved back to the first brace.
3652 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3653 marker if there already is one.
3655 Goto next marker Ctrl-. Goto the next marker in the current document.
3657 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3659 Go to tag definition Ctrl-T Jump to the definition of the current word or
3660 selection. See `Go to tag definition`_.
3662 Go to tag declaration Ctrl-Shift-T Jump to the declaration of the current word or
3663 selection. See `Go to tag declaration`_.
3665 Go to Start of Line Home Move the caret to the start of the line.
3666 Behaves differently if smart_home_key_ is set.
3668 Go to End of Line End Move the caret to the end of the line.
3670 Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
3671 This is useful when you use line wrapping and
3672 want to jump to the start of the wrapped, virtual
3673 line, not the real start of the whole line.
3674 If the line is not wrapped, it behaves like
3675 `Go to Start of Line`.
3677 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3678 If the line is not wrapped, it behaves like
3679 `Go to End of Line`.
3681 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3683 Go to Next Word Part Ctrl-\\ Goto the next part of the current word.
3684 =============================== ========================= ==================================================
3688 =============================== ========================= ==================================================
3689 Action Default shortcut Description
3690 =============================== ========================= ==================================================
3691 Fullscreen F11 (C) Switches to fullscreen mode.
3693 Toggle Messages Window Toggles the message window (status and compiler
3694 messages) on and off.
3696 Toggle Sidebar Shows or hides the sidebar.
3698 Toggle all additional widgets Hide and show all additional widgets like the
3699 notebook tabs, the toolbar, the messages window
3702 Zoom In Ctrl-+ (C) Zooms in the text.
3704 Zoom Out Ctrl-- (C) Zooms out the text.
3706 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3707 =============================== ========================= ==================================================
3711 ================================ ========================= ==================================================
3712 Action Default shortcut Description
3713 ================================ ========================= ==================================================
3714 Switch to Editor F2 Switches to editor widget.
3715 Also reshows the document statistics line
3716 (after a short timeout).
3718 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3721 Switch to Message Window Focus the Message Window's current tab.
3723 Switch to Compiler Focus the Compiler message window tab.
3725 Switch to Messages Focus the Messages message window tab.
3727 Switch to Scribble F6 Switches to scribble widget.
3729 Switch to VTE F4 Switches to VTE widget.
3731 Switch to Sidebar Focus the Sidebar.
3733 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3736 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3738 ================================ ========================= ==================================================
3741 Notebook tab keybindings
3742 ````````````````````````
3743 =============================== ========================= ==================================================
3744 Action Default shortcut Description
3745 =============================== ========================= ==================================================
3746 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3748 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3750 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3752 Holding Ctrl (or another modifier if the keybinding
3753 has been changed) will show a dialog, then repeated
3754 presses of the keybinding will switch to the 2nd-last
3755 used document, 3rd-last, etc. Also known as
3756 Most-Recently-Used documents switching.
3758 Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
3761 Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
3764 Move document first Moves the current document to the first position.
3766 Move document last Moves the current document to the last position.
3767 =============================== ========================= ==================================================
3770 Document keybindings
3771 ````````````````````
3772 ==================================== ==================== ==================================================
3773 Action Default shortcut Description
3774 ==================================== ==================== ==================================================
3775 Clone See `Cloning documents`_.
3777 Replace tabs with space Replaces all tabs with the right amount of spaces
3778 in the whole document, or the current selection.
3780 Replace spaces with tabs Replaces leading spaces with tab characters in the
3781 whole document, or the current selection.
3783 Toggle current fold Toggles the folding state of the current code block.
3785 Fold all Folds all contractible code blocks.
3787 Unfold all Unfolds all contracted code blocks.
3789 Reload symbol list Ctrl-Shift-R Reloads the tag/symbol list.
3791 Toggle Line wrapping Enables or disables wrapping of long lines.
3793 Toggle Line breaking Enables or disables automatic breaking of long
3794 lines at a configurable column.
3796 Remove Markers Remove any markers on lines or words which
3797 were set by using 'Mark All' in the
3798 search dialog or by manually marking lines.
3800 Remove Error Indicators Remove any error indicators in the
3803 Remove Markers and Error Indicators Combines ``Remove Markers`` and
3804 ``Remove Error Indicators``.
3805 ==================================== ==================== ==================================================
3810 =============================== ========================= ==================================================
3811 Action Default shortcut Description
3812 =============================== ========================= ==================================================
3813 New Create a new project.
3814 Open Opens a project file.
3815 Properties Shows project properties.
3816 Close Close the current project.
3817 =============================== ========================= ==================================================
3822 =============================== ========================= ==================================================
3823 Action Default shortcut Description
3824 =============================== ========================= ==================================================
3825 Compile F8 Compiles the current file.
3827 Build F9 Builds (compiles if necessary and links) the
3830 Make all Shift-F9 Builds the current file with the Make tool.
3832 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3835 Make object Shift-F8 Compiles the current file with the Make tool.
3837 Next error Jumps to the line with the next error from the
3840 Previous error Jumps to the line with the previous error from
3841 the last build process.
3843 Run F5 Executes the current file in a terminal emulation.
3845 Set Build Commands Opens the build commands dialog.
3846 =============================== ========================= ==================================================
3851 =============================== ========================= ==================================================
3852 Action Default shortcut Description
3853 =============================== ========================= ==================================================
3854 Show Color Chooser Opens the Color Chooser dialog.
3855 =============================== ========================= ==================================================
3860 =============================== ========================= ==================================================
3861 Action Default shortcut Description
3862 =============================== ========================= ==================================================
3863 Help F1 (C) Opens the manual.
3864 =============================== ========================= ==================================================
3872 You must use UTF-8 encoding *without BOM* for configuration files.
3875 Configuration file paths
3876 ------------------------
3877 Geany has default configuration files installed for the system and
3878 also per-user configuration files.
3880 The system files should not normally be edited because they will be
3881 overwritten when upgrading Geany.
3883 The user configuration directory can be overridden with the ``-c``
3884 switch, but this is not normally done. See `Command line options`_.
3887 Any missing subdirectories in the user configuration directory
3888 will be created when Geany starts.
3890 You can check the paths Geany is using with *Help->Debug Messages*.
3891 Near the top there should be 2 lines with something like::
3893 Geany-INFO: System data dir: /usr/share/geany
3894 Geany-INFO: User config dir: /home/username/.config/geany
3897 Paths on Unix-like systems
3898 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3899 The system path is ``$prefix/share/geany``, where ``$prefix`` is the
3900 path where Geany is installed (see `Installation prefix`_).
3902 The user configuration directory is normally:
3903 ``/home/username/.config/geany``
3907 The system path is the ``data`` subfolder of the installation path
3910 The user configuration directory might vary, but on Windows XP it's:
3911 ``C:\Documents and Settings\UserName\Application Data\geany``
3912 On Windows 7 and above you most likely will find it at:
3913 ``C:\users\UserName\Roaming\geany``
3918 There's a *Configuration files* submenu in the *Tools* menu that
3919 contains items for some of the available user configuration files.
3920 Clicking on one opens it in the editor for you to update. Geany will
3921 reload the file after you have saved it.
3924 Other configuration files not shown here will need to be opened
3925 manually, and will not be automatically reloaded when saved.
3926 (see *Reload Configuration* below).
3928 There's also a *Reload Configuration* item which can be used if you
3929 updated one of the other configuration files, or modified or added
3932 *Reload Configuration* is also necessary to update syntax highlighting colors.
3935 Syntax highlighting colors aren't updated in open documents after
3936 saving filetypes.common as this may take a significant
3940 Global configuration file
3941 -------------------------
3943 System administrators can add a global configuration file for Geany
3944 which will be used when starting Geany and a user configuration file
3947 The global configuration file is read from ``geany.conf`` in the
3948 system configuration path - see `Configuration file paths`_. It can
3949 contain any settings which are found in the usual configuration file
3950 created by Geany, but does not have to contain all settings.
3953 This feature is mainly intended for package maintainers or system
3954 admins who want to set up Geany in a multi user environment and
3955 set some sane default values for this environment. Usually users won't
3960 Filetype definition files
3961 -------------------------
3963 All color definitions and other filetype specific settings are
3964 stored in the filetype definition files. Those settings are colors
3965 for syntax highlighting, general settings like comment characters or
3966 word delimiter characters as well as compiler and linker settings.
3968 See also `Configuration file paths`_.
3972 Each filetype has a corresponding filetype definition file. The format
3973 for built-in filetype `Foo` is::
3977 The extension is normally just the filetype name in lower case.
3979 However there are some exceptions:
3981 =============== =========
3983 =============== =========
3987 Matlab/Octave matlab
3988 =============== =========
3990 There is also the `special file filetypes.common`_.
3992 For `custom filetypes`_, the filename for `Foo` is different::
3996 See the link for details.
4000 The system-wide filetype configuration files can be found in the
4001 system configuration path and are called ``filetypes.$ext``,
4002 where $ext is the name of the filetype. For every
4003 filetype there is a corresponding definition file. There is one
4004 exception: ``filetypes.common`` -- this file is for general settings,
4005 which are not specific to a certain filetype.
4008 It is not recommended that users edit the system-wide files,
4009 because they will be overridden when Geany is updated.
4013 To change the settings, copy a file from the system configuration
4014 path to the subdirectory ``filedefs`` in your user configuration
4015 directory. Then you can edit the file and the changes will still be
4016 available after an update of Geany.
4018 Alternatively, you can create the file yourself and add only the
4019 settings you want to change. All missing settings will be read from
4020 the corresponding system configuration file.
4024 At startup Geany looks for ``filetypes.*.conf`` files in the system and
4025 user filetype paths, adding any filetypes found with the name matching
4026 the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
4028 Custom filetypes are not as powerful as built-in filetypes, but
4029 support for the following has been implemented:
4031 * Recognizing and setting the filetype (after the user has manually updated
4032 the `filetype extensions`_ file).
4033 * `Filetype group membership`_.
4034 * Reading filetype settings in the ``[settings]`` section, including:
4035 * Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
4036 * Using an existing tag parser (`tag_parser`_ key).
4037 * Build commands (``[build-menu]`` section).
4038 * Loading global tags files (sharing the ``tag_parser`` filetype's namespace).
4040 See `Filetype configuration`_ for details on each setting.
4042 Creating a custom filetype from an existing filetype
4043 ````````````````````````````````````````````````````
4044 Because most filetype settings will relate to the syntax
4045 highlighting (e.g. styling, keywords, ``lexer_properties``
4046 sections), it is best to copy an existing filetype file that uses
4047 the lexer you wish to use as the basis of a custom filetype, using
4048 the correct filename extension format shown above, e.g.::
4050 cp filetypes.foo filetypes.Bar.conf
4052 Then add the ``lexer_filetype=Foo`` setting (if not already present)
4053 and add/adjust other settings.
4056 The ``[styling]`` and ``[keywords]`` sections have key names
4057 specific to each filetype/lexer. You must follow the same
4058 names - in particular, some lexers only support one keyword
4062 Filetype configuration
4063 ^^^^^^^^^^^^^^^^^^^^^^
4065 As well as the sections listed below, each filetype file can contain
4066 a [build-menu] section as described in `[build-menu] section`_.
4071 In this section the colors for syntax highlighting are defined. The
4074 * ``key=foreground_color;background_color;bold_flag;italic_flag``
4076 Colors have to be specified as RGB hex values prefixed by
4077 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4078 are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
4079 values are case-insensitive but it is a good idea to use lower-case.
4080 Note that you can also use *named colors* as well by substituting the
4081 color value with the name of a color as defined in the ``[named_colors]``
4082 section, see the `[named_colors] Section`_ for more information.
4084 Bold and italic are flags and should only be "true" or "false". If their
4085 value is something other than "true" or "false", "false" is assumed.
4087 You can omit fields to use the values from the style named ``"default"``.
4089 E.g. ``key=0xff0000;;true``
4091 This makes the key style have red foreground text, default background
4092 color text and bold emphasis.
4096 The second format uses a *named style* name to reference a style
4097 defined in filetypes.common.
4099 * ``key=named_style``
4100 * ``key2=named_style2,bold,italic``
4102 The bold and italic parts are optional, and if present are used to
4103 toggle the bold or italic flags to the opposite of the named style's
4104 flags. In contrast to style definition booleans, they are a literal
4105 ",bold,italic" and commas are used instead of semi-colons.
4107 E.g. ``key=comment,italic``
4109 This makes the key style match the ``"comment"`` named style, but with
4112 To define named styles, see the filetypes.common `[named_styles]
4115 Reading styles from another filetype
4116 ************************************
4117 You can automatically copy all of the styles from another filetype
4118 definition file by using the following syntax for the ``[styling]``
4123 Where Foo is a filetype name. The corresponding ``[styling]``
4124 section from ``filetypes.foo`` will be read.
4126 This is useful when the same lexer is being used for multiple
4127 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4128 styling the same as the C styling, you would put the following in
4137 This section contains keys for different keyword lists specific to
4138 the filetype. Some filetypes do not support keywords, so adding a
4139 new key will not work. You can only add or remove keywords to/from
4143 The keywords list must be in one line without line ending characters.
4146 [lexer_properties] section
4147 ``````````````````````````
4148 Here any special properties for the Scintilla lexer can be set in the
4149 format ``key.name.field=some.value``.
4151 Properties Geany uses are listed in the system filetype files. To find
4152 other properties you need Geany's source code::
4154 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
4161 This is the default file extension used when saving files, not
4162 including the period character (``.``). The extension used should
4163 match one of the patterns associated with that filetype (see
4164 `Filetype extensions`_).
4166 *Example:* ``extension=cxx``
4169 These characters define word boundaries when making selections
4170 and searching using word matching options.
4172 *Example:* (look at system filetypes.\* files)
4175 This overrides the *wordchars* filetypes.common setting, and
4176 has precedence over the *whitespace_chars* setting.
4179 A character or string which is used to comment code. If you want to use
4180 multiline comments only, don't set this but rather comment_open and
4183 Single-line comments are used in priority over multiline comments to
4184 comment a line, e.g. with the `Comment/Uncomment line` command.
4186 *Example:* ``comment_single=//``
4189 A character or string which is used to comment code. You need to also
4190 set comment_close to really use multiline comments. If you want to use
4191 single-line comments, prefer setting comment_single.
4193 Multiline comments are used in priority over single-line comments to
4194 comment a block, e.g. template comments.
4196 *Example:* ``comment_open=/*``
4199 If multiline comments are used, this is the character or string to
4202 *Example:* ``comment_close=*/``
4205 Set this to false if a comment character or string should start at
4206 column 0 of a line. If set to true it uses any indentation of the
4209 Note: Comment indentation
4211 ``comment_use_indent=true`` would generate this if a line is
4212 commented (e.g. with Ctrl-D)::
4216 ``comment_use_indent=false`` would generate this if a line is
4217 commented (e.g. with Ctrl-D)::
4219 # command_example();
4222 Note: This setting only works for single line comments (like '//',
4225 *Example:* ``comment_use_indent=true``
4228 A command which can be executed on the current word or the current
4231 Example usage: Open the API documentation for the
4232 current function call at the cursor position.
4235 be set for every filetype or if not set, a global command will
4236 be used. The command itself can be specified without the full
4237 path, then it is searched in $PATH. But for security reasons,
4238 it is recommended to specify the full path to the command. The
4239 wildcard %s will be replaced by the current word at the cursor
4240 position or by the current selection.
4242 Hint: for PHP files the following could be quite useful:
4243 context_action_cmd=firefox "http://www.php.net/%s"
4245 *Example:* ``context_action_cmd=devhelp -s "%s"``
4250 The TagManager language name, e.g. "C". Usually the same as the
4256 A filetype name to setup syntax highlighting from another filetype.
4257 This must not be recursive, i.e. it should be a filetype name that
4258 doesn't use the *lexer_filetype* key itself, e.g.::
4263 The second line is wrong, because ``filetypes.cpp`` itself uses
4264 ``lexer_filetype=C``, which would be recursive.
4266 symbol_list_sort_mode
4267 What the default symbol list sort order should be.
4269 ===== =====================================
4271 ===== =====================================
4273 1 Sort tags by appearance (line number)
4274 ===== =====================================
4276 .. _xml_indent_tags:
4279 If this setting is set to *true*, a new line after a line ending with an
4280 unclosed XML/HTML tag will be automatically indented. This only applies
4281 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4282 this setting in their system configuration files.
4285 The MIME type for this file type, e.g. "text/x-csrc". This is used
4286 for example to chose the icon to display for this file type.
4289 [indentation] section
4290 `````````````````````
4292 This section allows definition of default indentation settings specific to
4293 the file type, overriding the ones configured in the preferences. This can
4294 be useful for file types requiring specific indentation settings (e.g. tabs
4295 only for Makefile). These settings don't override auto-detection if activated.
4298 The forced indentation width.
4301 The forced indentation type.
4303 ===== =======================
4304 Value Indentation type
4305 ===== =======================
4308 2 Mixed (tabs and spaces)
4309 ===== =======================
4312 [build_settings] section
4313 ````````````````````````
4315 As of Geany 0.19 this section is supplemented by the `[build-menu] section`_.
4316 Values that are set in the [build-menu] section will override those in this section.
4319 This is a regular expression to parse a filename
4320 and line number from build output. If undefined, Geany will fall
4321 back to its default error message parsing.
4323 Only the first two matches will be read by Geany. Geany will look for
4324 a match that is purely digits, and use this for the line number. The
4325 remaining match will be used as the filename.
4327 *Example:* ``error_regex=(.+):([0-9]+):[0-9]+``
4329 This will parse a message such as:
4330 ``test.py:7:24: E202 whitespace before ']'``
4334 If any build menu item settings have been configured in the Build Menu Commands
4335 dialog or the Build tab of the project preferences dialog then these
4336 settings are stored in the [build-menu] section and override the settings in
4337 this section for that item.
4340 This item specifies the command to compile source code files. But
4341 it is also possible to use it with interpreted languages like Perl
4342 or Python. With these filetypes you can use this option as a kind of
4343 syntax parser, which sends output to the compiler message window.
4345 You should quote the filename to also support filenames with
4346 spaces. The following wildcards for filenames are available:
4348 * %f -- complete filename without path
4349 * %e -- filename without path and without extension
4351 *Example:* ``compiler=gcc -Wall -c "%f"``
4354 This item specifies the command to link the file. If the file is not
4355 already compiled, it will be compiled while linking. The -o option
4356 is automatically added by Geany. This item works well with GNU gcc,
4357 but may be problematic with other compilers (esp. with the linker).
4359 *Example:* ``linker=gcc -Wall "%f"``
4362 Use this item to execute your file. It has to have been built
4363 already. Use the %e wildcard to have only the name of the executable
4364 (i.e. without extension) or use the %f wildcard if you need the
4365 complete filename, e.g. for shell scripts.
4367 *Example:* ``run_cmd="./%e"``
4370 Special file filetypes.common
4371 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4373 There is a special filetype definition file called
4374 filetypes.common. This file defines some general non-filetype-specific
4377 You can open the user filetypes.common with the
4378 *Tools->Configuration Files->filetypes.common* menu item. This adds
4379 the default settings to the user file if the file doesn't exist.
4380 Alternatively the file can be created manually, adding only the
4381 settings you want to change. All missing settings will be read from
4385 See the `Filetype configuration`_ section for how to define styles.
4388 [named_styles] section
4389 ``````````````````````
4390 Named styles declared here can be used in the [styling] section of any
4395 *In filetypes.common*::
4398 foo=0xc00000;0xffffff;false;true
4406 This saves copying and pasting the whole style definition into several
4410 You can define aliases for named styles, as shown with the ``bar``
4411 entry in the above example, but they must be declared after the
4415 [named_colors] section
4416 ``````````````````````
4417 Named colors declared here can be used in the ``[styling]`` or
4418 ``[named_styles]`` section of any filetypes.* file or color scheme.
4423 my_red_color=#FF0000
4424 my_blue_color=#0000FF
4427 foo=my_red_color;my_blue_color;false;true
4429 This allows to define a color pallete by name so that to change a color
4430 scheme-wide only involves changing the hex value in a single location.
4435 This is the default style. It is used for styling files without a
4438 *Example:* ``default=0x000000;0xffffff;false;false``
4441 The style for coloring selected text. The format is:
4445 * Use foreground color
4446 * Use background color
4448 The colors are only set if the 3rd or 4th argument is true. When
4449 the colors are not overridden, the default is a dark grey
4450 background with syntax highlighted foreground text.
4452 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
4455 The style for brace highlighting when a matching brace was found.
4457 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
4460 The style for brace highlighting when no matching brace was found.
4462 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
4465 The style for coloring the caret(the blinking cursor). Only first
4466 and third argument is interpreted.
4467 Set the third argument to true to change the caret into a block caret.
4469 *Example:* ``caret=0x000000;0x0;false;false``
4472 The width for the caret(the blinking cursor). Only the first
4473 argument is interpreted. The width is specified in pixels with
4474 a maximum of three pixel. Use the width 0 to make the caret
4477 *Example:* ``caret=1;0;false;false``
4480 The style for coloring the background of the current line. Only
4481 the second and third arguments are interpreted. The second argument
4482 is the background color. Use the third argument to enable or
4483 disable background highlighting for the current line (has to be
4486 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
4489 The style for coloring the indentation guides. Only the first and
4490 second arguments are interpreted.
4492 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
4495 The style for coloring the white space if it is shown. The first
4496 both arguments define the foreground and background colors, the
4497 third argument sets whether to use the defined foreground color
4498 or to use the color defined by each filetype for the white space.
4499 The fourth argument defines whether to use the background color.
4501 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
4504 Line number margin foreground and background colors.
4506 .. _Folding Settings:
4509 Fold margin foreground and background colors.
4511 fold_symbol_highlight
4512 Highlight color of folding symbols.
4515 The style of folding icons. Only first and second arguments are
4518 Valid values for the first argument are:
4525 Valid values for the second argument are:
4528 * 1 -- for straight lines
4529 * 2 -- for curved lines
4531 *Default:* ``folding_style=1;1;``
4533 *Arrows:* ``folding_style=3;0;``
4536 Draw a thin horizontal line at the line where text is folded. Only
4537 first argument is used.
4539 Valid values for the first argument are:
4541 * 0 -- disable, do not draw a line
4542 * 1 -- draw the line above folded text
4543 * 2 -- draw the line below folded text
4545 *Example:* ``folding_horiz_line=0;0;false;false``
4548 First argument: drawing of visual flags to indicate a line is wrapped.
4549 This is a bitmask of the values:
4551 * 0 -- No visual flags
4552 * 1 -- Visual flag at end of subline of a wrapped line
4553 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
4554 indented by at least 1 to make room for the flag.
4556 Second argument: wether the visual flags to indicate a line is wrapped
4557 are drawn near the border or near the text. This is a bitmask of the values:
4559 * 0 -- Visual flags drawn near border
4560 * 1 -- Visual flag at end of subline drawn near text
4561 * 2 -- Visual flag at begin of subline drawn near text
4563 Only first and second arguments are interpreted.
4565 *Example:* ``line_wrap_visuals=3;0;false;false``
4568 First argument: sets the size of indentation of sublines for wrapped lines
4569 in terms of the width of a space, only used when the second argument is ``0``.
4571 Second argument: wrapped sublines can be indented to the position of their
4572 first subline or one more indent level. Possible values:
4574 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4575 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4576 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4578 Only first and second arguments are interpreted.
4580 *Example:* ``line_wrap_indent=0;1;false;false``
4583 Translucency for the current line (first argument) and the selection
4584 (second argument). Values between 0 and 256 are accepted.
4586 Note for Windows 95, 98 and ME users:
4587 keep this value at 256 to disable translucency otherwise Geany might crash.
4589 Only the first and second arguments are interpreted.
4591 *Example:* ``translucency=256;256;false;false``
4594 The style for a highlighted line (e.g when using Goto line or goto tag).
4595 The foreground color (first argument) is only used when the Markers margin
4596 is enabled (see View menu).
4598 Only the first and second arguments are interpreted.
4600 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4603 The style for a marked search results (when using "Mark" in Search dialogs).
4604 The second argument sets the background color for the drawn rectangle.
4606 Only the second argument is interpreted.
4608 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4611 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4612 (Ctrl-M)). The foreground color (first argument) is only used
4613 when the Markers margin is enabled (see View menu).
4615 Only the first and second arguments are interpreted.
4617 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4620 Translucency for the line marker (first argument) and the search marker
4621 (second argument). Values between 0 and 256 are accepted.
4623 Note for Windows 95, 98 and ME users:
4624 keep this value at 256 to disable translucency otherwise Geany might crash.
4626 Only the first and second arguments are interpreted.
4628 *Example:* ``marker_translucency=256;256;false;false``
4631 Amount of space to be drawn above and below the line's baseline.
4632 The first argument defines the amount of space to be drawn above the line, the second
4633 argument defines the amount of space to be drawn below.
4635 Only the first and second arguments are interpreted.
4637 *Example:* ``line_height=0;0;false;false``
4640 The style for coloring the calltips. The first two arguments
4641 define the foreground and background colors, the third and fourth
4642 arguments set whether to use the defined colors.
4644 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4650 Characters to treat as whitespace. These characters are ignored
4651 when moving, selecting and deleting across word boundaries
4652 (see `Scintilla keyboard commands`_).
4654 This should include space (\\s) and tab (\\t).
4656 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4659 These characters define word boundaries when making selections
4660 and searching using word matching options.
4662 *Example:* ``wordchars=_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``
4665 This has precedence over the *whitespace_chars* setting.
4673 To change the default filetype extension used when saving a new file,
4674 see `Filetype definition files`_.
4676 You can override the list of file extensions that Geany uses to detect
4677 filetypes using the user ``filetype_extensions.conf`` file. Use the
4678 *Tools->Configuration Files->filetype_extensions.conf* menu item. See
4679 also `Configuration file paths`_.
4681 You should only list lines for filetype extensions that you want to
4682 override in the user configuration file and remove or comment out
4683 others. The patterns are listed after the ``=`` sign, using a
4684 semi-colon separated list of patterns which should be matched for
4687 For example, to override the filetype extensions for Make, the file
4691 Make=Makefile*;*.mk;Buildfile;
4693 Filetype group membership
4694 ^^^^^^^^^^^^^^^^^^^^^^^^^
4695 Group membership is also stored in ``filetype_extensions.conf``. This
4696 file is used to store information Geany needs at startup, whereas the
4697 separate filetype definition files hold information only needed when
4698 a document with their filetype is used.
4700 The format looks like::
4709 The key names cannot be configured.
4712 Group membership is only read at startup.
4714 Preferences file format
4715 -----------------------
4717 The user preferences file ``geany.conf`` holds settings for all the items configured
4718 in the preferences dialog. This file should not be edited while Geany is running
4719 as the file will be overwritten when the preferences in Geany are changed or Geany
4723 [build-menu] section
4724 ^^^^^^^^^^^^^^^^^^^^
4726 The [build-menu] section contains the configuration of the build menu.
4727 This section can occur in filetype, preferences and project files and
4728 always has the format described here. Different menu items are loaded
4729 from different files, see the table in the `Build Menu Configuration`_
4730 section for details. All the settings can be configured from the dialogs
4731 except the execute command in filetype files and filetype definitions in
4732 the project file, so these are the only ones which need hand editing.
4734 The build-menu section stores one entry for each setting for each menu item that
4735 is configured. The keys for these settings have the format:
4741 * GG - is the menu item group,
4744 - NF for independent (non-filetype)
4747 * NN - is a two decimal digit number of the item within the group,
4749 * FF - is the field,
4753 - WD for working directory
4759 The project file contains project related settings and possibly a
4760 record of the current session files.
4763 [build-menu] additions
4764 ^^^^^^^^^^^^^^^^^^^^^^
4766 The project file also can have extra fields in the [build-menu] section
4767 in addition to those listed in `[build-menu] section`_ above.
4769 When filetype menu items are configured for the project they are stored
4770 in the project file.
4772 The ``filetypes`` entry is a list of the filetypes which exist in the
4775 For each filetype the entries for that filetype have the format defined in
4776 `[build-menu] section`_ but the key is prefixed by the name of the filetype
4777 as it appears in the ``filetypes`` entry, eg the entry for the label of
4778 filetype menu item 0 for the C filetype would be
4786 Geany supports the following templates:
4790 * Function description
4795 To use these templates, just open the Edit menu or open the popup menu
4796 by right-clicking in the editor widget, and choose "Insert Comments"
4797 and insert templates as you want.
4799 Some templates (like File header or ChangeLog entry) will always be
4800 inserted at the top of the file.
4802 To insert a function description, the cursor must be inside
4803 of the function, so that the function name can be determined
4804 automatically. The description will be positioned correctly one line
4805 above the function, just check it out. If the cursor is not inside
4806 of a function or the function name cannot be determined, the inserted
4807 function description won't contain the correct function name but "unknown"
4811 Geany automatically reloads template information when it notices you
4812 save a file in the user's template configuration directory. You can
4813 also force this by selecting *Tools->Reload Configuration*.
4819 Meta data can be used with all templates, but by default user set
4820 meta data is only used for the ChangeLog and File header templates.
4822 In the configuration dialog you can find a tab "Templates" (see
4823 `Template preferences`_). You can define the default values
4824 which will be inserted in the templates.
4830 File templates are templates used as the basis of a new file. To
4831 use them, choose the *New (with Template)* menu item from the *File*
4834 By default, file templates are installed for some filetypes. Custom
4835 file templates can be added by creating the appropriate template file. You can
4836 also edit the default file templates.
4838 The file's contents are just the text to place in the document, with
4839 optional template wildcards like ``{fileheader}``. The fileheader
4840 wildcard can be placed anywhere, but it's usually put on the first
4841 line of the file, followed by a blank line.
4843 Adding file templates
4844 `````````````````````
4846 File templates are read from ``templates/files`` under the
4847 `Configuration file paths`_.
4849 The filetype to use is detected from the template file's extension, if
4850 any. For example, creating a file ``module.c`` would add a menu item
4851 which created a new document with the filetype set to 'C'.
4853 The template file is read from disk when the corresponding menu item is
4857 Customizing templates
4858 ^^^^^^^^^^^^^^^^^^^^^
4860 Each template can be customized to your needs. The templates are
4861 stored in the ``~/.config/geany/templates/`` directory (see the section called
4862 `Command line options`_ for further information about the configuration
4863 directory). Just open the desired template with an editor (ideally,
4864 Geany ;-) ) and edit the template to your needs. There are some
4865 wildcards which will be automatically replaced by Geany at startup.
4871 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4873 **Wildcards for character escaping**
4875 ============== ============================================= =======================================
4876 Wildcard Description Available in
4877 ============== ============================================= =======================================
4878 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4879 wildcards being expanded).
4880 cb } Closing Brace. file templates, file header, snippets.
4881 pc \% Percent (used to escape e.g. %block% in
4882 snippets). snippets.
4883 ============== ============================================= =======================================
4885 **Global wildcards**
4887 These are configurable, see `Template preferences`_.
4889 ============== ============================================= =======================================
4890 Wildcard Description Available in
4891 ============== ============================================= =======================================
4892 developer The name of the developer. file templates, file header,
4893 function description, ChangeLog entry,
4896 initial The developer's initials, e.g. "ET" for file templates, file header,
4897 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4900 mail The email address of the developer. file templates, file header,
4901 function description, ChangeLog entry,
4904 company The company the developer is working for. file templates, file header,
4905 function description, ChangeLog entry,
4908 version The initial version of a new file. file templates, file header,
4909 function description, ChangeLog entry,
4911 ============== ============================================= =======================================
4913 **Date & time wildcards**
4915 The format for these wildcards can be changed in the preferences
4916 dialog, see `Template preferences`_. You can use any conversion
4917 specifiers which can be used with the ANSI C strftime function.
4918 For details please see http://man.cx/strftime.
4920 ============== ============================================= =======================================
4921 Wildcard Description Available in
4922 ============== ============================================= =======================================
4923 year The current year. Default format is: YYYY. file templates, file header,
4924 function description, ChangeLog entry,
4927 date The current date. Default format: file templates, file header,
4928 YYYY-MM-DD. function description, ChangeLog entry,
4931 datetime The current date and time. Default format: file templates, file header,
4932 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4934 ============== ============================================= =======================================
4936 **Dynamic wildcards**
4938 ============== ============================================= =======================================
4939 Wildcard Description Available in
4940 ============== ============================================= =======================================
4941 untitled The string "untitled" (this will be file templates, file header,
4942 translated to your locale), used in function description, ChangeLog entry,
4943 file templates. bsd, gpl, snippets.
4945 geanyversion The actual Geany version, e.g. file templates, file header,
4946 "Geany |(version)|". function description, ChangeLog entry,
4949 filename The filename of the current file. file header, snippets, file
4950 For new files, it's only replaced when templates.
4951 first saving if found on the first 4 lines
4954 project The current project's name, if any. file header, snippets, file templates.
4956 description The current project's description, if any. file header, snippets, file templates.
4958 functionname The function name of the function at the function description.
4959 cursor position. This wildcard will only be
4960 replaced in the function description
4963 command:path Executes the specified command and replace file templates, file header,
4964 the wildcard with the command's standard function description, ChangeLog entry,
4965 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
4967 ============== ============================================= =======================================
4969 **Template insertion wildcards**
4971 ============== ============================================= =======================================
4972 Wildcard Description Available in
4973 ============== ============================================= =======================================
4974 gpl This wildcard inserts a short GPL notice. file header.
4976 bsd This wildcard inserts a BSD licence notice. file header.
4978 fileheader The file header template. This wildcard snippets, file templates.
4979 will only be replaced in file templates.
4980 ============== ============================================= =======================================
4983 Special {command:} wildcard
4984 ***************************
4986 The {command:} wildcard is a special one because it can execute
4987 a specified command and put the command's output (stdout) into
4996 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
4998 Using this wildcard you can insert nearly any arbitrary text into the
5001 In the environment of the executed command the variables
5002 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
5003 The value of these variables is filled in only if Geany knows about it.
5004 For example, ``GEANY_FUNCNAME`` is only filled within the function
5005 description template. However, these variables are ``always`` set,
5006 just maybe with an empty value.
5007 You can easily access them e.g. within an executed shell script using::
5013 If the specified command could not be found or not executed, the wildcard is substituted
5014 by an empty string. In such cases, you can find the occurred error message on Geany's
5015 standard error and in the Help->Debug Messages dialog.
5018 Customizing the toolbar
5019 -----------------------
5021 You can add, remove and reorder the elements in the toolbar by using
5022 the toolbar editor, or by manually editing the configuration file
5025 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5026 by right-clicking on the toolbar itself and choosing it from the menu.
5028 Manually editing the toolbar layout
5029 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5031 To override the system-wide configuration file, copy it to your user
5032 configuration directory (see `Configuration file paths`_).
5036 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5038 Then edit it and add any of the available elements listed in the file or remove
5039 any of the existing elements. Of course, you can also reorder the elements as
5040 you wish and add or remove additional separators.
5041 This file must be valid XML, otherwise the global toolbar UI definition
5042 will be used instead.
5044 Your changes are applied once you save the file.
5047 (1) You cannot add new actions which are not listed below.
5048 (2) Everything you add or change must be inside the /ui/toolbar/ path.
5051 Available toolbar elements
5052 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5054 ================== ==============================================================================
5055 Element name Description
5056 ================== ==============================================================================
5057 New Create a new file
5058 Open Open an existing file
5059 Save Save the current file
5060 SaveAll Save all open files
5061 Reload Reload the current file from disk
5062 Close Close the current file
5063 CloseAll Close all open files
5064 Print Print the current file
5065 Cut Cut the current selection
5066 Copy Copy the current selection
5067 Paste Paste the contents of the clipboard
5068 Delete Delete the current selection
5069 Undo Undo the last modification
5070 Redo Redo the last modification
5071 NavBack Navigate back a location
5072 NavFor Navigate forward a location
5073 Compile Compile the current file
5074 Build Build the current file, includes a submenu for Make commands. Geany
5075 remembers the last chosen action from the submenu and uses this as default
5076 action when the button itself is clicked.
5077 Run Run or view the current file
5078 Color Open a color chooser dialog, to interactively pick colors from a palette
5079 ZoomIn Zoom in the text
5080 ZoomOut Zoom out the text
5081 UnIndent Decrease indentation
5082 Indent Increase indentation
5083 Replace Replace text in the current document
5084 SearchEntry The search field belonging to the 'Search' element (can be used alone)
5085 Search Find the entered text in the current file (only useful if you also
5087 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
5088 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
5089 Preferences Show the preferences dialog
5091 ================== ==============================================================================
5095 Plugin documentation
5096 ====================
5101 The HTML Characters plugin helps when working with special
5102 characters in XML/HTML, e.g. German Umlauts ü and ä.
5105 Insert entity dialog
5106 ^^^^^^^^^^^^^^^^^^^^
5108 When the plugin is enabled, you can insert special character
5109 entities using *Tools->Insert Special HTML Characters*.
5111 This opens up a dialog where you can find a huge amount of special
5112 characters sorted by category that you might like to use inside your
5113 document. You can expand and collapse the categories by clicking on
5114 the little arrow on the left hand side. Once you have found the
5115 desired character click on it and choose "Insert". This will insert
5116 the entity for the character at the current cursor position. You
5117 might also like to double click the chosen entity instead.
5120 Replace special chars by its entity
5121 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5123 To help make a XML/HTML document valid the plugin supports
5124 replacement of special chars known by the plugin. Both bulk
5125 replacement and immediate replacement during typing are supported.
5127 A few characters will not be replaced. These are
5138 You can activate/deactivate this feature using the *Tools->HTML
5139 Replacement->Auto-replace Special Characters* menu item. If it's
5140 activated, all special characters (beside the given exceptions from
5141 above) known by the plugin will be replaced by their entities.
5143 You could also set a keybinding for the plugin to toggle the status
5150 After inserting a huge amount of text, e.g. by using copy & paste, the
5151 plugin allows bulk replacement of all known characters (beside the
5152 mentioned exceptions). You can find the function under the same
5153 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
5154 configure a keybinding for the plugin.
5163 This plugin provides an option to automatically save documents.
5164 You can choose to save the current document, or all of your documents, at
5171 You can save the current document when the editor's focus goes out.
5172 Every pop-up, menu dialogs, or anything else that can make the editor lose the focus,
5173 will make the current document to be saved.
5178 This plugin sets on every new file (*File->New* or *File->New (with template)*)
5179 a randomly chosen filename and set its filetype appropriate to the used template
5180 or when no template was used, to a configurable default filetype.
5181 This enables you to quickly compile, build and/or run the new file without the
5182 need to give it an explicit filename using the Save As dialog. This might be
5183 useful when you often create new files just for testing some code or something
5190 This plugin creates a backup copy of the current file in Geany when it is
5191 saved. You can specify the directory where the backup copy is saved and
5192 you can configure the automatically added extension in the configure dialog
5193 in Geany's plugin manager.
5195 After the plugin was loaded in Geany's plugin manager, every file is
5196 copied into the configured backup directory *after* the file has been saved
5199 The created backup copy file permissions are set to read-write only for
5200 the user. This should help to not create world-readable files on possibly
5201 unsecure destination directories like /tmp (especially useful
5202 on multi-user systems).
5203 This applies only to non-Windows systems. On Windows, no explicit file
5204 permissions are set.
5207 Additionally, you can define how many levels of the original file's
5208 directory structure should be replicated in the backup copy path.
5209 For example, setting the option
5210 *Directory levels to include in the backup destination* to *2*
5211 cause the plugin to create the last two components of the original
5212 file's path in the backup copy path and place the new file there.
5215 Contributing to this document
5216 =============================
5218 This document (``geany.txt``) is written in `reStructuredText`__
5219 (or "reST"). The source file for it is located in Geany's ``doc``
5220 subdirectory. If you intend on making changes, you should grab the
5221 source right from Git to make sure you've got the newest version.
5222 First, you need to configure the build system to generate the HTML
5223 documentation passing the *--enable-html-docs* option to the *configure*
5224 script. Then after editing the file, run ``make`` (from the root build
5225 directory or from the *doc* subdirectory) to build the HTML documentation
5226 and see how your changes look. This regenerates the ``geany.html`` file
5227 inside the *doc* subdirectory. To generate a PDF file, configure with
5228 *--enable-pdf-docs* and run ``make`` as for the HTML version. The generated
5229 PDF file is named geany-|(version)|.pdf and is located inside the *doc*
5232 __ http://docutils.sourceforge.net/rst.html
5234 After you are happy with your changes, create a patch e.g. by using::
5236 % git diff geany.txt > foo.patch
5238 or even better, by creating a Git-formatted patch which will keep authoring
5239 and description data, by first committing your changes (doing so in a fresh
5240 new branch is recommended for `master` not to diverge from upstream) and then
5241 using git format-patch::
5243 % git checkout -b my-documentation-changes # create a fresh branch
5244 % git commit geany.txt
5245 Write a good commit message...
5246 % git format-patch HEAD^
5247 % git checkout master # go back to master
5249 and then submit that file to the mailing list for review.
5251 Also you can clone the Geany repository at GitHub and send a pull request.
5253 Note, you will need the Python docutils software package installed
5254 to build the docs. The package is named ``python-docutils`` on Debian
5260 Scintilla keyboard commands
5261 ===========================
5263 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
5265 This appendix is distributed under the terms of the License for
5266 Scintilla and SciTE. A copy of this license can be found in the file
5267 ``scintilla/License.txt`` included with the source code of this
5268 program and in the appendix of this document. See `License for
5269 Scintilla and SciTE`_.
5278 Keyboard commands for Scintilla mostly follow common Windows and GTK+
5279 conventions. All move keys (arrows, page up/down, home and end)
5280 allows to extend or reduce the stream selection when holding the
5281 Shift key, and the rectangular selection when holding the
5282 appropriate keys (see `Column mode editing (rectangular selections)`_).
5284 Some keys may not be available with some national keyboards
5285 or because they are taken by the system such as by a window manager
5286 or GTK. Keyboard equivalents of menu commands are listed in the
5287 menus. Some less common commands with no menu equivalent are:
5289 ============================================= ======================
5291 ============================================= ======================
5292 Magnify text size. Ctrl-Keypad+
5293 Reduce text size. Ctrl-Keypad-
5294 Restore text size to normal. Ctrl-Keypad/
5296 Dedent block. Shift-Tab
5297 Delete to start of word. Ctrl-BackSpace
5298 Delete to end of word. Ctrl-Delete
5299 Delete to start of line. Ctrl-Shift-BackSpace
5300 Go to start of document. Ctrl-Home
5301 Extend selection to start of document. Ctrl-Shift-Home
5302 Go to start of display line. Alt-Home
5303 Extend selection to start of display line. Alt-Shift-Home
5304 Go to end of document. Ctrl-End
5305 Extend selection to end of document. Ctrl-Shift-End
5306 Extend selection to end of display line. Alt-Shift-End
5307 Previous paragraph. Shift extends selection. Ctrl-Up
5308 Next paragraph. Shift extends selection. Ctrl-Down
5309 Previous word. Shift extends selection. Ctrl-Left
5310 Next word. Shift extends selection. Ctrl-Right
5311 ============================================= ======================
5322 * Double-click on empty space in the notebook tab bar to open a
5324 * Middle-click on a document's notebook tab to close the document.
5325 * Hold `Ctrl` and click on any notebook tab to switch to the last used
5327 * Double-click on a document's notebook tab to toggle all additional
5328 widgets (to show them again use the View menu or the keyboard
5329 shortcut). The interface pref must be enabled for this to work.
5334 * Alt-scroll wheel moves up/down a page.
5335 * Ctrl-scroll wheel zooms in/out.
5336 * Shift-scroll wheel scrolls 8 characters right/left.
5337 * Ctrl-click on a word in a document to perform *Go to Tag Definition*.
5338 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
5343 * Double-click on a symbol-list group to expand or compact it.
5348 * Scrolling the mouse wheel over a notebook tab bar will switch
5351 The following are derived from X-Windows features (but GTK still supports
5354 * Middle-click pastes the last selected text.
5355 * Middle-click on a scrollbar moves the scrollbar to that
5356 position without having to drag it.
5360 Compile-time options
5361 ====================
5363 There are some options which can only be changed at compile time,
5364 and some options which are used as the default for configurable
5365 options. To change these options, edit the appropriate source file
5366 in the ``src`` subdirectory. Look for a block of lines starting with
5367 ``#define GEANY_*``. Any definitions which are not listed here should
5371 Most users should not need to change these options.
5376 ============================== ============================================ ==================
5377 Option Description Default
5378 ============================== ============================================ ==================
5379 GEANY_STRING_UNTITLED A string used as the default name for new untitled
5380 files. Be aware that the string can be
5381 translated, so change it only if you know
5383 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
5384 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
5385 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
5387 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
5389 **Windows specific**
5390 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
5391 Windows file open and save dialogs instead
5392 GTK's file open and save dialogs. The
5393 default Windows file dialogs are missing
5394 some nice features like choosing a filetype
5395 or an encoding. *Do not touch this setting
5396 when building on a non-Win32 system.*
5397 ============================== ============================================ ==================
5402 ============================== ============================================ ==================
5403 Option Description Default
5404 ============================== ============================================ ==================
5405 GEANY_PROJECT_EXT The default filename extension for Geany geany
5406 project files. It is used when creating new
5407 projects and as filter mask for the project
5409 ============================== ============================================ ==================
5414 ============================== ============================================ ==================
5415 Option Description Default
5416 ============================== ============================================ ==================
5417 GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
5418 filetype with the extract filetype regex.
5419 ============================== ============================================ ==================
5424 ============================== ============================================ ==================
5425 Option Description Default
5426 ============================== ============================================ ==================
5427 GEANY_WORDCHARS These characters define word boundaries when a string with:
5428 making selections and searching using word a-z, A-Z, 0-9 and
5429 matching options. underscore.
5430 ============================== ============================================ ==================
5435 These are default settings that can be overridden in the `Preferences`_ dialog.
5437 ============================== ============================================ ==================
5438 Option Description Default
5439 ============================== ============================================ ==================
5440 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
5441 trigger the autocompletion list.
5442 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
5444 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
5445 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator command, see See below.
5446 `Terminal emulators`_.
5447 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
5448 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
5449 and process plain text files. This can also
5451 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
5452 GNU grep. This can also include a path.
5453 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
5454 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
5456 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
5457 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
5458 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
5460 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
5462 GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
5464 ============================== ============================================ ==================
5466 The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
5468 The GEANY_DEFAULT_TOOLS_TERMINAL default value on Windows is::
5472 and on any non-Windows system is::
5474 xterm -e "/bin/sh %c"
5480 ============================== ============================================ ==================
5481 Option Description Default
5482 ============================== ============================================ ==================
5483 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
5484 be shown in the editor window.
5485 This affects the special coloring
5486 when Geany detects a compiler output line as
5487 an error message and then highlights the
5488 corresponding line in the source code.
5489 Usually only the first few messages are
5490 interesting because following errors are
5492 All errors in the Compiler window are parsed
5493 and unaffected by this value.
5494 PRINTBUILDCMDS Every time a build menu item priority FALSE
5495 calculation is run, print the state of the
5496 menu item table in the form of the table
5497 in `Build Menu Configuration`_. May be
5498 useful to debug configuration file
5499 overloading. Warning produces a lot of
5500 output. Can also be enabled/disabled by the
5501 debugger by setting printbuildcmds to 1/0
5502 overriding the compile setting.
5503 ============================== ============================================ ==================
5507 GNU General Public License
5508 ==========================
5512 GNU GENERAL PUBLIC LICENSE
5513 Version 2, June 1991
5515 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5516 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5517 Everyone is permitted to copy and distribute verbatim copies
5518 of this license document, but changing it is not allowed.
5522 The licenses for most software are designed to take away your
5523 freedom to share and change it. By contrast, the GNU General Public
5524 License is intended to guarantee your freedom to share and change free
5525 software--to make sure the software is free for all its users. This
5526 General Public License applies to most of the Free Software
5527 Foundation's software and to any other program whose authors commit to
5528 using it. (Some other Free Software Foundation software is covered by
5529 the GNU Library General Public License instead.) You can apply it to
5532 When we speak of free software, we are referring to freedom, not
5533 price. Our General Public Licenses are designed to make sure that you
5534 have the freedom to distribute copies of free software (and charge for
5535 this service if you wish), that you receive source code or can get it
5536 if you want it, that you can change the software or use pieces of it
5537 in new free programs; and that you know you can do these things.
5539 To protect your rights, we need to make restrictions that forbid
5540 anyone to deny you these rights or to ask you to surrender the rights.
5541 These restrictions translate to certain responsibilities for you if you
5542 distribute copies of the software, or if you modify it.
5544 For example, if you distribute copies of such a program, whether
5545 gratis or for a fee, you must give the recipients all the rights that
5546 you have. You must make sure that they, too, receive or can get the
5547 source code. And you must show them these terms so they know their
5550 We protect your rights with two steps: (1) copyright the software, and
5551 (2) offer you this license which gives you legal permission to copy,
5552 distribute and/or modify the software.
5554 Also, for each author's protection and ours, we want to make certain
5555 that everyone understands that there is no warranty for this free
5556 software. If the software is modified by someone else and passed on, we
5557 want its recipients to know that what they have is not the original, so
5558 that any problems introduced by others will not reflect on the original
5559 authors' reputations.
5561 Finally, any free program is threatened constantly by software
5562 patents. We wish to avoid the danger that redistributors of a free
5563 program will individually obtain patent licenses, in effect making the
5564 program proprietary. To prevent this, we have made it clear that any
5565 patent must be licensed for everyone's free use or not licensed at all.
5567 The precise terms and conditions for copying, distribution and
5568 modification follow.
5570 GNU GENERAL PUBLIC LICENSE
5571 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5573 0. This License applies to any program or other work which contains
5574 a notice placed by the copyright holder saying it may be distributed
5575 under the terms of this General Public License. The "Program", below,
5576 refers to any such program or work, and a "work based on the Program"
5577 means either the Program or any derivative work under copyright law:
5578 that is to say, a work containing the Program or a portion of it,
5579 either verbatim or with modifications and/or translated into another
5580 language. (Hereinafter, translation is included without limitation in
5581 the term "modification".) Each licensee is addressed as "you".
5583 Activities other than copying, distribution and modification are not
5584 covered by this License; they are outside its scope. The act of
5585 running the Program is not restricted, and the output from the Program
5586 is covered only if its contents constitute a work based on the
5587 Program (independent of having been made by running the Program).
5588 Whether that is true depends on what the Program does.
5590 1. You may copy and distribute verbatim copies of the Program's
5591 source code as you receive it, in any medium, provided that you
5592 conspicuously and appropriately publish on each copy an appropriate
5593 copyright notice and disclaimer of warranty; keep intact all the
5594 notices that refer to this License and to the absence of any warranty;
5595 and give any other recipients of the Program a copy of this License
5596 along with the Program.
5598 You may charge a fee for the physical act of transferring a copy, and
5599 you may at your option offer warranty protection in exchange for a fee.
5601 2. You may modify your copy or copies of the Program or any portion
5602 of it, thus forming a work based on the Program, and copy and
5603 distribute such modifications or work under the terms of Section 1
5604 above, provided that you also meet all of these conditions:
5606 a) You must cause the modified files to carry prominent notices
5607 stating that you changed the files and the date of any change.
5609 b) You must cause any work that you distribute or publish, that in
5610 whole or in part contains or is derived from the Program or any
5611 part thereof, to be licensed as a whole at no charge to all third
5612 parties under the terms of this License.
5614 c) If the modified program normally reads commands interactively
5615 when run, you must cause it, when started running for such
5616 interactive use in the most ordinary way, to print or display an
5617 announcement including an appropriate copyright notice and a
5618 notice that there is no warranty (or else, saying that you provide
5619 a warranty) and that users may redistribute the program under
5620 these conditions, and telling the user how to view a copy of this
5621 License. (Exception: if the Program itself is interactive but
5622 does not normally print such an announcement, your work based on
5623 the Program is not required to print an announcement.)
5625 These requirements apply to the modified work as a whole. If
5626 identifiable sections of that work are not derived from the Program,
5627 and can be reasonably considered independent and separate works in
5628 themselves, then this License, and its terms, do not apply to those
5629 sections when you distribute them as separate works. But when you
5630 distribute the same sections as part of a whole which is a work based
5631 on the Program, the distribution of the whole must be on the terms of
5632 this License, whose permissions for other licensees extend to the
5633 entire whole, and thus to each and every part regardless of who wrote it.
5635 Thus, it is not the intent of this section to claim rights or contest
5636 your rights to work written entirely by you; rather, the intent is to
5637 exercise the right to control the distribution of derivative or
5638 collective works based on the Program.
5640 In addition, mere aggregation of another work not based on the Program
5641 with the Program (or with a work based on the Program) on a volume of
5642 a storage or distribution medium does not bring the other work under
5643 the scope of this License.
5645 3. You may copy and distribute the Program (or a work based on it,
5646 under Section 2) in object code or executable form under the terms of
5647 Sections 1 and 2 above provided that you also do one of the following:
5649 a) Accompany it with the complete corresponding machine-readable
5650 source code, which must be distributed under the terms of Sections
5651 1 and 2 above on a medium customarily used for software interchange; or,
5653 b) Accompany it with a written offer, valid for at least three
5654 years, to give any third party, for a charge no more than your
5655 cost of physically performing source distribution, a complete
5656 machine-readable copy of the corresponding source code, to be
5657 distributed under the terms of Sections 1 and 2 above on a medium
5658 customarily used for software interchange; or,
5660 c) Accompany it with the information you received as to the offer
5661 to distribute corresponding source code. (This alternative is
5662 allowed only for noncommercial distribution and only if you
5663 received the program in object code or executable form with such
5664 an offer, in accord with Subsection b above.)
5666 The source code for a work means the preferred form of the work for
5667 making modifications to it. For an executable work, complete source
5668 code means all the source code for all modules it contains, plus any
5669 associated interface definition files, plus the scripts used to
5670 control compilation and installation of the executable. However, as a
5671 special exception, the source code distributed need not include
5672 anything that is normally distributed (in either source or binary
5673 form) with the major components (compiler, kernel, and so on) of the
5674 operating system on which the executable runs, unless that component
5675 itself accompanies the executable.
5677 If distribution of executable or object code is made by offering
5678 access to copy from a designated place, then offering equivalent
5679 access to copy the source code from the same place counts as
5680 distribution of the source code, even though third parties are not
5681 compelled to copy the source along with the object code.
5683 4. You may not copy, modify, sublicense, or distribute the Program
5684 except as expressly provided under this License. Any attempt
5685 otherwise to copy, modify, sublicense or distribute the Program is
5686 void, and will automatically terminate your rights under this License.
5687 However, parties who have received copies, or rights, from you under
5688 this License will not have their licenses terminated so long as such
5689 parties remain in full compliance.
5691 5. You are not required to accept this License, since you have not
5692 signed it. However, nothing else grants you permission to modify or
5693 distribute the Program or its derivative works. These actions are
5694 prohibited by law if you do not accept this License. Therefore, by
5695 modifying or distributing the Program (or any work based on the
5696 Program), you indicate your acceptance of this License to do so, and
5697 all its terms and conditions for copying, distributing or modifying
5698 the Program or works based on it.
5700 6. Each time you redistribute the Program (or any work based on the
5701 Program), the recipient automatically receives a license from the
5702 original licensor to copy, distribute or modify the Program subject to
5703 these terms and conditions. You may not impose any further
5704 restrictions on the recipients' exercise of the rights granted herein.
5705 You are not responsible for enforcing compliance by third parties to
5708 7. If, as a consequence of a court judgment or allegation of patent
5709 infringement or for any other reason (not limited to patent issues),
5710 conditions are imposed on you (whether by court order, agreement or
5711 otherwise) that contradict the conditions of this License, they do not
5712 excuse you from the conditions of this License. If you cannot
5713 distribute so as to satisfy simultaneously your obligations under this
5714 License and any other pertinent obligations, then as a consequence you
5715 may not distribute the Program at all. For example, if a patent
5716 license would not permit royalty-free redistribution of the Program by
5717 all those who receive copies directly or indirectly through you, then
5718 the only way you could satisfy both it and this License would be to
5719 refrain entirely from distribution of the Program.
5721 If any portion of this section is held invalid or unenforceable under
5722 any particular circumstance, the balance of the section is intended to
5723 apply and the section as a whole is intended to apply in other
5726 It is not the purpose of this section to induce you to infringe any
5727 patents or other property right claims or to contest validity of any
5728 such claims; this section has the sole purpose of protecting the
5729 integrity of the free software distribution system, which is
5730 implemented by public license practices. Many people have made
5731 generous contributions to the wide range of software distributed
5732 through that system in reliance on consistent application of that
5733 system; it is up to the author/donor to decide if he or she is willing
5734 to distribute software through any other system and a licensee cannot
5737 This section is intended to make thoroughly clear what is believed to
5738 be a consequence of the rest of this License.
5740 8. If the distribution and/or use of the Program is restricted in
5741 certain countries either by patents or by copyrighted interfaces, the
5742 original copyright holder who places the Program under this License
5743 may add an explicit geographical distribution limitation excluding
5744 those countries, so that distribution is permitted only in or among
5745 countries not thus excluded. In such case, this License incorporates
5746 the limitation as if written in the body of this License.
5748 9. The Free Software Foundation may publish revised and/or new versions
5749 of the General Public License from time to time. Such new versions will
5750 be similar in spirit to the present version, but may differ in detail to
5751 address new problems or concerns.
5753 Each version is given a distinguishing version number. If the Program
5754 specifies a version number of this License which applies to it and "any
5755 later version", you have the option of following the terms and conditions
5756 either of that version or of any later version published by the Free
5757 Software Foundation. If the Program does not specify a version number of
5758 this License, you may choose any version ever published by the Free Software
5761 10. If you wish to incorporate parts of the Program into other free
5762 programs whose distribution conditions are different, write to the author
5763 to ask for permission. For software which is copyrighted by the Free
5764 Software Foundation, write to the Free Software Foundation; we sometimes
5765 make exceptions for this. Our decision will be guided by the two goals
5766 of preserving the free status of all derivatives of our free software and
5767 of promoting the sharing and reuse of software generally.
5771 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5772 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5773 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5774 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5775 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5776 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5777 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5778 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5779 REPAIR OR CORRECTION.
5781 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5782 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5783 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5784 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5785 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5786 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5787 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5788 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5789 POSSIBILITY OF SUCH DAMAGES.
5791 END OF TERMS AND CONDITIONS
5793 How to Apply These Terms to Your New Programs
5795 If you develop a new program, and you want it to be of the greatest
5796 possible use to the public, the best way to achieve this is to make it
5797 free software which everyone can redistribute and change under these terms.
5799 To do so, attach the following notices to the program. It is safest
5800 to attach them to the start of each source file to most effectively
5801 convey the exclusion of warranty; and each file should have at least
5802 the "copyright" line and a pointer to where the full notice is found.
5804 <one line to give the program's name and a brief idea of what it does.>
5805 Copyright (C) <year> <name of author>
5807 This program is free software; you can redistribute it and/or modify
5808 it under the terms of the GNU General Public License as published by
5809 the Free Software Foundation; either version 2 of the License, or
5810 (at your option) any later version.
5812 This program is distributed in the hope that it will be useful,
5813 but WITHOUT ANY WARRANTY; without even the implied warranty of
5814 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5815 GNU General Public License for more details.
5817 You should have received a copy of the GNU General Public License along
5818 with this program; if not, write to the Free Software Foundation, Inc.,
5819 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5822 Also add information on how to contact you by electronic and paper mail.
5824 If the program is interactive, make it output a short notice like this
5825 when it starts in an interactive mode:
5827 Gnomovision version 69, Copyright (C) year name of author
5828 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5829 This is free software, and you are welcome to redistribute it
5830 under certain conditions; type `show c' for details.
5832 The hypothetical commands `show w' and `show c' should show the appropriate
5833 parts of the General Public License. Of course, the commands you use may
5834 be called something other than `show w' and `show c'; they could even be
5835 mouse-clicks or menu items--whatever suits your program.
5837 You should also get your employer (if you work as a programmer) or your
5838 school, if any, to sign a "copyright disclaimer" for the program, if
5839 necessary. Here is a sample; alter the names:
5841 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5842 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5844 <signature of Ty Coon>, 1 April 1989
5845 Ty Coon, President of Vice
5847 This General Public License does not permit incorporating your program into
5848 proprietary programs. If your program is a subroutine library, you may
5849 consider it more useful to permit linking proprietary applications with the
5850 library. If this is what you want to do, use the GNU Library General
5851 Public License instead of this License.
5856 License for Scintilla and SciTE
5857 ===============================
5859 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5863 Permission to use, copy, modify, and distribute this software and
5864 its documentation for any purpose and without fee is hereby granted,
5865 provided that the above copyright notice appear in all copies and
5866 that both that copyright notice and this permission notice appear in
5867 supporting documentation.
5869 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5870 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5871 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5872 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5873 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5874 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5875 USE OR PERFORMANCE OF THIS SOFTWARE.