1 .. |(version)| replace:: 0.19
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
717 If you don't like it or don't need it at all, you can simply disable
718 folding support completely in the preferences dialog.
720 The folding behaviour can be changed with the "Fold/Unfold all children of
721 a fold point" option in the preference dialog. If activated, Geany will
722 unfold all nested fold points below the current one if they are already
723 folded (when clicking on a [+] symbol).
724 When clicking on a [-] symbol, Geany will fold all nested fold points
725 below the current one if they are unfolded.
727 This option can be inverted by pressing the Shift
728 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
729 children of a fold point" option is enabled, pressing Shift will disable
730 it for this click and vice versa.
733 Column mode editing (rectangular selections)
734 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
736 There is basic support for column mode editing. To use it, create a
737 rectangular selection by holding down the Control and Shift keys
738 (or Control and Alt if it doesn't work) while
739 selecting some text. It is also possible to create a zero-column selection.
740 Once a rectangular selection exists you can start editing the text within
741 this selection and the modifications will be done for every line in the
745 Drag and drop of text
746 ^^^^^^^^^^^^^^^^^^^^^
748 If you drag selected text in the editor widget of Geany the text is
749 moved to the position where the mouse pointer is when releasing the
750 mouse button. Holding Control when releasing the mouse button will
751 copy the text instead. This behaviour was changed in Geany 0.11 -
752 before the selected text was copied to the new position.
758 Geany allows each document to indent either with a tab character or
759 multiple spaces. The default indent mode is set in the `Editor Features
760 preferences`_ (see the link for more information). But
761 this can be overridden using either the *Document->Indent Type* menu,
762 or by using the *Detect from file* indentation preference. When enabled,
763 this scans each file that is opened and sets the indent mode based on
764 how many lines start with a tab vs. 2 or more spaces.
766 The indent mode for the current document is shown on the status bar
770 Indent with Tab characters.
774 Indent with tabs and spaces, depending on how much indentation is
781 When enabled, auto-indentation happens when pressing *Enter* in the
782 Editor. It adds a certain amount of indentation to the new line so the
783 user doesn't always have to indent each line manually.
785 Geany has four types of auto-indentation:
788 Disables auto-indentation completely.
790 Adds the same amount of whitespace on a new line as on the last line.
792 Does the same as *Basic* but also indents a new line after an opening
793 brace '{', and de-indents when typing a closing brace '}'. For Python,
794 a new line will be indented after typing ':' at the end of the
797 Similar to *Current chars* but the closing brace will be aligned to
798 match the indentation of the line with the opening brace.
804 Geany provides a handy bookmarking feature that lets you mark one
805 or more lines in a document, and return the cursor to them using a
808 To place a mark on a line, either left-mouse-click in the left margin
809 of the editor window, or else use Ctrl-m. This will
810 produce a small green plus symbol in the margin. You can have as many
811 marks in a document as you like. Click again (or use Ctrl-m again)
812 to remove the bookmark. To remove all the marks in a given document,
813 use "Remove Markers" in the Document menu.
815 To navigate down your document, jumping from one mark to the next,
816 use Ctrl-. (control period). To go in the opposite direction on
817 the page, use Ctrl-, (control comma). Using the bookmarking feature
818 together with the commands to switch from one editor tab to another
819 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
820 navigate around multiple files.
823 Code navigation history
824 ^^^^^^^^^^^^^^^^^^^^^^^
826 To ease navigation in source files and especially between
827 different files, Geany lets you jump between different navigation
828 points. Currently, this works for the following:
830 * `Go to tag declaration`_
831 * `Go to tag definition`_
836 When using one of these actions, Geany remembers your current position
837 and jumps to the new one. If you decide to go back to your previous
838 position in the file, just use "Navigate back a location". To
839 get back to the new position again, just use "Navigate forward a
840 location". This makes it easier to navigate in e.g. foreign code
841 and between different files.
844 Sending text through custom commands
845 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
847 You can define several custom commands in Geany and send the current
848 selection to one of these commands using the "Edit->Format->Send
849 Selection to" menu or keybindings.
850 The output of the command will be
851 used to replace the current selection. This makes it possible to use text
852 formatting tools with Geany in a general way. The selected text will
853 be sent to the standard input of the executed command, so the command
854 should be able to read from it and it should print all results to its
855 standard output which will be read by Geany. To help finding errors
856 in executing the command, the output of the program's standard error
857 will be printed on Geany's standard output.
859 To add a custom command, just go to the Set Custom Commands dialog
860 in the Format sub menu of the Edit and Popup menu. Then click on Add
861 to get a new text entry and type the command. You can also specify
862 some command line options. To delete a command, just clear the text
863 entry and press OK. It will be deleted automatically.
869 You can execute the context action command on the current word at the
870 cursor position or the available selection. This word or selection
871 can be used as an argument to the command.
872 The context action is invoked by a menu entry in the popup menu of the
873 editor and also a keyboard shortcut (see the section called
876 The command can be specified in the preferences dialog and also for
877 each filetype (see "context_action_cmd" in the section called
878 `Format`_). When the context action is invoked, the filetype
879 specific command is used if available, otherwise the command
880 specified in the preferences dialog is executed.
882 The current word or selection can be referred with the wildcard "%s"
883 in the command, it will be replaced by the current word or
884 selection before the command is executed.
886 For example a context action can be used to open API documentation
887 in a browser window, the command to open the PHP API documentation
890 firefox "http://www.php.net/%s"
892 when executing the command, the %s is substituted by the word near
893 the cursor position or by the current selection. If the cursor is at
894 the word "echo", a browser window will open(assumed your browser is
895 called firefox) and it will open the address: http://www.php.net/echo.
901 Geany can offer a list of possible completions for symbols defined in the
902 tags and for all words in a document.
904 The autocompletion list for symbols is presented when the first few
905 characters of the symbol are typed (configurable, see `Editor Completions
906 preferences`_, default 4) or when the *Complete word*
907 keybinding is pressed (configurable, see `Editor keybindings`_,
910 When the defined keybinding is typed and the *Autocomplete all words in
911 document* preference (in `Editor Completions preferences`_)
912 is selected then the autocompletion list will show all matching words
913 in the document, if there are no matching symbols.
915 If you don't want to use autocompletion it can be dismissed until
916 the next symbol by pressing Escape. The autocompletion list is updated
917 as more characters are typed so that it only shows completions that start
918 with the characters typed so far. If no symbols begin with the sequence,
919 the autocompletion window is closed.
921 The up and down arrows will move the selected item. The highlighted
922 item on the autocompletion list can be chosen from the list by pressing
923 Enter/Return. You can also double-click to select an item. The sequence
924 will be completed to match the chosen item, and if the *Drop rest of
925 word on completion* preference is set (in `Editor Completions
926 preferences`_) then any characters after the cursor that match
927 a symbol or word are deleted.
931 By default, pressing Tab will complete the selected item by word part;
932 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
937 * gtk_combo_box_<e><TAB>
938 * gtk_combo_box_entry_<s><ENTER>
939 * gtk_combo_box_entry_set_text_column
941 The key combination can be changed from Tab - See `Editor keybindings`_.
942 If you clear/change the key combination for word part completion, Tab
943 will complete the whole word instead, like Enter.
955 When you type ``foo.`` it will show an autocompletion list with 'i' and
958 It only works for languages that set parent scope names for e.g. struct
959 members. Currently this means C-like languages. The C tag parser only
960 parses global scopes, so this won't work for structs or objects declared
964 User-definable snippets
965 ^^^^^^^^^^^^^^^^^^^^^^^
967 Snippets are small strings or code constructs which can be replaced or
968 completed to a more complex string. So you can save a lot of time when
969 typing common strings and letting Geany do the work for you.
970 To know what to complete or replace Geany reads a configuration file
971 called ``snippets.conf`` at startup.
973 Maybe you need to often type your name, so define a snippet like this::
978 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
979 with "Enrico Tröger". The key to start autocompletion can be changed
980 in the preferences dialog, by default it is TAB. The corresponding keybinding
981 is called ``Complete snippet``.
983 The system-wide configuration file can be found in
984 ``$prefix/share/geany``, where ``$prefix`` is the path where Geany is
985 installed (see `Installation prefix`_). It is not recommended to edit the
986 system-wide file, because it will be overridden when Geany is updated.
988 To change the settings, copy the file from ``$prefix/share/geany``
989 in your configuration directory (usually ``~/.config/geany/``).
993 % cp /usr/local/share/geany/snippets.conf /home/username/.config/geany/
995 Then you can edit the file and the changes will remain available
996 after an update of Geany because the file resides in your
997 configuration directory. Alternatively, you can create a file
998 ``~/.config/geany/snippets.conf`` and add only these settings you want
999 to change. All missing settings will be read from the global snippets
1000 file in ``$prefix/share/geany``.
1002 The file ``snippets.conf`` contains sections defining snippets that
1003 are available for particular filetypes and in general.
1005 The two sections "Default" and "Special" apply to all filetypes.
1006 "Default" contains all snippets which are available for every
1007 filetype and "Special" contains snippets which can only be used in
1008 other snippets. So you can define often used parts of snippets and
1009 just use the special snippet as a placeholder (see the
1010 ``snippets.conf`` for details).
1012 You can define sections with the name of a filetype eg "C++". The
1013 snippets in that section are only available for use in files with that
1014 filetype. Snippets in filetype sections will hide snippets with the
1015 same name in the "Default" section when used in a file of that
1018 To define snippets you can use several special character sequences which
1019 will be replaced when using the snippet:
1021 **Substitution Sequences for snippets**
1023 ================ =========================================================
1024 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1025 char(s): LF, CR/LF, or CR).
1027 \\t or %ws% Insert an indentation step, it will be replaced according
1028 to the current document's indent mode.
1030 \\s \\s to force whitespace at beginning or end of a value
1031 ('key= value' won't work, use 'key=\\svalue')
1033 %cursor% Place the cursor at this position after completion has
1034 been done. You can define multiple %cursor% wildcards
1035 and use the keybinding ``Move cursor in snippet`` to jump
1036 to the next defined cursor position in the completed
1039 %...% "..." means the name of a key in the "Special" section.
1040 If you have defined a key "brace_open" in the "Special"
1041 section you can use %brace_open% in any other snippet.
1042 ================ =========================================================
1044 Snippet names must not contain spaces otherwise they won't
1045 work correctly. But beside that you can define almost any
1046 string as a snippet and use it later in Geany. It is not limited
1047 to existing contructs of certain programming languages(like ``if``,
1048 ``for``, ``switch``). Define whatever you need.
1050 Since Geany 0.15 you can also use most of the available templates wildcards
1051 listed in `Template wildcards`_. All wildcards which are listed as
1052 `available in snippets` can be used. For instance to improve the above example::
1055 myname=My name is {developer}
1056 mysystem=My system: {command:uname -a}
1058 this will replace ``myname`` with "My name is " and the value of the template
1059 preference ``developer``.
1061 You can change the way Geany recognizes the word to complete,
1062 that is how the start and end of a word is recognised when the
1063 snippet completion is requested. The section "Special" may
1064 contain a key "wordchars" which lists all characters a string may contain
1065 to be recognized as a word for completion. Leave it commented to use
1066 default characters or define it to add or remove characters to fit your
1070 Inserting Unicode characters
1071 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1073 With GTK 2.10 and above, you can insert Unicode code points by hitting
1074 Ctrl-Shift-u, then still holding Ctrl-Shift, type some hex digits representing
1075 the code point for the character you want and hit Enter or Return (still
1076 holding Ctrl-Shift). If you release Ctrl-Shift before hitting Enter or Return
1077 (or any other character), the code insertion is completed, but the typed
1078 character is also entered. In the case of Enter/Return, it is a newline, as
1082 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1083 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1084 or restart Geany. Note that it works slightly differently from other GTK
1085 applications, in that you'll need to continue to hold down the Ctrl and Shift
1086 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1088 For GTK < 2.10, it is also possible, but typing the first Ctrl-Shift-u
1089 is not necessary. One problem is that you may find the alphabetic
1090 keys conflict with other Geany keybindings.
1094 Search, replace and go to
1095 -------------------------
1097 This section describes search-related commands from the Search menu
1098 and the editor window's popup menu:
1104 * Go to tag definition \*
1105 * Go to tag declaration \*
1108 \* These items are available from the editor window's popup menu, or by
1109 using a keyboard shortcut (see `Search keybindings`_).
1113 There are also two toolbar entries:
1118 There are keybindings to focus each of these - see `Focus
1119 keybindings`_. Pressing Escape will then focus the editor.
1123 The quickest way to find some text is to use the search bar entry in
1124 the toolbar. This performs a case-insensitive search in the current
1125 document whilst you type. Pressing Enter will search again.
1130 The Find dialog is used for finding text in one or more open documents.
1132 .. image:: ./images/find_dialog.png
1138 The syntax for the *Use regular expressions* option is shown in
1139 `Regular expressions`_.
1142 *Use escape sequences* is implied for regular expressions.
1144 The *Use escape sequences* option will transform any escaped characters
1145 into their UTF-8 equivalent. For example, \\t will be transformed into
1146 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1147 (Unicode characters).
1153 To find all matches, click on the Find All expander. This will reveal
1160 Find All In Document will show a list of matching lines in the
1161 current document in the Messages tab of the Message Window. *Find All
1162 In Session* does the same for all open documents.
1164 Mark will highlight all matches in the current document with a
1165 colored box. These markers can be removed by selecting the
1166 Remove Markers command from the Document menu.
1169 Change font in search dialog text fields
1170 ````````````````````````````````````````
1172 All search related dialogs use a Monospace for the text input fields to
1173 increase the readability of input text. This is useful when you are
1174 typing input such as regular expressions with spaces, periods and commas which
1175 might it hard to read with a proportional font.
1177 If you want to change the font, you can do this easily
1178 by inserting the following style into your ``.gtkrc-2.0``
1179 (usually found in your home directory on UNIX-like systems and in the
1180 etc subdirectory of your Geany installation on Windows)::
1182 style "search_style"
1184 font_name="Monospace 8"
1186 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1188 Please note the addition of ":highest" in the last line which sets the priority
1189 of this style to the highest available. Otherwise, the style is ignored
1190 for the search dialogs.
1196 Find usage searches all open files. It is similar to the Find All In
1197 Session option in the Find dialog.
1199 If there is a selection, then it is used as the search text; otherwise
1200 the current word is used. The current word is either taken from the
1201 word nearest the edit cursor, or the word underneath the popup menu
1202 click position when the popup menu is used. The search results are
1203 shown in the Messages tab of the Message Window.
1209 Find in files is a more powerful version of Find usage that searches
1210 all files in a certain directory using the Grep tool. The Grep tool
1211 must be correctly set in Preferences to the path of the system's Grep
1212 utility. GNU Grep is recommended.
1214 .. image:: ./images/find_in_files_dialog.png
1217 The Encoding combo box can be used to define the encoding of the files
1218 to be searched. The entered search text is converted to the chosen encoding
1219 and the search results are converted back to UTF-8.
1220 The Extra options field is used to pass any additional arguments to
1224 Filtering out version control files
1225 ```````````````````````````````````
1227 When using the *Recurse in subfolders* option with a directory that's
1228 under version control, you can set the *Extra options* field to use
1229 grep's ``--exclude`` flag to filter out filenames.
1231 SVN Example: ``--exclude=*.svn-base``
1233 The --exclude argument only matches the file name part, not the path. If
1234 you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir`` argument to
1235 filter out CVS and hidden directories like ``.svn``.
1237 Example: ``--exclude-dir=.* --exclude-dir=CVS``
1243 The Replace dialog is used for replacing text in one or more open
1246 .. image:: ./images/replace_dialog.png
1248 The Replace dialog has the same options for matching text as the Find
1249 dialog. See the section `Matching options`_.
1251 The *Use regular expressions* option allows regular expressions to
1252 be used in the search string and back references in the replacement
1253 text -- see the entry for '\\n' in `Regular expressions`_.
1258 To replace several matches, click on the *Replace All* expander. This
1259 will reveal several options:
1265 *Replace All In Document* will replace all matching text in the
1266 current document. *Replace All In Session* does the same for all open
1267 documents. *Replace All In Selection* will replace all matching text
1268 in the current selection of the current document.
1271 Go to tag definition
1272 ^^^^^^^^^^^^^^^^^^^^
1274 If the current word is the name of a tag definition (like a function
1275 body) and the file containing the tag definition is open, this command
1276 will switch to that file and go to the corresponding line number. The
1277 current word is either the word nearest the edit cursor,
1278 or the word underneath the popup menu click position when the popup
1282 Go to tag declaration
1283 ^^^^^^^^^^^^^^^^^^^^^
1285 Like Go to tag definition, but for a forward declaration such as a
1286 function prototype or ``extern`` declaration instead of a function
1293 Go to a particular line number in the current file.
1299 You can use regular expressions in the Find and Replace dialogs
1300 by selecting the *Use regular expressions* check box (see `Matching
1301 options`_). The syntax is POSIX compatible, as described in the table
1305 1. The *Use escape sequences* dialog option always applies for regular
1307 2. Searching backwards with regular expressions is not supported.
1308 3. \\b, \\d, \\s, \\w are GNU extensions and may not be available
1309 on non-GNU POSIX systems unless you built Geany with the
1310 ``--enable-gnu-regex`` option (this is always used on Windows).
1312 **In a regular expression, the following characters are interpreted:**
1314 ======= ============================================================
1315 . Matches any character.
1317 ( This marks the start of a region for tagging a match.
1319 ) This marks the end of a tagged region.
1321 \\n Where n is 1 through 9 refers to the first through ninth tagged
1322 region when searching or replacing.
1324 Searching for (Wiki)\\1 matches WikiWiki.
1326 If the search string was Fred([1-9])XXX and the
1327 replace string was Sam\\1YYY, when applied to Fred2XXX this
1328 would generate Sam2YYY.
1330 \\0 When replacing, the whole matching text.
1332 \\b This matches a word boundary.
1334 \\c A backslash followed by d, D, s, S, w or W, becomes a
1335 character class (both inside and outside sets []).
1338 * D: any char except decimal digits
1339 * s: whitespace (space, \\t \\n \\r \\f \\v)
1340 * S: any char except whitespace (see above)
1341 * w: alphanumeric & underscore
1342 * W: any char except alphanumeric & underscore
1344 \\x This allows you to use a character x that would otherwise have
1345 a special meaning. For example, \\[ would be interpreted as [
1346 and not as the start of a character set. Use \\\\ for a literal
1349 [...] Matches one of the characters in the set. If the first
1350 character in the set is ^, it matches the characters NOT in
1351 the set, i.e. complements the set. A shorthand S-E (start
1352 dash end) is used to specify a set of characters S up to E,
1355 The special characters ] and - have no special
1356 meaning if they appear first in the set. - can also be last
1357 in the set. To include both, put ] first: []A-Z-].
1361 []|-] matches these 3 chars
1362 []-|] matches from ] to | chars
1363 [a-z] any lowercase alpha
1364 [^]-] any char except - and ]
1365 [^A-Z] any char except uppercase alpha
1368 ^ This matches the start of a line (unless used inside a set, see
1371 $ This matches the end of a line.
1373 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1374 Saam, Saaam and so on.
1376 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1377 Saam, Saaam and so on.
1379 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1380 ======= ============================================================
1383 This table is adapted from Scintilla and SciTE documentation,
1384 distributed under the `License for Scintilla and SciTE`_.
1391 Tags are information that relates symbols in a program with the
1392 source file location of the declaration and definition.
1394 Geany has built-in functionality for generating tag information (aka
1395 "workspace tags") for supported filetypes when you open a file. You
1396 can also have Geany automatically load external tag files (aka "global
1397 tags files") upon startup, or manually using *Tools --> Load Tags*.
1399 Geany uses its own tag file format, similar to what ``ctags`` uses
1400 (but is incompatible with ctags). You use Geany to generate global
1401 tags files, as described below.
1407 Tags for each document are parsed whenever a file is loaded or
1408 saved. These are shown in the Symbol list in the Sidebar. These tags
1409 are also used for autocompletion of symbols and calltips for all documents
1410 open in the current session that have the same filetype.
1412 The *Go to Tag* commands can be used with all workspace tags. See
1413 `Go to tag definition`_.
1419 Global tags are used to provide autocompletion of symbols and calltips
1420 without having to open the corresponding source files. This is intended
1421 for library APIs, as the tags file only has to be updated when you upgrade
1424 You can load a custom global tags file in two ways:
1426 * Using the *Load Tags* command in the Tools menu.
1427 * By creating a directory ``~/.config/geany/tags``, and moving or symlinking
1428 the tags files there before starting Geany.
1429 * By creating a directory ``$prefix/share/geany/tags``, and moving
1430 or symlinking the tags files there before starting Geany.
1431 ``$prefix`` is the installation prefix (see `Installation prefix`_).
1433 You can either download these files or generate your own. They have
1438 *lang_ext* is one of the extensions set for the filetype associated
1439 with the tags. See the section called `Filetype extensions`_ for
1443 Default global tags files
1444 `````````````````````````
1446 For some languages, a list of global tags is loaded when the
1447 corresponding filetype is first used. Currently these are for:
1449 * C -- GTK+ and GLib
1452 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1457 Global tags file format
1458 ```````````````````````
1460 Global tags files can have two different formats:
1463 * Pipe-separated format
1465 The first line of global tags files should be a comment, introduced
1466 by ``#`` followed by a space and a string like ``format=pipe``
1467 or ``format=tagmanager`` respectively, these are case-sensitive.
1468 This helps Geany to read the file properly. If this line
1469 is missing, Geany tries to auto-detect the used format but this
1473 The Tagmanager format is a bit more complex and is used for files
1474 created by the ``geany -g`` command. There is one tag per line.
1475 Different tag attributes like the return value or the argument list
1476 are separated with different characters indicating the type of the
1479 The Pipe-separated format is easier to read and write.
1480 There is one tag per line and different tag attributes are separated
1481 by the pipe character (``|``). A line looks like::
1483 basename|string|(string path [, string suffix])|
1485 | The first field is the tag name (usually a function name).
1486 | The second field is the type of the return value.
1487 | The third field is the argument list for this tag.
1488 | The fourth field is the description for this tag but
1489 currently unused and should be left empty.
1491 Except for the first field (tag name), all other field can be left
1492 empty but the pipe separator must appear for them.
1494 You can easily write your own global tag files using this format.
1495 Just save them in your tags directory, as described earlier in the
1496 section `Global tags`_.
1499 Generating a global tags file
1500 `````````````````````````````
1502 You can generate your own global tags files by parsing a list of
1503 source files. The command is::
1505 geany -g [-P] <Tag File> <File list>
1507 * Tag File filename should be in the format described earlier --
1508 see the section called `Global tags`_.
1509 * File list is a list of filenames, each with a full path (unless
1510 you are generating C/C++ tags and have set the CFLAGS environment
1511 variable appropriately).
1512 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1513 to process ``#include`` directives for C/C++ source files. Use this
1514 option if you want to specify each source file on the command-line
1515 instead of using a 'master' header file. Also can be useful if you
1516 don't want to specify the CFLAGS environment variable.
1518 Example for the wxD library for the D programming language::
1520 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1523 *Generating C/C++ tag files:*
1525 For C/C++ tag files, gcc and grep are required, so that header files
1526 can be preprocessed to include any other headers they depend upon.
1528 For C/C++ files, the environment variable CFLAGS should be set with
1529 appropriate ``-I/path`` include paths. The following example works with
1530 the bash shell, generating tags for the GnomeUI library::
1532 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1533 /usr/include/libgnomeui-2.0/gnome.h
1535 You can adapt this command to use CFLAGS and header files appropriate
1536 for whichever libraries you want.
1539 *Replacing the default C/C++ tags file:*
1541 Geany currently uses a default global tags file c99.tags for
1542 C and C++, commonly installed in /usr/share/geany. This file can
1543 be replaced with one containing tags parsed from a different set
1544 of header files. When Geany is next started, your custom tags file
1545 will be loaded instead of the default c99.tags. You should keep a
1546 copy of the generated tags file because it will get overwritten when
1553 You can also ignore certain tags if they would lead to wrong parsing of
1554 the code. Simply create a file called "ignore.tags" in your Geany
1555 configuration directory (usually ``~/.config/geany/``). Then list all tags
1556 you want to ignore in this file, separated by spaces and/or newlines.
1558 More detailed information about the usage from the Exuberant Ctags
1561 Specifies a list of identifiers which are to be specially handled
1562 while parsing C and C++ source files. This option is specifically
1563 provided to handle special cases arising through the use of
1564 pre-processor macros. When the identifiers listed are simple identifiers,
1565 these identifiers will be ignored during parsing of the source files.
1566 If an identifier is suffixed with a '+' character, ctags will also
1567 ignore any parenthesis-enclosed argument list which may immediately
1568 follow the identifier in the source files.
1569 If two identifiers are separated with the '=' character, the first
1570 identifiers is replaced by the second identifiers for parsing purposes.
1572 For even more detailed information please read the manual page of
1579 You may adjust Geany's settings using the Edit --> Preferences
1580 dialog. Any changes you make there can be applied by hitting either
1581 the Apply or the OK button. These settings will persist between Geany
1582 sessions. Note that most settings here have descriptive popup bubble
1583 help -- just hover the mouse over the item in question to get help
1586 You may also adjust some View settings (under the View menu) that
1587 persist between Geany sessions. The settings under the Document menu,
1588 however, are only for the current document and revert to defaults
1589 when restarting Geany.
1591 There are also some rarer `Hidden preferences`_.
1594 In the paragraphs that follow, the text describing a dialog tab
1595 comes after the screenshot of that tab.
1598 General Startup preferences
1599 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1601 .. image:: ./images/pref_dialog_gen_startup.png
1606 Load files from the last session
1607 On startup, load the same files you had open the last time you
1610 Load virtual terminal support
1611 Load the library for running a terminal in the message window area.
1613 Enable plugin support
1614 Allow plugins to be used in Geany.
1618 Save window position and geometry
1619 Save the current position and size of the main window so next time
1620 you open Geany it's in the same location.
1623 Have a dialog pop up to confirm that you really want to quit Geany.
1629 Path to start in when opening or saving files.
1630 It must be an absolute path.
1631 Leave it blank to use the current working directory.
1634 Path to start in when opening project files.
1637 By default Geany looks in the global installation path and in the
1638 configuration directory. In addition the path entered here will be searched
1639 for plugins. Usually you do not need to set an additional path to search for
1640 plugins. It might be useful when Geany is installed on a multi-user machine
1641 and additional plugins are available in a common location for all users.
1642 Leave blank to not set an additional lookup path.
1645 General Miscellaneous preferences
1646 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1648 .. image:: ./images/pref_dialog_gen_misc.png
1653 Beep on errors when compilation has finished
1654 Have the computer make a beeping sound when compilation of your program
1655 has completed or any errors occurred.
1657 Switch status message list at new message
1658 Switch to the status message tab (in the notebook window at the bottom)
1659 once a new status message arrives.
1661 Suppress status messages in the status bar
1662 Remove all messages from the status bar. The messages are still displayed
1663 in the status messages window.
1666 Another option is to use the *Switch to Editor* keybinding - it
1667 reshows the document statistics on the status bar. See `Focus
1670 Auto-focus widgets (focus follows mouse)
1671 Give the focus automatically to widgets below the mouse cursor.
1672 This works for the main editor widget, the scribble, the toolbar search field
1673 goto line fields and the VTE.
1678 Always wrap search and hide the Find dialog
1679 Always wrap search around the document and hide the Find dialog after clicking
1682 Use the current word under the cursor for Find dialogs
1683 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1684 there is no selection. When this option is disabled, the search term last used in the
1685 appropriate Find dialog is used.
1687 Use the current file's directory for Find in Files
1688 When opening the Find in Files dialog, set the directory to search to the directory of the current
1689 active file. When this option is disabled, the directory of the last use of the Find in Files
1695 Use project-based session files
1696 Save your current session when closing projects. You will be able to
1697 resume different project sessions, automatically opening the files
1698 you had open previously.
1700 Store project file inside the project base directory
1701 When creating new projects, the default path for the project file contains
1702 the project base path. Without this option enabled, the default project file
1703 path is one level above the project base path.
1704 In either case, you can easily set the final project file path in the
1705 *New Project* dialog. This option provides the more common
1706 defaults automatically for convenience.
1709 Interface preferences
1710 ^^^^^^^^^^^^^^^^^^^^^
1712 .. image:: ./images/pref_dialog_interface.png
1718 Whether to show the sidebar at all.
1721 Show the list of functions, variables, and other information in the
1722 current document you are editing.
1725 Show all the documents you have open currently. This can be used to
1726 change between documents (see `Switching between documents`_) and
1727 to perform some common operations such as saving, closing and reloading.
1730 Whether to place the sidebar on the left or right of the editor window.
1736 Change the font used to display documents.
1739 Change the font used for the Symbols sidebar tab.
1742 Change the font used for the message window area.
1748 Show a notebook tab for all documents so you can switch between them
1749 using the mouse (instead of using the Documents window).
1752 Make each tab show a close button so you can easily close open
1755 Placement of new file tabs
1756 Whether to create a document with its notebook tab to the left or
1757 right of all existing tabs.
1759 Double-clicking hides all additional widgets
1760 Whether to call the View->Toggle All Additional Widgets command
1761 when double-clicking on a notebook tab.
1767 Set the positioning of the editor's notebook tabs to the right,
1768 left, top, or bottom of the editing window.
1771 Set the positioning of the sidebar's notebook tabs to the right,
1772 left, top, or bottom of the sidebar window.
1775 Set the positioning of the message window's notebook tabs to the
1776 right, left, top, or bottom of the message window.
1782 Show the status bar at the bottom of the main window. It gives information about
1783 the file you are editing like the line and column you are on, whether any
1784 modifications were done, the file encoding, the filetype and other information.
1790 Affects the main toolbar underneath the menu bar.
1792 .. image:: ./images/pref_dialog_toolbar.png
1798 Whether to show the toolbar.
1800 Append Toolbar to the Menu
1801 Allows to append the toolbar to the main menu bar instead of placing it below.
1802 This is useful to save vertical space.
1805 See `Customizing the toolbar`_.
1811 Select the toolbar icon style to use - either icons and text, just
1813 The choice System default uses whatever icon style is set by GTK.
1816 Select the size of the icons you see (large, small or very small).
1817 The choice System default uses whatever icon size is set by GTK.
1820 Editor Features preferences
1821 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1823 .. image:: ./images/pref_dialog_edit_features.png
1829 Show long lines wrapped around to new display lines.
1831 Enable "smart" home key
1832 Whether to move the cursor to the first non-whitespace character
1833 on the line when you hit the home key on your keyboard. Pressing it
1834 again will go to the very start of the line.
1836 Disable Drag and Drop
1837 Do not allow the dragging and dropping of selected text in documents.
1840 Allow groups of lines in a document to be collapsed for easier
1843 Fold/Unfold all children of a fold point
1844 Whether to fold/unfold all child fold points when a parent line
1847 Use indicators to show compile errors
1848 Underline lines with compile errors using red squiggles to indicate
1849 them in the editor area.
1851 Newline strip trailing spaces
1852 Remove any white space at the end of the line when you hit the
1855 Line breaking column
1856 The editor column number to insert a newline at when Line Breaking
1857 is enabled for the current document.
1859 Comment toggle marker
1860 A string which is added when toggling a line comment in a source file.
1861 It is used to mark the comment as toggled.
1864 Editor Indentation preferences
1865 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1867 .. image:: ./images/pref_dialog_edit_indentation.png
1872 See `Indentation`_ for more information.
1875 When Geany inserts indentation, whether to use:
1879 * Tabs and Spaces, depending on how much indentation is on a line
1881 The *Tabs and Spaces* indent type is also known as *Soft tab
1882 support* in some other editors.
1885 The width of a single indent size in spaces. By default the indent
1886 size is equivalent to 4 spaces.
1889 When the *Tabs and Spaces* indent type is enabled, this is the
1890 display size of a tab. Otherwise this is ignored. Although
1891 configurable, this should usually be set to 8.
1894 Try to detect and set the indent type based on file content, when
1898 The type of auto-indentation you wish to use after pressing Enter,
1902 Just add the indentation of the previous line.
1904 Add indentation based on the current filetype and any characters at
1905 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
1907 Like *Current chars* but for C-like languages, make a closing
1908 ``}`` brace line up with the matching opening brace.
1911 If set, pressing tab will indent the current line or selection, and
1912 unindent when pressing Shift-tab. Otherwise, the tab key will
1913 insert a tab character into the document (which can be different
1914 from indentation, depending on the indent type).
1917 There are also separate configurable keybindings for indent &
1918 unindent, but this preference allows the tab key to have different
1919 meanings in different contexts - e.g. for snippet completion.
1921 Editor Completions preferences
1922 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1924 .. image:: ./images/pref_dialog_edit_completions.png
1930 Whether to replace special keywords after typing Tab into a
1931 pre-defined text snippet.
1932 See `User-definable snippets`_.
1934 XML tag autocompletion
1935 When you open an XML tag automatically generate its completion tag.
1937 Automatic continuation multi-line comments
1938 Continue automatically multi-line comments in languages like C, C++
1939 and Java when a new line is entered inside such a comment.
1940 With this option enabled, Geany will insert a ``*`` on every new line
1941 inside a multi-line comment, for example when you press return in the
1945 * This is a C multi-line comment, press <Return>
1947 then Geany would insert::
1951 on the next line with the correct indentation based on the previous line,
1952 as long as the multi-line is not closed by ``*/``.
1954 Autocomplete symbols
1955 When you start to type a symbol name, look for the full string to
1956 allow it to be completed for you.
1958 Autocomplete all words in document
1959 When you start to type a word, Geany will search the whole document for
1960 words starting with the typed part to complete it, assuming there
1961 are no tag names to show.
1963 Drop rest of word on completion
1964 Remove any word part to the right of the cursor when choosing a
1965 completion list item.
1967 Characters to type for autocompletion
1968 Number of characters of a word to type before autocompletion is
1971 Completion list height
1972 The number of rows to display for the autocompletion window.
1974 Max. symbol name suggestions
1975 The maximum number of items in the autocompletion list.
1978 Auto-close quotes and brackets
1979 ``````````````````````````````
1981 Geany can automatically insert a closing bracket and quote characters when
1982 you open them. For instance, you type a ``(`` and Geany will automatically
1983 insert ``)``. With the following options, you can define for which
1984 characters this should work.
1987 Auto-close parenthesis when typing an opening one
1990 Auto-close curly brackets (braces) when typing an opening one
1993 Auto-close square brackets when typing an opening one
1996 Auto-close single quotes when typing an opening one
1999 Auto-close double quotes when typing an opening one
2002 Editor Display preferences
2003 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2005 This is for visual elements displayed in the editor window.
2007 .. image:: ./images/pref_dialog_edit_display.png
2012 Invert syntax highlighting colors
2013 Invert all colors, by default this makes white text on a black
2016 Show indendation guides
2017 Show vertical lines to help show how much leading indentation there
2021 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2022 show which kinds of whitespace are used.
2025 Display a symbol everywhere that a carriage return or line feed
2029 Show or hide the Line Number margin.
2032 Show or hide the small margin right of the line numbers, which is used
2035 Stop scrolling at last line
2036 When enabled Geany stops scrolling when at the last line of the document.
2037 Otherwise you can scroll one more page even if there are no real lines.
2043 The long line marker helps to indicate overly-long lines, or as a hint
2044 to the user for when to break the line.
2048 Show a thin vertical line in the editor window at the given column
2051 Change the background color of characters after the given column
2052 position to the color set below. (This is recommended over the
2053 *Line* setting if you use proportional fonts).
2055 Don't mark long lines at all.
2058 Set this value to a value greater than zero to specify the column
2059 where it should appear.
2061 Long line marker color
2062 Set the color of the long line marker.
2068 Virtual space is space beyond the end of each line.
2069 The cursor may be moved into virtual space but no real space will be
2070 added to the document until there is some text typed or some other
2071 text insertion command is used.
2074 Do not show virtual spaces
2076 Only for rectangular selections
2077 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2080 Always show virtual spaces beyond the end of lines
2086 .. image:: ./images/pref_dialog_files.png
2091 Open new documents from the command-line
2092 Whether to create new documents when passing filenames that don't
2093 exist from the command-line.
2095 Default encoding (new files)
2096 The type of file encoding you wish to use when creating files.
2098 Used fixed encoding when opening files
2099 Assume all files you are opening are using the type of encoding specified below.
2101 Default encoding (existing files)
2102 Opens all files with the specified encoding instead of auto-detecting it.
2103 Use this option when it's not possible for Geany to detect the exact encoding.
2105 Default end of line characters
2106 The end of line characters to which should be used for new files.
2107 On Windows systems, you generally want to use CR/LF which are the common
2108 characters to mark line breaks.
2109 On Unix-like systems, LF is default and CR is used on MAC systems.
2113 Perform formatting operations when a document is saved. These
2114 can each be undone with the Undo command.
2116 Ensure newline at file end
2117 Add a newline at the end of the document if one is missing.
2119 Strip trailing spaces
2120 Remove the trailing spaces on each line of the document.
2122 Replace tabs by space
2123 Replace all tabs in the document with the equivalent number of spaces.
2126 It is better to use spaces to indent than use this preference - see
2132 Recent files list length
2133 The number of files to remember in the recently used files list.
2136 The number of seconds to periodically check the current document's
2137 file on disk in case it has changed. Setting it to 0 will disable
2141 These checks are only performed on local files. Remote files are
2142 not checked for changes due to performance issues
2143 (remote files are files in ``~/.gvfs/``).
2149 .. image:: ./images/pref_dialog_tools.png
2155 The location of your terminal executable.
2158 The location of your web browser executable.
2161 The location of the grep executable.
2164 For Windows users: at the time of writing it is recommended to use
2165 the grep.exe from the UnxUtils project
2166 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2167 Mingw project for instance might not work with Geany at the moment.
2173 Set this to a command to execute on the current word.
2174 You can use the "%s" wildcard to pass the current word below the cursor
2175 to the specified command.
2178 Template preferences
2179 ^^^^^^^^^^^^^^^^^^^^
2181 This data is used as meta data for various template text to insert into
2182 a document, such as the file header. You only need to set fields that
2183 you want to use in your template files.
2186 For changes made here to take effect, either selecting
2187 *Tools->Reload Configuration* or restarting Geany is required.
2189 .. image:: ./images/pref_dialog_templ.png
2195 The name of the developer who will be creating files.
2198 The initials of the developer.
2201 The email address of the developer.
2204 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2207 The company the developer is working for.
2210 The initial version of files you will be creating.
2213 Specify a format for the the {year} wildcard. You can use any conversion specifiers
2214 which can be used with the ANSI C strftime function. For details please see
2215 http://man.cx/strftime.
2218 Specify a format for the the {date} wildcard. You can use any conversion specifiers
2219 which can be used with the ANSI C strftime function. For details please see
2220 http://man.cx/strftime.
2223 Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
2224 which can be used with the ANSI C strftime function. For details please see
2225 http://man.cx/strftime.
2228 Keybinding preferences
2229 ^^^^^^^^^^^^^^^^^^^^^^
2231 .. image:: ./images/pref_dialog_keys.png
2233 There are some commands listed in the keybinding dialog that are not, by default,
2234 bound to a key combination, and may not be available as a menu item.
2237 For more information see the section `Keybindings`_.
2240 Printing preferences
2241 ^^^^^^^^^^^^^^^^^^^^
2243 .. image:: ./images/pref_dialog_printing.png
2245 Use external command for printing
2246 Use a system command to print your file out.
2248 Use native GTK printing
2249 Let the GTK GUI toolkit handle your print request.
2252 Print the line numbers on the left of your paper.
2255 Print the page number on the bottom right of your paper.
2258 Print a header on every page that is sent to the printer.
2260 Use base name of the printed file
2261 Don't use the entire path for the header, only the filename.
2264 How the date should be printed. You can use the same format
2265 specifiers as in the ANSI C function strftime(). For details please
2266 see http://man.cx/strftime.
2269 Terminal (VTE) preferences
2270 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2272 See also: `Virtual terminal emulator widget (VTE)`_.
2274 .. image:: ./images/pref_dialog_vte.png
2280 Select the font that will be used in the terminal emulation control.
2283 Select the font color.
2286 Select the background color of the terminal.
2289 The number of lines buffered so that you can scroll though the history.
2292 The location of the shell on your system.
2295 Scroll the terminal to the prompt line when pressing a key.
2298 Scroll the output down.
2301 Let the terminal cursor blink.
2303 Override Geany keybindings
2304 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2306 Disable menu shortcut key (F10 by default)
2307 Disable the menu shortcut when you are in the virtual terminal.
2309 Follow path of the current file
2310 Make the path of the terminal change according to the path of the
2313 Execute programs in VTE
2314 Execute programs in the virtual terminal instead of using the external
2315 terminal tool. Note that if you run multiple execute commands at once
2316 the output may become mixed together in the VTE.
2318 Don't use run script
2319 Don't use the simple run script which is usually used to display
2320 the exit status of the executed program.
2321 This can be useful if you already have a program running in the VTE
2322 like a Python console (e.g. ipython). Use this with care.
2328 Project Management is optional in Geany. Currently it can be used for:
2330 * Storing and opening session files on a project basis.
2331 * Configuring the Build menu on a project basis.
2333 A list of session files can be stored and opened with the project
2334 when the *Use project-based session files* preference is enabled,
2335 in the *Project* group of the `Preferences`_ dialog.
2337 As long as a project is open, the Build menu will use
2338 the items defined in project's settings, instead of the defaults.
2339 See `Build Menu Configuration`_ for information on configuring the menu.
2341 The current project's settings are saved when it is closed, or when
2342 Geany is shutdown. When restarting Geany, the previously opened project
2343 file that was in use at the end of the last session will be reopened.
2345 The project menu items are detailed below.
2351 To create a new project, fill in the *Name* field. By default this
2352 will setup a new project file ``~/projects/name.geany``. Usually it's
2353 best to store all your project files in the same directory (they are
2354 independent of any source directory trees).
2356 The Base path text field is setup to use ``~/projects/name``. This
2357 can safely be set to any existing path -- it will not touch the file
2358 structure contained in it.
2364 You can set an optional description for the project, but it is not
2365 used elsewhere by Geany.
2367 The *Base path* field is used as the directory to run the Build menu commands.
2368 The specified path can be an absolute path or it is considered to be
2369 relative to the project's file name.
2372 Set Base Path Button
2373 ````````````````````
2375 This button is a convenience to set the working directory fields
2376 in the non-filetype Build menu items to %p to use the project base path.
2379 Pressing the 'set' button will overright any working directories
2380 you have configured for the project.
2386 The Open command displays a standard file chooser, starting in
2387 ``~/projects``. Choose a project file named with the ``.geany``
2390 When project session support is enabled, Geany will close the currently
2391 open files and open the session files associated with the project.
2397 Project file settings are saved when the project is closed.
2399 When project session support is enabled, Geany will close the project
2400 session files and open any previously closed default session files.
2405 After editing code with Geany, the next step is to compile, link, build,
2406 interpret, run etc. As Geany supports many languages each with a different
2407 approach to such operations, and as there are also many language independant
2408 software building systems, Geany does not have a built in build system, nor
2409 does it limit which system you can use. Instead the build menu provides
2410 a configurable and flexible means of running any external commands to
2411 execute your preferred build system.
2413 This section provides a description of the default configuration of the
2414 build menu and then covers how to configure it, and where the defaults fit in.
2416 Running the commands from within Geany has two benefits:
2418 * the current file is automatically saved before the command is run
2419 * the output is captured in the Compiler notebook tab and parsed for
2422 Warnings and errors that can be parsed for line numbers will be shown in
2423 red in the Compiler tab and you can click on them to switch to the relevant
2424 source file (or open it) and mark the line number. Also lines with
2425 warnings or errors are marked in the source, see `Indicators`_ below.
2428 If Geany's default error message parsing does not parse errors for
2429 the tool you're using, you can set a custom regex in the Build Commands
2430 Dialog, see `Build Menu Configuration`_
2435 Indicators are red squiggly underlines which are used to highlight
2436 errors which occurred while compiling the current file. So you can
2437 easily see where your code failed to compile. To remove the indicators,
2438 just select "Remove all indicators" in the document file menu.
2440 If you do not like this feature, you can disable it in the preferences
2444 Default Build Menu Items
2445 ^^^^^^^^^^^^^^^^^^^^^^^^
2446 Depending on the current file's filetype, the default Build menu will contain
2447 the following items:
2452 * Make Custom Target
2457 * Set Build Menu Commands
2463 The Compile command has different uses for different kinds of files.
2465 For compilable languages such as C and C++, the Compile command is
2466 set up to compile the current source file into a binary object file.
2468 Java source files will be compiled to class file bytecode.
2470 Interpreted languages such as Perl, Python, Ruby will compile to
2471 bytecode if the language supports it, or will run a syntax check,
2472 or if that is not available will run the file in its language interpreter.
2478 For compilable languages such as C and C++, the Build command will link
2479 the current source file's equivalent object file into an executable. If
2480 the object file does not exist, the source will be compiled and linked
2481 in one step, producing just the executable binary.
2483 Interpreted languages do not use the Build command.
2489 This runs "make" in the same directory as the
2495 This is similar to running 'Make' but you will be prompted for
2496 the make target name to be passed to the Make tool. For example,
2497 typing 'clean' in the dialog prompt will run "make clean".
2503 Make object will run "make current_file.o" in the same directory as
2504 the current file, using the filename for 'current_file'. It is useful
2505 for building just the current file without building the whole project.
2510 The next error item will move to the next detected error in the file.
2514 The previous error item will move to the previous detected error in the file.
2519 Execute will run the corresponding executable file, shell script or
2520 interpreted script in a terminal window. Note that the Terminal tool
2521 path must be correctly set in the Tools tab of the Preferences dialog -
2522 you can use any terminal program that runs a Bourne compatible shell
2523 and accept the "-e" command line argument to start a command or can be
2524 selected to us the build-in VTE if it is available, see
2525 `Virtual terminal emulator widget (VTE)`_.
2527 After your program or script has finished executing, you will be
2528 prompted to press the return key. This allows you to review any text
2529 output from the program before the terminal window is closed.
2531 The execute command output is not parsed for errors.
2534 Stopping running processes
2535 ``````````````````````````
2537 When there is a running program, the Execute menu item in the menu and
2538 the Run button in the toolbar
2539 becomes a stop button and you can stop the current running program. This
2540 works by sending a signal to the process (and its child process(es))
2541 to stop the process. The signal used is SIGQUIT.
2543 Depending on the process you started it is possible that the process
2544 cannot be stopped. For example this can happen when the process creates
2545 more than one child process.
2551 Xterm is known to work properly. If you are using "Terminal"
2552 (the terminal program of Xfce), you should add the command line
2553 option ``--disable-server`` otherwise the started process cannot be
2554 stopped. Just add this option in the preferences dialog on the Tools
2555 tab in the terminal field.
2561 By default the Compile and Build commands invoke the GCC compiler and
2562 linker with only the basic arguments needed by all programs. Using
2563 Set Build Commands you can add any include paths and compile
2564 flags for the compiler, any library names and paths for the linker,
2565 and any arguments you want to use when running Execute.
2567 For details of configuration see `Build Menu Configuration`_ below.
2570 If you need complex settings for your build system, or several
2571 different settings, then writing a Makefile and using the Make
2572 commands is recommended; this will also make it easier for users to
2573 build your software.
2575 These settings are saved automatically when Geany is shut down.
2577 Build Menu Configuration
2578 ^^^^^^^^^^^^^^^^^^^^^^^^
2580 The build menu has considerable flexibility and configurability, allowing
2581 both menu labels the commands they execute and the directory they execute
2582 in to be configured.
2584 For example, if you change one of the default make commands to run say 'waf'
2585 you can also change the label to match.
2587 Underlines in the labels set mnemonic characters.
2589 The build menu is divided into four groups of items each with different
2592 * file items - are configurable and depend on the filetype of the current
2593 document, put the output in the compiler tab and parse it for errors
2594 * non-file items - are configurable and mostly don't depend on the filetype
2595 of the current document, put the output in the compiler tab and parse
2597 * execute items - are configurable and intended for executing your
2598 program or other long running programs. The output is not parsed for errors
2599 and is directed to the terminal selected in preferences.
2600 * fixed items - are not configurable because they perform the Geany built in actions,
2601 go to the next error, go to the previous error and show the build menu
2604 The maximum numbers of items in each of the configurable groups can be
2605 configured when Geany starts using hidden settings(see `Preferences File Format`_).
2606 Even though the maximum number of items may have been increased, only
2607 those menu items that have values configured are shown in the menu.
2609 The groups of menu items obtain their configuration from four potential
2610 sources. The highest pririty source that has the menu item defined will
2611 be used. The sources in decreasing priority are:
2613 * a project file if open
2614 * the user preferences
2615 * the system filetype definitions
2618 The detailed relationships between sources and the configurable menu item groups
2619 is shown in the following table.
2621 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2622 | Group | Project File | Preferences | System Filetype | Defaults |
2623 +==============+=====================+==========================+===================+===============================+
2624 | Filetype | Loads From: project | Loads From: | Loads From: | None |
2625 | | file | filetype.xxx file in | filetype.xxx in | |
2626 | | | ~/.config/geany/filedefs | Geany install | |
2627 | | Saves To: project | | | |
2628 | | file | Saves to: as above, | Saves to: as user | |
2629 | | | creating if needed. | preferences left. | |
2630 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2631 | Non-Filetype | Loads From: project | Loads From: | Loads From: | 1: |
2632 | | file | geany.conf file in | filetype.xxx in | Label: _Make |
2633 | | | ~/.config/geany | Geany install | Command: make |
2634 | | Saves To: project | | | |
2635 | | file | Saves to: as above, | Saves to: as user | 2: |
2636 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
2637 | | | | | Command: make |
2640 | | | | | Label: Make _Object |
2641 | | | | | Command: make %e.o |
2642 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2643 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute Command: ./%e |
2644 | | file or else | geany.conf file in | filetype.xxx in | |
2645 | | filetype defined in | ~/.config/geany or else | Geany install | |
2646 | | project file | filetype.xxx file in | | |
2647 | | | ~/.config/geany/filedefs | Saves To: as user | |
2648 | | Saves To: | | preferences left | |
2649 | | project file | Saves To: | | |
2650 | | | filetype.xxx file in | | |
2651 | | | ~/.config/geany/filedefs | | |
2652 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2654 The following notes on the table reference cells by coordinate as (group,source):
2656 * General - for filetype.xxx substitute the filetype name of the
2657 current document for xxx.
2659 * System Filetypes - Labels loaded from these sources are locale sensitive
2660 and can contain translations.
2662 * (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
2663 filetype file so that users can configure all other filetype preferences
2664 as well. Projects can only configure menu items per filetype. Saving
2665 in the project file means that there is only one file per project not
2668 * (Non-Filetype, System Filetype) - although conceptually strange, defining
2669 non-filetype commands in a filetype file, this provides the ability to
2670 define filetype dependent default menu items.
2672 * (Execute, Project File) and (Execute, Preferences) - the project filetype based execute
2673 configuration and preferences non-filetype based execute can only be set by hand editing the
2674 appropriate file, see `Preferences File Format`_ and `Project File Format`_.
2676 Build Menu Commands Dialog
2677 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2679 Most of the configuration of the build menu is done through the Build Menu
2680 Commands Dialog. You edit the configuration sourced from preferences in the
2681 dialog opened from the Build->Build Menu Commands item and you edit the
2682 configuration from the project in the build tab of the project preferences
2683 dialog. Both use the same form shown below.
2685 .. image:: ./images/build_menu_commands_dialog.png
2687 The dialog is divided into three sections:
2689 * Filetype menu items which will be selected based on the filetype of the
2690 currently open document,
2692 * Non-filetype menu items, and
2694 * Execute menu items.
2696 The filetype and non-filetype sections also contains a field for the regular
2697 expression used for parsing command output for error and warning messages.
2699 The columns in the first three sections allow setting of the label, command,
2700 and working directory to run the command in.
2702 An item with an empty label will not be shown in the menu.
2704 An empty working directory will default to the directory of the current document.
2705 If there is no current document then the command will not run.
2707 The dialog will always show the command selected by priority, not just the
2708 commands configured in this configuration source. This ensures that you always
2709 see what the menu item is going to do if activated.
2711 If the current source of the menu item is higher priority than the
2712 configuration source you are editing then the command will be shown
2713 in the dialog but will be insensitive (greyed out). This can't happen
2714 with the project source but can with the preferences source dialog.
2716 The clear buttons remove the definition from the configuration source you are editing.
2717 When you do this the command from the next lower priority source will be shown.
2718 To hide lower priority menu items without having anything show in the menu
2719 configure with a nothing in the label but at least one character in the command.
2721 Substitutions in Commands and Working Directories
2722 `````````````````````````````````````````````````
2724 The first occurance of each of the following character sequences in each of the
2725 command and working directory fields is substituted by the items specified below
2726 before the command is run.
2728 * %d - substituted by the absolute path to the directory of the current file.
2729 * %e - substituted by the name of the current file without the extension or path.
2730 * %f - substituted by the name of the current file without the path.
2731 * %p - if a project is open, substituted by the base path from the project.
2734 If the basepath set in the project preferences is not an absolute path , then it is
2735 taken as relative to the directory of the project file. This allows a project file
2736 stored in the source tree to specify all commands and working directories relative
2737 to the tree itself, so that the whole tree including the project file, can be moved
2738 and even checked into and out of version control without having to re-configure the
2741 Build Menu Keyboard Shortcuts
2742 `````````````````````````````
2744 Keyboard shortcuts can be defiend for the first two filetype menu items, the first three
2745 non-filetype menu items, the first two execute menu items and the fixed menu items.
2746 In the keybindings configuration dialog (see `Keybinding preferences`_)
2747 these items are identified by the default labels shown in the `Build Menu`_ section above.
2749 It is currently not possible to bind keyboard shortcuts to more than these menu items.
2754 The configurable Build Menu capability was introduced in Geany V0.19 and
2755 required a new section to be added to the configuration files (See
2756 `Preferences File Format`_). Geany will still load older format project,
2757 preferences and filetype file settings and will attempt to map them into the new
2758 configuration format. There is not a simple clean mapping between the formats.
2759 The mapping used produces the most sensible results for the majority of cases.
2760 However, if they do not map the way you want, you may have to manually
2761 configure some settings using the Build Commands
2762 Dialog or the Build tab of the project preferences dialog.
2764 Any setting configured in either of these dialogs will override settings mapped from
2765 older format configuration files.
2770 Since Geany 0.13 there has been printing support using GTK's printing API.
2771 The printed page(s) will look nearly the same as on your screen in Geany.
2772 Additionally, there are some options to modify the printed page(s).
2774 You can define whether to print line numbers, page numbers at the bottom of
2775 each page and whether to print a page header on each page. This header
2776 contains the filename of the printed document, the current page number and
2777 the date and time of printing. By default, the file name of the document
2778 with full path information is added to the header. If you prefer to add
2779 only the basename of the file(without any path information) you can set it
2780 in the preferences dialog. You can also adjust the format of the date and
2781 time added to the page header. The available conversion specifiers are the
2782 same as the ones which can be used with the ANSI C strftime function.
2784 All of these settings can also be changed in the print dialog just before
2785 actual printing is done.
2786 On Unix-like systems the provided print dialog offers a print preview. The
2787 preview file is opened with a PDF viewer and by default GTK uses ``evince``
2788 for print preview. If you have not installed evince or just want to use
2789 another PDF viewer, you can change the program to use in the file
2790 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
2793 gtk-print-preview-command = "epdfview %f"
2795 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
2796 as the print preview command.
2798 Unfortunately, native GTK printing support is only available if Geany was
2799 built against GTK 2.10 (or above) **and** is running with GTK 2.10 (or above).
2800 If not, Geany provides basic printing support. This means you can print a
2801 file by passing the filename of the current file to a command which
2802 actually prints the file. However, the printed document contains no syntax
2803 highlighting. You can adjust the command to which the filename is
2804 passed in the preferences dialog. The default command is::
2808 ``%f`` will be substituted by the filename of the current file. Geany
2809 will not show errors from the command itself, so you should make
2810 sure that it works before(e.g. by trying to execute it from the
2813 A nicer example, which many prefer is::
2815 % a2ps -1 --medium=A4 -o - %f | xfprint4
2817 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
2818 gtklp or similar programs can be used.
2825 Plugins are loaded at startup, if the *Enable plugin support*
2826 general preference is set. There is also a command-line option,
2827 ``-p``, which prevents plugins being loaded. Plugins are scanned in
2828 the following directories:
2830 * ``$prefix/lib/geany`` (see `Installation prefix`_)
2831 * ``~/.config/geany/plugins``
2833 Most plugins add menu items to the *Tools* menu when they are loaded.
2835 Since Geany 0.13, there is a Plugin Manager to let you choose which plugins
2836 should be loaded at startup. You can also load and unload plugins on the
2837 fly using this dialog. Once you click the checkbox for a specific plugin
2838 in the dialog, it is loaded or unloaded according to its previous state.
2839 By default, no plugins are loaded at startup until you select some.
2840 You can also configure some plugin specific options when the plugin
2843 See also `Plugin documentation`_ for information about single plugins
2844 which are included in Geany.
2850 Geany supports the default keyboard shortcuts for the Scintilla
2851 editing widget. For a list of these commands, see `Scintilla
2852 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
2853 by any custom keybindings with the same keyboard shortcut.
2859 There are a few non-configurable bindings to switch between documents,
2860 listed below. These can also be overridden by custom keybindings.
2862 =============== ==================================
2864 =============== ==================================
2865 Alt-[1-9] Select left-most tab, from 1 to 9.
2866 Alt-0 Select right-most tab.
2867 Ctrl-Shift-PgUp Select left-most tab.
2868 Ctrl-Shift-PgDn Select right-most tab.
2869 =============== ==================================
2872 Configurable keybindings
2873 ^^^^^^^^^^^^^^^^^^^^^^^^
2875 For all actions listed below you can define your own keybindings. Open
2876 the Preferences dialog, select the desired action and click on
2877 change. In the resulting dialog you can press the key combination you
2878 want to assign to the action and it will be saved when you press OK.
2879 You can define only one key combination for each action and each key
2880 combination can only be defined for one action.
2882 Some of the default key combinations are common across many
2883 applications, for example *Ctrl-N* for New and *Ctrl-O* for Open.
2884 Because they are so common it is not advisable to change these, but
2885 you can add other key combinations for these actions. For example
2886 *Ctrl-O* is set to execute menu_open by default, but you can also
2887 define *Alt-O*, so that the file open dialog is shown by pressing
2888 either *Ctrl-O* or *Alt-O*.
2890 The following tables list all customizable keyboard shortcuts, those
2891 which are common to many applications are marked with (C) after the
2896 =============================== ========================= ==================================================
2897 Action Default shortcut Description
2898 =============================== ========================= ==================================================
2899 New Ctrl-N (C) Creates a new file.
2901 Open Ctrl-O (C) Opens a file.
2903 Open selected file Ctrl-Shift-O Opens the selected filename.
2905 Re-open last closed tab Re-opens the last closed document tab.
2907 Save Ctrl-S (C) Saves the current file.
2909 Save As Saves the current file under a new name.
2911 Save all Ctrl-Shift-S Saves all open files.
2913 Close all Ctrl-Shift-W Closes all open files.
2915 Close Ctrl-W (C) Closes the current file.
2917 Reload file Ctrl-R (C) Reloads the current file. All unsaved changes
2920 Print Ctrl-P (C) Prints the current file.
2921 =============================== ========================= ==================================================
2926 =============================== ========================= ==================================================
2927 Action Default shortcut Description
2928 =============================== ========================= ==================================================
2929 Undo Ctrl-Z (C) Un-does the last action.
2931 Redo Ctrl-Y Re-does the last action.
2933 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
2936 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
2937 end of the current line.
2939 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
2941 Transpose current line Ctrl-T Transposes the current line with the previous one.
2943 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
2944 view. The cursor position and or an existing
2945 selection will not be changed.
2947 Scroll up by one line Alt-Up Scrolls the view.
2949 Scroll down by one line Alt-Down Scrolls the view.
2951 Complete word Ctrl-Space Shows the autocompletion list. If already showing
2952 tag completion, it shows document word completion
2953 instead, even if it is not enabled for automatic
2954 completion. Likewise if no tag suggestions are
2955 available, it shows document word completion.
2957 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
2960 Show macro list Ctrl-Return Shows a list of available macros and variables in
2963 Complete snippet Tab If you type a construct like if or for and press
2964 this key, it will be completed with a matching
2967 Suppress snippet completion If you type a construct like if or for and press
2968 this key, it will not be completed, and a space or
2969 tab will be inserted, depending on what the
2970 construct completion keybinding is set to. For
2971 example, if you have set the construct completion
2972 keybinding to space, then setting this to
2973 Shift+space will prevent construct completion and
2976 Context Action Executes a command and passes the current word
2977 (near the cursor position) or selection as an
2978 argument. See the section called `Context
2981 Move cursor in snippet Jumps to the next defined cursor positions in a
2982 completed snippets if multiple cursor positions
2985 Word part completion Tab When the autocompletion list is visible, complete
2986 the currently selected item up to the next word
2989 Move line(s) up Move the current line or selected lines up by
2992 Move line(s) down Move the current line or selected lines down by
2994 =============================== ========================= ==================================================
2997 Clipboard keybindings
2998 `````````````````````
2999 =============================== ========================= ==================================================
3000 Action Default shortcut Description
3001 =============================== ========================= ==================================================
3002 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3004 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3006 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3008 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3009 selection) to the clipboard.
3011 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3012 selection) to the clipboard.
3013 =============================== ========================= ==================================================
3018 =============================== ========================= ==================================================
3019 Action Default shortcut Description
3020 =============================== ========================= ==================================================
3021 Select all Ctrl-A (C) Makes a selection of all text in the current
3024 Select current word Alt-Shift-W Selects the current word under the cursor.
3026 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3027 which is defined by two empty lines around it.
3029 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3030 partially selected lines).
3032 Select to previous word part (Extend) selection to previous word part boundary.
3034 Select to next word part (Extend) selection to next word part boundary.
3035 =============================== ========================= ==================================================
3040 =============================== ========================= ==================================================
3041 Action Default shortcut Description
3042 =============================== ========================= ==================================================
3043 Insert date Shift-Alt-D Inserts a customisable date.
3045 Insert alternative whitespace Inserts a tab character when spaces should
3046 be used for indentation and inserts space
3047 characters of the amount of a tab width when
3048 tabs should be used for indentation.
3049 =============================== ========================= ==================================================
3054 =============================== ========================= ==================================================
3055 Action Default shortcut Description
3056 =============================== ========================= ==================================================
3057 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3058 selection will be changed into uppercase and vice
3059 versa. If the selection contains lower- and
3060 uppercase characters, all will be converted to
3063 Comment line Comments current line or selection.
3065 Uncomment line Uncomments current line or selection.
3067 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3068 a comment if the line is commented.
3070 Increase indent Ctrl-I Indents the current line or selection by one tab
3071 or by spaces in the amount of the tab width
3074 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3075 the tab width setting from the indentation of the
3076 current line or selection.
3078 Increase indent by one space Indents the current line or selection by one
3081 Decrease indent by one space Deindents the current line or selection by one
3084 Smart line indent Indents the current line or all selected lines
3085 with the same indentation as the previous line.
3087 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3088 external command (available for the first
3089 three configured commands, see
3090 `Sending text through custom commands`_ for
3093 Send Selection to Terminal Sends the current selection or the current
3094 line (if there is no selection) to the
3095 embedded Terminal (VTE).
3097 Reflow lines/block Reformat selected lines or current
3098 (indented) text block,
3099 breaking lines at the long line marker or the
3100 line breaking column if line breaking is
3101 enabled for the current document.
3102 =============================== ========================= ==================================================
3105 Settings keybindings
3106 ````````````````````
3107 =============================== ========================= ==================================================
3108 Action Default shortcut Description
3109 =============================== ========================= ==================================================
3110 Preferences Ctrl-Alt-P Opens preferences dialog.
3112 Plugin Preferences Opens plugin preferences dialog.
3113 =============================== ========================= ==================================================
3118 =============================== ========================= ==================================================
3119 Action Default shortcut Description
3120 =============================== ========================= ==================================================
3121 Find Ctrl-F (C) Opens the Find dialog.
3123 Find Next Ctrl-G Finds next result.
3125 Find Previous Ctrl-Shift-G Finds previous result.
3127 Replace Ctrl-H (C) Opens the Replace dialog.
3129 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3131 Next message Jumps to the line with the next message in
3132 the Messages window.
3134 Previous message Jumps to the line with the previous message
3135 in the Messages window.
3137 Find Usage Finds all occurrences of the current word (near
3138 the keyboard cursor) or selection in all open
3139 documents and displays them in the messages
3142 Find Document Usage Finds all occurrences of the current word (near
3143 the keyboard cursor) or selection in the current
3144 document and displays them in the messages
3147 Mark All Ctrl-Shift-M Highlight all matches of the current
3148 word/selection in the current document
3149 with a colored box. If there's nothing to
3150 find, highlighted matches will be cleared.
3151 =============================== ========================= ==================================================
3156 =============================== ========================= ==================================================
3157 Action Default shortcut Description
3158 =============================== ========================= ==================================================
3159 Navigate forward a location Switches to the next location in the navigation
3160 history. See the section called `Code Navigation
3163 Navigate back a location Switches to the previous location in the
3164 navigation history. See the section called
3165 `Code navigation history`_.
3167 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3168 shows the Go to line dialog.
3170 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3171 is moved to the brace which belongs to the current
3172 one. If this keyboard shortcut is pressed again,
3173 the cursor is moved back to the first brace.
3175 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3176 marker if there already is one.
3178 Goto next marker Ctrl-. Goto the next marker in the current document.
3180 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3182 Go to tag definition Jump to the definition of the current word (near
3183 the keyboard cursor). If the definition cannot be
3184 found (e.g. the relevant file is not open) Geany
3185 will beep and do nothing. See the section called
3186 `Go to tag definition`_.
3188 Go to tag declaration Jump to the declaration of the current word (near
3189 the keyboard cursor). If the declaration cannot be
3190 found (e.g. the relevant file is not open) Geany
3191 will beep and do nothing. See the section called
3192 `Go to tag declaration`_.
3194 Go to Start of Line Home Move the caret to the end of the line indentation
3195 unless it is already there, in which case it moves
3196 it to the start of the line.
3198 Go to End of Line End Move the caret to the end of the line.
3200 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3201 This is useful when you use line wrapping and
3202 want to jump to the end of the wrapped, virtual
3203 line, not the real end of the whole line.
3204 If the line is not wrapped, it behaves like
3205 `Go to End of Line`, see above.
3207 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3209 Go to Next Word Part Ctrl-\ Goto the next part of the current word.
3210 =============================== ========================= ==================================================
3214 =============================== ========================= ==================================================
3215 Action Default shortcut Description
3216 =============================== ========================= ==================================================
3217 Fullscreen F11 (C) Switches to fullscreen mode.
3219 Toggle Messages Window Toggles the message window (status and compiler
3220 messages) on and off.
3222 Toggle Sidebar Shows or hides the sidebar.
3224 Toggle all additional widgets Hide and show all additional widgets like the
3225 notebook tabs, the toolbar, the messages window
3228 Zoom In Ctrl-+ (C) Zooms in the text.
3230 Zoom Out Ctrl-- (C) Zooms out the text.
3232 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3233 =============================== ========================= ==================================================
3237 ================================ ========================= ==================================================
3238 Action Default shortcut Description
3239 ================================ ========================= ==================================================
3240 Switch to Editor F2 Switches to editor widget.
3241 Also reshows the document statistics line
3242 (after a short timeout).
3244 Switch to Scribble F6 Switches to scribble widget.
3246 Switch to VTE F4 Switches to VTE widget.
3248 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3251 Switch to Sidebar Focus the Sidebar.
3253 Switch to Compiler Focus the Compiler message window tab.
3255 Switch to Messages Focus the Messages message window tab.
3257 Switch to Message Window Focus the Message Window's current tab.
3259 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3262 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3264 ================================ ========================= ==================================================
3267 Notebook tab keybindings
3268 ````````````````````````
3269 =============================== ========================= ==================================================
3270 Action Default shortcut Description
3271 =============================== ========================= ==================================================
3272 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3274 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3276 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3278 Holding Ctrl (or another modifier if the keybinding
3279 has been changed) will show a dialog, then repeated
3280 presses of the keybinding will switch to the 2nd-last
3281 used document, 3rd-last, etc. Also known as
3282 Most-Recently-Used documents switching.
3284 Move document left Alt-PageUp Changes the current document with the left hand
3287 Move document right Alt-PageDown Changes the current document with the right hand
3290 Move document first Moves the current document to the first position.
3292 Move document last Moves the current document to the last position.
3293 =============================== ========================= ==================================================
3296 Document keybindings
3297 ````````````````````
3298 =============================== ========================= ==================================================
3299 Action Default shortcut Description
3300 =============================== ========================= ==================================================
3301 Replace tabs by space Replaces all tabs with the right amount of spaces.
3303 Replace spaces by tabs Replaces all spaces with tab characters.
3305 Toggle current fold Toggles the folding state of the current code block.
3307 Fold all Folds all contractible code blocks.
3309 Unfold all Unfolds all contracted code blocks.
3311 Reload symbol list Ctrl-Shift-R Reloads the tag/symbol list.
3313 Toggle Line wrapping Enables or disables wrapping of long lines.
3315 Toggle Line breaking Enables or disables automatic breaking of long
3316 lines at a configurable column.
3318 Remove Markers Remove any markers on lines or words which
3319 were set by using 'Mark All' in the
3320 search dialog or by manually marking lines.
3322 Remove Error Indicators Remove any error indicators in the
3324 =============================== ========================= ==================================================
3329 =============================== ========================= ==================================================
3330 Action Default shortcut Description
3331 =============================== ========================= ==================================================
3332 Compile F8 Compiles the current file.
3334 Build F9 Builds (compiles if necessary and links) the
3337 Make all Shift-F9 Builds the current file with the Make tool.
3339 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3342 Make object Compiles the current file with the Make tool.
3344 Next error Jumps to the line with the next error from the
3347 Previous error Jumps to the line with the previous error from
3348 the last build process.
3350 Run F5 Executes the current file in a terminal emulation.
3352 Set Build Commands Opens the build commands dialog.
3353 =============================== ========================= ==================================================
3358 =============================== ========================= ==================================================
3359 Action Default shortcut Description
3360 =============================== ========================= ==================================================
3361 Show Color Chooser Opens the Color Chooser dialog.
3362 =============================== ========================= ==================================================
3367 =============================== ========================= ==================================================
3368 Action Default shortcut Description
3369 =============================== ========================= ==================================================
3370 Help F1 (C) Opens the manual.
3371 =============================== ========================= ==================================================
3379 You must use UTF-8 encoding *without BOM* for configuration files.
3384 There's a *Configuration files* submenu in the *Tools* menu that
3385 contains items for some of the available user configuration files.
3386 Clicking on one opens it in the editor for you to update. Geany will
3387 reload the file after you have saved it.
3390 Other configuration files not shown here will need to be opened
3391 manually, and will not be automatically reloaded when saved.
3392 (see *Reload Configuration* below).
3394 There's also a *Reload Configuration* item which can be used if you
3395 updated one of the other configuration files, or modified or added
3398 *Reload Configuration* is also necessary to update syntax highlighting colors.
3401 Syntax highlighting colors aren't updated in open documents after
3402 saving filetypes.common as this can possibly take a significant
3406 Global configuration file
3407 -------------------------
3409 There is a global configuration file for Geany which will be used for
3410 any settings not defined in the users local configuration file.
3411 Settings present in the local configuration file override those in the global
3414 The global configuration file is read from
3415 ``$prefix/share/geany/geany.conf`` (where ``$prefix`` is the path where
3416 Geany is installed, see `Installation prefix`_) when starting Geany and
3417 an user configuration file does not exist. It can contain any settings
3418 which are found in the usual configuration file created by Geany but
3419 does not have to contain all settings.
3422 This feature is mainly intended for package maintainers or system
3423 admins who want to set up Geany in a multi user environment and
3424 set some sane default values for this environment. Usually users won't
3429 Filetype definition files
3430 -------------------------
3432 All color definitions and other filetype specific settings are
3433 stored in the filetype definition files. Those settings are colors
3434 for syntax highlighting, general settings like comment characters or
3435 word delimiter characters as well as compiler and linker settings.
3439 At startup Geany looks for ``filetypes.*.conf`` files in the system and
3440 user filetype paths, adding any filetypes found with the name matching
3441 the '``*``' wildcard.
3443 Custom filetypes are not as powerful as built-in filetypes, but the following
3444 have been implemented:
3446 * Recognizing and setting the filetype (after the user has manually edited
3447 ``filetype_extensions.conf``).
3448 * Filetype settings in the [settings] section (see `Format`_).
3449 * Using existing tag parsing (``tag_parser`` key).
3450 * Using existing syntax highlighting (``lexer_filetype`` key).
3452 * Loading global tags files (namespace will be shared with tag_parser
3457 The system-wide configuration files can be found in
3458 ``$prefix/share/geany`` and are called ``filetypes.$ext``,
3459 where ``$prefix`` is the path where Geany is installed (see
3460 `Installation prefix`_) and $ext is the name of the filetype. For every
3461 filetype there is a corresponding definition file. There is one
3462 exception: ``filetypes.common`` -- this file is for general settings,
3463 which are not specific to a certain filetype.
3466 It is not recommended that users edit the system-wide files,
3467 because they will be overridden when Geany is updated.
3471 To change the settings, copy a file from ``$prefix/share/geany`` to
3472 the subdirectory filedefs in your configuration directory (usually
3473 ``~/.config/geany/``).
3477 % cp /usr/local/share/geany/filetypes.c /home/username/.config/geany/filedefs/
3479 Then you can edit the file and the changes are also
3480 available after an update of Geany because they reside in your
3481 configuration directory. Alternatively, you can create a file
3482 ``~/.config/geany/filedefs/filetypes.X`` and add only these settings you want
3483 to change. All missing settings will be read from the corresponding
3484 global definition file in ``$prefix/share/geany``.
3486 As well as the sections listed below, each filetype file can contain
3487 a [build-menu] section as described in `[build-menu] Section`_.
3496 In this section the colors for syntax highlighting are defined. The
3499 * ``key=foreground_color;background_color;bold_flag;italic_flag``
3501 Colors have to be specified as RGB hex values prefixed by
3502 0x. For example red is 0xff0000, blue is 0x0000ff. The values are
3503 case-insensitive, but it is a good idea to use small letters. Bold
3504 and italic are flags and should only be "true" or "false". If their
3505 value is something other than "true" or "false", "false" is assumed.
3507 You can omit fields to use the values from the style named ``"default"``.
3509 E.g. ``key=0xff0000;;true``
3511 This makes the key style have red foreground text, default background
3512 color text and bold emphasis.
3516 The second format uses a *named style* name to reference a style
3517 defined in filetypes.common.
3519 * ``key=named_style``
3520 * ``key2=named_style2,bold,italic``
3522 The bold and italic parts are optional, and if present are used to
3523 toggle the bold or italic flags to the opposite of the named style's
3524 flags. In contrast to style definition booleans, they are a literal
3525 ",bold,italic" and commas are used instead of semi-colons.
3527 E.g. ``key=comment,italic``
3529 This makes the key style match the ``"comment"`` named style, but with
3532 To define named styles, see the filetypes.common `[named_styles]
3539 This section contains keys for different keyword lists specific to
3540 the filetype. Some filetypes do not support keywords, so adding a
3541 new key will not work. You can only add or remove keywords to/from
3545 The keywords list must be in one line without line ending characters.
3548 [lexer_properties] Section
3549 ``````````````````````````
3550 Here any special properties for the Scintilla lexer can be set in the
3551 format ``key.name.field=some.value``.
3558 This is the default file extension used when saving files, not
3559 including the period character (``.``). The extension used should
3560 match one of the patterns associated with that filetype (see
3561 `Filetype extensions`_).
3563 *Example:* ``extension=cxx``
3566 These characters define word boundaries when making selections
3567 and searching using word matching options.
3569 *Example:* (look at system filetypes.\* files)
3572 A character or string which is used to comment code. If you want to
3573 use multiline comments, also set comment_close, otherwise leave it
3576 *Example:* ``comment_open=/*``
3579 If multiline comments are used, this is the character or string to
3582 *Example:* ``comment_close=*/``
3585 Set this to false if a comment character or string should start at
3586 column 0 of a line. If set to true it uses any indentation of the
3589 Note: Comment indentation
3591 ``comment_use_indent=true`` would generate this if a line is
3592 commented (e.g. with Ctrl-D)::
3596 ``comment_use_indent=false`` would generate this if a line is
3597 commented (e.g. with Ctrl-D)::
3599 # command_example();
3602 Note: This setting only works for single line comments (like '//',
3605 *Example:* ``comment_use_indent=true``
3608 A command which can be executed on the current word or the current
3611 Example usage: Open the API documentation for the
3612 current function call at the cursor position.
3615 be set for every filetype or if not set, a global command will
3616 be used. The command itself can be specified without the full
3617 path, then it is searched in $PATH. But for security reasons,
3618 it is recommended to specify the full path to the command. The
3619 wildcard %s will be replaced by the current word at the cursor
3620 position or by the current selection.
3622 Hint: for PHP files the following could be quite useful:
3623 context_action_cmd=firefox "http://www.php.net/%s"
3625 *Example:* ``context_action_cmd=devhelp -s "%s"``
3628 The TagManager language name, e.g. "C".
3631 A filetype name to setup syntax highlighting from another filetype.
3632 This must not be recursive, i.e. it should be a filetype name that
3633 doesn't use the lexer_filetype key itself.
3636 [build_settings] Section
3637 ````````````````````````
3639 As of Geany v0.19 this section is supplemented by the `[build-menu] Section`_.
3640 Values that are set in the [build-menu] section will override those in this section.
3643 This is a GNU-style extended regular expression to parse a filename
3644 and line number from build output. If undefined, Geany will fall
3645 back to its default error message parsing.
3647 Only the first two matches will be read by Geany. Geany will look for
3648 a match that is purely digits, and use this for the line number. The
3649 remaining match will be used as the filename.
3651 *Example:* ``error_regex=(.+):([0-9]+):[0-9]+``
3653 This will parse a message such as:
3654 ``test.py:7:24: E202 whitespace before ']'``
3658 If any build menu item settings have been configured in the Build Menu Commands
3659 dialog or the Build tab of the project preferences dialog then these
3660 settings are stored in the [build-menu] section and override the settings in
3661 this section for that item.
3664 This item specifies the command to compile source code files. But
3665 it is also possible to use it with interpreted languages like Perl
3666 or Python. With these filetypes you can use this option as a kind of
3667 syntax parser, which sends output to the compiler message window.
3669 You should quote the filename to also support filenames with
3670 spaces. The following wildcards for filenames are available:
3672 * %f -- complete filename without path
3673 * %e -- filename without path and without extension
3675 *Example:* ``compiler=gcc -Wall -c "%f"``
3678 This item specifies the command to link the file. If the file is not
3679 already compiled, it will be compiled while linking. The -o option
3680 is automatically added by Geany. This item works well with GNU gcc,
3681 but may be problematic with other compilers (esp. with the linker).
3683 *Example:* ``linker=gcc -Wall "%f"``
3686 Use this item to execute your file. It has to have been built
3687 already. Use the %e wildcard to have only the name of the executable
3688 (i.e. without extension) or use the %f wildcard if you need the
3689 complete filename, e.g. for shell scripts.
3691 *Example:* ``run_cmd="./%e"``
3694 Special file filetypes.common
3695 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3697 There is a special filetype definition file called
3698 filetypes.common. This file defines some general non-filetype-specific
3701 See the `Format`_ section for how to define styles.
3704 [named_styles] Section
3705 ``````````````````````
3706 Named styles declared here can be used in the [styling] section of any
3711 *In filetypes.common*::
3714 foo=0xc00000;0xffffff;false;true
3722 This saves copying and pasting the whole style definition into several
3726 You can define aliases for named styles, as shown with the ``bar``
3727 entry in the above example, but they must be declared after the
3734 This is the default style. It is used for styling files without a
3737 *Example:* ``default=0x000000;0xffffff;false;false``
3740 The style for coloring selected text. The format is:
3744 * Use foreground color
3745 * Use background color
3747 The colors are only set if the 3rd or 4th argument is true. When
3748 the colors are not overridden, the default is a dark grey
3749 background with syntax highlighted foreground text.
3751 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
3754 The style for brace highlighting when a matching brace was found.
3756 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
3759 The style for brace highlighting when no matching brace was found.
3761 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
3764 The style for coloring the caret(the blinking cursor). Only first
3765 and third argument is interpreted.
3766 Set the third argument to true to change the caret into a block caret.
3768 *Example:* ``caret=0x000000;0x0;false;false``
3771 The width for the caret(the blinking cursor). Only the first
3772 argument is interpreted. The width is specified in pixels with
3773 a maximum of three pixel. Use the width 0 to make the caret
3776 *Example:* ``caret=1;0;false;false``
3779 The style for coloring the background of the current line. Only
3780 the second and third arguments are interpreted. The second argument
3781 is the background color. Use the third argument to enable or
3782 disable background highlighting for the current line (has to be
3785 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
3788 The style for coloring the indentation guides. Only the first and
3789 second arguments are interpreted.
3791 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
3794 The style for coloring the white space if it is shown. The first
3795 both arguments define the foreground and background colors, the
3796 third argument sets whether to use the defined foreground color
3797 or to use the color defined by each filetype for the white space.
3798 The fourth argument defines whether to use the background color.
3800 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
3803 The style of folding icons. Only first and second arguments are
3806 Valid values for the first argument are:
3811 Valid values for the second argument are:
3813 * 1 -- for straight lines
3814 * 2 -- for curved lines
3816 *Example:* ``folding_style=1;1;false;false``
3819 Draw a thin horizontal line at the line where text is folded. Only
3820 first argument is used.
3822 Valid values for the first argument are:
3824 * 0 -- disable, do not draw a line
3825 * 1 -- draw the line above folded text
3826 * 2 -- draw the line below folded text
3828 *Example:* ``folding_horiz_line=0;0;false;false``
3831 First argument: drawing of visual flags to indicate a line is wrapped.
3832 This is a bitmask of the values:
3834 * 0 -- No visual flags
3835 * 1 -- Visual flag at end of subline of a wrapped line
3836 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
3837 indented by at least 1 to make room for the flag.
3839 Second argument: wether the visual flags to indicate a line is wrapped
3840 are drawn near the border or near the text. This is a bitmask of the values:
3842 * 0 -- Visual flags drawn near border
3843 * 1 -- Visual flag at end of subline drawn near text
3844 * 2 -- Visual flag at begin of subline drawn near text
3846 Only first and second argument is interpreted.
3848 *Example:* ``line_wrap_visuals=3;0;false;false``
3851 First argument: sets the size of indentation of sublines for wrapped lines
3852 in terms of the width of a space, only used when the second argument is ``0``.
3854 Second argument: wrapped sublines can be indented to the position of their
3855 first subline or one more indent level. Possible values:
3857 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
3858 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
3859 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
3861 Only first and second argument is interpreted.
3863 *Example:* ``line_wrap_indent=0;1;false;false``
3866 Translucency for the current line (first argument) and the selection
3867 (second argument). Values between 0 and 256 are accepted.
3869 Note for Windows 95, 98 and ME users:
3870 keep this value at 256 to disable translucency otherwise Geany might crash.
3872 Only the first and second argument is interpreted.
3874 *Example:* ``translucency=256;256;false;false``
3877 The style for a highlighted line (e.g when using Goto line or goto tag).
3878 The foreground color (first argument) is only used when the Markers margin
3879 is enabled (see View menu).
3881 Only the first and second argument is interpreted.
3883 *Example:* ``marker_line=0x000000;0xffff00;false;false``
3886 The style for a marked search results (when using "Mark" in Search dialogs).
3887 The second argument sets the background colour for the drawn rectangle.
3889 Only the second argument is interpreted.
3891 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
3894 The style for a marked line (e.g when using the "Toggle Marker" keybinding
3895 (Ctrl-M)). The foreground color (first argument) is only used
3896 when the Markers margin is enabled (see View menu).
3898 Only the first and second argument is interpreted.
3900 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
3903 Translucency for the line marker (first argument) and the search marker
3904 (second argument). Values between 0 and 256 are accepted.
3906 Note for Windows 95, 98 and ME users:
3907 keep this value at 256 to disable translucency otherwise Geany might crash.
3909 Only the first and second argument is interpreted.
3911 *Example:* ``marker_translucency=256;256;false;false``
3914 Amount of space to be drawn above and below the line's baseline.
3915 The first argument defines the amount of space to be drawn above the line, the second
3916 argument defines the amount of space to be drawn below.
3918 Only the first and second argument is interpreted.
3920 *Example:* ``line_height=0;0;false;false``
3923 The style for coloring the calltips. The first two arguments
3924 define the foreground and background colors, the third and fourth
3925 arguments set whether to use the defined colors.
3927 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
3933 Characters to treat as whitespace. These characters are ignored
3934 when moving, selecting and deleting across word boundaries
3935 (see `Scintilla keyboard commands`_).
3937 This should include space (\\s) and tab (\\t).
3939 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
3946 To change the default filetype extension used when saving a new file,
3947 see `Filetype definition files`_.
3949 You can override the list of file extensions that Geany uses for each
3950 filetype using the ``filetype_extensions.conf`` file.
3952 To override the system-wide configuration file, copy it from
3953 ``$prefix/share/geany`` to your configuration directory, usually
3954 ``~/.config/geany/``. ``$prefix`` is the path where Geany is installed
3955 (see `Installation prefix`_).
3959 % cp /usr/local/share/geany/filetype_extensions.conf /home/username/.config/geany/
3961 Then edit it and remove all the lines for filetype extensions that
3962 you do not want to override. The remaining lines can be edited after
3963 the ``=`` sign, using a semi-colon separated list of patterns which
3964 should be matched for that filetype.
3966 For example, to set the filetype extensions for Make, the
3967 ``/home/username/.config/geany/filetype_extensions.conf`` file should
3971 Make=Makefile*;*.mk;Buildfile;
3973 Preferences File Format
3974 -----------------------
3976 The preferences file ``~/.config/geany/geany.conf`` holds settings for all the items configured
3977 in the preferences dialog. This file should not be edited while Geany is running
3978 as the file will be overwritten when the preferences in Geany are changed or Geany
3985 There are some rarely used preferences that are not shown in the Preferences
3986 dialog. These can be set by editing the preferences file, then
3987 selecting *Tools->Reload Configuration* or restarting Geany. Search for the
3988 key name, then edit the value. Example:
3990 ``brace_match_ltgt=true``
3992 The table below show the key names of hidden preferences in the
3995 ================================ =========================================== ==================
3996 Key Description Default
3997 ================================ =========================================== ==================
3999 brace_match_ltgt Whether to highlight <, > angle brackets. false
4000 show_editor_scrollbars Whether to display scrollbars. If set to true
4001 false, the horizontal and vertical
4002 scrollbars are hidden completely.
4003 use_gtk_word_boundaries Whether to look for the end of a word when true
4004 using word-boundary related Scintilla
4005 commands (see `Scintilla keyboard
4007 complete_snippets_whilst_editing Whether to allow completion of snippets false
4008 when editing an existing line (i.e. there
4009 is some text after the current cursor
4010 position on the line). Only used when the
4011 keybinding ``Complete snippet`` is set to
4013 **Interface related**
4014 show_symbol_list_expanders Whether to show or hide the small expander true
4015 icons on the symbol list treeview (only
4016 available with GTK 2.12 or above).
4017 allow_always_save Whether files can be saved always, even if false
4018 they don't have any changes. By default,
4019 the Save buttons and menu items are
4020 disabled when a file is unchanged. When
4021 setting this option to true, the Save
4022 buttons and menu items are always active
4023 and files can be saved.
4025 emulation Terminal emulation mode. Only change this xterm
4026 if you have VTE termcap files other than
4027 ``vte/termcap/xterm``.
4028 send_selection_unsafe By default, Geany strips any trailing false
4029 newline characters from the current
4030 selection before sending it to the terminal
4031 to not execute arbitrary code. This is
4032 mainly a security feature.
4033 If, for whatever reasons, you really want
4034 it to be executed directly, set this option
4037 use_safe_file_saving Defines the mode how Geany saves files to false
4038 disk. If disabled, Geany directly writes
4039 the content of the document to disk. This
4040 might cause in loss of data when there is
4041 no more free space on disk to save the
4042 file. When set to true, Geany first saves
4043 the contents into a temporary file and if
4044 this succeeded, the temporary file is
4045 moved to the real file to save.
4046 This gives better error checking in case of
4047 no more free disk space. But it also
4048 destroys hard links of the original file
4049 and its permissions (e.g. executable flags
4050 are reset). Use this with care as it can
4051 break things seriously.
4052 The better approach would be to ensure your
4053 disk won't run out of free space.
4054 **Build Menu related**
4055 number_ft_menu_items The maximum number of menu items in the 2
4056 filetype section of the Build menu.
4057 number_non_ft_menu_items The maximum number of menu items in the 3
4058 non-filetype section of the Build menu.
4059 number_exec_menu_items The maximum number of menu items in the 2
4060 execute section of the Build menu.
4061 ================================ =========================================== ==================
4063 [build-menu] Section
4064 ^^^^^^^^^^^^^^^^^^^^
4066 The [build-menu] section contains the configuration of the build menu.
4067 This section can occur in filetype, preferences and project files and
4068 always has the format described here. Different menu items are loaded
4069 from different files, see the table in the `Build Menu Configuration`_
4070 section for details. All the settings can be configured from the dialogs
4071 except the execute command in filetype files and filetype definitions in
4072 the project file, so these are the only ones which need hand editing.
4074 The build-menu section stores one entry for each setting for each menu item that
4075 is configured. The keys for these settings have the format:
4081 * GG - is the menu item group,
4084 - NF for non-filetype
4087 * NN - is a two decimal digit number of the item within the group,
4089 * FF - is the field,
4093 - WD for working directory
4099 The project file contains project related settings and possibly a
4100 record of the current session files.
4103 [build-menu] Additions
4104 ^^^^^^^^^^^^^^^^^^^^^^
4106 The project file also can have extra fields in the [build-menu] section
4107 in addition to those listed in `[build-menu] Section`_ above.
4109 When filetype menu items are configured for the project they are stored
4110 in the project file.
4112 The ``filetypes`` entry is a list of the filetypes which exist in the
4115 For each filetype the entries for that filetype have the format defined in
4116 `[build-menu] Section`_ but the key is prefixed by the name of the filetype
4117 as it appears in the ``filetypes`` entry, eg the entry for the label of
4118 filetype menu item 0 for the C filetype would be
4126 Geany supports the following templates:
4130 * Function description
4135 To use these templates, just open the Edit menu or open the popup menu
4136 by right-clicking in the editor widget, and choose "Insert Comments"
4137 and insert templates as you want.
4139 Some templates (like File header or ChangeLog entry) will always be
4140 inserted at the top of the file.
4142 To insert a function description, the cursor must be inside
4143 of the function, so that the function name can be determined
4144 automatically. The description will be positioned correctly one line
4145 above the function, just check it out. If the cursor is not inside
4146 of a function or the function name cannot be determined, the inserted
4147 function description won't contain the correct function name but "unknown"
4154 Meta data can be used with all templates, but by default user set
4155 meta data is only used for the ChangeLog and File header templates.
4157 In the configuration dialog you can find a tab "Templates" (see
4158 `Template preferences`_). You can define the default values
4159 which will be inserted in the templates. You should select
4160 *Tools->Reload Configuration* or restart Geany after making changes.
4166 File templates are templates used as the basis of a new file. To
4167 use them, choose the *New (with Template)* menu item from the *File*
4170 By default, file templates are installed for some filetypes. Custom
4171 file templates can be added by creating the appropriate template file
4172 and then selecting *Tools->Reload Configuration* or restarting Geany. You can
4173 also edit the default file templates.
4175 The file's contents are just the text to place in the document, with
4176 optional template wildcards like ``{fileheader}``. The fileheader
4177 wildcard can be placed anywhere, but it's usually put on the first
4178 line of the file, followed by a blank line.
4180 Custom file templates
4181 `````````````````````
4183 These are read from the following directories:
4185 * ``$prefix/share/geany/templates/files`` (see `Installation prefix`_)
4186 * ``~/.config/geany/templates/files`` (created the first time
4189 The filetype to use is detected from the template file's extension, if
4190 any. For example, creating a file ``module.c`` would add a menu item
4191 which created a new document with the filetype set to 'C'.
4193 The template file is read from disk when the corresponding menu item is
4194 clicked, so you don't need to select *Tools->Reload Configuration* or restart
4195 Geany after editing a custom file template.
4201 It's recommended to use custom file templates instead.
4203 Filetype template files are read from the ``~/.config/geany/templates``
4204 directory, and are named "filetype." followed by the filetype
4205 name, e.g. "filetype.python", "filetype.sh", etc. If you are
4206 unsure about the filetype name extensions, they are the same as
4207 the filetype configuration file extensions, commonly installed in
4208 ``/usr/share/geany``, with the prefix "filetypes.".
4210 There is also a template file ``filetype.none`` which is used when
4211 the New command is used without a filetype. This is empty by default.
4214 Customizing templates
4215 ^^^^^^^^^^^^^^^^^^^^^
4217 Each template can be customized to your needs. The templates are
4218 stored in the ``~/.config/geany/templates/`` directory (see the section called
4219 `Command line options`_ for further information about the configuration
4220 directory). Just open the desired template with an editor (ideally,
4221 Geany ;-) ) and edit the template to your needs. There are some
4222 wildcards which will be automatically replaced by Geany at startup.
4228 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4230 ============== ============================================= =======================================
4231 Wildcard Description Available in
4232 ============== ============================================= =======================================
4233 developer The name of the developer. filetype templates, file header,
4234 function description, ChangeLog entry,
4237 initial The developer's initials, e.g. "ET" for filetype templates, file header,
4238 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4241 mail The email address of the developer. filetype templates, file header,
4242 function description, ChangeLog entry,
4245 company The company the developer is working for. filetype templates, file header,
4246 function description, ChangeLog entry,
4249 year [1]_ The current year. Default format is: YYYY filetype templates, file header,
4250 function description, ChangeLog entry,
4253 version The initial version of a new file. filetype templates, file header,
4254 function description, ChangeLog entry,
4257 date [1]_ The current date. Default format: YYYY-MM-DD. filetype templates, file header,
4258 function description, ChangeLog entry,
4261 untitled The string "untitled" (this will be filetype templates, file header,
4262 translated to your locale), used in function description, ChangeLog entry,
4263 filetype templates. bsd, gpl, snippets
4265 geanyversion The actual Geany version, e.g. filetype templates, file header,
4266 "Geany |(version)|". function description, ChangeLog entry,
4269 datetime [1]_ The current date and time. Default format: filetype templates, file header,
4270 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4273 filename The filename of the current file. file header, snippets
4275 gpl This wildcard inserts a short GPL notice. file header
4277 bsd This wildcard inserts a BSD licence notice. file header
4279 functionname The function name of the function at the function description
4280 cursor position. This wildcard will only be
4281 replaced in the function description
4284 fileheader The file header template. This wildcard file header, snippets, custom filetype
4285 will only be replaced in filetype templates
4288 command:path Executes the specified command and replace filetype templates, file header,
4289 the wildcard with the command's standard function description, ChangeLog entry,
4290 output. See `Special {command:} wilcard`_ bsd, gpl, snippets
4292 ============== ============================================= =======================================
4295 .. [1] The format for the ``year``, ``date`` and ``datetime`` wildcards can be changed
4296 in the preferences dialog, see `Template preferences`_. You can
4297 use any conversion specifiers which can be used with the ANSI C strftime function.
4298 For details please see http://man.cx/strftime.
4301 Special {command:} wilcard
4302 **************************
4304 The {command:} wilcard is a special one because it can execute
4305 a specified command and put the command's output (stdout) into
4314 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
4316 Using this wildcard you can insert nearly any arbitrary text into the
4319 In the environment of the executed command the variables
4320 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
4321 The value of these variables is filled in only if Geany knows about it.
4322 For example, ``GEANY_FUNCNAME`` is only filled within the function
4323 description template. However, these variables are ``always`` set,
4324 just maybe with an empty value.
4325 You can easily access them e.g. within an executed shell script using::
4331 If the specified command could not be found or not executed, the wildcard is substituted
4332 by an empty string. In such cases, you can find the occurred error message on Geany's
4333 standard error and in the Help->Debug Messages dialog.
4336 Customizing the toolbar
4337 -----------------------
4339 You can add, remove and reorder the elements in the toolbar by using the toolbar editor
4340 by manually editing the file ``ui_toolbar.xml``.
4342 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
4343 by right-clicking on the toolbar itself and choosing it from the menu.
4345 Manually editing of the toolbar layout
4346 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4348 To override the system-wide configuration file, copy it from
4349 ``$prefix/share/geany`` to your configuration directory, usually
4350 ``~/.config/geany/``. ``$prefix`` is the path where Geany is installed
4351 (see `Installation prefix`_).
4355 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
4357 Then edit it and add any of the available elements listed in the file or remove
4358 any of the existing elements. Of course, you can also reorder the elements as
4359 you wish and add or remove additional separators.
4360 This file must be valid XML, otherwise the global toolbar UI definition
4361 will be used instead.
4363 Your changes are applied once you save the file.
4366 (1) You cannot add new actions which are not listed below.
4367 (2) Everything you add or change must be inside the /ui/toolbar/ path.
4370 Available toolbar elements
4371 ^^^^^^^^^^^^^^^^^^^^^^^^^^
4373 ================== ==============================================================================
4374 Element name Description
4375 ================== ==============================================================================
4376 New Create a new file
4377 Open Open an existing file
4378 Save Save the current file
4379 SaveAll Save all open files
4380 Reload Reload the current file from disk
4381 Close Close the current file
4382 CloseAll Close all open files
4383 Print Print the current file
4384 Cut Cut the current selection
4385 Copy Copy the current selection
4386 Paste Paste the contents of the clipboard
4387 Delete Delete the current selection
4388 Undo Undo the last modification
4389 Redo Redo the last modification
4390 NavBack Navigate back a location
4391 NavFor Navigate forward a location
4392 Compile Compile the current file
4393 Build Build the current file, includes a submenu for Make commands. Geany
4394 remembers the last chosen action from the submenu and uses this as default
4395 action when the button itself is clicked.
4396 Run Run or view the current file
4397 Color Open a color chooser dialog, to interactively pick colors from a palette
4398 ZoomIn Zoom in the text
4399 ZoomOut Zoom out the text
4400 UnIndent Decrease indentation
4401 Indent Increase indentation
4402 Replace Replace text in the current document
4403 SearchEntry The search field belonging to the 'Search' element (can be used alone)
4404 Search Find the entered text in the current file (only useful if you also
4406 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
4407 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
4408 Preferences Show the preferences dialog
4410 ================== ==============================================================================
4414 Plugin documentation
4415 ====================
4422 This plugin sets on every new file (File->New or File-> New (with template))
4423 a randomly chosen filename and set its filetype appropriate to the used template
4424 or when no template was used, to a configurable default filetype.
4425 This enables you to quickly compile, build and/or run the new file without the
4426 need to give it an explicit filename using the Save As dialog. This might be
4427 useful when you often create new files just for testing some code or something
4434 This plugin creates a backup copy of the current file in Geany when it is
4435 saved. You can specify the directory where the backup copy is saved and
4436 you can configure the automatically added extension in the configure dialog
4437 in Geany's plugin manager.
4439 After the plugin was loaded in Geany's plugin manager, every file is
4440 copied into the configured backup directory when the file is saved in Geany.
4444 Contributing to this document
4445 =============================
4447 This document (``geany.txt``) is written in `reStructuredText`__
4448 (or "reST"). The source file for it is located in Geany's ``doc``
4449 subdirectory. If you intend on making changes, you should grab the
4450 source right from SVN to make sure you've got the newest version. After
4451 editing the file, to build the HTML document to see how your changes
4452 look, run "``make doc``" in the subdirectory ``doc`` of Geany's source
4453 directory. This regenerates the ``geany.html`` file. To generate a PDF
4454 file, use the command "``make pdf``" which should generate a file called
4455 geany-|(version)|.pdf.
4457 __ http://docutils.sourceforge.net/rst.html
4459 After you are happy with your changes, create a patch::
4461 % svn diff geany.txt > foo.patch
4463 and then submit that file to the mailing list for review.
4465 Note, you will need the Python docutils software package installed
4466 to build the docs. The package is named ``python-docutils`` on Debian
4472 Scintilla keyboard commands
4473 ===========================
4475 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
4477 This appendix is distributed under the terms of the License for
4478 Scintilla and SciTE. A copy of this license can be found in the file
4479 ``scintilla/License.txt`` included with the source code of this
4480 program and in the appendix of this document. See `License for
4481 Scintilla and SciTE`_.
4490 Keyboard commands for Scintilla mostly follow common Windows and GTK+
4491 conventions. All move keys (arrows, page up/down, home and end)
4492 allows to extend or reduce the stream selection when holding the
4493 Shift key, and the rectangular selection when holding the Shift and
4494 Ctrl keys. Some keys may not be available with some national keyboards
4495 or because they are taken by the system such as by a window manager
4496 or GTK. Keyboard equivalents of menu commands are listed in the
4497 menus. Some less common commands with no menu equivalent are:
4499 ============================================= ======================
4501 ============================================= ======================
4502 Magnify text size. Ctrl+Keypad+
4503 Reduce text size. Ctrl+Keypad-
4504 Restore text size to normal. Ctrl+Keypad/
4506 Dedent block. Shift+Tab
4507 Delete to start of word. Ctrl+BackSpace
4508 Delete to end of word. Ctrl+Delete
4509 Delete to start of line. Ctrl+Shift+BackSpace
4510 Go to start of document. Ctrl+Home
4511 Extend selection to start of document. Ctrl+Shift+Home
4512 Go to start of display line. Alt+Home
4513 Extend selection to start of display line. Alt+Shift+Home
4514 Go to end of document. Ctrl+End
4515 Extend selection to end of document. Ctrl+Shift+End
4516 Extend selection to end of display line. Alt+Shift+End
4517 Previous paragraph. Shift extends selection. Ctrl+Up
4518 Next paragraph. Shift extends selection. Ctrl+Down
4519 Previous word. Shift extends selection. Ctrl+Left
4520 Next word. Shift extends selection. Ctrl+Right
4521 ============================================= ======================
4532 * Double-click on empty space in the notebook tab bar to open a
4534 * Middle-click on a document's notebook tab to close the document.
4535 * Hold `Ctrl` and click on any notebook tab to switch to the last used
4537 * Double-click on a document's notebook tab to toggle all additional
4538 widgets (to show them again use the View menu or the keyboard
4539 shortcut). The interface pref must be enabled for this to work.
4544 * Alt-scroll wheel moves up/down a page.
4545 * Ctrl-scroll wheel zooms in/out.
4546 * Shift-scroll wheel scrolls 8 characters right/left.
4547 * Ctrl-click on a word in a document to perform *Go to Tag Definition*.
4548 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
4553 * Double-click on a symbol-list group to expand or compact it.
4558 * Scrolling the mouse wheel over a notebook tab bar will switch
4561 The following are derived from X-Windows features (but GTK still supports
4564 * Middle-click pastes the last selected text.
4565 * Middle-click on a scrollbar moves the scrollbar to that
4566 position without having to drag it.
4570 Compile-time options
4571 ====================
4573 There are some options which can only be changed at compile time,
4574 and some options which are used as the default for configurable
4575 options. To change these options, edit the appropriate source file
4576 in the ``src`` subdirectory. Look for a block of lines starting with
4577 ``#define GEANY_*``. Any definitions which are not listed here should
4581 Most users should not need to change these options.
4586 ============================== ============================================ ==================
4587 Option Description Default
4588 ============================== ============================================ ==================
4589 GEANY_STRING_UNTITLED A string used as the default name for new untitled
4590 files. Be aware that the string can be
4591 translated, so change it only if you know
4593 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
4594 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
4595 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
4597 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
4599 **Windows specific**
4600 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
4601 Windows file open and save dialogs instead
4602 GTK's file open and save dialogs. The
4603 default Windows file dialogs are missing
4604 some nice features like choosing a filetype
4605 or an encoding. *Do not touch this setting
4606 when building on a non-Win32 system.*
4607 ============================== ============================================ ==================
4612 ============================== ============================================ ==================
4613 Option Description Default
4614 ============================== ============================================ ==================
4615 GEANY_PROJECT_EXT The default filename extension for Geany geany
4616 project files. It is used when creating new
4617 projects and as filter mask for the project
4619 ============================== ============================================ ==================
4624 ============================== ============================================ ==================
4625 Option Description Default
4626 ============================== ============================================ ==================
4627 GEANY_WORDCHARS These characters define word boundaries when a string with:
4628 making selections and searching using word a-z, A-Z, 0-9 and
4629 matching options. underscore.
4630 ============================== ============================================ ==================
4635 These are default settings that can be overridden in the `Preferences`_ dialog.
4637 ============================== ============================================ ==================
4638 Option Description Default
4639 ============================== ============================================ ==================
4640 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
4641 trigger the autocompletion list.
4642 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
4644 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
4645 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept the "xterm"
4646 command line option "-e". This can also
4648 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
4649 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
4650 and process plain text files. This can also
4652 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
4653 GNU grep. This can also include a path.
4654 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
4655 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
4657 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
4658 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
4659 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
4661 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
4663 ============================== ============================================ ==================
4668 ============================== ============================================ ==================
4669 Option Description Default
4670 ============================== ============================================ ==================
4671 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error messages which should 100
4672 be highlighted in the Compiler message
4673 window. This affects the special coloring
4674 when Geany detects a compiler output line as
4675 an error message and then highlight the
4676 corresponding line in the source code.
4677 Usually only the first few messages are
4678 interesting because following errors are
4680 ============================== ============================================ ==================
4685 ============================== ============================================ ==================
4686 Option Description Default
4687 ============================== ============================================ ==================
4688 PRINTBUILDCMDS Every time a build menu item priority FALSE
4689 calculation is run, print the state of the
4690 menu item table in the form of the table
4691 in `Build Menu Configuration`_. May be
4692 useful to debug configuration file
4693 overloading. Warning produces a lot of
4694 output. Can also be enabled/disabled by the
4695 debugger by setting printbuildcmds to 1/0
4696 overriding the compile setting.
4697 ============================== ============================================ ==================
4701 GNU General Public License
4702 ==========================
4706 GNU GENERAL PUBLIC LICENSE
4707 Version 2, June 1991
4709 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
4710 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4711 Everyone is permitted to copy and distribute verbatim copies
4712 of this license document, but changing it is not allowed.
4716 The licenses for most software are designed to take away your
4717 freedom to share and change it. By contrast, the GNU General Public
4718 License is intended to guarantee your freedom to share and change free
4719 software--to make sure the software is free for all its users. This
4720 General Public License applies to most of the Free Software
4721 Foundation's software and to any other program whose authors commit to
4722 using it. (Some other Free Software Foundation software is covered by
4723 the GNU Library General Public License instead.) You can apply it to
4726 When we speak of free software, we are referring to freedom, not
4727 price. Our General Public Licenses are designed to make sure that you
4728 have the freedom to distribute copies of free software (and charge for
4729 this service if you wish), that you receive source code or can get it
4730 if you want it, that you can change the software or use pieces of it
4731 in new free programs; and that you know you can do these things.
4733 To protect your rights, we need to make restrictions that forbid
4734 anyone to deny you these rights or to ask you to surrender the rights.
4735 These restrictions translate to certain responsibilities for you if you
4736 distribute copies of the software, or if you modify it.
4738 For example, if you distribute copies of such a program, whether
4739 gratis or for a fee, you must give the recipients all the rights that
4740 you have. You must make sure that they, too, receive or can get the
4741 source code. And you must show them these terms so they know their
4744 We protect your rights with two steps: (1) copyright the software, and
4745 (2) offer you this license which gives you legal permission to copy,
4746 distribute and/or modify the software.
4748 Also, for each author's protection and ours, we want to make certain
4749 that everyone understands that there is no warranty for this free
4750 software. If the software is modified by someone else and passed on, we
4751 want its recipients to know that what they have is not the original, so
4752 that any problems introduced by others will not reflect on the original
4753 authors' reputations.
4755 Finally, any free program is threatened constantly by software
4756 patents. We wish to avoid the danger that redistributors of a free
4757 program will individually obtain patent licenses, in effect making the
4758 program proprietary. To prevent this, we have made it clear that any
4759 patent must be licensed for everyone's free use or not licensed at all.
4761 The precise terms and conditions for copying, distribution and
4762 modification follow.
4764 GNU GENERAL PUBLIC LICENSE
4765 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
4767 0. This License applies to any program or other work which contains
4768 a notice placed by the copyright holder saying it may be distributed
4769 under the terms of this General Public License. The "Program", below,
4770 refers to any such program or work, and a "work based on the Program"
4771 means either the Program or any derivative work under copyright law:
4772 that is to say, a work containing the Program or a portion of it,
4773 either verbatim or with modifications and/or translated into another
4774 language. (Hereinafter, translation is included without limitation in
4775 the term "modification".) Each licensee is addressed as "you".
4777 Activities other than copying, distribution and modification are not
4778 covered by this License; they are outside its scope. The act of
4779 running the Program is not restricted, and the output from the Program
4780 is covered only if its contents constitute a work based on the
4781 Program (independent of having been made by running the Program).
4782 Whether that is true depends on what the Program does.
4784 1. You may copy and distribute verbatim copies of the Program's
4785 source code as you receive it, in any medium, provided that you
4786 conspicuously and appropriately publish on each copy an appropriate
4787 copyright notice and disclaimer of warranty; keep intact all the
4788 notices that refer to this License and to the absence of any warranty;
4789 and give any other recipients of the Program a copy of this License
4790 along with the Program.
4792 You may charge a fee for the physical act of transferring a copy, and
4793 you may at your option offer warranty protection in exchange for a fee.
4795 2. You may modify your copy or copies of the Program or any portion
4796 of it, thus forming a work based on the Program, and copy and
4797 distribute such modifications or work under the terms of Section 1
4798 above, provided that you also meet all of these conditions:
4800 a) You must cause the modified files to carry prominent notices
4801 stating that you changed the files and the date of any change.
4803 b) You must cause any work that you distribute or publish, that in
4804 whole or in part contains or is derived from the Program or any
4805 part thereof, to be licensed as a whole at no charge to all third
4806 parties under the terms of this License.
4808 c) If the modified program normally reads commands interactively
4809 when run, you must cause it, when started running for such
4810 interactive use in the most ordinary way, to print or display an
4811 announcement including an appropriate copyright notice and a
4812 notice that there is no warranty (or else, saying that you provide
4813 a warranty) and that users may redistribute the program under
4814 these conditions, and telling the user how to view a copy of this
4815 License. (Exception: if the Program itself is interactive but
4816 does not normally print such an announcement, your work based on
4817 the Program is not required to print an announcement.)
4819 These requirements apply to the modified work as a whole. If
4820 identifiable sections of that work are not derived from the Program,
4821 and can be reasonably considered independent and separate works in
4822 themselves, then this License, and its terms, do not apply to those
4823 sections when you distribute them as separate works. But when you
4824 distribute the same sections as part of a whole which is a work based
4825 on the Program, the distribution of the whole must be on the terms of
4826 this License, whose permissions for other licensees extend to the
4827 entire whole, and thus to each and every part regardless of who wrote it.
4829 Thus, it is not the intent of this section to claim rights or contest
4830 your rights to work written entirely by you; rather, the intent is to
4831 exercise the right to control the distribution of derivative or
4832 collective works based on the Program.
4834 In addition, mere aggregation of another work not based on the Program
4835 with the Program (or with a work based on the Program) on a volume of
4836 a storage or distribution medium does not bring the other work under
4837 the scope of this License.
4839 3. You may copy and distribute the Program (or a work based on it,
4840 under Section 2) in object code or executable form under the terms of
4841 Sections 1 and 2 above provided that you also do one of the following:
4843 a) Accompany it with the complete corresponding machine-readable
4844 source code, which must be distributed under the terms of Sections
4845 1 and 2 above on a medium customarily used for software interchange; or,
4847 b) Accompany it with a written offer, valid for at least three
4848 years, to give any third party, for a charge no more than your
4849 cost of physically performing source distribution, a complete
4850 machine-readable copy of the corresponding source code, to be
4851 distributed under the terms of Sections 1 and 2 above on a medium
4852 customarily used for software interchange; or,
4854 c) Accompany it with the information you received as to the offer
4855 to distribute corresponding source code. (This alternative is
4856 allowed only for noncommercial distribution and only if you
4857 received the program in object code or executable form with such
4858 an offer, in accord with Subsection b above.)
4860 The source code for a work means the preferred form of the work for
4861 making modifications to it. For an executable work, complete source
4862 code means all the source code for all modules it contains, plus any
4863 associated interface definition files, plus the scripts used to
4864 control compilation and installation of the executable. However, as a
4865 special exception, the source code distributed need not include
4866 anything that is normally distributed (in either source or binary
4867 form) with the major components (compiler, kernel, and so on) of the
4868 operating system on which the executable runs, unless that component
4869 itself accompanies the executable.
4871 If distribution of executable or object code is made by offering
4872 access to copy from a designated place, then offering equivalent
4873 access to copy the source code from the same place counts as
4874 distribution of the source code, even though third parties are not
4875 compelled to copy the source along with the object code.
4877 4. You may not copy, modify, sublicense, or distribute the Program
4878 except as expressly provided under this License. Any attempt
4879 otherwise to copy, modify, sublicense or distribute the Program is
4880 void, and will automatically terminate your rights under this License.
4881 However, parties who have received copies, or rights, from you under
4882 this License will not have their licenses terminated so long as such
4883 parties remain in full compliance.
4885 5. You are not required to accept this License, since you have not
4886 signed it. However, nothing else grants you permission to modify or
4887 distribute the Program or its derivative works. These actions are
4888 prohibited by law if you do not accept this License. Therefore, by
4889 modifying or distributing the Program (or any work based on the
4890 Program), you indicate your acceptance of this License to do so, and
4891 all its terms and conditions for copying, distributing or modifying
4892 the Program or works based on it.
4894 6. Each time you redistribute the Program (or any work based on the
4895 Program), the recipient automatically receives a license from the
4896 original licensor to copy, distribute or modify the Program subject to
4897 these terms and conditions. You may not impose any further
4898 restrictions on the recipients' exercise of the rights granted herein.
4899 You are not responsible for enforcing compliance by third parties to
4902 7. If, as a consequence of a court judgment or allegation of patent
4903 infringement or for any other reason (not limited to patent issues),
4904 conditions are imposed on you (whether by court order, agreement or
4905 otherwise) that contradict the conditions of this License, they do not
4906 excuse you from the conditions of this License. If you cannot
4907 distribute so as to satisfy simultaneously your obligations under this
4908 License and any other pertinent obligations, then as a consequence you
4909 may not distribute the Program at all. For example, if a patent
4910 license would not permit royalty-free redistribution of the Program by
4911 all those who receive copies directly or indirectly through you, then
4912 the only way you could satisfy both it and this License would be to
4913 refrain entirely from distribution of the Program.
4915 If any portion of this section is held invalid or unenforceable under
4916 any particular circumstance, the balance of the section is intended to
4917 apply and the section as a whole is intended to apply in other
4920 It is not the purpose of this section to induce you to infringe any
4921 patents or other property right claims or to contest validity of any
4922 such claims; this section has the sole purpose of protecting the
4923 integrity of the free software distribution system, which is
4924 implemented by public license practices. Many people have made
4925 generous contributions to the wide range of software distributed
4926 through that system in reliance on consistent application of that
4927 system; it is up to the author/donor to decide if he or she is willing
4928 to distribute software through any other system and a licensee cannot
4931 This section is intended to make thoroughly clear what is believed to
4932 be a consequence of the rest of this License.
4934 8. If the distribution and/or use of the Program is restricted in
4935 certain countries either by patents or by copyrighted interfaces, the
4936 original copyright holder who places the Program under this License
4937 may add an explicit geographical distribution limitation excluding
4938 those countries, so that distribution is permitted only in or among
4939 countries not thus excluded. In such case, this License incorporates
4940 the limitation as if written in the body of this License.
4942 9. The Free Software Foundation may publish revised and/or new versions
4943 of the General Public License from time to time. Such new versions will
4944 be similar in spirit to the present version, but may differ in detail to
4945 address new problems or concerns.
4947 Each version is given a distinguishing version number. If the Program
4948 specifies a version number of this License which applies to it and "any
4949 later version", you have the option of following the terms and conditions
4950 either of that version or of any later version published by the Free
4951 Software Foundation. If the Program does not specify a version number of
4952 this License, you may choose any version ever published by the Free Software
4955 10. If you wish to incorporate parts of the Program into other free
4956 programs whose distribution conditions are different, write to the author
4957 to ask for permission. For software which is copyrighted by the Free
4958 Software Foundation, write to the Free Software Foundation; we sometimes
4959 make exceptions for this. Our decision will be guided by the two goals
4960 of preserving the free status of all derivatives of our free software and
4961 of promoting the sharing and reuse of software generally.
4965 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
4966 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
4967 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
4968 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
4969 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
4970 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
4971 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
4972 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
4973 REPAIR OR CORRECTION.
4975 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
4976 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
4977 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
4978 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
4979 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
4980 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
4981 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
4982 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
4983 POSSIBILITY OF SUCH DAMAGES.
4985 END OF TERMS AND CONDITIONS
4987 How to Apply These Terms to Your New Programs
4989 If you develop a new program, and you want it to be of the greatest
4990 possible use to the public, the best way to achieve this is to make it
4991 free software which everyone can redistribute and change under these terms.
4993 To do so, attach the following notices to the program. It is safest
4994 to attach them to the start of each source file to most effectively
4995 convey the exclusion of warranty; and each file should have at least
4996 the "copyright" line and a pointer to where the full notice is found.
4998 <one line to give the program's name and a brief idea of what it does.>
4999 Copyright (C) <year> <name of author>
5001 This program is free software; you can redistribute it and/or modify
5002 it under the terms of the GNU General Public License as published by
5003 the Free Software Foundation; either version 2 of the License, or
5004 (at your option) any later version.
5006 This program is distributed in the hope that it will be useful,
5007 but WITHOUT ANY WARRANTY; without even the implied warranty of
5008 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5009 GNU General Public License for more details.
5011 You should have received a copy of the GNU General Public License
5012 along with this program; if not, write to the Free Software
5013 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
5016 Also add information on how to contact you by electronic and paper mail.
5018 If the program is interactive, make it output a short notice like this
5019 when it starts in an interactive mode:
5021 Gnomovision version 69, Copyright (C) year name of author
5022 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5023 This is free software, and you are welcome to redistribute it
5024 under certain conditions; type `show c' for details.
5026 The hypothetical commands `show w' and `show c' should show the appropriate
5027 parts of the General Public License. Of course, the commands you use may
5028 be called something other than `show w' and `show c'; they could even be
5029 mouse-clicks or menu items--whatever suits your program.
5031 You should also get your employer (if you work as a programmer) or your
5032 school, if any, to sign a "copyright disclaimer" for the program, if
5033 necessary. Here is a sample; alter the names:
5035 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5036 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5038 <signature of Ty Coon>, 1 April 1989
5039 Ty Coon, President of Vice
5041 This General Public License does not permit incorporating your program into
5042 proprietary programs. If your program is a subroutine library, you may
5043 consider it more useful to permit linking proprietary applications with the
5044 library. If this is what you want to do, use the GNU Library General
5045 Public License instead of this License.
5050 License for Scintilla and SciTE
5051 ===============================
5053 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5057 Permission to use, copy, modify, and distribute this software and
5058 its documentation for any purpose and without fee is hereby granted,
5059 provided that the above copyright notice appear in all copies and
5060 that both that copyright notice and this permission notice appear in
5061 supporting documentation.
5063 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5064 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5065 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5066 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5067 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5068 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5069 USE OR PERFORMANCE OF THIS SOFTWARE.