1 .. |(version)| replace:: 0.20
7 -------------------------
8 A fast, light, GTK+ IDE
9 -------------------------
11 :Authors: Enrico Tröger,
19 This document is distributed under the terms of the GNU General Public
20 License as published by the Free Software Foundation; either version 2
21 of the License, or (at your option) any later version. A copy of this
22 license can be found in the file COPYING included with the source code
23 of this program, and also in the chapter `GNU General Public License`_.
37 Geany is a small and lightweight Integrated Development Environment. It
38 was developed to provide a small and fast IDE, which has only a few
39 dependencies on other packages. Another goal was to be as independent
40 as possible from a particular Desktop Environment like KDE or GNOME -
41 Geany only requires the GTK2 runtime libraries.
43 Some basic features of Geany:
47 * Autocompletion of symbols/words
48 * Construct completion/snippets
49 * Auto-closing of XML and HTML tags
51 * Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
55 * Build system to compile and execute your code
56 * Simple project management
64 You can obtain Geany from http://www.geany.org/ or perhaps also from
65 your distribution. For a list of available packages, please see
66 http://www.geany.org/Download/ThirdPartyPackages.
73 Geany is distributed under the terms of the GNU General Public License
74 as published by the Free Software Foundation; either version 2 of
75 the License, or (at your option) any later version. A copy of this
76 license can be found in the file COPYING included with the source
77 code of this program and in the chapter, `GNU General Public License`_.
79 The included Scintilla library (found in the subdirectory
80 ``scintilla/``) has its own license, which can be found in the chapter,
81 `License for Scintilla and SciTE`_.
88 This documentation is available in HTML and text formats.
89 The latest version can always be found at http://www.geany.org/.
91 If you want to contribute to it, see `Contributing to this document`_.
103 You will need the GTK (>= 2.8.0) libraries and their dependencies
104 (Pango, GLib and ATK). Your distro should provide packages for these,
105 usually installed by default. For Windows, you can download an installer
106 from the website which bundles these libraries.
112 There are many binary packages available. For an up-to-date but maybe
113 incomplete list see http://www.geany.org/Download/ThirdPartyPackages.
119 Compiling Geany is quite easy.
120 To do so, you need the GTK (>= 2.8.0) libraries and header files.
121 You also need the Pango, GLib and ATK libraries and header files.
122 All these files are available at http://www.gtk.org, but very often
123 your distro will provide development packages to save the trouble of
124 building these yourself.
126 Furthermore you need, of course, a C and C++ compiler. The GNU versions
127 of these tools are recommended.
129 Autotools based build system
130 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
132 The Autotools based build system is very mature and has been well tested.
133 To use it, you just need the Make tool, preferably GNU Make.
135 Then run the following commands::
144 Waf based build system
145 ^^^^^^^^^^^^^^^^^^^^^^
147 The Waf build system is still quite young and under heavy development but already in a
148 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
149 to install Python on your system.
150 The advantage of the Waf build system over the Autotools based build system is that the whole
151 build process might be a bit faster. Especially when you use the Waf
152 cache feature for repetitive builds (e.g. when changing only a few source files
153 to test something) will become much faster since Waf will cache and re-use the
154 unchanged built files and only compile the changed code again. See `Waf Cache`_ for details.
155 To build Geany with Waf as run::
167 The Waf build system has a nice and interesting feature which can help to avoid
168 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
169 or trying to debug something in Geany.
170 Waf is able to store and retrieve the object files from a cache. This cache is declared
171 using the environment variable ``WAFCACHE``.
172 A possible location of the cache directory could be ``~/.cache/waf``. In order to make use of
173 this, you first need to create this directory::
175 $ mkdir -p ~/.cache/waf
177 then add the environment variable to your shell configuration (the following example is for
178 Bash and should be adjusted to your used shell)::
180 export WAFCACHE=/home/username/.cache/waf
182 Remember to replace ``username`` with your actual username.
184 More information about the Waf cache feature are available at
185 http://code.google.com/p/waf/wiki/CacheObjectFiles.
189 You should be careful about the size of the cache directory as it may
190 grow rapidly over time.
191 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
193 An easy way to keep it clean is to run the following command regularly to remove old
196 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
198 This will delete all files in the cache directory which are older than 14 days.
200 For details about the ``find`` command and its options, check its manual page.
205 The configure script supports several common options, for a detailed
213 (depending on which build system you use).
215 You may also want to read the INSTALL file for advanced installation
218 * See also `Compile-time options`_.
220 Dynamic linking loader support and VTE
221 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
222 In the case that your system lacks dynamic linking loader support, you
223 probably want to pass the option ``--disable-vte`` to the ``configure``
224 script. This prevents compiling Geany with dynamic linking loader
225 support for automatically loading ``libvte.so.4`` if available.
229 If there are any errors during compilation, check your build
230 environment and try to find the error, otherwise contact the mailing
231 list or one the authors. Sometimes you might need to ask for specific
232 help from your distribution.
237 If you want to edit any of Geany's system configuration files after
238 installation you will need to know the installation prefix. Usually this
239 is not necessary as you can just use per user configuration files and
240 you will not need root permissions.
242 Use the ``--print-prefix`` option to Geany to check - see `Command line
243 options`_. The first path is the prefix.
245 This is commonly ``/usr`` if you installed from a binary package, or
246 ``/usr/local`` if you build from source.
257 You can start Geany in the following ways:
259 * From the Desktop Environment menu:
261 Choose in your application menu of your used Desktop Environment:
262 Development --> Geany.
264 * From the command line:
266 To start Geany from a command line, type the following and press
274 The Geany window is shown in the following figure:
276 .. image:: ./images/main_window.png
278 The workspace has the following parts:
281 * An optional toolbar.
282 * An optional sidebar that can show the following tabs:
284 * Documents - A document list, and
285 * Symbols - A list of symbols in your code.
287 * The main editor window.
288 * An optional message window which can show the following tabs:
290 * Status - A list of status messages.
291 * Compiler - The output of compiling or building programs.
292 * Messages - Results of 'Find Usage', 'Find Usage' 'Find in Files' and other actions
293 * Scribble - A text scratchpad for any use.
294 * Terminal - An optional terminal window.
298 Additional tabs may be added to the sidebar and message window by plugins.
300 The position of the tabs can be selected in the interface preferences.
302 The sizes of the sidebar and message window can be adjusted by
303 dragging the dividers.
308 ============ ======================= =================================================
309 Short option Long option Function
310 ============ ======================= =================================================
311 *none* +number Set initial line number for the first opened file
312 (same as --line, do not put a space between the + sign
313 and the number). E.g. "geany +7 foo.bar" will open the
314 file foo.bar and place the cursor in line 7.
316 *none* --column Set initial column number for the first opened file.
318 -c dir_name --config=directory_name Use an alternate configuration directory. The default
319 configuration directory is ``~/.config/geany/`` and that
320 is where ``geany.conf`` and other configuration files
323 *none* --ft-names Print a list of Geany's internal filetype names (useful
324 for snippets configuration).
326 -g --generate-tags Generate a global tags file (see
327 `Generating a global tags file`_).
329 -P --no-preprocessing Don't preprocess C/C++ files when generating tags.
331 -i --new-instance Do not open files in a running instance, force opening
332 a new instance. Only available if Geany was compiled
333 with support for Sockets.
335 -l --line Set initial line number for the first opened file.
337 *none* --list-documents Return a list of open documents in a running Geany
339 This can be used to read the currently opened documents in
340 Geany from an external script or tool. The returned list
341 is separated by newlines (LF) and consists of the full,
342 UTF-8 encoded filenames of the documents.
343 Only available if Geany was compiled with support for
346 -m --no-msgwin Do not show the message window. Use this option if you
347 do not need compiler messages or VTE support.
349 -n --no-ctags Do not load symbol completion and call tip data. Use this
350 option if you do not want to use them.
352 -p --no-plugins Do not load plugins or plugin support.
354 *none* --print-prefix Print installation prefix, the data directory, the lib
355 directory and the locale directory (in this order) to
356 stdout, one line each. This is mainly intended for plugin
357 authors to detect installation paths.
359 -s --no-session Do not load the previous session's files.
361 -t --no-terminal Do not load terminal support. Use this option if you do
362 not want to load the virtual terminal emulator widget
363 at startup. If you do not have ``libvte.so.4`` installed,
364 then terminal-support is automatically disabled. Only
365 available if Geany was compiled with support for VTE.
367 *none* --socket-file Use this socket filename for communication with a
368 running Geany instance. This can be used with the following
369 command to execute Geany on the current workspace::
371 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
373 *none* --vte-lib Specify explicitly the path including filename or only
374 the filename to the VTE library, e.g.
375 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
376 only needed when the auto-detection does not work. Only
377 available if Geany was compiled with support for VTE.
379 -v --verbose Be verbose (print useful status messages).
381 -V --version Show version information and exit.
383 -? --help Show help information and exit.
385 *none* [files ...] Open all given files at startup. This option causes
386 Geany to ignore loading stored files from the last
387 session (if enabled).
388 Geany also recognizes line and column information when
389 appended to the filename with colons, e.g.
390 "geany foo.bar:10:5" will open the file foo.bar and
391 place the cursor in line 10 at column 5.
393 Projects can also be opened but a project file (\*.geany)
394 must be the first non-option argument. All additionally
395 given files are ignored.
396 ============ ======================= =================================================
398 You can also pass line number and column number information, e.g.::
400 geany some_file.foo:55:4
402 Geany supports all generic GTK options, a list is available on the
414 At startup, Geany loads all files from the last time Geany was
415 launched. You can disable this feature in the preferences dialog
416 (see `General Startup preferences`_). If you specify some
417 files on the command line, only these files will be opened, but you
418 can find the files from the last session in the file menu under the
419 "Recent files" item. By default this contains the last 10 recently
420 opened files. You can change the number of recently opened files in
421 the preferences dialog.
423 You can start several instances of Geany, but only the first will
424 load files from the last session. To run a second instance of Geany,
425 do not specify any filenames on the command-line, or disable opening
426 files in a running instance using the appropriate command line option.
429 Opening files from the command-line in a running instance
430 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
432 Geany detects if there is an an instance of itself already running and opens files
433 from the command-line in that instance. So, Geany can
434 be used to view and edit files by opening them from other programs
435 such as a file manager.
437 You can also pass line number and column number information, e.g.::
439 geany some_file.foo:55:4
441 This would open the file ``some_file.foo`` with the cursor on line 55,
444 If you do not like this for some reason, you can disable using the first
445 instance by using the appropriate command line option -- see the section
446 called `Command line options`_.
449 Virtual terminal emulator widget (VTE)
450 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
452 If you have installed ``libvte.so`` on your system, it is loaded
453 automatically by Geany, and you will have a terminal widget in the
454 notebook at the bottom.
456 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
457 will not be loaded. So there is no need to install the package containing
458 this file in order to run Geany. Additionally, you can disable the use
459 of the terminal widget by command line option, for more information
460 see the section called `Command line options`_.
462 You can use this terminal (from now on called VTE) much as you would
463 a terminal program like xterm. There is basic clipboard support. You
464 can paste the contents of the clipboard by pressing the right mouse
465 button to open the popup menu, and choosing Paste. To copy text from
466 the VTE, just select the desired text and then press the right mouse
467 button and choose Copy from the popup menu. On systems running the
468 X Window System you can paste the last selected text by pressing the
469 middle mouse button in the VTE (on 2-button mice, the middle button
470 can often be simulated by pressing both mouse buttons together).
472 In the preferences dialog you can specify a shell which should be
473 started in the VTE. To make the specified shell a login shell just
474 use the appropriate command line options for the shell. These options
475 should be found in the manual page of the shell. For zsh and bash
476 you can use the argument ``--login``.
479 Geany tries to load ``libvte.so``. If this fails, it tries to load
480 some other filenames. If this fails too, you should check whether you
481 installed libvte correctly. Again note, Geany will run without this
484 It could be, that the library is called something else than
485 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
486 please set a link to the correct file (as root)::
488 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
490 Obviously, you have to adjust the paths and set X to the number of your
493 You can also specify the filename of the VTE library to use on the command
494 line (see the section called `Command line options`_) or at compile time
495 by specifying the command line option ``--with-vte-module-path`` to
499 Defining own widget styles using .gtkrc-2.0
500 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
502 You can define your widget style for many of Geany's GUI parts. To
503 do this, just edit your ``.gtkrc-2.0`` (usually found in your home
504 directory on UNIX-like systems and in the etc subdirectory of your
505 Geany installation on Windows).
507 To have a defined style used by Geany you must assign it to
508 at least one of Geany's widgets. For example use the following line::
510 widget "Geany*" style "geanyStyle"
512 This would assign your style "geany_style" to all Geany
513 widgets. You can also assign styles only to specific widgets. At the
514 moment you can use the following widgets:
526 An example of a simple ``.gtkrc-2.0``::
532 widget "GeanyMainWindow" style "geanyStyle"
538 widget "GeanyPrefsDialog" style "geanyStyle"
544 Switching between documents
545 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
547 The documents list and the editor tabs are two different ways
548 to switch between documents using the mouse. When you hit the key
549 combination to move between tabs, the order is determined by the tab
550 order. Its is not alphabetical as shown in the documents list
551 (regardless of whether or not editor tabs are visible).
553 The tabs can be positioned at the top, bottom, left, or right of the
554 main editing window, by a selection in the interface preferences.
556 See the `Notebook tab keybindings`_ section for useful
557 shortcuts including for Most-Recently-Used document switching.
560 Character sets and Unicode Byte-Order-Mark (BOM)
561 ------------------------------------------------
567 Geany provides support for detecting and converting character sets. So
568 you can open and save files in different character sets, and even
569 convert a file from one character set to another. To do this,
570 Geany uses the character conversion capabilities of the GLib library.
572 Only text files are supported, i.e. opening files which contain
573 NULL-bytes may fail. Geany will try to open the file anyway but it is
574 likely that the file will be truncated because it can only be read up
575 to the first occurrence of a NULL-byte. All characters after this
576 position are lost and are not written when you save the file.
578 Geany tries to detect the encoding of a file while opening it, but
579 auto-detecting the encoding of a file is not easy and sometimes an
580 encoding might not be detected correctly. In this case you have to
581 set the encoding of the file manually in order to display it
582 correctly. You can this in the file open dialog by selecting an
583 encoding in the drop down box or by reloading the file with the
584 file menu item "Reload as". The auto-detection works well for most
585 encodings but there are also some encodings where it is known that
586 auto-detection has problems.
588 There are different ways to set different encodings in Geany:
590 * Using the file open dialog
592 This opens the file with the encoding specified in the encoding drop
593 down box. If the encoding is set to "Detect from file" auto-detection
594 will be used. If the encoding is set to "Without encoding (None)" the
595 file will be opened without any character conversion and Geany will
596 not try to auto-detect the encoding (see below for more information).
598 * Using the "Reload as" menu item
600 This item reloads the current file with the specified encoding. It can
601 help if you opened a file and found out that the wrong encoding was used.
603 * Using the "Set encoding" menu item
605 Contrary to the above two options, this will not change or reload
606 the current file unless you save it. It is useful when you want to
607 change the encoding of the file.
609 * Specifying the encoding in the file itself
611 As mentioned above, auto-detecting the encoding of a file may fail on
612 some encodings. If you know that Geany doesn't open a certain file,
613 you can add the specification line, described in the next section,
614 to the beginning of the file to force Geany to use a specific
615 encoding when opening the file.
618 In-file encoding specification
619 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
621 Geany detects meta tags of HTML files which contain charset information
624 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
626 and the specified charset is used when opening the file. This is useful if the
627 encoding of the file cannot be detected properly.
628 For non-HTML files you can also define a line like::
630 /* geany_encoding=ISO-8859-15 */
634 # geany_encoding=ISO-8859-15 #
636 to force an encoding to be used. The #, /\* and \*/ are examples
637 of filetype-specific comment characters. It doesn't matter which
638 characters are around the string " geany_encoding=ISO-8859-15 " as long
639 as there is at least one whitespace character before and after this
640 string. Whitespace characters are in this case a space or tab character.
641 An example to use this could be you have a file with ISO-8859-15
642 encoding but Geany constantly detects the file encoding as ISO-8859-1.
643 Then you simply add such a line to the file and Geany will open it
644 correctly the next time.
646 Since Geany 0.15 you can also use lines which match the
647 regular expression used to find the encoding string:
648 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
651 These specifications must be in the first 512 bytes of the file.
652 Anything after the first 512 bytes will not be recognized.
656 # encoding = ISO-8859-15
660 # coding: ISO-8859-15
662 Special encoding "None"
663 ^^^^^^^^^^^^^^^^^^^^^^^
665 There is a special encoding "None" which uses no
666 encoding. It is useful when you know that Geany cannot auto-detect
667 the encoding of a file and it is not displayed correctly. Especially
668 when the file contains NULL-bytes this can be useful to skip auto
669 detection and open the file properly at least until the occurrence
670 of the first NULL-byte. Using this encoding opens the file as it is
671 without any character conversion.
674 Unicode Byte-Order-Mark (BOM)
675 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
677 Furthermore, Geany detects a Unicode Byte Order Mark (see
678 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
679 this feature is only available if the opened file is in a Unicode
680 encoding. The Byte Order Mark helps to detect the encoding of a file,
681 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
682 using a Byte Order Mark could cause some problems for programs not
683 expecting it, e.g. the compiler gcc stops
684 with stray errors, PHP does not parse a script containing a BOM and
685 script files starting with a she-bang maybe cannot be started. In the
686 status bar you can easily see whether the file starts with a BOM or
689 If you want to set a BOM for a file or if you want to remove it
690 from a file, just use the document menu and toggle the checkbox.
693 If you are unsure what a BOM is or if you do not understand where
694 to use it, then it is probably not important for you and you can
706 Geany provides basic code folding support. Folding means the ability to
707 show and hide parts of the text in the current file. You can hide
708 unimportant code sections and concentrate on the parts you are working on
709 and later you can show hidden sections again. In the editor window there is
710 a small grey margin on the left side with [+] and [-] symbols which
711 show hidden parts and hide parts of the file respectively. By
712 clicking on these icons you can simply show and hide sections which are
713 marked by vertical lines within this margin. For many filetypes nested
714 folding is supported, so there may be several fold points within other
718 You can customize the folding icon and line styles - see the
719 filetypes.common `Folding Settings`_.
721 If you don't like it or don't need it at all, you can simply disable
722 folding support completely in the preferences dialog.
724 The folding behaviour can be changed with the "Fold/Unfold all children of
725 a fold point" option in the preference dialog. If activated, Geany will
726 unfold all nested fold points below the current one if they are already
727 folded (when clicking on a [+] symbol).
728 When clicking on a [-] symbol, Geany will fold all nested fold points
729 below the current one if they are unfolded.
731 This option can be inverted by pressing the Shift
732 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
733 children of a fold point" option is enabled, pressing Shift will disable
734 it for this click and vice versa.
737 Column mode editing (rectangular selections)
738 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
740 There is basic support for column mode editing. To use it, create a
741 rectangular selection by holding down the Control and Shift keys
742 (or Control and Alt if it doesn't work) while
743 selecting some text. It is also possible to create a zero-column selection.
744 Once a rectangular selection exists you can start editing the text within
745 this selection and the modifications will be done for every line in the
749 Drag and drop of text
750 ^^^^^^^^^^^^^^^^^^^^^
752 If you drag selected text in the editor widget of Geany the text is
753 moved to the position where the mouse pointer is when releasing the
754 mouse button. Holding Control when releasing the mouse button will
755 copy the text instead. This behaviour was changed in Geany 0.11 -
756 before the selected text was copied to the new position.
762 Geany allows each document to indent either with a tab character,
763 multiple spaces or a combination of both. The default indent
764 settings are set in `Editor Indentation preferences`_ (see the link
765 for more information).
767 The default settings can be overridden per-document using the
768 Document menu. They can also be overridden by projects - see
769 `Project Management`_.
771 The indent mode for the current document is shown on the status bar
775 Indent with Tab characters.
779 Indent with tabs and spaces, depending on how much indentation is
782 Applying new indentation settings
783 `````````````````````````````````
784 After changing the default settings you may wish to apply the new
785 settings to every document in the current session. To do this use the
786 *Project->Apply Default Indentation* menu item.
788 Detecting indent type
789 `````````````````````
790 The *Detect from file* indentation preference can be used to
791 scan each file as it's opened and set the indent type based on
792 how many lines start with a tab vs. 2 or more spaces.
798 When enabled, auto-indentation happens when pressing *Enter* in the
799 Editor. It adds a certain amount of indentation to the new line so the
800 user doesn't always have to indent each line manually.
802 Geany has four types of auto-indentation:
805 Disables auto-indentation completely.
807 Adds the same amount of whitespace on a new line as on the last line.
809 Does the same as *Basic* but also indents a new line after an opening
810 brace '{', and de-indents when typing a closing brace '}'. For Python,
811 a new line will be indented after typing ':' at the end of the
814 Similar to *Current chars* but the closing brace will be aligned to
815 match the indentation of the line with the opening brace.
817 There is also XML-tag auto-indentation. This is enabled when the
818 mode is more than just Basic, and is also controlled by a filetype
819 setting - see `xml_indent_tags`_.
825 Geany provides a handy bookmarking feature that lets you mark one
826 or more lines in a document, and return the cursor to them using a
829 To place a mark on a line, either left-mouse-click in the left margin
830 of the editor window, or else use Ctrl-m. This will
831 produce a small green plus symbol in the margin. You can have as many
832 marks in a document as you like. Click again (or use Ctrl-m again)
833 to remove the bookmark. To remove all the marks in a given document,
834 use "Remove Markers" in the Document menu.
836 To navigate down your document, jumping from one mark to the next,
837 use Ctrl-. (control period). To go in the opposite direction on
838 the page, use Ctrl-, (control comma). Using the bookmarking feature
839 together with the commands to switch from one editor tab to another
840 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
841 navigate around multiple files.
844 Code navigation history
845 ^^^^^^^^^^^^^^^^^^^^^^^
847 To ease navigation in source files and especially between
848 different files, Geany lets you jump between different navigation
849 points. Currently, this works for the following:
851 * `Go to tag declaration`_
852 * `Go to tag definition`_
857 When using one of these actions, Geany remembers your current position
858 and jumps to the new one. If you decide to go back to your previous
859 position in the file, just use "Navigate back a location". To
860 get back to the new position again, just use "Navigate forward a
861 location". This makes it easier to navigate in e.g. foreign code
862 and between different files.
865 Sending text through custom commands
866 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
868 You can define several custom commands in Geany and send the current
869 selection to one of these commands using the *Edit->Format->Send
870 Selection to* menu or keybindings. The output of the command will be
871 used to replace the current selection. This makes it possible to use
872 text formatting tools with Geany in a general way.
874 The selected text will be sent to the standard input of the executed
875 command, so the command should be able to read from it and it should
876 print all results to its standard output which will be read by
877 Geany. To help finding errors in executing the command, the output
878 of the program's standard error will be printed on Geany's standard
881 To add a custom command, use the *Send Selection to->Set Custom
882 Commands* menu item. Click on *Add* to get a new text entry and type
883 the command. You can also specify some command line options. To
884 delete a command, just clear the text entry and press OK. It will be
885 deleted automatically.
887 Normal shell quoting is supported, so you can do things like:
889 * ``sed 's/\./(dot)/g'``
891 The above example would normally be done with the `Replace all`_
892 function, but it can be handy to have common commands already set up.
898 You can execute the context action command on the current word at the
899 cursor position or the available selection. This word or selection
900 can be used as an argument to the command.
901 The context action is invoked by a menu entry in the popup menu of the
902 editor and also a keyboard shortcut (see the section called
905 The command can be specified in the preferences dialog and also for
906 each filetype (see "context_action_cmd" in the section called
907 `Filetype configuration`_). When the context action is invoked, the filetype
908 specific command is used if available, otherwise the command
909 specified in the preferences dialog is executed.
911 The current word or selection can be referred with the wildcard "%s"
912 in the command, it will be replaced by the current word or
913 selection before the command is executed.
915 For example a context action can be used to open API documentation
916 in a browser window, the command to open the PHP API documentation
919 firefox "http://www.php.net/%s"
921 when executing the command, the %s is substituted by the word near
922 the cursor position or by the current selection. If the cursor is at
923 the word "echo", a browser window will open(assumed your browser is
924 called firefox) and it will open the address: http://www.php.net/echo.
930 Geany can offer a list of possible completions for symbols defined in the
931 tags and for all words in a document.
933 The autocompletion list for symbols is presented when the first few
934 characters of the symbol are typed (configurable, see `Editor Completions
935 preferences`_, default 4) or when the *Complete word*
936 keybinding is pressed (configurable, see `Editor keybindings`_,
939 When the defined keybinding is typed and the *Autocomplete all words in
940 document* preference (in `Editor Completions preferences`_)
941 is selected then the autocompletion list will show all matching words
942 in the document, if there are no matching symbols.
944 If you don't want to use autocompletion it can be dismissed until
945 the next symbol by pressing Escape. The autocompletion list is updated
946 as more characters are typed so that it only shows completions that start
947 with the characters typed so far. If no symbols begin with the sequence,
948 the autocompletion window is closed.
950 The up and down arrows will move the selected item. The highlighted
951 item on the autocompletion list can be chosen from the list by pressing
952 Enter/Return. You can also double-click to select an item. The sequence
953 will be completed to match the chosen item, and if the *Drop rest of
954 word on completion* preference is set (in `Editor Completions
955 preferences`_) then any characters after the cursor that match
956 a symbol or word are deleted.
960 By default, pressing Tab will complete the selected item by word part;
961 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
966 * gtk_combo_box_<e><TAB>
967 * gtk_combo_box_entry_<s><ENTER>
968 * gtk_combo_box_entry_set_text_column
970 The key combination can be changed from Tab - See `Editor keybindings`_.
971 If you clear/change the key combination for word part completion, Tab
972 will complete the whole word instead, like Enter.
984 When you type ``foo.`` it will show an autocompletion list with 'i' and
987 It only works for languages that set parent scope names for e.g. struct
988 members. Currently this means C-like languages. The C tag parser only
989 parses global scopes, so this won't work for structs or objects declared
993 User-definable snippets
994 ^^^^^^^^^^^^^^^^^^^^^^^
996 Snippets are small strings or code constructs which can be replaced or
997 completed to a more complex string. So you can save a lot of time when
998 typing common strings and letting Geany do the work for you.
999 To know what to complete or replace Geany reads a configuration file
1000 called ``snippets.conf`` at startup.
1002 Maybe you need to often type your name, so define a snippet like this::
1005 myname=Enrico Tröger
1007 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
1008 with "Enrico Tröger". The key to start autocompletion can be changed
1009 in the preferences dialog, by default it is TAB. The corresponding keybinding
1010 is called ``Complete snippet``.
1014 The system-wide configuration file can be found in
1015 ``$prefix/share/geany``, where ``$prefix`` is the path where Geany is
1016 installed (see `Installation prefix`_). It is not recommended to edit the
1017 system-wide file, because it will be overridden when Geany is updated.
1019 To change the settings, copy the file from ``$prefix/share/geany``
1020 in your configuration directory (usually ``~/.config/geany/``).
1024 % cp /usr/local/share/geany/snippets.conf /home/username/.config/geany/
1026 Then you can edit the file and the changes will remain available
1027 after an update of Geany because the file resides in your
1028 configuration directory. Alternatively, you can create a file
1029 ``~/.config/geany/snippets.conf`` and add only these settings you want
1030 to change. All missing settings will be read from the global snippets
1031 file in ``$prefix/share/geany``.
1035 The file ``snippets.conf`` contains sections defining snippets that
1036 are available for particular filetypes and in general.
1038 The two sections "Default" and "Special" apply to all filetypes.
1039 "Default" contains all snippets which are available for every
1040 filetype and "Special" contains snippets which can only be used in
1041 other snippets. So you can define often used parts of snippets and
1042 just use the special snippet as a placeholder (see the
1043 ``snippets.conf`` for details).
1045 You can define sections with the name of a filetype eg "C++". The
1046 snippets in that section are only available for use in files with that
1047 filetype. Snippets in filetype sections will hide snippets with the
1048 same name in the "Default" section when used in a file of that
1051 **Substitution sequences for snippets**
1053 To define snippets you can use several special character sequences which
1054 will be replaced when using the snippet:
1056 ================ =========================================================
1057 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1058 char(s): LF, CR/LF, or CR).
1060 \\t or %ws% Insert an indentation step, it will be replaced according
1061 to the current document's indent mode.
1063 \\s \\s to force whitespace at beginning or end of a value
1064 ('key= value' won't work, use 'key=\\svalue')
1066 %cursor% Place the cursor at this position after completion has
1067 been done. You can define multiple %cursor% wildcards
1068 and use the keybinding ``Move cursor in snippet`` to jump
1069 to the next defined cursor position in the completed
1072 %...% "..." means the name of a key in the "Special" section.
1073 If you have defined a key "brace_open" in the "Special"
1074 section you can use %brace_open% in any other snippet.
1075 ================ =========================================================
1077 Snippet names must not contain spaces otherwise they won't
1078 work correctly. But beside that you can define almost any
1079 string as a snippet and use it later in Geany. It is not limited
1080 to existing contructs of certain programming languages(like ``if``,
1081 ``for``, ``switch``). Define whatever you need.
1083 **Template wildcards**
1085 Since Geany 0.15 you can also use most of the available templates wildcards
1086 listed in `Template wildcards`_. All wildcards which are listed as
1087 `available in snippets` can be used. For instance to improve the above example::
1090 myname=My name is {developer}
1091 mysystem=My system: {command:uname -a}
1093 this will replace ``myname`` with "My name is " and the value of the template
1094 preference ``developer``.
1098 You can change the way Geany recognizes the word to complete,
1099 that is how the start and end of a word is recognised when the
1100 snippet completion is requested. The section "Special" may
1101 contain a key "wordchars" which lists all characters a string may contain
1102 to be recognized as a word for completion. Leave it commented to use
1103 default characters or define it to add or remove characters to fit your
1109 Normally you would type the snippet name and press Tab. However, you
1110 can define keybindings for snippets under the *Keybindings* group in
1115 block_cursor=<Ctrl>8
1118 Snippet keybindings may be overridden by Geany's configurable
1122 Inserting Unicode characters
1123 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1125 With GTK 2.10 and above, you can insert Unicode code points by hitting
1126 Ctrl-Shift-u, then still holding Ctrl-Shift, type some hex digits representing
1127 the code point for the character you want and hit Enter or Return (still
1128 holding Ctrl-Shift). If you release Ctrl-Shift before hitting Enter or Return
1129 (or any other character), the code insertion is completed, but the typed
1130 character is also entered. In the case of Enter/Return, it is a newline, as
1134 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1135 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1136 or restart Geany. Note that it works slightly differently from other GTK
1137 applications, in that you'll need to continue to hold down the Ctrl and Shift
1138 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1140 For GTK < 2.10, it is also possible, but typing the first Ctrl-Shift-u
1141 is not necessary. One problem is that you may find the alphabetic
1142 keys conflict with other Geany keybindings.
1146 Search, replace and go to
1147 -------------------------
1149 This section describes search-related commands from the Search menu
1150 and the editor window's popup menu:
1157 * Go to tag definition
1158 * Go to tag declaration
1163 There are also two toolbar entries:
1168 There are keybindings to focus each of these - see `Focus
1169 keybindings`_. Pressing Escape will then focus the editor.
1173 The quickest way to find some text is to use the search bar entry in
1174 the toolbar. This performs a case-insensitive search in the current
1175 document whilst you type. Pressing Enter will search again.
1180 The Find dialog is used for finding text in one or more open documents.
1182 .. image:: ./images/find_dialog.png
1188 The syntax for the *Use regular expressions* option is shown in
1189 `Regular expressions`_.
1192 *Use escape sequences* is implied for regular expressions.
1194 The *Use escape sequences* option will transform any escaped characters
1195 into their UTF-8 equivalent. For example, \\t will be transformed into
1196 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1197 (Unicode characters).
1203 To find all matches, click on the Find All expander. This will reveal
1210 Find All In Document will show a list of matching lines in the
1211 current document in the Messages tab of the Message Window. *Find All
1212 In Session* does the same for all open documents.
1214 Mark will highlight all matches in the current document with a
1215 colored box. These markers can be removed by selecting the
1216 Remove Markers command from the Document menu.
1219 Change font in search dialog text fields
1220 ````````````````````````````````````````
1222 All search related dialogs use a Monospace for the text input fields to
1223 increase the readability of input text. This is useful when you are
1224 typing input such as regular expressions with spaces, periods and commas which
1225 might it hard to read with a proportional font.
1227 If you want to change the font, you can do this easily
1228 by inserting the following style into your ``.gtkrc-2.0``
1229 (usually found in your home directory on UNIX-like systems and in the
1230 etc subdirectory of your Geany installation on Windows)::
1232 style "search_style"
1234 font_name="Monospace 8"
1236 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1238 Please note the addition of ":highest" in the last line which sets the priority
1239 of this style to the highest available. Otherwise, the style is ignored
1240 for the search dialogs.
1245 The *Find Next/Previous Selection* commands perform a search for the
1246 current selected text. If nothing is selected, by default the current
1247 word is used instead. This can be customized by the
1248 *find_selection_type* hidden pref - see `Hidden preferences`_.
1250 ===== =============================================
1251 Value *find_selection_type* behaviour
1252 ===== =============================================
1253 0 Use the current word (default).
1254 1 Try the X selection first, then current word.
1255 2 Repeat last search.
1256 ===== =============================================
1262 Find usage searches all open files. It is similar to the Find All In
1263 Session option in the Find dialog.
1265 If there is a selection, then it is used as the search text; otherwise
1266 the current word is used. The current word is either taken from the
1267 word nearest the edit cursor, or the word underneath the popup menu
1268 click position when the popup menu is used. The search results are
1269 shown in the Messages tab of the Message Window.
1275 Find in files is a more powerful version of Find usage that searches
1276 all files in a certain directory using the Grep tool. The Grep tool
1277 must be correctly set in Preferences to the path of the system's Grep
1278 utility. GNU Grep is recommended (see note below).
1280 .. image:: ./images/find_in_files_dialog.png
1282 The *Files* field optionally searches only files matching the
1283 patterns listed. Patterns are basic and shell-like, separated by a
1284 space. To search all ``.c`` and ``.h`` files, use: ``*.c *.h``.
1286 The *Encoding* field can be used to define the encoding of the files
1287 to be searched. The entered search text is converted to the chosen encoding
1288 and the search results are converted back to UTF-8.
1290 The *Extra options* field is used to pass any additional arguments to
1294 The *Files* setting uses ``--include=``, *Recurse in subfolders*
1295 uses ``-r``; both are GNU Grep options and may not work with other
1296 Grep implementations.
1299 Filtering out version control files
1300 ```````````````````````````````````
1302 When using the *Recurse in subfolders* option with a directory that's
1303 under version control, you can set the *Extra options* field to filter
1304 out version control files.
1306 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1307 argument to filter out CVS and hidden directories like ``.svn``.
1309 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1311 If you have an older Grep, you can try using the ``--exclude`` flag
1312 to filter out filenames.
1314 SVN Example: ``--exclude=*.svn-base``
1316 The --exclude argument only matches the file name part, not the path.
1322 The Replace dialog is used for replacing text in one or more open
1325 .. image:: ./images/replace_dialog.png
1327 The Replace dialog has the same options for matching text as the Find
1328 dialog. See the section `Matching options`_.
1330 The *Use regular expressions* option allows regular expressions to
1331 be used in the search string and back references in the replacement
1332 text -- see the entry for '\\n' in `Regular expressions`_.
1337 To replace several matches, click on the *Replace All* expander. This
1338 will reveal several options:
1344 *Replace All In Document* will replace all matching text in the
1345 current document. *Replace All In Session* does the same for all open
1346 documents. *Replace All In Selection* will replace all matching text
1347 in the current selection of the current document.
1350 Go to tag definition
1351 ^^^^^^^^^^^^^^^^^^^^
1353 If the current word is the name of a tag definition (like a function
1354 body) and the file containing the tag definition is open, this command
1355 will switch to that file and go to the corresponding line number. The
1356 current word is either the word nearest the edit cursor,
1357 or the word underneath the popup menu click position when the popup
1361 If the current word's tag is on the current line, Geany will try
1362 to look for a tag declaration instead, as this is more useful.
1363 Likewise 'Go to tag declaration' will search for a tag definition
1367 Go to tag declaration
1368 ^^^^^^^^^^^^^^^^^^^^^
1370 Like Go to tag definition, but for a forward declaration such as a
1371 C function prototype or ``extern`` declaration instead of a function
1378 Go to a particular line number in the current file.
1384 You can use regular expressions in the Find and Replace dialogs
1385 by selecting the *Use regular expressions* check box (see `Matching
1386 options`_). The syntax is POSIX compatible, as described in the table
1390 1. The *Use escape sequences* dialog option always applies for regular
1392 2. Searching backwards with regular expressions is not supported.
1393 3. \\b, \\d, \\s, \\w are GNU extensions and may not be available
1394 on non-GNU POSIX systems unless you built Geany with the
1395 ``--enable-gnu-regex`` option (this is always used on Windows).
1397 **In a regular expression, the following characters are interpreted:**
1399 ======= ============================================================
1400 . Matches any character.
1402 ( This marks the start of a region for tagging a match.
1404 ) This marks the end of a tagged region.
1406 \\n Where n is 1 through 9 refers to the first through ninth tagged
1407 region when searching or replacing.
1409 Searching for (Wiki)\\1 matches WikiWiki.
1411 If the search string was Fred([1-9])XXX and the
1412 replace string was Sam\\1YYY, when applied to Fred2XXX this
1413 would generate Sam2YYY.
1415 \\0 When replacing, the whole matching text.
1417 \\b This matches a word boundary.
1419 \\c A backslash followed by d, D, s, S, w or W, becomes a
1420 character class (both inside and outside sets []).
1423 * D: any char except decimal digits
1424 * s: whitespace (space, \\t \\n \\r \\f \\v)
1425 * S: any char except whitespace (see above)
1426 * w: alphanumeric & underscore
1427 * W: any char except alphanumeric & underscore
1429 \\x This allows you to use a character x that would otherwise have
1430 a special meaning. For example, \\[ would be interpreted as [
1431 and not as the start of a character set. Use \\\\ for a literal
1434 [...] Matches one of the characters in the set. If the first
1435 character in the set is ^, it matches the characters NOT in
1436 the set, i.e. complements the set. A shorthand S-E (start
1437 dash end) is used to specify a set of characters S up to E,
1440 The special characters ] and - have no special
1441 meaning if they appear first in the set. - can also be last
1442 in the set. To include both, put ] first: []A-Z-].
1446 []|-] matches these 3 chars
1447 []-|] matches from ] to | chars
1448 [a-z] any lowercase alpha
1449 [^]-] any char except - and ]
1450 [^A-Z] any char except uppercase alpha
1453 ^ This matches the start of a line (unless used inside a set, see
1456 $ This matches the end of a line.
1458 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1459 Saam, Saaam and so on.
1461 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1462 Saam, Saaam and so on.
1464 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1465 ======= ============================================================
1468 This table is adapted from Scintilla and SciTE documentation,
1469 distributed under the `License for Scintilla and SciTE`_.
1476 Tags are information that relates symbols in a program with the
1477 source file location of the declaration and definition.
1479 Geany has built-in functionality for generating tag information (aka
1480 "workspace tags") for supported filetypes when you open a file. You
1481 can also have Geany automatically load external tag files (aka "global
1482 tags files") upon startup, or manually using *Tools --> Load Tags*.
1484 Geany uses its own tag file format, similar to what ``ctags`` uses
1485 (but is incompatible with ctags). You use Geany to generate global
1486 tags files, as described below.
1492 Tags for each document are parsed whenever a file is loaded or
1493 saved. These are shown in the Symbol list in the Sidebar. These tags
1494 are also used for autocompletion of symbols and calltips for all documents
1495 open in the current session that have the same filetype.
1497 The *Go to Tag* commands can be used with all workspace tags. See
1498 `Go to tag definition`_.
1504 Global tags are used to provide autocompletion of symbols and calltips
1505 without having to open the corresponding source files. This is intended
1506 for library APIs, as the tags file only has to be updated when you upgrade
1509 You can load a custom global tags file in two ways:
1511 * Using the *Load Tags* command in the Tools menu.
1512 * By creating a directory ``~/.config/geany/tags``, and moving or symlinking
1513 the tags files there before starting Geany.
1514 * By creating a directory ``$prefix/share/geany/tags``, and moving
1515 or symlinking the tags files there before starting Geany.
1516 ``$prefix`` is the installation prefix (see `Installation prefix`_).
1518 You can either download these files or generate your own. They have
1523 *lang_ext* is one of the extensions set for the filetype associated
1524 with the tags. See the section called `Filetype extensions`_ for
1528 Default global tags files
1529 `````````````````````````
1531 For some languages, a list of global tags is loaded when the
1532 corresponding filetype is first used. Currently these are for:
1534 * C -- GTK+ and GLib
1537 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1542 Global tags file format
1543 ```````````````````````
1545 Global tags files can have two different formats:
1548 * Pipe-separated format
1550 The first line of global tags files should be a comment, introduced
1551 by ``#`` followed by a space and a string like ``format=pipe``
1552 or ``format=tagmanager`` respectively, these are case-sensitive.
1553 This helps Geany to read the file properly. If this line
1554 is missing, Geany tries to auto-detect the used format but this
1558 The Tagmanager format is a bit more complex and is used for files
1559 created by the ``geany -g`` command. There is one tag per line.
1560 Different tag attributes like the return value or the argument list
1561 are separated with different characters indicating the type of the
1564 The Pipe-separated format is easier to read and write.
1565 There is one tag per line and different tag attributes are separated
1566 by the pipe character (``|``). A line looks like::
1568 basename|string|(string path [, string suffix])|
1570 | The first field is the tag name (usually a function name).
1571 | The second field is the type of the return value.
1572 | The third field is the argument list for this tag.
1573 | The fourth field is the description for this tag but
1574 currently unused and should be left empty.
1576 Except for the first field (tag name), all other field can be left
1577 empty but the pipe separator must appear for them.
1579 You can easily write your own global tag files using this format.
1580 Just save them in your tags directory, as described earlier in the
1581 section `Global tags`_.
1584 Generating a global tags file
1585 `````````````````````````````
1587 You can generate your own global tags files by parsing a list of
1588 source files. The command is::
1590 geany -g [-P] <Tag File> <File list>
1592 * Tag File filename should be in the format described earlier --
1593 see the section called `Global tags`_.
1594 * File list is a list of filenames, each with a full path (unless
1595 you are generating C/C++ tags and have set the CFLAGS environment
1596 variable appropriately).
1597 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1598 to process ``#include`` directives for C/C++ source files. Use this
1599 option if you want to specify each source file on the command-line
1600 instead of using a 'master' header file. Also can be useful if you
1601 don't want to specify the CFLAGS environment variable.
1603 Example for the wxD library for the D programming language::
1605 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1608 *Generating C/C++ tag files:*
1610 For C/C++ tag files, gcc and grep are required, so that header files
1611 can be preprocessed to include any other headers they depend upon.
1613 For C/C++ files, the environment variable CFLAGS should be set with
1614 appropriate ``-I/path`` include paths. The following example works with
1615 the bash shell, generating tags for the GnomeUI library::
1617 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1618 /usr/include/libgnomeui-2.0/gnome.h
1620 You can adapt this command to use CFLAGS and header files appropriate
1621 for whichever libraries you want.
1624 *Replacing the default C/C++ tags file:*
1626 Geany currently uses a default global tags file c99.tags for
1627 C and C++, commonly installed in /usr/share/geany. This file can
1628 be replaced with one containing tags parsed from a different set
1629 of header files. When Geany is next started, your custom tags file
1630 will be loaded instead of the default c99.tags. You should keep a
1631 copy of the generated tags file because it will get overwritten when
1638 You can also ignore certain tags if they would lead to wrong parsing of
1639 the code. Simply create a file called "ignore.tags" in your Geany
1640 configuration directory (usually ``~/.config/geany/``). Then list all tags
1641 you want to ignore in this file, separated by spaces and/or newlines.
1643 More detailed information about the usage from the Exuberant Ctags
1646 Specifies a list of identifiers which are to be specially handled
1647 while parsing C and C++ source files. This option is specifically
1648 provided to handle special cases arising through the use of
1649 pre-processor macros. When the identifiers listed are simple identifiers,
1650 these identifiers will be ignored during parsing of the source files.
1651 If an identifier is suffixed with a '+' character, ctags will also
1652 ignore any parenthesis-enclosed argument list which may immediately
1653 follow the identifier in the source files.
1654 If two identifiers are separated with the '=' character, the first
1655 identifiers is replaced by the second identifiers for parsing purposes.
1657 For even more detailed information please read the manual page of
1664 You may adjust Geany's settings using the Edit --> Preferences
1665 dialog. Any changes you make there can be applied by hitting either
1666 the Apply or the OK button. These settings will persist between Geany
1667 sessions. Note that most settings here have descriptive popup bubble
1668 help -- just hover the mouse over the item in question to get help
1671 You may also adjust some View settings (under the View menu) that
1672 persist between Geany sessions. The settings under the Document menu,
1673 however, are only for the current document and revert to defaults
1674 when restarting Geany.
1676 There are also some rarer `Hidden preferences`_.
1679 In the paragraphs that follow, the text describing a dialog tab
1680 comes after the screenshot of that tab.
1683 General Startup preferences
1684 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1686 .. image:: ./images/pref_dialog_gen_startup.png
1691 Load files from the last session
1692 On startup, load the same files you had open the last time you
1695 Load virtual terminal support
1696 Load the library for running a terminal in the message window area.
1698 Enable plugin support
1699 Allow plugins to be used in Geany.
1703 Save window position and geometry
1704 Save the current position and size of the main window so next time
1705 you open Geany it's in the same location.
1708 Have a dialog pop up to confirm that you really want to quit Geany.
1714 Path to start in when opening or saving files.
1715 It must be an absolute path.
1716 Leave it blank to use the current working directory.
1719 Path to start in when opening project files.
1722 By default Geany looks in the global installation path and in the
1723 configuration directory. In addition the path entered here will be searched
1724 for plugins. Usually you do not need to set an additional path to search for
1725 plugins. It might be useful when Geany is installed on a multi-user machine
1726 and additional plugins are available in a common location for all users.
1727 Leave blank to not set an additional lookup path.
1730 General Miscellaneous preferences
1731 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1733 .. image:: ./images/pref_dialog_gen_misc.png
1738 Beep on errors when compilation has finished
1739 Have the computer make a beeping sound when compilation of your program
1740 has completed or any errors occurred.
1742 Switch status message list at new message
1743 Switch to the status message tab (in the notebook window at the bottom)
1744 once a new status message arrives.
1746 Suppress status messages in the status bar
1747 Remove all messages from the status bar. The messages are still displayed
1748 in the status messages window.
1751 Another option is to use the *Switch to Editor* keybinding - it
1752 reshows the document statistics on the status bar. See `Focus
1755 Use Windows File Open/Save dialogs
1756 Defines whether to use the native Windows File Open/Save dialogs or
1757 whether to use the GTK default dialogs.
1759 Auto-focus widgets (focus follows mouse)
1760 Give the focus automatically to widgets below the mouse cursor.
1761 This works for the main editor widget, the scribble, the toolbar search field
1762 goto line fields and the VTE.
1767 Always wrap search and hide the Find dialog
1768 Always wrap search around the document and hide the Find dialog after clicking
1771 Use the current word under the cursor for Find dialogs
1772 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1773 there is no selection. When this option is disabled, the search term last used in the
1774 appropriate Find dialog is used.
1776 Use the current file's directory for Find in Files
1777 When opening the Find in Files dialog, set the directory to search to the directory of the current
1778 active file. When this option is disabled, the directory of the last use of the Find in Files
1784 Use project-based session files
1785 Save your current session when closing projects. You will be able to
1786 resume different project sessions, automatically opening the files
1787 you had open previously.
1789 Store project file inside the project base directory
1790 When creating new projects, the default path for the project file contains
1791 the project base path. Without this option enabled, the default project file
1792 path is one level above the project base path.
1793 In either case, you can easily set the final project file path in the
1794 *New Project* dialog. This option provides the more common
1795 defaults automatically for convenience.
1798 Interface preferences
1799 ^^^^^^^^^^^^^^^^^^^^^
1801 .. image:: ./images/pref_dialog_interface.png
1807 Whether to show the sidebar at all.
1810 Show the list of functions, variables, and other information in the
1811 current document you are editing.
1814 Show all the documents you have open currently. This can be used to
1815 change between documents (see `Switching between documents`_) and
1816 to perform some common operations such as saving, closing and reloading.
1819 Whether to place the sidebar on the left or right of the editor window.
1825 Change the font used to display documents.
1828 Change the font used for the Symbols sidebar tab.
1831 Change the font used for the message window area.
1837 Show a notebook tab for all documents so you can switch between them
1838 using the mouse (instead of using the Documents window).
1841 Make each tab show a close button so you can easily close open
1844 Placement of new file tabs
1845 Whether to create a document with its notebook tab to the left or
1846 right of all existing tabs.
1849 Whether to place file tabs next to the current tab
1850 rather than at the edges of the notebook.
1852 Double-clicking hides all additional widgets
1853 Whether to call the View->Toggle All Additional Widgets command
1854 when double-clicking on a notebook tab.
1860 Set the positioning of the editor's notebook tabs to the right,
1861 left, top, or bottom of the editing window.
1864 Set the positioning of the sidebar's notebook tabs to the right,
1865 left, top, or bottom of the sidebar window.
1868 Set the positioning of the message window's notebook tabs to the
1869 right, left, top, or bottom of the message window.
1875 Show the status bar at the bottom of the main window. It gives information about
1876 the file you are editing like the line and column you are on, whether any
1877 modifications were done, the file encoding, the filetype and other information.
1883 Affects the main toolbar underneath the menu bar.
1885 .. image:: ./images/pref_dialog_toolbar.png
1891 Whether to show the toolbar.
1893 Append Toolbar to the Menu
1894 Allows to append the toolbar to the main menu bar instead of placing it below.
1895 This is useful to save vertical space.
1898 See `Customizing the toolbar`_.
1904 Select the toolbar icon style to use - either icons and text, just
1906 The choice System default uses whatever icon style is set by GTK.
1909 Select the size of the icons you see (large, small or very small).
1910 The choice System default uses whatever icon size is set by GTK.
1913 Editor Features preferences
1914 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1916 .. image:: ./images/pref_dialog_edit_features.png
1922 Show long lines wrapped around to new display lines.
1925 Whether to move the cursor to the first non-whitespace character
1926 on the line when you hit the home key on your keyboard. Pressing it
1927 again will go to the very start of the line.
1929 Disable Drag and Drop
1930 Do not allow the dragging and dropping of selected text in documents.
1933 Allow groups of lines in a document to be collapsed for easier
1936 Fold/Unfold all children of a fold point
1937 Whether to fold/unfold all child fold points when a parent line
1940 Use indicators to show compile errors
1941 Underline lines with compile errors using red squiggles to indicate
1942 them in the editor area.
1944 Newline strip trailing spaces
1945 Remove any white space at the end of the line when you hit the
1948 Line breaking column
1949 The editor column number to insert a newline at when Line Breaking
1950 is enabled for the current document.
1952 Comment toggle marker
1953 A string which is added when toggling a line comment in a source file.
1954 It is used to mark the comment as toggled.
1957 Editor Indentation preferences
1958 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1960 .. image:: ./images/pref_dialog_edit_indentation.png
1965 See `Indentation`_ for more information.
1968 When Geany inserts indentation, whether to use:
1972 * Tabs and Spaces, depending on how much indentation is on a line
1974 The *Tabs and Spaces* indent type is also known as *Soft tab
1975 support* in some other editors.
1978 The width of a single indent size in spaces. By default the indent
1979 size is equivalent to 4 spaces.
1982 Try to detect and set the indent type based on file content, when
1986 The type of auto-indentation you wish to use after pressing Enter,
1990 Just add the indentation of the previous line.
1992 Add indentation based on the current filetype and any characters at
1993 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
1995 Like *Current chars* but for C-like languages, make a closing
1996 ``}`` brace line up with the matching opening brace.
1999 If set, pressing tab will indent the current line or selection, and
2000 unindent when pressing Shift-tab. Otherwise, the tab key will
2001 insert a tab character into the document (which can be different
2002 from indentation, depending on the indent type).
2005 There are also separate configurable keybindings for indent &
2006 unindent, but this preference allows the tab key to have different
2007 meanings in different contexts - e.g. for snippet completion.
2009 Editor Completions preferences
2010 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2012 .. image:: ./images/pref_dialog_edit_completions.png
2018 Whether to replace special keywords after typing Tab into a
2019 pre-defined text snippet.
2020 See `User-definable snippets`_.
2022 XML/HTML tag auto-closing
2023 When you open an XML/HTML tag automatically generate its
2026 Automatic continuation multi-line comments
2027 Continue automatically multi-line comments in languages like C, C++
2028 and Java when a new line is entered inside such a comment.
2029 With this option enabled, Geany will insert a ``*`` on every new line
2030 inside a multi-line comment, for example when you press return in the
2034 * This is a C multi-line comment, press <Return>
2036 then Geany would insert::
2040 on the next line with the correct indentation based on the previous line,
2041 as long as the multi-line is not closed by ``*/``.
2043 Autocomplete symbols
2044 When you start to type a symbol name, look for the full string to
2045 allow it to be completed for you.
2047 Autocomplete all words in document
2048 When you start to type a word, Geany will search the whole document for
2049 words starting with the typed part to complete it, assuming there
2050 are no tag names to show.
2052 Drop rest of word on completion
2053 Remove any word part to the right of the cursor when choosing a
2054 completion list item.
2056 Characters to type for autocompletion
2057 Number of characters of a word to type before autocompletion is
2060 Completion list height
2061 The number of rows to display for the autocompletion window.
2063 Max. symbol name suggestions
2064 The maximum number of items in the autocompletion list.
2067 Auto-close quotes and brackets
2068 ``````````````````````````````
2070 Geany can automatically insert a closing bracket and quote characters when
2071 you open them. For instance, you type a ``(`` and Geany will automatically
2072 insert ``)``. With the following options, you can define for which
2073 characters this should work.
2076 Auto-close parenthesis when typing an opening one
2079 Auto-close curly brackets (braces) when typing an opening one
2082 Auto-close square brackets when typing an opening one
2085 Auto-close single quotes when typing an opening one
2088 Auto-close double quotes when typing an opening one
2091 Editor Display preferences
2092 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2094 This is for visual elements displayed in the editor window.
2096 .. image:: ./images/pref_dialog_edit_display.png
2101 Invert syntax highlighting colors
2102 Invert all colors, by default this makes white text on a black
2105 Show indendation guides
2106 Show vertical lines to help show how much leading indentation there
2110 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2111 show which kinds of whitespace are used.
2114 Display a symbol everywhere that a carriage return or line feed
2118 Show or hide the Line Number margin.
2121 Show or hide the small margin right of the line numbers, which is used
2124 Stop scrolling at last line
2125 When enabled Geany stops scrolling when at the last line of the document.
2126 Otherwise you can scroll one more page even if there are no real lines.
2132 The long line marker helps to indicate overly-long lines, or as a hint
2133 to the user for when to break the line.
2137 Show a thin vertical line in the editor window at the given column
2140 Change the background color of characters after the given column
2141 position to the color set below. (This is recommended over the
2142 *Line* setting if you use proportional fonts).
2144 Don't mark long lines at all.
2147 Set this value to a value greater than zero to specify the column
2148 where it should appear.
2150 Long line marker color
2151 Set the color of the long line marker.
2157 Virtual space is space beyond the end of each line.
2158 The cursor may be moved into virtual space but no real space will be
2159 added to the document until there is some text typed or some other
2160 text insertion command is used.
2163 Do not show virtual spaces
2165 Only for rectangular selections
2166 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2169 Always show virtual spaces beyond the end of lines
2175 .. image:: ./images/pref_dialog_files.png
2180 Open new documents from the command-line
2181 Whether to create new documents when passing filenames that don't
2182 exist from the command-line.
2184 Default encoding (new files)
2185 The type of file encoding you wish to use when creating files.
2187 Used fixed encoding when opening files
2188 Assume all files you are opening are using the type of encoding specified below.
2190 Default encoding (existing files)
2191 Opens all files with the specified encoding instead of auto-detecting it.
2192 Use this option when it's not possible for Geany to detect the exact encoding.
2194 Default end of line characters
2195 The end of line characters to which should be used for new files.
2196 On Windows systems, you generally want to use CR/LF which are the common
2197 characters to mark line breaks.
2198 On Unix-like systems, LF is default and CR is used on MAC systems.
2202 Perform formatting operations when a document is saved. These
2203 can each be undone with the Undo command.
2205 Ensure newline at file end
2206 Add a newline at the end of the document if one is missing.
2208 Ensure consistent line endings
2209 Ensures that newline characters always get converted before
2210 saving, avoiding mixed line endings in the same file.
2212 Strip trailing spaces
2213 Remove the trailing spaces on each line of the document.
2215 Replace tabs by space
2216 Replace all tabs in the document with the equivalent number of spaces.
2219 It is better to use spaces to indent than use this preference - see
2225 Recent files list length
2226 The number of files to remember in the recently used files list.
2229 The number of seconds to periodically check the current document's
2230 file on disk in case it has changed. Setting it to 0 will disable
2234 These checks are only performed on local files. Remote files are
2235 not checked for changes due to performance issues
2236 (remote files are files in ``~/.gvfs/``).
2242 .. image:: ./images/pref_dialog_tools.png
2248 The location of your terminal executable.
2251 The location of your web browser executable.
2254 The location of the grep executable.
2257 For Windows users: at the time of writing it is recommended to use
2258 the grep.exe from the UnxUtils project
2259 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2260 Mingw project for instance might not work with Geany at the moment.
2266 Set this to a command to execute on the current word.
2267 You can use the "%s" wildcard to pass the current word below the cursor
2268 to the specified command.
2271 Template preferences
2272 ^^^^^^^^^^^^^^^^^^^^
2274 This data is used as meta data for various template text to insert into
2275 a document, such as the file header. You only need to set fields that
2276 you want to use in your template files.
2279 For changes made here to take effect, you must either select
2280 *Tools->Reload Configuration* or restart Geany.
2282 .. image:: ./images/pref_dialog_templ.png
2288 The name of the developer who will be creating files.
2291 The initials of the developer.
2294 The email address of the developer.
2297 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2300 The company the developer is working for.
2303 The initial version of files you will be creating.
2306 Specify a format for the the {year} wildcard. You can use any conversion specifiers
2307 which can be used with the ANSI C strftime function. For details please see
2308 http://man.cx/strftime.
2311 Specify a format for the the {date} wildcard. You can use any conversion specifiers
2312 which can be used with the ANSI C strftime function. For details please see
2313 http://man.cx/strftime.
2316 Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
2317 which can be used with the ANSI C strftime function. For details please see
2318 http://man.cx/strftime.
2321 Keybinding preferences
2322 ^^^^^^^^^^^^^^^^^^^^^^
2324 .. image:: ./images/pref_dialog_keys.png
2326 There are some commands listed in the keybinding dialog that are not, by default,
2327 bound to a key combination, and may not be available as a menu item.
2330 For more information see the section `Keybindings`_.
2333 Printing preferences
2334 ^^^^^^^^^^^^^^^^^^^^
2336 .. image:: ./images/pref_dialog_printing.png
2338 Use external command for printing
2339 Use a system command to print your file out.
2341 Use native GTK printing
2342 Let the GTK GUI toolkit handle your print request.
2345 Print the line numbers on the left of your paper.
2348 Print the page number on the bottom right of your paper.
2351 Print a header on every page that is sent to the printer.
2353 Use base name of the printed file
2354 Don't use the entire path for the header, only the filename.
2357 How the date should be printed. You can use the same format
2358 specifiers as in the ANSI C function strftime(). For details please
2359 see http://man.cx/strftime.
2362 Terminal (VTE) preferences
2363 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2365 See also: `Virtual terminal emulator widget (VTE)`_.
2367 .. image:: ./images/pref_dialog_vte.png
2373 Select the font that will be used in the terminal emulation control.
2376 Select the font color.
2379 Select the background color of the terminal.
2382 The number of lines buffered so that you can scroll though the history.
2385 The location of the shell on your system.
2388 Scroll the terminal to the prompt line when pressing a key.
2391 Scroll the output down.
2394 Let the terminal cursor blink.
2396 Override Geany keybindings
2397 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2399 Disable menu shortcut key (F10 by default)
2400 Disable the menu shortcut when you are in the virtual terminal.
2402 Follow path of the current file
2403 Make the path of the terminal change according to the path of the
2406 Execute programs in VTE
2407 Execute programs in the virtual terminal instead of using the external
2408 terminal tool. Note that if you run multiple execute commands at once
2409 the output may become mixed together in the VTE.
2411 Don't use run script
2412 Don't use the simple run script which is usually used to display
2413 the exit status of the executed program.
2414 This can be useful if you already have a program running in the VTE
2415 like a Python console (e.g. ipython). Use this with care.
2421 Project Management is optional in Geany. Currently it can be used for:
2423 * Storing and opening session files on a project basis.
2424 * Overriding default settings with project equivalents.
2425 * Configuring the Build menu on a project basis.
2427 A list of session files can be stored and opened with the project
2428 when the *Use project-based session files* preference is enabled,
2429 in the *Project* group of the `Preferences`_ dialog.
2431 As long as a project is open, the Build menu will use
2432 the items defined in project's settings, instead of the defaults.
2433 See `Build Menu Configuration`_ for information on configuring the menu.
2435 The current project's settings are saved when it is closed, or when
2436 Geany is shutdown. When restarting Geany, the previously opened project
2437 file that was in use at the end of the last session will be reopened.
2439 The project menu items are detailed below.
2445 To create a new project, fill in the *Name* field. By default this
2446 will setup a new project file ``~/projects/name.geany``. Usually it's
2447 best to store all your project files in the same directory (they are
2448 independent of any source directory trees).
2450 The Base path text field is setup to use ``~/projects/name``. This
2451 can safely be set to any existing path -- it will not touch the file
2452 structure contained in it.
2458 You can set an optional description for the project. Currently it's
2459 only used for a template wildcard - see `Template wildcards`_.
2461 The *Base path* field is used as the directory to run the Build menu commands.
2462 The specified path can be an absolute path or it is considered to be
2463 relative to the project's file name.
2465 The *Indentation* tab allows you to override the default
2466 `Indentation`_ settings.
2472 The Open command displays a standard file chooser, starting in
2473 ``~/projects``. Choose a project file named with the ``.geany``
2476 When project session support is enabled, Geany will close the currently
2477 open files and open the session files associated with the project.
2483 Project file settings are saved when the project is closed.
2485 When project session support is enabled, Geany will close the project
2486 session files and open any previously closed default session files.
2491 After editing code with Geany, the next step is to compile, link, build,
2492 interpret, run etc. As Geany supports many languages each with a different
2493 approach to such operations, and as there are also many language independent
2494 software building systems, Geany does not have a built-in build system, nor
2495 does it limit which system you can use. Instead the build menu provides
2496 a configurable and flexible means of running any external commands to
2497 execute your preferred build system.
2499 This section provides a description of the default configuration of the
2500 build menu and then covers how to configure it, and where the defaults fit in.
2502 Running the commands from within Geany has two benefits:
2504 * The current file is automatically saved before the command is run.
2505 * The output is captured in the Compiler notebook tab and parsed for
2508 Warnings and errors that can be parsed for line numbers will be shown in
2509 red in the Compiler tab and you can click on them to switch to the relevant
2510 source file (or open it) and mark the line number. Also lines with
2511 warnings or errors are marked in the source, see `Indicators`_ below.
2514 If Geany's default error message parsing does not parse errors for
2515 the tool you're using, you can set a custom regex in the Build Commands
2516 Dialog, see `Build Menu Configuration`_.
2521 Indicators are red squiggly underlines which are used to highlight
2522 errors which occurred while compiling the current file. So you can
2523 easily see where your code failed to compile. You can remove them by
2524 selecting *Remove Error Indicators* in the Document menu.
2526 If you do not like this feature, you can disable it - see `Editor Features
2530 Default Build Menu Items
2531 ^^^^^^^^^^^^^^^^^^^^^^^^
2532 Depending on the current file's filetype, the default Build menu will contain
2533 the following items:
2538 * Make Custom Target
2543 * Set Build Menu Commands
2549 The Compile command has different uses for different kinds of files.
2551 For compilable languages such as C and C++, the Compile command is
2552 set up to compile the current source file into a binary object file.
2554 Java source files will be compiled to class file bytecode.
2556 Interpreted languages such as Perl, Python, Ruby will compile to
2557 bytecode if the language supports it, or will run a syntax check,
2558 or if that is not available will run the file in its language interpreter.
2563 For compilable languages such as C and C++, the Build command will link
2564 the current source file's equivalent object file into an executable. If
2565 the object file does not exist, the source will be compiled and linked
2566 in one step, producing just the executable binary.
2568 Interpreted languages do not use the Build command.
2571 If you need complex settings for your build system, or several
2572 different settings, then writing a Makefile and using the Make
2573 commands is recommended; this will also make it easier for users to
2574 build your software.
2580 This runs "make" in the same directory as the
2586 This is similar to running 'Make' but you will be prompted for
2587 the make target name to be passed to the Make tool. For example,
2588 typing 'clean' in the dialog prompt will run "make clean".
2594 Make object will run "make current_file.o" in the same directory as
2595 the current file, using the filename for 'current_file'. It is useful
2596 for building just the current file without building the whole project.
2601 The next error item will move to the next detected error in the file.
2605 The previous error item will move to the previous detected error in the file.
2610 Execute will run the corresponding executable file, shell script or
2611 interpreted script in a terminal window. Note that the Terminal tool
2612 path must be correctly set in the Tools tab of the Preferences dialog -
2613 you can use any terminal program that runs a Bourne compatible shell
2614 and accept the "-e" command line argument to start a command or can be
2615 selected to use the built-in VTE if it is available - see
2616 `Virtual terminal emulator widget (VTE)`_.
2618 After your program or script has finished executing, you will be
2619 prompted to press the return key. This allows you to review any text
2620 output from the program before the terminal window is closed.
2623 The execute command output is not parsed for errors.
2626 Stopping running processes
2627 ``````````````````````````
2629 When there is a running program, the Execute menu item in the menu and
2630 the Run button in the toolbar
2631 each become a stop button so you can stop the current running program (and
2632 any child processes). This works by sending the SIGQUIT signal to the process.
2634 Depending on the process you started it is possible that the process
2635 cannot be stopped. For example this can happen when the process creates
2636 more than one child process.
2642 Xterm is known to work properly. If you are using "Terminal"
2643 (the terminal program of Xfce), you should add the command line
2644 option ``--disable-server`` otherwise the started process cannot be
2645 stopped. Just add this option in the preferences dialog on the Tools
2646 tab in the terminal field.
2652 By default Compile, Build and Execute are fairly basic commands. You
2653 may wish to customise them using *Set Build Commands*.
2655 E.g. for C you can add any include paths and compile flags for the
2656 compiler, any library names and paths for the linker, and any
2657 arguments you want to use when running Execute.
2659 Build Menu Configuration
2660 ^^^^^^^^^^^^^^^^^^^^^^^^
2662 The build menu has considerable flexibility and configurability, allowing
2663 both menu labels the commands they execute and the directory they execute
2664 in to be configured.
2666 For example, if you change one of the default make commands to run say 'waf'
2667 you can also change the label to match.
2669 These settings are saved automatically when Geany is shut down.
2671 The build menu is divided into four groups of items each with different
2674 * Filetype build commands - are configurable and depend on the filetype of the
2675 current document; they capture output in the compiler tab and parse it for
2677 * Independent build commands - are configurable and mostly don't depend on the
2678 filetype of the current document; they also capture output in the
2679 compiler tab and parse it for errors.
2680 * Execute commands - are configurable and intended for executing your
2681 program or other long running programs. The output is not parsed for errors
2682 and is directed to the terminal selected in preferences.
2683 * Fixed commands - these perform built-in actions:
2685 * Go to the next error.
2686 * Go to the previous error.
2687 * Show the build menu commands dialog.
2689 The maximum numbers of items in each of the configurable groups can be
2690 configured when Geany starts using hidden settings (see `Preferences File Format`_).
2691 Even though the maximum number of items may have been increased, only
2692 those menu items that have values configured are shown in the menu.
2694 The groups of menu items obtain their configuration from four potential
2695 sources. The highest priority source that has the menu item defined will
2696 be used. The sources in decreasing priority are:
2698 * A project file if open
2699 * The user preferences
2700 * The system filetype definitions
2703 The detailed relationships between sources and the configurable menu item groups
2704 is shown in the following table.
2706 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2707 | Group | Project File | Preferences | System Filetype | Defaults |
2708 +==============+=====================+==========================+===================+===============================+
2709 | Filetype | Loads From: project | Loads From: | Loads From: | None |
2710 | | file | filetype.xxx file in | filetype.xxx in | |
2711 | | | ~/.config/geany/filedefs | Geany install | |
2712 | | Saves To: project | | | |
2713 | | file | Saves to: as above, | Saves to: as user | |
2714 | | | creating if needed. | preferences left. | |
2715 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2716 | Filetype | Loads From: project | Loads From: | Loads From: | 1: |
2717 | Independent | file | geany.conf file in | filetype.xxx in | Label: _Make |
2718 | | | ~/.config/geany | Geany install | Command: make |
2719 | | Saves To: project | | | |
2720 | | file | Saves to: as above, | Saves to: as user | 2: |
2721 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
2722 | | | | | Command: make |
2725 | | | | | Label: Make _Object |
2726 | | | | | Command: make %e.o |
2727 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2728 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
2729 | | file or else | geany.conf file in | filetype.xxx in | Command: ./%e |
2730 | | filetype defined in | ~/.config/geany or else | Geany install | |
2731 | | project file | filetype.xxx file in | | |
2732 | | | ~/.config/geany/filedefs | Saves To: as user | |
2733 | | Saves To: | | preferences left. | |
2734 | | project file | Saves To: | | |
2735 | | | filetype.xxx file in | | |
2736 | | | ~/.config/geany/filedefs | | |
2737 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2739 The following notes on the table reference cells by coordinate as (group,source):
2741 * General - for filetype.xxx substitute the filetype name of the
2742 current document for xxx.
2744 * System Filetypes - Labels loaded from these sources are locale sensitive
2745 and can contain translations.
2747 * (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
2748 filetype file so that users can configure all other filetype preferences
2749 as well. Projects can only configure menu items per filetype. Saving
2750 in the project file means that there is only one file per project not
2753 * (Filetype-Independent, System Filetype) - although conceptually strange, defining
2754 filetype-independent commands in a filetype file, this provides the ability to
2755 define filetype dependent default menu items.
2757 * (Execute, Project File) and (Execute, Preferences) - the project independent
2758 execute and preferences independent execute commands can only be set by hand
2759 editing the appropriate file, see `Preferences File Format`_ and `Project File
2762 Build Menu Commands Dialog
2763 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2765 Most of the configuration of the build menu is done through the Build Menu
2766 Commands Dialog. You edit the configuration sourced from preferences in the
2767 dialog opened from the Build->Build Menu Commands item and you edit the
2768 configuration from the project in the build tab of the project preferences
2769 dialog. Both use the same form shown below.
2771 .. image:: ./images/build_menu_commands_dialog.png
2773 The dialog is divided into three sections:
2775 * Filetype build commands (selected based on the current document's filetype).
2776 * Independent build commands (available regardless of filetype).
2777 * Filetype execute commands.
2779 The filetype and independent sections also each contain a field for the regular
2780 expression used for parsing command output for error and warning messages.
2782 The columns in the first three sections allow setting of the label, command,
2783 and working directory to run the command in.
2785 An item with an empty label will not be shown in the menu.
2787 An empty working directory will default to the directory of the current document.
2788 If there is no current document then the command will not run.
2790 The dialog will always show the command selected by priority, not just the
2791 commands configured in this configuration source. This ensures that you always
2792 see what the menu item is going to do if activated.
2794 If the current source of the menu item is higher priority than the
2795 configuration source you are editing then the command will be shown
2796 in the dialog but will be insensitive (greyed out). This can't happen
2797 with the project source but can with the preferences source dialog.
2799 The clear buttons remove the definition from the configuration source you are editing.
2800 When you do this the command from the next lower priority source will be shown.
2801 To hide lower priority menu items without having anything show in the menu
2802 configure with a nothing in the label but at least one character in the command.
2804 Substitutions in Commands and Working Directories
2805 `````````````````````````````````````````````````
2807 The first occurence of each of the following character sequences in each of the
2808 command and working directory fields is substituted by the items specified below
2809 before the command is run.
2811 * %d - substituted by the absolute path to the directory of the current file.
2812 * %e - substituted by the name of the current file without the extension or path.
2813 * %f - substituted by the name of the current file without the path.
2814 * %p - if a project is open, substituted by the base path from the project.
2817 If the basepath set in the project preferences is not an absolute path , then it is
2818 taken as relative to the directory of the project file. This allows a project file
2819 stored in the source tree to specify all commands and working directories relative
2820 to the tree itself, so that the whole tree including the project file, can be moved
2821 and even checked into and out of version control without having to re-configure the
2824 Build Menu Keyboard Shortcuts
2825 `````````````````````````````
2827 Keyboard shortcuts can be defined for the first two filetype menu items, the first three
2828 independent menu items, the first two execute menu items and the fixed menu items.
2829 In the keybindings configuration dialog (see `Keybinding preferences`_)
2830 these items are identified by the default labels shown in the `Build Menu`_ section above.
2832 It is currently not possible to bind keyboard shortcuts to more than these menu items.
2834 You can also use underlines in the labels to set mnemonic characters.
2839 The configurable Build Menu capability was introduced in Geany 0.19 and
2840 required a new section to be added to the configuration files (See
2841 `Preferences File Format`_). Geany will still load older format project,
2842 preferences and filetype file settings and will attempt to map them into the new
2843 configuration format. There is not a simple clean mapping between the formats.
2844 The mapping used produces the most sensible results for the majority of cases.
2845 However, if they do not map the way you want, you may have to manually
2846 configure some settings using the Build Commands
2847 Dialog or the Build tab of the project preferences dialog.
2849 Any setting configured in either of these dialogs will override settings mapped from
2850 older format configuration files.
2855 Since Geany 0.13 there has been printing support using GTK's printing API.
2856 The printed page(s) will look nearly the same as on your screen in Geany.
2857 Additionally, there are some options to modify the printed page(s).
2860 The background text color is set to white, except for text with
2861 a white foreground. This allows dark color schemes to save ink
2864 You can define whether to print line numbers, page numbers at the bottom of
2865 each page and whether to print a page header on each page. This header
2866 contains the filename of the printed document, the current page number and
2867 the date and time of printing. By default, the file name of the document
2868 with full path information is added to the header. If you prefer to add
2869 only the basename of the file(without any path information) you can set it
2870 in the preferences dialog. You can also adjust the format of the date and
2871 time added to the page header. The available conversion specifiers are the
2872 same as the ones which can be used with the ANSI C strftime function.
2874 All of these settings can also be changed in the print dialog just before
2875 actual printing is done.
2876 On Unix-like systems the provided print dialog offers a print preview. The
2877 preview file is opened with a PDF viewer and by default GTK uses ``evince``
2878 for print preview. If you have not installed evince or just want to use
2879 another PDF viewer, you can change the program to use in the file
2880 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
2883 gtk-print-preview-command = "epdfview %f"
2885 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
2886 as the print preview command.
2888 Unfortunately, native GTK printing support is only available if Geany was
2889 built against GTK 2.10 (or above) **and** is running with GTK 2.10 (or above).
2890 If not, Geany provides basic printing support. This means you can print a
2891 file by passing the filename of the current file to a command which
2892 actually prints the file. However, the printed document contains no syntax
2893 highlighting. You can adjust the command to which the filename is
2894 passed in the preferences dialog. The default command is::
2898 ``%f`` will be substituted by the filename of the current file. Geany
2899 will not show errors from the command itself, so you should make
2900 sure that it works before(e.g. by trying to execute it from the
2903 A nicer example, which many prefer is::
2905 % a2ps -1 --medium=A4 -o - %f | xfprint4
2907 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
2908 gtklp or similar programs can be used.
2915 Plugins are loaded at startup, if the *Enable plugin support*
2916 general preference is set. There is also a command-line option,
2917 ``-p``, which prevents plugins being loaded. Plugins are scanned in
2918 the following directories:
2920 * ``$prefix/lib/geany`` (see `Installation prefix`_)
2921 * ``~/.config/geany/plugins``
2923 Most plugins add menu items to the *Tools* menu when they are loaded.
2925 Since Geany 0.13, there is a Plugin Manager to let you choose which plugins
2926 should be loaded at startup. You can also load and unload plugins on the
2927 fly using this dialog. Once you click the checkbox for a specific plugin
2928 in the dialog, it is loaded or unloaded according to its previous state.
2929 By default, no plugins are loaded at startup until you select some.
2930 You can also configure some plugin specific options when the plugin
2933 See also `Plugin documentation`_ for information about single plugins
2934 which are included in Geany.
2940 Geany supports the default keyboard shortcuts for the Scintilla
2941 editing widget. For a list of these commands, see `Scintilla
2942 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
2943 by any custom keybindings with the same keyboard shortcut.
2949 There are a few non-configurable bindings to switch between documents,
2950 listed below. These can also be overridden by custom keybindings.
2952 =============== ==================================
2954 =============== ==================================
2955 Alt-[1-9] Select left-most tab, from 1 to 9.
2956 Alt-0 Select right-most tab.
2957 Ctrl-Shift-PgUp Select left-most tab.
2958 Ctrl-Shift-PgDn Select right-most tab.
2959 =============== ==================================
2962 Configurable keybindings
2963 ^^^^^^^^^^^^^^^^^^^^^^^^
2965 For all actions listed below you can define your own keybindings. Open
2966 the Preferences dialog, select the desired action and click on
2967 change. In the resulting dialog you can press the key combination you
2968 want to assign to the action and it will be saved when you press OK.
2969 You can define only one key combination for each action and each key
2970 combination can only be defined for one action.
2972 Some of the default key combinations are common across many
2973 applications, for example *Ctrl-N* for New and *Ctrl-O* for Open.
2974 Because they are so common it is not advisable to change these, but
2975 you can add other key combinations for these actions. For example
2976 *Ctrl-O* is set to execute menu_open by default, but you can also
2977 define *Alt-O*, so that the file open dialog is shown by pressing
2978 either *Ctrl-O* or *Alt-O*.
2980 The following tables list all customizable keyboard shortcuts, those
2981 which are common to many applications are marked with (C) after the
2986 =============================== ========================= ==================================================
2987 Action Default shortcut Description
2988 =============================== ========================= ==================================================
2989 New Ctrl-N (C) Creates a new file.
2991 Open Ctrl-O (C) Opens a file.
2993 Open selected file Ctrl-Shift-O Opens the selected filename.
2995 Re-open last closed tab Re-opens the last closed document tab.
2997 Save Ctrl-S (C) Saves the current file.
2999 Save As Saves the current file under a new name.
3001 Save all Ctrl-Shift-S Saves all open files.
3003 Close all Ctrl-Shift-W Closes all open files.
3005 Close Ctrl-W (C) Closes the current file.
3007 Reload file Ctrl-R (C) Reloads the current file. All unsaved changes
3010 Print Ctrl-P (C) Prints the current file.
3011 =============================== ========================= ==================================================
3016 =============================== ========================= ==================================================
3017 Action Default shortcut Description
3018 =============================== ========================= ==================================================
3019 Undo Ctrl-Z (C) Un-does the last action.
3021 Redo Ctrl-Y Re-does the last action.
3023 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3026 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3027 end of the current line.
3029 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3031 Transpose current line Ctrl-T Transposes the current line with the previous one.
3033 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3034 view. The cursor position and or an existing
3035 selection will not be changed.
3037 Scroll up by one line Alt-Up Scrolls the view.
3039 Scroll down by one line Alt-Down Scrolls the view.
3041 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3042 tag completion, it shows document word completion
3043 instead, even if it is not enabled for automatic
3044 completion. Likewise if no tag suggestions are
3045 available, it shows document word completion.
3047 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3050 Show macro list Ctrl-Return Shows a list of available macros and variables in
3053 Complete snippet Tab If you type a construct like if or for and press
3054 this key, it will be completed with a matching
3057 Suppress snippet completion If you type a construct like if or for and press
3058 this key, it will not be completed, and a space or
3059 tab will be inserted, depending on what the
3060 construct completion keybinding is set to. For
3061 example, if you have set the construct completion
3062 keybinding to space, then setting this to
3063 Shift+space will prevent construct completion and
3066 Context Action Executes a command and passes the current word
3067 (near the cursor position) or selection as an
3068 argument. See the section called `Context
3071 Move cursor in snippet Jumps to the next defined cursor positions in a
3072 completed snippets if multiple cursor positions
3075 Word part completion Tab When the autocompletion list is visible, complete
3076 the currently selected item up to the next word
3079 Move line(s) up Move the current line or selected lines up by
3082 Move line(s) down Move the current line or selected lines down by
3084 =============================== ========================= ==================================================
3087 Clipboard keybindings
3088 `````````````````````
3089 =============================== ========================= ==================================================
3090 Action Default shortcut Description
3091 =============================== ========================= ==================================================
3092 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3094 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3096 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3098 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3099 selection) to the clipboard.
3101 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3102 selection) to the clipboard.
3103 =============================== ========================= ==================================================
3108 =============================== ========================= ==================================================
3109 Action Default shortcut Description
3110 =============================== ========================= ==================================================
3111 Select all Ctrl-A (C) Makes a selection of all text in the current
3114 Select current word Alt-Shift-W Selects the current word under the cursor.
3116 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3117 which is defined by two empty lines around it.
3119 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3120 partially selected lines).
3122 Select to previous word part (Extend) selection to previous word part boundary.
3124 Select to next word part (Extend) selection to next word part boundary.
3125 =============================== ========================= ==================================================
3130 =============================== ========================= ==================================================
3131 Action Default shortcut Description
3132 =============================== ========================= ==================================================
3133 Insert date Shift-Alt-D Inserts a customisable date.
3135 Insert alternative whitespace Inserts a tab character when spaces should
3136 be used for indentation and inserts space
3137 characters of the amount of a tab width when
3138 tabs should be used for indentation.
3140 Insert New Line Before Current Inserts a new line with indentation.
3142 Insert New Line After Current Inserts a new line with indentation.
3143 =============================== ========================= ==================================================
3148 =============================== ========================= ==================================================
3149 Action Default shortcut Description
3150 =============================== ========================= ==================================================
3151 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3152 selection will be changed into uppercase and vice
3153 versa. If the selection contains lower- and
3154 uppercase characters, all will be converted to
3157 Comment line Comments current line or selection.
3159 Uncomment line Uncomments current line or selection.
3161 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3162 a comment if the line is commented.
3164 Increase indent Ctrl-I Indents the current line or selection by one tab
3165 or by spaces in the amount of the tab width
3168 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3169 the tab width setting from the indentation of the
3170 current line or selection.
3172 Increase indent by one space Indents the current line or selection by one
3175 Decrease indent by one space Deindents the current line or selection by one
3178 Smart line indent Indents the current line or all selected lines
3179 with the same indentation as the previous line.
3181 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3182 external command (available for the first
3183 three configured commands, see
3184 `Sending text through custom commands`_ for
3187 Send Selection to Terminal Sends the current selection or the current
3188 line (if there is no selection) to the
3189 embedded Terminal (VTE).
3191 Reflow lines/block Reformat selected lines or current
3192 (indented) text block,
3193 breaking lines at the long line marker or the
3194 line breaking column if line breaking is
3195 enabled for the current document.
3196 =============================== ========================= ==================================================
3199 Settings keybindings
3200 ````````````````````
3201 =============================== ========================= ==================================================
3202 Action Default shortcut Description
3203 =============================== ========================= ==================================================
3204 Preferences Ctrl-Alt-P Opens preferences dialog.
3206 Plugin Preferences Opens plugin preferences dialog.
3207 =============================== ========================= ==================================================
3212 =============================== ========================= ==================================================
3213 Action Default shortcut Description
3214 =============================== ========================= ==================================================
3215 Find Ctrl-F (C) Opens the Find dialog.
3217 Find Next Ctrl-G Finds next result.
3219 Find Previous Ctrl-Shift-G Finds previous result.
3221 Find Next Selection Finds next occurence of selected text.
3223 Find Previous Selection Finds previous occurence of selected text.
3225 Replace Ctrl-H (C) Opens the Replace dialog.
3227 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3229 Next message Jumps to the line with the next message in
3230 the Messages window.
3232 Previous message Jumps to the line with the previous message
3233 in the Messages window.
3235 Find Usage Finds all occurrences of the current word (near
3236 the keyboard cursor) or selection in all open
3237 documents and displays them in the messages
3240 Find Document Usage Finds all occurrences of the current word (near
3241 the keyboard cursor) or selection in the current
3242 document and displays them in the messages
3245 Mark All Ctrl-Shift-M Highlight all matches of the current
3246 word/selection in the current document
3247 with a colored box. If there's nothing to
3248 find, highlighted matches will be cleared.
3249 =============================== ========================= ==================================================
3254 =============================== ========================= ==================================================
3255 Action Default shortcut Description
3256 =============================== ========================= ==================================================
3257 Navigate forward a location Switches to the next location in the navigation
3258 history. See the section called `Code Navigation
3261 Navigate back a location Switches to the previous location in the
3262 navigation history. See the section called
3263 `Code navigation history`_.
3265 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3266 shows the Go to line dialog.
3268 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3269 is moved to the brace which belongs to the current
3270 one. If this keyboard shortcut is pressed again,
3271 the cursor is moved back to the first brace.
3273 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3274 marker if there already is one.
3276 Goto next marker Ctrl-. Goto the next marker in the current document.
3278 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3280 Go to tag definition Jump to the definition of the current word (near
3281 the keyboard cursor). If the definition cannot be
3282 found (e.g. the relevant file is not open) Geany
3283 will beep and do nothing. See the section called
3284 `Go to tag definition`_.
3286 Go to tag declaration Jump to the declaration of the current word (near
3287 the keyboard cursor). If the declaration cannot be
3288 found (e.g. the relevant file is not open) Geany
3289 will beep and do nothing. See the section called
3290 `Go to tag declaration`_.
3292 Go to Start of Line Home Move the caret to the end of the line indentation
3293 unless it is already there, in which case it moves
3294 it to the start of the line.
3296 Go to End of Line End Move the caret to the end of the line.
3298 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3299 This is useful when you use line wrapping and
3300 want to jump to the end of the wrapped, virtual
3301 line, not the real end of the whole line.
3302 If the line is not wrapped, it behaves like
3303 `Go to End of Line`, see above.
3305 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3307 Go to Next Word Part Ctrl-\ Goto the next part of the current word.
3308 =============================== ========================= ==================================================
3312 =============================== ========================= ==================================================
3313 Action Default shortcut Description
3314 =============================== ========================= ==================================================
3315 Fullscreen F11 (C) Switches to fullscreen mode.
3317 Toggle Messages Window Toggles the message window (status and compiler
3318 messages) on and off.
3320 Toggle Sidebar Shows or hides the sidebar.
3322 Toggle all additional widgets Hide and show all additional widgets like the
3323 notebook tabs, the toolbar, the messages window
3326 Zoom In Ctrl-+ (C) Zooms in the text.
3328 Zoom Out Ctrl-- (C) Zooms out the text.
3330 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3331 =============================== ========================= ==================================================
3335 ================================ ========================= ==================================================
3336 Action Default shortcut Description
3337 ================================ ========================= ==================================================
3338 Switch to Editor F2 Switches to editor widget.
3339 Also reshows the document statistics line
3340 (after a short timeout).
3342 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3345 Switch to Message Window Focus the Message Window's current tab.
3347 Switch to Compiler Focus the Compiler message window tab.
3349 Switch to Messages Focus the Messages message window tab.
3351 Switch to Scribble F6 Switches to scribble widget.
3353 Switch to VTE F4 Switches to VTE widget.
3355 Switch to Sidebar Focus the Sidebar.
3357 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3360 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3362 ================================ ========================= ==================================================
3365 Notebook tab keybindings
3366 ````````````````````````
3367 =============================== ========================= ==================================================
3368 Action Default shortcut Description
3369 =============================== ========================= ==================================================
3370 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3372 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3374 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3376 Holding Ctrl (or another modifier if the keybinding
3377 has been changed) will show a dialog, then repeated
3378 presses of the keybinding will switch to the 2nd-last
3379 used document, 3rd-last, etc. Also known as
3380 Most-Recently-Used documents switching.
3382 Move document left Alt-PageUp Changes the current document with the left hand
3385 Move document right Alt-PageDown Changes the current document with the right hand
3388 Move document first Moves the current document to the first position.
3390 Move document last Moves the current document to the last position.
3391 =============================== ========================= ==================================================
3394 Document keybindings
3395 ````````````````````
3396 =============================== ========================= ==================================================
3397 Action Default shortcut Description
3398 =============================== ========================= ==================================================
3399 Replace tabs by space Replaces all tabs with the right amount of spaces.
3401 Replace spaces by tabs Replaces all spaces with tab characters.
3403 Toggle current fold Toggles the folding state of the current code block.
3405 Fold all Folds all contractible code blocks.
3407 Unfold all Unfolds all contracted code blocks.
3409 Reload symbol list Ctrl-Shift-R Reloads the tag/symbol list.
3411 Toggle Line wrapping Enables or disables wrapping of long lines.
3413 Toggle Line breaking Enables or disables automatic breaking of long
3414 lines at a configurable column.
3416 Remove Markers Remove any markers on lines or words which
3417 were set by using 'Mark All' in the
3418 search dialog or by manually marking lines.
3420 Remove Error Indicators Remove any error indicators in the
3422 =============================== ========================= ==================================================
3427 =============================== ========================= ==================================================
3428 Action Default shortcut Description
3429 =============================== ========================= ==================================================
3430 Compile F8 Compiles the current file.
3432 Build F9 Builds (compiles if necessary and links) the
3435 Make all Shift-F9 Builds the current file with the Make tool.
3437 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3440 Make object Compiles the current file with the Make tool.
3442 Next error Jumps to the line with the next error from the
3445 Previous error Jumps to the line with the previous error from
3446 the last build process.
3448 Run F5 Executes the current file in a terminal emulation.
3450 Set Build Commands Opens the build commands dialog.
3451 =============================== ========================= ==================================================
3456 =============================== ========================= ==================================================
3457 Action Default shortcut Description
3458 =============================== ========================= ==================================================
3459 Show Color Chooser Opens the Color Chooser dialog.
3460 =============================== ========================= ==================================================
3465 =============================== ========================= ==================================================
3466 Action Default shortcut Description
3467 =============================== ========================= ==================================================
3468 Help F1 (C) Opens the manual.
3469 =============================== ========================= ==================================================
3477 You must use UTF-8 encoding *without BOM* for configuration files.
3482 There's a *Configuration files* submenu in the *Tools* menu that
3483 contains items for some of the available user configuration files.
3484 Clicking on one opens it in the editor for you to update. Geany will
3485 reload the file after you have saved it.
3488 Other configuration files not shown here will need to be opened
3489 manually, and will not be automatically reloaded when saved.
3490 (see *Reload Configuration* below).
3492 There's also a *Reload Configuration* item which can be used if you
3493 updated one of the other configuration files, or modified or added
3496 *Reload Configuration* is also necessary to update syntax highlighting colors.
3499 Syntax highlighting colors aren't updated in open documents after
3500 saving filetypes.common as this may take a significant
3504 Global configuration file
3505 -------------------------
3507 There is a global configuration file for Geany which will be used for
3508 any settings not defined in the users local configuration file.
3509 Settings present in the local configuration file override those in the global
3512 The global configuration file is read from
3513 ``$prefix/share/geany/geany.conf`` (where ``$prefix`` is the path where
3514 Geany is installed, see `Installation prefix`_) when starting Geany and
3515 an user configuration file does not exist. It can contain any settings
3516 which are found in the usual configuration file created by Geany but
3517 does not have to contain all settings.
3520 This feature is mainly intended for package maintainers or system
3521 admins who want to set up Geany in a multi user environment and
3522 set some sane default values for this environment. Usually users won't
3527 Filetype definition files
3528 -------------------------
3530 All color definitions and other filetype specific settings are
3531 stored in the filetype definition files. Those settings are colors
3532 for syntax highlighting, general settings like comment characters or
3533 word delimiter characters as well as compiler and linker settings.
3537 At startup Geany looks for ``filetypes.*.conf`` files in the system and
3538 user filetype paths, adding any filetypes found with the name matching
3539 the '``*``' wildcard.
3541 Custom filetypes are not as powerful as built-in filetypes, but the following
3542 have been implemented:
3544 * Recognizing and setting the filetype (after the user has manually edited
3545 ``filetype_extensions.conf``).
3546 * Filetype settings in the [settings] section (see `Filetype configuration`_).
3547 * Using existing tag parsing (``tag_parser`` key).
3548 * Using existing syntax highlighting (``lexer_filetype`` key).
3550 * Loading global tags files (namespace will be shared with tag_parser
3555 The system-wide configuration files can be found in
3556 ``$prefix/share/geany`` and are called ``filetypes.$ext``,
3557 where ``$prefix`` is the path where Geany is installed (see
3558 `Installation prefix`_) and $ext is the name of the filetype. For every
3559 filetype there is a corresponding definition file. There is one
3560 exception: ``filetypes.common`` -- this file is for general settings,
3561 which are not specific to a certain filetype.
3564 It is not recommended that users edit the system-wide files,
3565 because they will be overridden when Geany is updated.
3569 To change the settings, copy a file from ``$prefix/share/geany`` to
3570 the subdirectory filedefs in your configuration directory (usually
3571 ``~/.config/geany/``).
3575 % cp /usr/local/share/geany/filetypes.c /home/username/.config/geany/filedefs/
3577 Then you can edit the file and the changes are also
3578 available after an update of Geany because they reside in your
3579 configuration directory. Alternatively, you can create a file
3580 ``~/.config/geany/filedefs/filetypes.X`` and add only these settings you want
3581 to change. All missing settings will be read from the corresponding
3582 global definition file in ``$prefix/share/geany``.
3586 Filetype configuration
3587 ^^^^^^^^^^^^^^^^^^^^^^
3589 As well as the sections listed below, each filetype file can contain
3590 a [build-menu] section as described in `[build-menu] Section`_.
3595 In this section the colors for syntax highlighting are defined. The
3598 * ``key=foreground_color;background_color;bold_flag;italic_flag``
3600 Colors have to be specified as RGB hex values prefixed by
3601 0x. For example red is 0xff0000, blue is 0x0000ff. The values are
3602 case-insensitive, but it is a good idea to use small letters. Bold
3603 and italic are flags and should only be "true" or "false". If their
3604 value is something other than "true" or "false", "false" is assumed.
3606 You can omit fields to use the values from the style named ``"default"``.
3608 E.g. ``key=0xff0000;;true``
3610 This makes the key style have red foreground text, default background
3611 color text and bold emphasis.
3615 The second format uses a *named style* name to reference a style
3616 defined in filetypes.common.
3618 * ``key=named_style``
3619 * ``key2=named_style2,bold,italic``
3621 The bold and italic parts are optional, and if present are used to
3622 toggle the bold or italic flags to the opposite of the named style's
3623 flags. In contrast to style definition booleans, they are a literal
3624 ",bold,italic" and commas are used instead of semi-colons.
3626 E.g. ``key=comment,italic``
3628 This makes the key style match the ``"comment"`` named style, but with
3631 To define named styles, see the filetypes.common `[named_styles]
3638 This section contains keys for different keyword lists specific to
3639 the filetype. Some filetypes do not support keywords, so adding a
3640 new key will not work. You can only add or remove keywords to/from
3644 The keywords list must be in one line without line ending characters.
3647 [lexer_properties] Section
3648 ``````````````````````````
3649 Here any special properties for the Scintilla lexer can be set in the
3650 format ``key.name.field=some.value``.
3652 Properties Geany uses are listed in the system filetype files. To find
3653 other properties you need Geany's source code::
3655 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
3662 This is the default file extension used when saving files, not
3663 including the period character (``.``). The extension used should
3664 match one of the patterns associated with that filetype (see
3665 `Filetype extensions`_).
3667 *Example:* ``extension=cxx``
3670 These characters define word boundaries when making selections
3671 and searching using word matching options.
3673 *Example:* (look at system filetypes.\* files)
3676 This can be overridden by the *whitespace_chars*
3677 filetypes.common setting.
3680 A character or string which is used to comment code. If you want to
3681 use multiline comments, also set comment_close, otherwise leave it
3684 *Example:* ``comment_open=/*``
3687 If multiline comments are used, this is the character or string to
3690 *Example:* ``comment_close=*/``
3693 Set this to false if a comment character or string should start at
3694 column 0 of a line. If set to true it uses any indentation of the
3697 Note: Comment indentation
3699 ``comment_use_indent=true`` would generate this if a line is
3700 commented (e.g. with Ctrl-D)::
3704 ``comment_use_indent=false`` would generate this if a line is
3705 commented (e.g. with Ctrl-D)::
3707 # command_example();
3710 Note: This setting only works for single line comments (like '//',
3713 *Example:* ``comment_use_indent=true``
3716 A command which can be executed on the current word or the current
3719 Example usage: Open the API documentation for the
3720 current function call at the cursor position.
3723 be set for every filetype or if not set, a global command will
3724 be used. The command itself can be specified without the full
3725 path, then it is searched in $PATH. But for security reasons,
3726 it is recommended to specify the full path to the command. The
3727 wildcard %s will be replaced by the current word at the cursor
3728 position or by the current selection.
3730 Hint: for PHP files the following could be quite useful:
3731 context_action_cmd=firefox "http://www.php.net/%s"
3733 *Example:* ``context_action_cmd=devhelp -s "%s"``
3736 The TagManager language name, e.g. "C".
3739 A filetype name to setup syntax highlighting from another filetype.
3740 This must not be recursive, i.e. it should be a filetype name that
3741 doesn't use the lexer_filetype key itself.
3743 symbol_list_sort_mode
3744 What the default symbol list sort order should be.
3746 ===== =====================================
3748 ===== =====================================
3750 1 Sort tags by appearance (line number)
3751 ===== =====================================
3753 .. _xml_indent_tags:
3756 If this setting is set to *true*, a new line after a line ending with an
3757 unclosed XML/HTML tag will be automatically indented. This only applies
3758 to filetypes for which the HTML or XML lexer is used. Such filetypes have
3759 this setting in their system configuration files.
3762 [build_settings] Section
3763 ````````````````````````
3765 As of Geany 0.19 this section is supplemented by the `[build-menu] Section`_.
3766 Values that are set in the [build-menu] section will override those in this section.
3769 This is a GNU-style extended regular expression to parse a filename
3770 and line number from build output. If undefined, Geany will fall
3771 back to its default error message parsing.
3773 Only the first two matches will be read by Geany. Geany will look for
3774 a match that is purely digits, and use this for the line number. The
3775 remaining match will be used as the filename.
3777 *Example:* ``error_regex=(.+):([0-9]+):[0-9]+``
3779 This will parse a message such as:
3780 ``test.py:7:24: E202 whitespace before ']'``
3784 If any build menu item settings have been configured in the Build Menu Commands
3785 dialog or the Build tab of the project preferences dialog then these
3786 settings are stored in the [build-menu] section and override the settings in
3787 this section for that item.
3790 This item specifies the command to compile source code files. But
3791 it is also possible to use it with interpreted languages like Perl
3792 or Python. With these filetypes you can use this option as a kind of
3793 syntax parser, which sends output to the compiler message window.
3795 You should quote the filename to also support filenames with
3796 spaces. The following wildcards for filenames are available:
3798 * %f -- complete filename without path
3799 * %e -- filename without path and without extension
3801 *Example:* ``compiler=gcc -Wall -c "%f"``
3804 This item specifies the command to link the file. If the file is not
3805 already compiled, it will be compiled while linking. The -o option
3806 is automatically added by Geany. This item works well with GNU gcc,
3807 but may be problematic with other compilers (esp. with the linker).
3809 *Example:* ``linker=gcc -Wall "%f"``
3812 Use this item to execute your file. It has to have been built
3813 already. Use the %e wildcard to have only the name of the executable
3814 (i.e. without extension) or use the %f wildcard if you need the
3815 complete filename, e.g. for shell scripts.
3817 *Example:* ``run_cmd="./%e"``
3820 Special file filetypes.common
3821 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3823 There is a special filetype definition file called
3824 filetypes.common. This file defines some general non-filetype-specific
3828 See the `Filetype configuration`_ section for how to define styles.
3831 [named_styles] Section
3832 ``````````````````````
3833 Named styles declared here can be used in the [styling] section of any
3838 *In filetypes.common*::
3841 foo=0xc00000;0xffffff;false;true
3849 This saves copying and pasting the whole style definition into several
3853 You can define aliases for named styles, as shown with the ``bar``
3854 entry in the above example, but they must be declared after the
3861 This is the default style. It is used for styling files without a
3864 *Example:* ``default=0x000000;0xffffff;false;false``
3867 The style for coloring selected text. The format is:
3871 * Use foreground color
3872 * Use background color
3874 The colors are only set if the 3rd or 4th argument is true. When
3875 the colors are not overridden, the default is a dark grey
3876 background with syntax highlighted foreground text.
3878 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
3881 The style for brace highlighting when a matching brace was found.
3883 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
3886 The style for brace highlighting when no matching brace was found.
3888 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
3891 The style for coloring the caret(the blinking cursor). Only first
3892 and third argument is interpreted.
3893 Set the third argument to true to change the caret into a block caret.
3895 *Example:* ``caret=0x000000;0x0;false;false``
3898 The width for the caret(the blinking cursor). Only the first
3899 argument is interpreted. The width is specified in pixels with
3900 a maximum of three pixel. Use the width 0 to make the caret
3903 *Example:* ``caret=1;0;false;false``
3906 The style for coloring the background of the current line. Only
3907 the second and third arguments are interpreted. The second argument
3908 is the background color. Use the third argument to enable or
3909 disable background highlighting for the current line (has to be
3912 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
3915 The style for coloring the indentation guides. Only the first and
3916 second arguments are interpreted.
3918 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
3921 The style for coloring the white space if it is shown. The first
3922 both arguments define the foreground and background colors, the
3923 third argument sets whether to use the defined foreground color
3924 or to use the color defined by each filetype for the white space.
3925 The fourth argument defines whether to use the background color.
3927 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
3930 Line number margin foreground and background colors.
3932 .. _Folding Settings:
3935 Fold margin foreground and background colors.
3937 fold_symbol_highlight
3938 Highlight color of folding symbols.
3941 The style of folding icons. Only first and second arguments are
3944 Valid values for the first argument are:
3951 Valid values for the second argument are:
3954 * 1 -- for straight lines
3955 * 2 -- for curved lines
3957 *Default:* ``folding_style=1;1;``
3959 *Arrows:* ``folding_style=3;0;``
3962 Draw a thin horizontal line at the line where text is folded. Only
3963 first argument is used.
3965 Valid values for the first argument are:
3967 * 0 -- disable, do not draw a line
3968 * 1 -- draw the line above folded text
3969 * 2 -- draw the line below folded text
3971 *Example:* ``folding_horiz_line=0;0;false;false``
3974 First argument: drawing of visual flags to indicate a line is wrapped.
3975 This is a bitmask of the values:
3977 * 0 -- No visual flags
3978 * 1 -- Visual flag at end of subline of a wrapped line
3979 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
3980 indented by at least 1 to make room for the flag.
3982 Second argument: wether the visual flags to indicate a line is wrapped
3983 are drawn near the border or near the text. This is a bitmask of the values:
3985 * 0 -- Visual flags drawn near border
3986 * 1 -- Visual flag at end of subline drawn near text
3987 * 2 -- Visual flag at begin of subline drawn near text
3989 Only first and second argument is interpreted.
3991 *Example:* ``line_wrap_visuals=3;0;false;false``
3994 First argument: sets the size of indentation of sublines for wrapped lines
3995 in terms of the width of a space, only used when the second argument is ``0``.
3997 Second argument: wrapped sublines can be indented to the position of their
3998 first subline or one more indent level. Possible values:
4000 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4001 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4002 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4004 Only first and second argument is interpreted.
4006 *Example:* ``line_wrap_indent=0;1;false;false``
4009 Translucency for the current line (first argument) and the selection
4010 (second argument). Values between 0 and 256 are accepted.
4012 Note for Windows 95, 98 and ME users:
4013 keep this value at 256 to disable translucency otherwise Geany might crash.
4015 Only the first and second argument is interpreted.
4017 *Example:* ``translucency=256;256;false;false``
4020 The style for a highlighted line (e.g when using Goto line or goto tag).
4021 The foreground color (first argument) is only used when the Markers margin
4022 is enabled (see View menu).
4024 Only the first and second argument is interpreted.
4026 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4029 The style for a marked search results (when using "Mark" in Search dialogs).
4030 The second argument sets the background colour for the drawn rectangle.
4032 Only the second argument is interpreted.
4034 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4037 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4038 (Ctrl-M)). The foreground color (first argument) is only used
4039 when the Markers margin is enabled (see View menu).
4041 Only the first and second argument is interpreted.
4043 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4046 Translucency for the line marker (first argument) and the search marker
4047 (second argument). Values between 0 and 256 are accepted.
4049 Note for Windows 95, 98 and ME users:
4050 keep this value at 256 to disable translucency otherwise Geany might crash.
4052 Only the first and second argument is interpreted.
4054 *Example:* ``marker_translucency=256;256;false;false``
4057 Amount of space to be drawn above and below the line's baseline.
4058 The first argument defines the amount of space to be drawn above the line, the second
4059 argument defines the amount of space to be drawn below.
4061 Only the first and second argument is interpreted.
4063 *Example:* ``line_height=0;0;false;false``
4066 The style for coloring the calltips. The first two arguments
4067 define the foreground and background colors, the third and fourth
4068 arguments set whether to use the defined colors.
4070 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4076 Characters to treat as whitespace. These characters are ignored
4077 when moving, selecting and deleting across word boundaries
4078 (see `Scintilla keyboard commands`_).
4080 This should include space (\\s) and tab (\\t).
4082 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4089 To change the default filetype extension used when saving a new file,
4090 see `Filetype definition files`_.
4092 You can override the list of file extensions that Geany uses for each
4093 filetype using the ``filetype_extensions.conf`` file.
4095 To override the system-wide configuration file, copy it from
4096 ``$prefix/share/geany`` to your configuration directory, usually
4097 ``~/.config/geany/``. ``$prefix`` is the path where Geany is installed
4098 (see `Installation prefix`_).
4102 % cp /usr/local/share/geany/filetype_extensions.conf /home/username/.config/geany/
4104 Then edit it and remove all the lines for filetype extensions that
4105 you do not want to override. The remaining lines can be edited after
4106 the ``=`` sign, using a semi-colon separated list of patterns which
4107 should be matched for that filetype.
4109 For example, to set the filetype extensions for Make, the
4110 ``/home/username/.config/geany/filetype_extensions.conf`` file should
4114 Make=Makefile*;*.mk;Buildfile;
4116 Preferences File Format
4117 -----------------------
4119 The preferences file ``~/.config/geany/geany.conf`` holds settings for all the items configured
4120 in the preferences dialog. This file should not be edited while Geany is running
4121 as the file will be overwritten when the preferences in Geany are changed or Geany
4128 There are some rarely used preferences that are not shown in the Preferences
4129 dialog. These can be set by editing the preferences file, then
4130 restarting Geany. Search for the key name, then edit the value. Example:
4132 ``brace_match_ltgt=true``
4135 If you just installed or updated Geany, you should restart it
4136 first so Geany can write/update the config file and you can find
4139 The table below show the key names of hidden preferences in the
4142 ================================ =========================================== ==================
4143 Key Description Default
4144 ================================ =========================================== ==================
4146 brace_match_ltgt Whether to highlight <, > angle brackets. false
4147 use_gtk_word_boundaries Whether to look for the end of a word when true
4148 using word-boundary related Scintilla
4149 commands (see `Scintilla keyboard
4151 complete_snippets_whilst_editing Whether to allow completion of snippets false
4152 when editing an existing line (i.e. there
4153 is some text after the current cursor
4154 position on the line). Only used when the
4155 keybinding ``Complete snippet`` is set to
4157 show_editor_scrollbars Whether to display scrollbars. If set to true
4158 false, the horizontal and vertical
4159 scrollbars are hidden completely.
4160 **Interface related**
4161 show_symbol_list_expanders Whether to show or hide the small expander true
4162 icons on the symbol list treeview (only
4163 available with GTK 2.12 or above).
4164 allow_always_save Whether files can be saved always, even if false
4165 they don't have any changes. By default,
4166 the Save buttons and menu items are
4167 disabled when a file is unchanged. When
4168 setting this option to true, the Save
4169 buttons and menu items are always active
4170 and files can be saved.
4171 compiler_tab_autoscroll Whether to automatically scroll to the true
4172 last line of the output in the Compiler
4174 statusbar_template The status bar statistics line format. See below.
4175 (Search in src/ui_utils.c for details).
4176 new_document_after_close Whether to open a new document after all false
4177 documents have been closed.
4178 msgwin_status_visible Whether to show the Status tab in the true
4180 msgwin_compiler_visible Whether to show the Compiler tab in the true
4182 msgwin_messages_visible Whether to show the Messages tab in the true
4184 msgwin_scribble_visible Whether to show the Scribble tab in the true
4186 ================================ =========================================== ==================
4188 By default, statusbar_template is empty. This tells Geany to use its
4189 internal default, which is currently:
4191 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
4193 Note that ``\t`` = tab.
4195 ================================ =========================================== ==================
4196 Key Description Default
4197 ================================ =========================================== ==================
4199 emulation Terminal emulation mode. Only change this xterm
4200 if you have VTE termcap files other than
4201 ``vte/termcap/xterm``.
4202 send_selection_unsafe By default, Geany strips any trailing false
4203 newline characters from the current
4204 selection before sending it to the terminal
4205 to not execute arbitrary code. This is
4206 mainly a security feature.
4207 If, for whatever reasons, you really want
4208 it to be executed directly, set this option
4211 use_safe_file_saving Defines the mode how Geany saves files to false
4212 disk. If disabled, Geany directly writes
4213 the content of the document to disk. This
4214 might cause in loss of data when there is
4215 no more free space on disk to save the
4216 file. When set to true, Geany first saves
4217 the contents into a temporary file and if
4218 this succeeded, the temporary file is
4219 moved to the real file to save.
4220 This gives better error checking in case of
4221 no more free disk space. But it also
4222 destroys hard links of the original file
4223 and its permissions (e.g. executable flags
4224 are reset). Use this with care as it can
4225 break things seriously.
4226 The better approach would be to ensure your
4227 disk won't run out of free space.
4229 find_selection_type See `Find selection`_. 0
4230 **Build Menu related**
4231 number_ft_menu_items The maximum number of menu items in the 2
4232 filetype section of the Build menu.
4233 number_non_ft_menu_items The maximum number of menu items in the 3
4234 independent section of the Build menu.
4235 number_exec_menu_items The maximum number of menu items in the 2
4236 execute section of the Build menu.
4237 ================================ =========================================== ==================
4239 [build-menu] Section
4240 ^^^^^^^^^^^^^^^^^^^^
4242 The [build-menu] section contains the configuration of the build menu.
4243 This section can occur in filetype, preferences and project files and
4244 always has the format described here. Different menu items are loaded
4245 from different files, see the table in the `Build Menu Configuration`_
4246 section for details. All the settings can be configured from the dialogs
4247 except the execute command in filetype files and filetype definitions in
4248 the project file, so these are the only ones which need hand editing.
4250 The build-menu section stores one entry for each setting for each menu item that
4251 is configured. The keys for these settings have the format:
4257 * GG - is the menu item group,
4260 - NF for independent (non-filetype)
4263 * NN - is a two decimal digit number of the item within the group,
4265 * FF - is the field,
4269 - WD for working directory
4275 The project file contains project related settings and possibly a
4276 record of the current session files.
4279 [build-menu] Additions
4280 ^^^^^^^^^^^^^^^^^^^^^^
4282 The project file also can have extra fields in the [build-menu] section
4283 in addition to those listed in `[build-menu] Section`_ above.
4285 When filetype menu items are configured for the project they are stored
4286 in the project file.
4288 The ``filetypes`` entry is a list of the filetypes which exist in the
4291 For each filetype the entries for that filetype have the format defined in
4292 `[build-menu] Section`_ but the key is prefixed by the name of the filetype
4293 as it appears in the ``filetypes`` entry, eg the entry for the label of
4294 filetype menu item 0 for the C filetype would be
4302 Geany supports the following templates:
4306 * Function description
4311 To use these templates, just open the Edit menu or open the popup menu
4312 by right-clicking in the editor widget, and choose "Insert Comments"
4313 and insert templates as you want.
4315 Some templates (like File header or ChangeLog entry) will always be
4316 inserted at the top of the file.
4318 To insert a function description, the cursor must be inside
4319 of the function, so that the function name can be determined
4320 automatically. The description will be positioned correctly one line
4321 above the function, just check it out. If the cursor is not inside
4322 of a function or the function name cannot be determined, the inserted
4323 function description won't contain the correct function name but "unknown"
4327 Geany automatically reloads template information when it notices you
4328 save a file in the user's template configuration directory. You can
4329 also force this by selecting *Tools->Reload Configuration*.
4335 Meta data can be used with all templates, but by default user set
4336 meta data is only used for the ChangeLog and File header templates.
4338 In the configuration dialog you can find a tab "Templates" (see
4339 `Template preferences`_). You can define the default values
4340 which will be inserted in the templates. You should select
4341 *Tools->Reload Configuration* or restart Geany after making changes.
4347 File templates are templates used as the basis of a new file. To
4348 use them, choose the *New (with Template)* menu item from the *File*
4351 By default, file templates are installed for some filetypes. Custom
4352 file templates can be added by creating the appropriate template file. You can
4353 also edit the default file templates.
4355 The file's contents are just the text to place in the document, with
4356 optional template wildcards like ``{fileheader}``. The fileheader
4357 wildcard can be placed anywhere, but it's usually put on the first
4358 line of the file, followed by a blank line.
4360 Custom file templates
4361 `````````````````````
4363 These are read from the following directories:
4365 * ``$prefix/share/geany/templates/files`` (see `Installation prefix`_)
4366 * ``~/.config/geany/templates/files`` (created the first time
4369 The filetype to use is detected from the template file's extension, if
4370 any. For example, creating a file ``module.c`` would add a menu item
4371 which created a new document with the filetype set to 'C'.
4373 The template file is read from disk when the corresponding menu item is
4380 It's recommended to use custom file templates instead.
4382 Filetype template files are read from the ``~/.config/geany/templates``
4383 directory, and are named "filetype." followed by the filetype
4384 name, e.g. "filetype.python", "filetype.sh", etc. If you are
4385 unsure about the filetype name extensions, they are the same as
4386 the filetype configuration file extensions, commonly installed in
4387 ``/usr/share/geany``, with the prefix "filetypes.".
4389 There is also a template file ``filetype.none`` which is used when
4390 the New command is used without a filetype. This is empty by default.
4393 Customizing templates
4394 ^^^^^^^^^^^^^^^^^^^^^
4396 Each template can be customized to your needs. The templates are
4397 stored in the ``~/.config/geany/templates/`` directory (see the section called
4398 `Command line options`_ for further information about the configuration
4399 directory). Just open the desired template with an editor (ideally,
4400 Geany ;-) ) and edit the template to your needs. There are some
4401 wildcards which will be automatically replaced by Geany at startup.
4407 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4409 **Wildcards for character escaping**
4411 ============== ============================================= =======================================
4412 Wildcard Description Available in
4413 ============== ============================================= =======================================
4414 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4415 wildcards being expanded).
4416 cb } Closing Brace. file templates, file header, snippets.
4417 pc \% Percent (used to escape e.g. %block% in
4418 snippets). snippets.
4419 ============== ============================================= =======================================
4421 **Global wildcards**
4423 These are configurable, see `Template preferences`_.
4425 ============== ============================================= =======================================
4426 Wildcard Description Available in
4427 ============== ============================================= =======================================
4428 developer The name of the developer. file templates, file header,
4429 function description, ChangeLog entry,
4432 initial The developer's initials, e.g. "ET" for file templates, file header,
4433 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4436 mail The email address of the developer. file templates, file header,
4437 function description, ChangeLog entry,
4440 company The company the developer is working for. file templates, file header,
4441 function description, ChangeLog entry,
4444 version The initial version of a new file. file templates, file header,
4445 function description, ChangeLog entry,
4447 ============== ============================================= =======================================
4449 **Date & time wildcards**
4451 The format for these wildcards can be changed in the preferences
4452 dialog, see `Template preferences`_. You can use any conversion
4453 specifiers which can be used with the ANSI C strftime function.
4454 For details please see http://man.cx/strftime.
4456 ============== ============================================= =======================================
4457 Wildcard Description Available in
4458 ============== ============================================= =======================================
4459 year The current year. Default format is: YYYY. file templates, file header,
4460 function description, ChangeLog entry,
4463 date The current date. Default format: file templates, file header,
4464 YYYY-MM-DD. function description, ChangeLog entry,
4467 datetime The current date and time. Default format: file templates, file header,
4468 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4470 ============== ============================================= =======================================
4472 **Dynamic wildcards**
4474 ============== ============================================= =======================================
4475 Wildcard Description Available in
4476 ============== ============================================= =======================================
4477 untitled The string "untitled" (this will be file templates, file header,
4478 translated to your locale), used in function description, ChangeLog entry,
4479 file templates. bsd, gpl, snippets.
4481 geanyversion The actual Geany version, e.g. file templates, file header,
4482 "Geany |(version)|". function description, ChangeLog entry,
4485 filename The filename of the current file. file header, snippets, file
4486 For new files, it's only replaced when templates.
4487 first saving if found on the first 3 lines
4490 project The current project's name, if any. file header, snippets, file templates.
4492 description The current project's description, if any. file header, snippets, file templates.
4494 functionname The function name of the function at the function description.
4495 cursor position. This wildcard will only be
4496 replaced in the function description
4499 command:path Executes the specified command and replace file templates, file header,
4500 the wildcard with the command's standard function description, ChangeLog entry,
4501 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
4503 ============== ============================================= =======================================
4505 **Template insertion wildcards**
4507 ============== ============================================= =======================================
4508 Wildcard Description Available in
4509 ============== ============================================= =======================================
4510 gpl This wildcard inserts a short GPL notice. file header.
4512 bsd This wildcard inserts a BSD licence notice. file header.
4514 fileheader The file header template. This wildcard snippets, file templates.
4515 will only be replaced in filetype
4517 ============== ============================================= =======================================
4520 Special {command:} wildcard
4521 ***************************
4523 The {command:} wildcard is a special one because it can execute
4524 a specified command and put the command's output (stdout) into
4533 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
4535 Using this wildcard you can insert nearly any arbitrary text into the
4538 In the environment of the executed command the variables
4539 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
4540 The value of these variables is filled in only if Geany knows about it.
4541 For example, ``GEANY_FUNCNAME`` is only filled within the function
4542 description template. However, these variables are ``always`` set,
4543 just maybe with an empty value.
4544 You can easily access them e.g. within an executed shell script using::
4550 If the specified command could not be found or not executed, the wildcard is substituted
4551 by an empty string. In such cases, you can find the occurred error message on Geany's
4552 standard error and in the Help->Debug Messages dialog.
4555 Customizing the toolbar
4556 -----------------------
4558 You can add, remove and reorder the elements in the toolbar by using the toolbar editor
4559 by manually editing the file ``ui_toolbar.xml``.
4561 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
4562 by right-clicking on the toolbar itself and choosing it from the menu.
4564 Manually editing of the toolbar layout
4565 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4567 To override the system-wide configuration file, copy it from
4568 ``$prefix/share/geany`` to your configuration directory, usually
4569 ``~/.config/geany/``. ``$prefix`` is the path where Geany is installed
4570 (see `Installation prefix`_).
4574 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
4576 Then edit it and add any of the available elements listed in the file or remove
4577 any of the existing elements. Of course, you can also reorder the elements as
4578 you wish and add or remove additional separators.
4579 This file must be valid XML, otherwise the global toolbar UI definition
4580 will be used instead.
4582 Your changes are applied once you save the file.
4585 (1) You cannot add new actions which are not listed below.
4586 (2) Everything you add or change must be inside the /ui/toolbar/ path.
4589 Available toolbar elements
4590 ^^^^^^^^^^^^^^^^^^^^^^^^^^
4592 ================== ==============================================================================
4593 Element name Description
4594 ================== ==============================================================================
4595 New Create a new file
4596 Open Open an existing file
4597 Save Save the current file
4598 SaveAll Save all open files
4599 Reload Reload the current file from disk
4600 Close Close the current file
4601 CloseAll Close all open files
4602 Print Print the current file
4603 Cut Cut the current selection
4604 Copy Copy the current selection
4605 Paste Paste the contents of the clipboard
4606 Delete Delete the current selection
4607 Undo Undo the last modification
4608 Redo Redo the last modification
4609 NavBack Navigate back a location
4610 NavFor Navigate forward a location
4611 Compile Compile the current file
4612 Build Build the current file, includes a submenu for Make commands. Geany
4613 remembers the last chosen action from the submenu and uses this as default
4614 action when the button itself is clicked.
4615 Run Run or view the current file
4616 Color Open a color chooser dialog, to interactively pick colors from a palette
4617 ZoomIn Zoom in the text
4618 ZoomOut Zoom out the text
4619 UnIndent Decrease indentation
4620 Indent Increase indentation
4621 Replace Replace text in the current document
4622 SearchEntry The search field belonging to the 'Search' element (can be used alone)
4623 Search Find the entered text in the current file (only useful if you also
4625 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
4626 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
4627 Preferences Show the preferences dialog
4629 ================== ==============================================================================
4633 Plugin documentation
4634 ====================
4639 The HTMLChars plugin helps when working with special characters in
4640 XML/HTML, e.g. German Umlauts ü and ä.
4643 Insert entity dialog
4644 ^^^^^^^^^^^^^^^^^^^^
4646 When the plugin is enabled, you can insert special character
4647 entities using *Tools->Insert Special HTML Characters*.
4649 This opens up a dialog where you can find a huge amount of special
4650 characters sorted by category that you might like to use inside your
4651 document. You can expand and collapse the categories by clicking on
4652 the little arrow on the left hand side. Once you have found the
4653 desired character click on it and choose "Insert". This will insert
4654 the entity for the character at the current cursor position. You
4655 might also like to double click the chosen entity instead.
4658 Replace special chars by its entity
4659 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4661 To help make a XML/HTML document valid the plugin supports
4662 replacement of special chars known by the plugin. Both bulk
4663 replacement and immediate replacement during typing are supported.
4665 A few characters will not be replaced. These are
4676 You can activate/deactivate this feature using the *Tools->HTML
4677 Replacement->Auto-replace Special Characters* menu item. If it's
4678 activated, all special characters (beside the given exceptions from
4679 above) known by the plugin will be replaced by their entities.
4681 You could also set a keybinding for the plugin to toggle the status
4688 After inserting a huge amount of text, e.g. by using copy & paste, the
4689 plugin allows bulk replacement of all known characters (beside the
4690 mentioned exceptions). You can find the function under the same
4691 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
4692 configure a keybinding for the plugin.
4700 This plugin sets on every new file (*File->New* or *File->New (with template)*)
4701 a randomly chosen filename and set its filetype appropriate to the used template
4702 or when no template was used, to a configurable default filetype.
4703 This enables you to quickly compile, build and/or run the new file without the
4704 need to give it an explicit filename using the Save As dialog. This might be
4705 useful when you often create new files just for testing some code or something
4712 This plugin creates a backup copy of the current file in Geany when it is
4713 saved. You can specify the directory where the backup copy is saved and
4714 you can configure the automatically added extension in the configure dialog
4715 in Geany's plugin manager.
4717 After the plugin was loaded in Geany's plugin manager, every file is
4718 copied into the configured backup directory when the file is saved in Geany.
4722 Contributing to this document
4723 =============================
4725 This document (``geany.txt``) is written in `reStructuredText`__
4726 (or "reST"). The source file for it is located in Geany's ``doc``
4727 subdirectory. If you intend on making changes, you should grab the
4728 source right from SVN to make sure you've got the newest version. After
4729 editing the file, to build the HTML document to see how your changes
4730 look, run "``make doc``" in the subdirectory ``doc`` of Geany's source
4731 directory. This regenerates the ``geany.html`` file. To generate a PDF
4732 file, use the command "``make pdf``" which should generate a file called
4733 geany-|(version)|.pdf.
4735 __ http://docutils.sourceforge.net/rst.html
4737 After you are happy with your changes, create a patch::
4739 % svn diff geany.txt > foo.patch
4741 and then submit that file to the mailing list for review.
4743 Note, you will need the Python docutils software package installed
4744 to build the docs. The package is named ``python-docutils`` on Debian
4750 Scintilla keyboard commands
4751 ===========================
4753 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
4755 This appendix is distributed under the terms of the License for
4756 Scintilla and SciTE. A copy of this license can be found in the file
4757 ``scintilla/License.txt`` included with the source code of this
4758 program and in the appendix of this document. See `License for
4759 Scintilla and SciTE`_.
4768 Keyboard commands for Scintilla mostly follow common Windows and GTK+
4769 conventions. All move keys (arrows, page up/down, home and end)
4770 allows to extend or reduce the stream selection when holding the
4771 Shift key, and the rectangular selection when holding the Shift and
4772 Ctrl keys. Some keys may not be available with some national keyboards
4773 or because they are taken by the system such as by a window manager
4774 or GTK. Keyboard equivalents of menu commands are listed in the
4775 menus. Some less common commands with no menu equivalent are:
4777 ============================================= ======================
4779 ============================================= ======================
4780 Magnify text size. Ctrl+Keypad+
4781 Reduce text size. Ctrl+Keypad-
4782 Restore text size to normal. Ctrl+Keypad/
4784 Dedent block. Shift+Tab
4785 Delete to start of word. Ctrl+BackSpace
4786 Delete to end of word. Ctrl+Delete
4787 Delete to start of line. Ctrl+Shift+BackSpace
4788 Go to start of document. Ctrl+Home
4789 Extend selection to start of document. Ctrl+Shift+Home
4790 Go to start of display line. Alt+Home
4791 Extend selection to start of display line. Alt+Shift+Home
4792 Go to end of document. Ctrl+End
4793 Extend selection to end of document. Ctrl+Shift+End
4794 Extend selection to end of display line. Alt+Shift+End
4795 Previous paragraph. Shift extends selection. Ctrl+Up
4796 Next paragraph. Shift extends selection. Ctrl+Down
4797 Previous word. Shift extends selection. Ctrl+Left
4798 Next word. Shift extends selection. Ctrl+Right
4799 ============================================= ======================
4810 * Double-click on empty space in the notebook tab bar to open a
4812 * Middle-click on a document's notebook tab to close the document.
4813 * Hold `Ctrl` and click on any notebook tab to switch to the last used
4815 * Double-click on a document's notebook tab to toggle all additional
4816 widgets (to show them again use the View menu or the keyboard
4817 shortcut). The interface pref must be enabled for this to work.
4822 * Alt-scroll wheel moves up/down a page.
4823 * Ctrl-scroll wheel zooms in/out.
4824 * Shift-scroll wheel scrolls 8 characters right/left.
4825 * Ctrl-click on a word in a document to perform *Go to Tag Definition*.
4826 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
4831 * Double-click on a symbol-list group to expand or compact it.
4836 * Scrolling the mouse wheel over a notebook tab bar will switch
4839 The following are derived from X-Windows features (but GTK still supports
4842 * Middle-click pastes the last selected text.
4843 * Middle-click on a scrollbar moves the scrollbar to that
4844 position without having to drag it.
4848 Compile-time options
4849 ====================
4851 There are some options which can only be changed at compile time,
4852 and some options which are used as the default for configurable
4853 options. To change these options, edit the appropriate source file
4854 in the ``src`` subdirectory. Look for a block of lines starting with
4855 ``#define GEANY_*``. Any definitions which are not listed here should
4859 Most users should not need to change these options.
4864 ============================== ============================================ ==================
4865 Option Description Default
4866 ============================== ============================================ ==================
4867 GEANY_STRING_UNTITLED A string used as the default name for new untitled
4868 files. Be aware that the string can be
4869 translated, so change it only if you know
4871 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
4872 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
4873 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
4875 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
4877 **Windows specific**
4878 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
4879 Windows file open and save dialogs instead
4880 GTK's file open and save dialogs. The
4881 default Windows file dialogs are missing
4882 some nice features like choosing a filetype
4883 or an encoding. *Do not touch this setting
4884 when building on a non-Win32 system.*
4885 ============================== ============================================ ==================
4890 ============================== ============================================ ==================
4891 Option Description Default
4892 ============================== ============================================ ==================
4893 GEANY_PROJECT_EXT The default filename extension for Geany geany
4894 project files. It is used when creating new
4895 projects and as filter mask for the project
4897 ============================== ============================================ ==================
4902 ============================== ============================================ ==================
4903 Option Description Default
4904 ============================== ============================================ ==================
4905 GEANY_WORDCHARS These characters define word boundaries when a string with:
4906 making selections and searching using word a-z, A-Z, 0-9 and
4907 matching options. underscore.
4908 ============================== ============================================ ==================
4913 These are default settings that can be overridden in the `Preferences`_ dialog.
4915 ============================== ============================================ ==================
4916 Option Description Default
4917 ============================== ============================================ ==================
4918 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
4919 trigger the autocompletion list.
4920 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
4922 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
4923 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept the "xterm"
4924 command line option "-e". This can also
4926 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
4927 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
4928 and process plain text files. This can also
4930 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
4931 GNU grep. This can also include a path.
4932 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
4933 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
4935 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
4936 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
4937 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
4939 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
4941 ============================== ============================================ ==================
4946 ============================== ============================================ ==================
4947 Option Description Default
4948 ============================== ============================================ ==================
4949 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
4950 be shown in the editor window.
4951 This affects the special coloring
4952 when Geany detects a compiler output line as
4953 an error message and then highlights the
4954 corresponding line in the source code.
4955 Usually only the first few messages are
4956 interesting because following errors are
4958 All errors in the Compiler window are parsed
4959 and unaffected by this value.
4960 PRINTBUILDCMDS Every time a build menu item priority FALSE
4961 calculation is run, print the state of the
4962 menu item table in the form of the table
4963 in `Build Menu Configuration`_. May be
4964 useful to debug configuration file
4965 overloading. Warning produces a lot of
4966 output. Can also be enabled/disabled by the
4967 debugger by setting printbuildcmds to 1/0
4968 overriding the compile setting.
4969 ============================== ============================================ ==================
4973 GNU General Public License
4974 ==========================
4978 GNU GENERAL PUBLIC LICENSE
4979 Version 2, June 1991
4981 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
4982 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4983 Everyone is permitted to copy and distribute verbatim copies
4984 of this license document, but changing it is not allowed.
4988 The licenses for most software are designed to take away your
4989 freedom to share and change it. By contrast, the GNU General Public
4990 License is intended to guarantee your freedom to share and change free
4991 software--to make sure the software is free for all its users. This
4992 General Public License applies to most of the Free Software
4993 Foundation's software and to any other program whose authors commit to
4994 using it. (Some other Free Software Foundation software is covered by
4995 the GNU Library General Public License instead.) You can apply it to
4998 When we speak of free software, we are referring to freedom, not
4999 price. Our General Public Licenses are designed to make sure that you
5000 have the freedom to distribute copies of free software (and charge for
5001 this service if you wish), that you receive source code or can get it
5002 if you want it, that you can change the software or use pieces of it
5003 in new free programs; and that you know you can do these things.
5005 To protect your rights, we need to make restrictions that forbid
5006 anyone to deny you these rights or to ask you to surrender the rights.
5007 These restrictions translate to certain responsibilities for you if you
5008 distribute copies of the software, or if you modify it.
5010 For example, if you distribute copies of such a program, whether
5011 gratis or for a fee, you must give the recipients all the rights that
5012 you have. You must make sure that they, too, receive or can get the
5013 source code. And you must show them these terms so they know their
5016 We protect your rights with two steps: (1) copyright the software, and
5017 (2) offer you this license which gives you legal permission to copy,
5018 distribute and/or modify the software.
5020 Also, for each author's protection and ours, we want to make certain
5021 that everyone understands that there is no warranty for this free
5022 software. If the software is modified by someone else and passed on, we
5023 want its recipients to know that what they have is not the original, so
5024 that any problems introduced by others will not reflect on the original
5025 authors' reputations.
5027 Finally, any free program is threatened constantly by software
5028 patents. We wish to avoid the danger that redistributors of a free
5029 program will individually obtain patent licenses, in effect making the
5030 program proprietary. To prevent this, we have made it clear that any
5031 patent must be licensed for everyone's free use or not licensed at all.
5033 The precise terms and conditions for copying, distribution and
5034 modification follow.
5036 GNU GENERAL PUBLIC LICENSE
5037 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5039 0. This License applies to any program or other work which contains
5040 a notice placed by the copyright holder saying it may be distributed
5041 under the terms of this General Public License. The "Program", below,
5042 refers to any such program or work, and a "work based on the Program"
5043 means either the Program or any derivative work under copyright law:
5044 that is to say, a work containing the Program or a portion of it,
5045 either verbatim or with modifications and/or translated into another
5046 language. (Hereinafter, translation is included without limitation in
5047 the term "modification".) Each licensee is addressed as "you".
5049 Activities other than copying, distribution and modification are not
5050 covered by this License; they are outside its scope. The act of
5051 running the Program is not restricted, and the output from the Program
5052 is covered only if its contents constitute a work based on the
5053 Program (independent of having been made by running the Program).
5054 Whether that is true depends on what the Program does.
5056 1. You may copy and distribute verbatim copies of the Program's
5057 source code as you receive it, in any medium, provided that you
5058 conspicuously and appropriately publish on each copy an appropriate
5059 copyright notice and disclaimer of warranty; keep intact all the
5060 notices that refer to this License and to the absence of any warranty;
5061 and give any other recipients of the Program a copy of this License
5062 along with the Program.
5064 You may charge a fee for the physical act of transferring a copy, and
5065 you may at your option offer warranty protection in exchange for a fee.
5067 2. You may modify your copy or copies of the Program or any portion
5068 of it, thus forming a work based on the Program, and copy and
5069 distribute such modifications or work under the terms of Section 1
5070 above, provided that you also meet all of these conditions:
5072 a) You must cause the modified files to carry prominent notices
5073 stating that you changed the files and the date of any change.
5075 b) You must cause any work that you distribute or publish, that in
5076 whole or in part contains or is derived from the Program or any
5077 part thereof, to be licensed as a whole at no charge to all third
5078 parties under the terms of this License.
5080 c) If the modified program normally reads commands interactively
5081 when run, you must cause it, when started running for such
5082 interactive use in the most ordinary way, to print or display an
5083 announcement including an appropriate copyright notice and a
5084 notice that there is no warranty (or else, saying that you provide
5085 a warranty) and that users may redistribute the program under
5086 these conditions, and telling the user how to view a copy of this
5087 License. (Exception: if the Program itself is interactive but
5088 does not normally print such an announcement, your work based on
5089 the Program is not required to print an announcement.)
5091 These requirements apply to the modified work as a whole. If
5092 identifiable sections of that work are not derived from the Program,
5093 and can be reasonably considered independent and separate works in
5094 themselves, then this License, and its terms, do not apply to those
5095 sections when you distribute them as separate works. But when you
5096 distribute the same sections as part of a whole which is a work based
5097 on the Program, the distribution of the whole must be on the terms of
5098 this License, whose permissions for other licensees extend to the
5099 entire whole, and thus to each and every part regardless of who wrote it.
5101 Thus, it is not the intent of this section to claim rights or contest
5102 your rights to work written entirely by you; rather, the intent is to
5103 exercise the right to control the distribution of derivative or
5104 collective works based on the Program.
5106 In addition, mere aggregation of another work not based on the Program
5107 with the Program (or with a work based on the Program) on a volume of
5108 a storage or distribution medium does not bring the other work under
5109 the scope of this License.
5111 3. You may copy and distribute the Program (or a work based on it,
5112 under Section 2) in object code or executable form under the terms of
5113 Sections 1 and 2 above provided that you also do one of the following:
5115 a) Accompany it with the complete corresponding machine-readable
5116 source code, which must be distributed under the terms of Sections
5117 1 and 2 above on a medium customarily used for software interchange; or,
5119 b) Accompany it with a written offer, valid for at least three
5120 years, to give any third party, for a charge no more than your
5121 cost of physically performing source distribution, a complete
5122 machine-readable copy of the corresponding source code, to be
5123 distributed under the terms of Sections 1 and 2 above on a medium
5124 customarily used for software interchange; or,
5126 c) Accompany it with the information you received as to the offer
5127 to distribute corresponding source code. (This alternative is
5128 allowed only for noncommercial distribution and only if you
5129 received the program in object code or executable form with such
5130 an offer, in accord with Subsection b above.)
5132 The source code for a work means the preferred form of the work for
5133 making modifications to it. For an executable work, complete source
5134 code means all the source code for all modules it contains, plus any
5135 associated interface definition files, plus the scripts used to
5136 control compilation and installation of the executable. However, as a
5137 special exception, the source code distributed need not include
5138 anything that is normally distributed (in either source or binary
5139 form) with the major components (compiler, kernel, and so on) of the
5140 operating system on which the executable runs, unless that component
5141 itself accompanies the executable.
5143 If distribution of executable or object code is made by offering
5144 access to copy from a designated place, then offering equivalent
5145 access to copy the source code from the same place counts as
5146 distribution of the source code, even though third parties are not
5147 compelled to copy the source along with the object code.
5149 4. You may not copy, modify, sublicense, or distribute the Program
5150 except as expressly provided under this License. Any attempt
5151 otherwise to copy, modify, sublicense or distribute the Program is
5152 void, and will automatically terminate your rights under this License.
5153 However, parties who have received copies, or rights, from you under
5154 this License will not have their licenses terminated so long as such
5155 parties remain in full compliance.
5157 5. You are not required to accept this License, since you have not
5158 signed it. However, nothing else grants you permission to modify or
5159 distribute the Program or its derivative works. These actions are
5160 prohibited by law if you do not accept this License. Therefore, by
5161 modifying or distributing the Program (or any work based on the
5162 Program), you indicate your acceptance of this License to do so, and
5163 all its terms and conditions for copying, distributing or modifying
5164 the Program or works based on it.
5166 6. Each time you redistribute the Program (or any work based on the
5167 Program), the recipient automatically receives a license from the
5168 original licensor to copy, distribute or modify the Program subject to
5169 these terms and conditions. You may not impose any further
5170 restrictions on the recipients' exercise of the rights granted herein.
5171 You are not responsible for enforcing compliance by third parties to
5174 7. If, as a consequence of a court judgment or allegation of patent
5175 infringement or for any other reason (not limited to patent issues),
5176 conditions are imposed on you (whether by court order, agreement or
5177 otherwise) that contradict the conditions of this License, they do not
5178 excuse you from the conditions of this License. If you cannot
5179 distribute so as to satisfy simultaneously your obligations under this
5180 License and any other pertinent obligations, then as a consequence you
5181 may not distribute the Program at all. For example, if a patent
5182 license would not permit royalty-free redistribution of the Program by
5183 all those who receive copies directly or indirectly through you, then
5184 the only way you could satisfy both it and this License would be to
5185 refrain entirely from distribution of the Program.
5187 If any portion of this section is held invalid or unenforceable under
5188 any particular circumstance, the balance of the section is intended to
5189 apply and the section as a whole is intended to apply in other
5192 It is not the purpose of this section to induce you to infringe any
5193 patents or other property right claims or to contest validity of any
5194 such claims; this section has the sole purpose of protecting the
5195 integrity of the free software distribution system, which is
5196 implemented by public license practices. Many people have made
5197 generous contributions to the wide range of software distributed
5198 through that system in reliance on consistent application of that
5199 system; it is up to the author/donor to decide if he or she is willing
5200 to distribute software through any other system and a licensee cannot
5203 This section is intended to make thoroughly clear what is believed to
5204 be a consequence of the rest of this License.
5206 8. If the distribution and/or use of the Program is restricted in
5207 certain countries either by patents or by copyrighted interfaces, the
5208 original copyright holder who places the Program under this License
5209 may add an explicit geographical distribution limitation excluding
5210 those countries, so that distribution is permitted only in or among
5211 countries not thus excluded. In such case, this License incorporates
5212 the limitation as if written in the body of this License.
5214 9. The Free Software Foundation may publish revised and/or new versions
5215 of the General Public License from time to time. Such new versions will
5216 be similar in spirit to the present version, but may differ in detail to
5217 address new problems or concerns.
5219 Each version is given a distinguishing version number. If the Program
5220 specifies a version number of this License which applies to it and "any
5221 later version", you have the option of following the terms and conditions
5222 either of that version or of any later version published by the Free
5223 Software Foundation. If the Program does not specify a version number of
5224 this License, you may choose any version ever published by the Free Software
5227 10. If you wish to incorporate parts of the Program into other free
5228 programs whose distribution conditions are different, write to the author
5229 to ask for permission. For software which is copyrighted by the Free
5230 Software Foundation, write to the Free Software Foundation; we sometimes
5231 make exceptions for this. Our decision will be guided by the two goals
5232 of preserving the free status of all derivatives of our free software and
5233 of promoting the sharing and reuse of software generally.
5237 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5238 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5239 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5240 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5241 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5242 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5243 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5244 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5245 REPAIR OR CORRECTION.
5247 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5248 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5249 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5250 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5251 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5252 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5253 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5254 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5255 POSSIBILITY OF SUCH DAMAGES.
5257 END OF TERMS AND CONDITIONS
5259 How to Apply These Terms to Your New Programs
5261 If you develop a new program, and you want it to be of the greatest
5262 possible use to the public, the best way to achieve this is to make it
5263 free software which everyone can redistribute and change under these terms.
5265 To do so, attach the following notices to the program. It is safest
5266 to attach them to the start of each source file to most effectively
5267 convey the exclusion of warranty; and each file should have at least
5268 the "copyright" line and a pointer to where the full notice is found.
5270 <one line to give the program's name and a brief idea of what it does.>
5271 Copyright (C) <year> <name of author>
5273 This program is free software; you can redistribute it and/or modify
5274 it under the terms of the GNU General Public License as published by
5275 the Free Software Foundation; either version 2 of the License, or
5276 (at your option) any later version.
5278 This program is distributed in the hope that it will be useful,
5279 but WITHOUT ANY WARRANTY; without even the implied warranty of
5280 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5281 GNU General Public License for more details.
5283 You should have received a copy of the GNU General Public License
5284 along with this program; if not, write to the Free Software
5285 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
5288 Also add information on how to contact you by electronic and paper mail.
5290 If the program is interactive, make it output a short notice like this
5291 when it starts in an interactive mode:
5293 Gnomovision version 69, Copyright (C) year name of author
5294 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5295 This is free software, and you are welcome to redistribute it
5296 under certain conditions; type `show c' for details.
5298 The hypothetical commands `show w' and `show c' should show the appropriate
5299 parts of the General Public License. Of course, the commands you use may
5300 be called something other than `show w' and `show c'; they could even be
5301 mouse-clicks or menu items--whatever suits your program.
5303 You should also get your employer (if you work as a programmer) or your
5304 school, if any, to sign a "copyright disclaimer" for the program, if
5305 necessary. Here is a sample; alter the names:
5307 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5308 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5310 <signature of Ty Coon>, 1 April 1989
5311 Ty Coon, President of Vice
5313 This General Public License does not permit incorporating your program into
5314 proprietary programs. If your program is a subroutine library, you may
5315 consider it more useful to permit linking proprietary applications with the
5316 library. If this is what you want to do, use the GNU Library General
5317 Public License instead of this License.
5322 License for Scintilla and SciTE
5323 ===============================
5325 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5329 Permission to use, copy, modify, and distribute this software and
5330 its documentation for any purpose and without fee is hereby granted,
5331 provided that the above copyright notice appear in all copies and
5332 that both that copyright notice and this permission notice appear in
5333 supporting documentation.
5335 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5336 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5337 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5338 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5339 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5340 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5341 USE OR PERFORMANCE OF THIS SOFTWARE.