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
718 You can customize the folding icon and line styles - see the
719 filetypes.common `Folding Settings`_.
721 If you don't like it or don't need it at all, you can simply disable
722 folding support completely in the preferences dialog.
724 The folding behaviour can be changed with the "Fold/Unfold all children of
725 a fold point" option in the preference dialog. If activated, Geany will
726 unfold all nested fold points below the current one if they are already
727 folded (when clicking on a [+] symbol).
728 When clicking on a [-] symbol, Geany will fold all nested fold points
729 below the current one if they are unfolded.
731 This option can be inverted by pressing the Shift
732 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
733 children of a fold point" option is enabled, pressing Shift will disable
734 it for this click and vice versa.
737 Column mode editing (rectangular selections)
738 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
740 There is basic support for column mode editing. To use it, create a
741 rectangular selection by holding down the Control and Shift keys
742 (or Control and Alt if it doesn't work) while
743 selecting some text. It is also possible to create a zero-column selection.
744 Once a rectangular selection exists you can start editing the text within
745 this selection and the modifications will be done for every line in the
749 Drag and drop of text
750 ^^^^^^^^^^^^^^^^^^^^^
752 If you drag selected text in the editor widget of Geany the text is
753 moved to the position where the mouse pointer is when releasing the
754 mouse button. Holding Control when releasing the mouse button will
755 copy the text instead. This behaviour was changed in Geany 0.11 -
756 before the selected text was copied to the new position.
762 Geany allows each document to indent either with a tab character or
763 multiple spaces. The default indent mode is set in the `Editor Features
764 preferences`_ (see the link for more information). But
765 this can be overridden using either the *Document->Indent Type* menu,
766 or by using the *Detect from file* indentation preference. When enabled,
767 this scans each file that is opened and sets the indent mode based on
768 how many lines start with a tab vs. 2 or more spaces.
770 The indent mode for the current document is shown on the status bar
774 Indent with Tab characters.
778 Indent with tabs and spaces, depending on how much indentation is
785 When enabled, auto-indentation happens when pressing *Enter* in the
786 Editor. It adds a certain amount of indentation to the new line so the
787 user doesn't always have to indent each line manually.
789 Geany has four types of auto-indentation:
792 Disables auto-indentation completely.
794 Adds the same amount of whitespace on a new line as on the last line.
796 Does the same as *Basic* but also indents a new line after an opening
797 brace '{', and de-indents when typing a closing brace '}'. For Python,
798 a new line will be indented after typing ':' at the end of the
801 Similar to *Current chars* but the closing brace will be aligned to
802 match the indentation of the line with the opening brace.
808 Geany provides a handy bookmarking feature that lets you mark one
809 or more lines in a document, and return the cursor to them using a
812 To place a mark on a line, either left-mouse-click in the left margin
813 of the editor window, or else use Ctrl-m. This will
814 produce a small green plus symbol in the margin. You can have as many
815 marks in a document as you like. Click again (or use Ctrl-m again)
816 to remove the bookmark. To remove all the marks in a given document,
817 use "Remove Markers" in the Document menu.
819 To navigate down your document, jumping from one mark to the next,
820 use Ctrl-. (control period). To go in the opposite direction on
821 the page, use Ctrl-, (control comma). Using the bookmarking feature
822 together with the commands to switch from one editor tab to another
823 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
824 navigate around multiple files.
827 Code navigation history
828 ^^^^^^^^^^^^^^^^^^^^^^^
830 To ease navigation in source files and especially between
831 different files, Geany lets you jump between different navigation
832 points. Currently, this works for the following:
834 * `Go to tag declaration`_
835 * `Go to tag definition`_
840 When using one of these actions, Geany remembers your current position
841 and jumps to the new one. If you decide to go back to your previous
842 position in the file, just use "Navigate back a location". To
843 get back to the new position again, just use "Navigate forward a
844 location". This makes it easier to navigate in e.g. foreign code
845 and between different files.
848 Sending text through custom commands
849 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
851 You can define several custom commands in Geany and send the current
852 selection to one of these commands using the "Edit->Format->Send
853 Selection to" menu or keybindings.
854 The output of the command will be
855 used to replace the current selection. This makes it possible to use text
856 formatting tools with Geany in a general way. The selected text will
857 be sent to the standard input of the executed command, so the command
858 should be able to read from it and it should print all results to its
859 standard output which will be read by Geany. To help finding errors
860 in executing the command, the output of the program's standard error
861 will be printed on Geany's standard output.
863 To add a custom command, just go to the Set Custom Commands dialog
864 in the Format sub menu of the Edit and Popup menu. Then click on Add
865 to get a new text entry and type the command. You can also specify
866 some command line options. To delete a command, just clear the text
867 entry and press OK. It will be deleted automatically.
873 You can execute the context action command on the current word at the
874 cursor position or the available selection. This word or selection
875 can be used as an argument to the command.
876 The context action is invoked by a menu entry in the popup menu of the
877 editor and also a keyboard shortcut (see the section called
880 The command can be specified in the preferences dialog and also for
881 each filetype (see "context_action_cmd" in the section called
882 `Format`_). When the context action is invoked, the filetype
883 specific command is used if available, otherwise the command
884 specified in the preferences dialog is executed.
886 The current word or selection can be referred with the wildcard "%s"
887 in the command, it will be replaced by the current word or
888 selection before the command is executed.
890 For example a context action can be used to open API documentation
891 in a browser window, the command to open the PHP API documentation
894 firefox "http://www.php.net/%s"
896 when executing the command, the %s is substituted by the word near
897 the cursor position or by the current selection. If the cursor is at
898 the word "echo", a browser window will open(assumed your browser is
899 called firefox) and it will open the address: http://www.php.net/echo.
905 Geany can offer a list of possible completions for symbols defined in the
906 tags and for all words in a document.
908 The autocompletion list for symbols is presented when the first few
909 characters of the symbol are typed (configurable, see `Editor Completions
910 preferences`_, default 4) or when the *Complete word*
911 keybinding is pressed (configurable, see `Editor keybindings`_,
914 When the defined keybinding is typed and the *Autocomplete all words in
915 document* preference (in `Editor Completions preferences`_)
916 is selected then the autocompletion list will show all matching words
917 in the document, if there are no matching symbols.
919 If you don't want to use autocompletion it can be dismissed until
920 the next symbol by pressing Escape. The autocompletion list is updated
921 as more characters are typed so that it only shows completions that start
922 with the characters typed so far. If no symbols begin with the sequence,
923 the autocompletion window is closed.
925 The up and down arrows will move the selected item. The highlighted
926 item on the autocompletion list can be chosen from the list by pressing
927 Enter/Return. You can also double-click to select an item. The sequence
928 will be completed to match the chosen item, and if the *Drop rest of
929 word on completion* preference is set (in `Editor Completions
930 preferences`_) then any characters after the cursor that match
931 a symbol or word are deleted.
935 By default, pressing Tab will complete the selected item by word part;
936 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
941 * gtk_combo_box_<e><TAB>
942 * gtk_combo_box_entry_<s><ENTER>
943 * gtk_combo_box_entry_set_text_column
945 The key combination can be changed from Tab - See `Editor keybindings`_.
946 If you clear/change the key combination for word part completion, Tab
947 will complete the whole word instead, like Enter.
959 When you type ``foo.`` it will show an autocompletion list with 'i' and
962 It only works for languages that set parent scope names for e.g. struct
963 members. Currently this means C-like languages. The C tag parser only
964 parses global scopes, so this won't work for structs or objects declared
968 User-definable snippets
969 ^^^^^^^^^^^^^^^^^^^^^^^
971 Snippets are small strings or code constructs which can be replaced or
972 completed to a more complex string. So you can save a lot of time when
973 typing common strings and letting Geany do the work for you.
974 To know what to complete or replace Geany reads a configuration file
975 called ``snippets.conf`` at startup.
977 Maybe you need to often type your name, so define a snippet like this::
982 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
983 with "Enrico Tröger". The key to start autocompletion can be changed
984 in the preferences dialog, by default it is TAB. The corresponding keybinding
985 is called ``Complete snippet``.
987 The system-wide configuration file can be found in
988 ``$prefix/share/geany``, where ``$prefix`` is the path where Geany is
989 installed (see `Installation prefix`_). It is not recommended to edit the
990 system-wide file, because it will be overridden when Geany is updated.
992 To change the settings, copy the file from ``$prefix/share/geany``
993 in your configuration directory (usually ``~/.config/geany/``).
997 % cp /usr/local/share/geany/snippets.conf /home/username/.config/geany/
999 Then you can edit the file and the changes will remain available
1000 after an update of Geany because the file resides in your
1001 configuration directory. Alternatively, you can create a file
1002 ``~/.config/geany/snippets.conf`` and add only these settings you want
1003 to change. All missing settings will be read from the global snippets
1004 file in ``$prefix/share/geany``.
1006 The file ``snippets.conf`` contains sections defining snippets that
1007 are available for particular filetypes and in general.
1009 The two sections "Default" and "Special" apply to all filetypes.
1010 "Default" contains all snippets which are available for every
1011 filetype and "Special" contains snippets which can only be used in
1012 other snippets. So you can define often used parts of snippets and
1013 just use the special snippet as a placeholder (see the
1014 ``snippets.conf`` for details).
1016 You can define sections with the name of a filetype eg "C++". The
1017 snippets in that section are only available for use in files with that
1018 filetype. Snippets in filetype sections will hide snippets with the
1019 same name in the "Default" section when used in a file of that
1022 To define snippets you can use several special character sequences which
1023 will be replaced when using the snippet:
1025 **Substitution Sequences for snippets**
1027 ================ =========================================================
1028 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1029 char(s): LF, CR/LF, or CR).
1031 \\t or %ws% Insert an indentation step, it will be replaced according
1032 to the current document's indent mode.
1034 \\s \\s to force whitespace at beginning or end of a value
1035 ('key= value' won't work, use 'key=\\svalue')
1037 %cursor% Place the cursor at this position after completion has
1038 been done. You can define multiple %cursor% wildcards
1039 and use the keybinding ``Move cursor in snippet`` to jump
1040 to the next defined cursor position in the completed
1043 %...% "..." means the name of a key in the "Special" section.
1044 If you have defined a key "brace_open" in the "Special"
1045 section you can use %brace_open% in any other snippet.
1046 ================ =========================================================
1048 Snippet names must not contain spaces otherwise they won't
1049 work correctly. But beside that you can define almost any
1050 string as a snippet and use it later in Geany. It is not limited
1051 to existing contructs of certain programming languages(like ``if``,
1052 ``for``, ``switch``). Define whatever you need.
1054 Since Geany 0.15 you can also use most of the available templates wildcards
1055 listed in `Template wildcards`_. All wildcards which are listed as
1056 `available in snippets` can be used. For instance to improve the above example::
1059 myname=My name is {developer}
1060 mysystem=My system: {command:uname -a}
1062 this will replace ``myname`` with "My name is " and the value of the template
1063 preference ``developer``.
1065 You can change the way Geany recognizes the word to complete,
1066 that is how the start and end of a word is recognised when the
1067 snippet completion is requested. The section "Special" may
1068 contain a key "wordchars" which lists all characters a string may contain
1069 to be recognized as a word for completion. Leave it commented to use
1070 default characters or define it to add or remove characters to fit your
1074 Inserting Unicode characters
1075 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1077 With GTK 2.10 and above, you can insert Unicode code points by hitting
1078 Ctrl-Shift-u, then still holding Ctrl-Shift, type some hex digits representing
1079 the code point for the character you want and hit Enter or Return (still
1080 holding Ctrl-Shift). If you release Ctrl-Shift before hitting Enter or Return
1081 (or any other character), the code insertion is completed, but the typed
1082 character is also entered. In the case of Enter/Return, it is a newline, as
1086 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1087 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1088 or restart Geany. Note that it works slightly differently from other GTK
1089 applications, in that you'll need to continue to hold down the Ctrl and Shift
1090 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1092 For GTK < 2.10, it is also possible, but typing the first Ctrl-Shift-u
1093 is not necessary. One problem is that you may find the alphabetic
1094 keys conflict with other Geany keybindings.
1098 Search, replace and go to
1099 -------------------------
1101 This section describes search-related commands from the Search menu
1102 and the editor window's popup menu:
1108 * Go to tag definition \*
1109 * Go to tag declaration \*
1112 \* These items are available from the editor window's popup menu, or by
1113 using a keyboard shortcut (see `Search keybindings`_).
1117 There are also two toolbar entries:
1122 There are keybindings to focus each of these - see `Focus
1123 keybindings`_. Pressing Escape will then focus the editor.
1127 The quickest way to find some text is to use the search bar entry in
1128 the toolbar. This performs a case-insensitive search in the current
1129 document whilst you type. Pressing Enter will search again.
1134 The Find dialog is used for finding text in one or more open documents.
1136 .. image:: ./images/find_dialog.png
1142 The syntax for the *Use regular expressions* option is shown in
1143 `Regular expressions`_.
1146 *Use escape sequences* is implied for regular expressions.
1148 The *Use escape sequences* option will transform any escaped characters
1149 into their UTF-8 equivalent. For example, \\t will be transformed into
1150 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1151 (Unicode characters).
1157 To find all matches, click on the Find All expander. This will reveal
1164 Find All In Document will show a list of matching lines in the
1165 current document in the Messages tab of the Message Window. *Find All
1166 In Session* does the same for all open documents.
1168 Mark will highlight all matches in the current document with a
1169 colored box. These markers can be removed by selecting the
1170 Remove Markers command from the Document menu.
1173 Change font in search dialog text fields
1174 ````````````````````````````````````````
1176 All search related dialogs use a Monospace for the text input fields to
1177 increase the readability of input text. This is useful when you are
1178 typing input such as regular expressions with spaces, periods and commas which
1179 might it hard to read with a proportional font.
1181 If you want to change the font, you can do this easily
1182 by inserting the following style into your ``.gtkrc-2.0``
1183 (usually found in your home directory on UNIX-like systems and in the
1184 etc subdirectory of your Geany installation on Windows)::
1186 style "search_style"
1188 font_name="Monospace 8"
1190 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1192 Please note the addition of ":highest" in the last line which sets the priority
1193 of this style to the highest available. Otherwise, the style is ignored
1194 for the search dialogs.
1200 Find usage searches all open files. It is similar to the Find All In
1201 Session option in the Find dialog.
1203 If there is a selection, then it is used as the search text; otherwise
1204 the current word is used. The current word is either taken from the
1205 word nearest the edit cursor, or the word underneath the popup menu
1206 click position when the popup menu is used. The search results are
1207 shown in the Messages tab of the Message Window.
1213 Find in files is a more powerful version of Find usage that searches
1214 all files in a certain directory using the Grep tool. The Grep tool
1215 must be correctly set in Preferences to the path of the system's Grep
1216 utility. GNU Grep is recommended.
1218 .. image:: ./images/find_in_files_dialog.png
1221 The Encoding combo box can be used to define the encoding of the files
1222 to be searched. The entered search text is converted to the chosen encoding
1223 and the search results are converted back to UTF-8.
1224 The Extra options field is used to pass any additional arguments to
1228 Filtering out version control files
1229 ```````````````````````````````````
1231 When using the *Recurse in subfolders* option with a directory that's
1232 under version control, you can set the *Extra options* field to filter
1233 out version control files.
1235 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1236 argument to filter out CVS and hidden directories like ``.svn``.
1238 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1240 If you have an older Grep, you can try using the ``--exclude`` flag
1241 to filter out filenames.
1243 SVN Example: ``--exclude=*.svn-base``
1245 The --exclude argument only matches the file name part, not the path.
1251 The Replace dialog is used for replacing text in one or more open
1254 .. image:: ./images/replace_dialog.png
1256 The Replace dialog has the same options for matching text as the Find
1257 dialog. See the section `Matching options`_.
1259 The *Use regular expressions* option allows regular expressions to
1260 be used in the search string and back references in the replacement
1261 text -- see the entry for '\\n' in `Regular expressions`_.
1266 To replace several matches, click on the *Replace All* expander. This
1267 will reveal several options:
1273 *Replace All In Document* will replace all matching text in the
1274 current document. *Replace All In Session* does the same for all open
1275 documents. *Replace All In Selection* will replace all matching text
1276 in the current selection of the current document.
1279 Go to tag definition
1280 ^^^^^^^^^^^^^^^^^^^^
1282 If the current word is the name of a tag definition (like a function
1283 body) and the file containing the tag definition is open, this command
1284 will switch to that file and go to the corresponding line number. The
1285 current word is either the word nearest the edit cursor,
1286 or the word underneath the popup menu click position when the popup
1290 Go to tag declaration
1291 ^^^^^^^^^^^^^^^^^^^^^
1293 Like Go to tag definition, but for a forward declaration such as a
1294 function prototype or ``extern`` declaration instead of a function
1301 Go to a particular line number in the current file.
1307 You can use regular expressions in the Find and Replace dialogs
1308 by selecting the *Use regular expressions* check box (see `Matching
1309 options`_). The syntax is POSIX compatible, as described in the table
1313 1. The *Use escape sequences* dialog option always applies for regular
1315 2. Searching backwards with regular expressions is not supported.
1316 3. \\b, \\d, \\s, \\w are GNU extensions and may not be available
1317 on non-GNU POSIX systems unless you built Geany with the
1318 ``--enable-gnu-regex`` option (this is always used on Windows).
1320 **In a regular expression, the following characters are interpreted:**
1322 ======= ============================================================
1323 . Matches any character.
1325 ( This marks the start of a region for tagging a match.
1327 ) This marks the end of a tagged region.
1329 \\n Where n is 1 through 9 refers to the first through ninth tagged
1330 region when searching or replacing.
1332 Searching for (Wiki)\\1 matches WikiWiki.
1334 If the search string was Fred([1-9])XXX and the
1335 replace string was Sam\\1YYY, when applied to Fred2XXX this
1336 would generate Sam2YYY.
1338 \\0 When replacing, the whole matching text.
1340 \\b This matches a word boundary.
1342 \\c A backslash followed by d, D, s, S, w or W, becomes a
1343 character class (both inside and outside sets []).
1346 * D: any char except decimal digits
1347 * s: whitespace (space, \\t \\n \\r \\f \\v)
1348 * S: any char except whitespace (see above)
1349 * w: alphanumeric & underscore
1350 * W: any char except alphanumeric & underscore
1352 \\x This allows you to use a character x that would otherwise have
1353 a special meaning. For example, \\[ would be interpreted as [
1354 and not as the start of a character set. Use \\\\ for a literal
1357 [...] Matches one of the characters in the set. If the first
1358 character in the set is ^, it matches the characters NOT in
1359 the set, i.e. complements the set. A shorthand S-E (start
1360 dash end) is used to specify a set of characters S up to E,
1363 The special characters ] and - have no special
1364 meaning if they appear first in the set. - can also be last
1365 in the set. To include both, put ] first: []A-Z-].
1369 []|-] matches these 3 chars
1370 []-|] matches from ] to | chars
1371 [a-z] any lowercase alpha
1372 [^]-] any char except - and ]
1373 [^A-Z] any char except uppercase alpha
1376 ^ This matches the start of a line (unless used inside a set, see
1379 $ This matches the end of a line.
1381 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1382 Saam, Saaam and so on.
1384 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1385 Saam, Saaam and so on.
1387 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1388 ======= ============================================================
1391 This table is adapted from Scintilla and SciTE documentation,
1392 distributed under the `License for Scintilla and SciTE`_.
1399 Tags are information that relates symbols in a program with the
1400 source file location of the declaration and definition.
1402 Geany has built-in functionality for generating tag information (aka
1403 "workspace tags") for supported filetypes when you open a file. You
1404 can also have Geany automatically load external tag files (aka "global
1405 tags files") upon startup, or manually using *Tools --> Load Tags*.
1407 Geany uses its own tag file format, similar to what ``ctags`` uses
1408 (but is incompatible with ctags). You use Geany to generate global
1409 tags files, as described below.
1415 Tags for each document are parsed whenever a file is loaded or
1416 saved. These are shown in the Symbol list in the Sidebar. These tags
1417 are also used for autocompletion of symbols and calltips for all documents
1418 open in the current session that have the same filetype.
1420 The *Go to Tag* commands can be used with all workspace tags. See
1421 `Go to tag definition`_.
1427 Global tags are used to provide autocompletion of symbols and calltips
1428 without having to open the corresponding source files. This is intended
1429 for library APIs, as the tags file only has to be updated when you upgrade
1432 You can load a custom global tags file in two ways:
1434 * Using the *Load Tags* command in the Tools menu.
1435 * By creating a directory ``~/.config/geany/tags``, and moving or symlinking
1436 the tags files there before starting Geany.
1437 * By creating a directory ``$prefix/share/geany/tags``, and moving
1438 or symlinking the tags files there before starting Geany.
1439 ``$prefix`` is the installation prefix (see `Installation prefix`_).
1441 You can either download these files or generate your own. They have
1446 *lang_ext* is one of the extensions set for the filetype associated
1447 with the tags. See the section called `Filetype extensions`_ for
1451 Default global tags files
1452 `````````````````````````
1454 For some languages, a list of global tags is loaded when the
1455 corresponding filetype is first used. Currently these are for:
1457 * C -- GTK+ and GLib
1460 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1465 Global tags file format
1466 ```````````````````````
1468 Global tags files can have two different formats:
1471 * Pipe-separated format
1473 The first line of global tags files should be a comment, introduced
1474 by ``#`` followed by a space and a string like ``format=pipe``
1475 or ``format=tagmanager`` respectively, these are case-sensitive.
1476 This helps Geany to read the file properly. If this line
1477 is missing, Geany tries to auto-detect the used format but this
1481 The Tagmanager format is a bit more complex and is used for files
1482 created by the ``geany -g`` command. There is one tag per line.
1483 Different tag attributes like the return value or the argument list
1484 are separated with different characters indicating the type of the
1487 The Pipe-separated format is easier to read and write.
1488 There is one tag per line and different tag attributes are separated
1489 by the pipe character (``|``). A line looks like::
1491 basename|string|(string path [, string suffix])|
1493 | The first field is the tag name (usually a function name).
1494 | The second field is the type of the return value.
1495 | The third field is the argument list for this tag.
1496 | The fourth field is the description for this tag but
1497 currently unused and should be left empty.
1499 Except for the first field (tag name), all other field can be left
1500 empty but the pipe separator must appear for them.
1502 You can easily write your own global tag files using this format.
1503 Just save them in your tags directory, as described earlier in the
1504 section `Global tags`_.
1507 Generating a global tags file
1508 `````````````````````````````
1510 You can generate your own global tags files by parsing a list of
1511 source files. The command is::
1513 geany -g [-P] <Tag File> <File list>
1515 * Tag File filename should be in the format described earlier --
1516 see the section called `Global tags`_.
1517 * File list is a list of filenames, each with a full path (unless
1518 you are generating C/C++ tags and have set the CFLAGS environment
1519 variable appropriately).
1520 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1521 to process ``#include`` directives for C/C++ source files. Use this
1522 option if you want to specify each source file on the command-line
1523 instead of using a 'master' header file. Also can be useful if you
1524 don't want to specify the CFLAGS environment variable.
1526 Example for the wxD library for the D programming language::
1528 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1531 *Generating C/C++ tag files:*
1533 For C/C++ tag files, gcc and grep are required, so that header files
1534 can be preprocessed to include any other headers they depend upon.
1536 For C/C++ files, the environment variable CFLAGS should be set with
1537 appropriate ``-I/path`` include paths. The following example works with
1538 the bash shell, generating tags for the GnomeUI library::
1540 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1541 /usr/include/libgnomeui-2.0/gnome.h
1543 You can adapt this command to use CFLAGS and header files appropriate
1544 for whichever libraries you want.
1547 *Replacing the default C/C++ tags file:*
1549 Geany currently uses a default global tags file c99.tags for
1550 C and C++, commonly installed in /usr/share/geany. This file can
1551 be replaced with one containing tags parsed from a different set
1552 of header files. When Geany is next started, your custom tags file
1553 will be loaded instead of the default c99.tags. You should keep a
1554 copy of the generated tags file because it will get overwritten when
1561 You can also ignore certain tags if they would lead to wrong parsing of
1562 the code. Simply create a file called "ignore.tags" in your Geany
1563 configuration directory (usually ``~/.config/geany/``). Then list all tags
1564 you want to ignore in this file, separated by spaces and/or newlines.
1566 More detailed information about the usage from the Exuberant Ctags
1569 Specifies a list of identifiers which are to be specially handled
1570 while parsing C and C++ source files. This option is specifically
1571 provided to handle special cases arising through the use of
1572 pre-processor macros. When the identifiers listed are simple identifiers,
1573 these identifiers will be ignored during parsing of the source files.
1574 If an identifier is suffixed with a '+' character, ctags will also
1575 ignore any parenthesis-enclosed argument list which may immediately
1576 follow the identifier in the source files.
1577 If two identifiers are separated with the '=' character, the first
1578 identifiers is replaced by the second identifiers for parsing purposes.
1580 For even more detailed information please read the manual page of
1587 You may adjust Geany's settings using the Edit --> Preferences
1588 dialog. Any changes you make there can be applied by hitting either
1589 the Apply or the OK button. These settings will persist between Geany
1590 sessions. Note that most settings here have descriptive popup bubble
1591 help -- just hover the mouse over the item in question to get help
1594 You may also adjust some View settings (under the View menu) that
1595 persist between Geany sessions. The settings under the Document menu,
1596 however, are only for the current document and revert to defaults
1597 when restarting Geany.
1599 There are also some rarer `Hidden preferences`_.
1602 In the paragraphs that follow, the text describing a dialog tab
1603 comes after the screenshot of that tab.
1606 General Startup preferences
1607 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1609 .. image:: ./images/pref_dialog_gen_startup.png
1614 Load files from the last session
1615 On startup, load the same files you had open the last time you
1618 Load virtual terminal support
1619 Load the library for running a terminal in the message window area.
1621 Enable plugin support
1622 Allow plugins to be used in Geany.
1626 Save window position and geometry
1627 Save the current position and size of the main window so next time
1628 you open Geany it's in the same location.
1631 Have a dialog pop up to confirm that you really want to quit Geany.
1637 Path to start in when opening or saving files.
1638 It must be an absolute path.
1639 Leave it blank to use the current working directory.
1642 Path to start in when opening project files.
1645 By default Geany looks in the global installation path and in the
1646 configuration directory. In addition the path entered here will be searched
1647 for plugins. Usually you do not need to set an additional path to search for
1648 plugins. It might be useful when Geany is installed on a multi-user machine
1649 and additional plugins are available in a common location for all users.
1650 Leave blank to not set an additional lookup path.
1653 General Miscellaneous preferences
1654 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1656 .. image:: ./images/pref_dialog_gen_misc.png
1661 Beep on errors when compilation has finished
1662 Have the computer make a beeping sound when compilation of your program
1663 has completed or any errors occurred.
1665 Switch status message list at new message
1666 Switch to the status message tab (in the notebook window at the bottom)
1667 once a new status message arrives.
1669 Suppress status messages in the status bar
1670 Remove all messages from the status bar. The messages are still displayed
1671 in the status messages window.
1674 Another option is to use the *Switch to Editor* keybinding - it
1675 reshows the document statistics on the status bar. See `Focus
1678 Use Windows File Open/Save dialogs
1679 Defines whether to use the native Windows File Open/Save dialogs or
1680 whether to use the GTK default dialogs.
1682 Auto-focus widgets (focus follows mouse)
1683 Give the focus automatically to widgets below the mouse cursor.
1684 This works for the main editor widget, the scribble, the toolbar search field
1685 goto line fields and the VTE.
1690 Always wrap search and hide the Find dialog
1691 Always wrap search around the document and hide the Find dialog after clicking
1694 Use the current word under the cursor for Find dialogs
1695 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1696 there is no selection. When this option is disabled, the search term last used in the
1697 appropriate Find dialog is used.
1699 Use the current file's directory for Find in Files
1700 When opening the Find in Files dialog, set the directory to search to the directory of the current
1701 active file. When this option is disabled, the directory of the last use of the Find in Files
1707 Use project-based session files
1708 Save your current session when closing projects. You will be able to
1709 resume different project sessions, automatically opening the files
1710 you had open previously.
1712 Store project file inside the project base directory
1713 When creating new projects, the default path for the project file contains
1714 the project base path. Without this option enabled, the default project file
1715 path is one level above the project base path.
1716 In either case, you can easily set the final project file path in the
1717 *New Project* dialog. This option provides the more common
1718 defaults automatically for convenience.
1721 Interface preferences
1722 ^^^^^^^^^^^^^^^^^^^^^
1724 .. image:: ./images/pref_dialog_interface.png
1730 Whether to show the sidebar at all.
1733 Show the list of functions, variables, and other information in the
1734 current document you are editing.
1737 Show all the documents you have open currently. This can be used to
1738 change between documents (see `Switching between documents`_) and
1739 to perform some common operations such as saving, closing and reloading.
1742 Whether to place the sidebar on the left or right of the editor window.
1748 Change the font used to display documents.
1751 Change the font used for the Symbols sidebar tab.
1754 Change the font used for the message window area.
1760 Show a notebook tab for all documents so you can switch between them
1761 using the mouse (instead of using the Documents window).
1764 Make each tab show a close button so you can easily close open
1767 Placement of new file tabs
1768 Whether to create a document with its notebook tab to the left or
1769 right of all existing tabs.
1772 Whether to place file tabs next to the current tab
1773 rather than at the edges of the notebook.
1775 Double-clicking hides all additional widgets
1776 Whether to call the View->Toggle All Additional Widgets command
1777 when double-clicking on a notebook tab.
1783 Set the positioning of the editor's notebook tabs to the right,
1784 left, top, or bottom of the editing window.
1787 Set the positioning of the sidebar's notebook tabs to the right,
1788 left, top, or bottom of the sidebar window.
1791 Set the positioning of the message window's notebook tabs to the
1792 right, left, top, or bottom of the message window.
1798 Show the status bar at the bottom of the main window. It gives information about
1799 the file you are editing like the line and column you are on, whether any
1800 modifications were done, the file encoding, the filetype and other information.
1806 Affects the main toolbar underneath the menu bar.
1808 .. image:: ./images/pref_dialog_toolbar.png
1814 Whether to show the toolbar.
1816 Append Toolbar to the Menu
1817 Allows to append the toolbar to the main menu bar instead of placing it below.
1818 This is useful to save vertical space.
1821 See `Customizing the toolbar`_.
1827 Select the toolbar icon style to use - either icons and text, just
1829 The choice System default uses whatever icon style is set by GTK.
1832 Select the size of the icons you see (large, small or very small).
1833 The choice System default uses whatever icon size is set by GTK.
1836 Editor Features preferences
1837 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1839 .. image:: ./images/pref_dialog_edit_features.png
1845 Show long lines wrapped around to new display lines.
1847 Enable "smart" home key
1848 Whether to move the cursor to the first non-whitespace character
1849 on the line when you hit the home key on your keyboard. Pressing it
1850 again will go to the very start of the line.
1852 Disable Drag and Drop
1853 Do not allow the dragging and dropping of selected text in documents.
1856 Allow groups of lines in a document to be collapsed for easier
1859 Fold/Unfold all children of a fold point
1860 Whether to fold/unfold all child fold points when a parent line
1863 Use indicators to show compile errors
1864 Underline lines with compile errors using red squiggles to indicate
1865 them in the editor area.
1867 Newline strip trailing spaces
1868 Remove any white space at the end of the line when you hit the
1871 Line breaking column
1872 The editor column number to insert a newline at when Line Breaking
1873 is enabled for the current document.
1875 Comment toggle marker
1876 A string which is added when toggling a line comment in a source file.
1877 It is used to mark the comment as toggled.
1880 Editor Indentation preferences
1881 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1883 .. image:: ./images/pref_dialog_edit_indentation.png
1888 See `Indentation`_ for more information.
1891 When Geany inserts indentation, whether to use:
1895 * Tabs and Spaces, depending on how much indentation is on a line
1897 The *Tabs and Spaces* indent type is also known as *Soft tab
1898 support* in some other editors.
1901 The width of a single indent size in spaces. By default the indent
1902 size is equivalent to 4 spaces.
1905 Try to detect and set the indent type based on file content, when
1909 The type of auto-indentation you wish to use after pressing Enter,
1913 Just add the indentation of the previous line.
1915 Add indentation based on the current filetype and any characters at
1916 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
1918 Like *Current chars* but for C-like languages, make a closing
1919 ``}`` brace line up with the matching opening brace.
1922 If set, pressing tab will indent the current line or selection, and
1923 unindent when pressing Shift-tab. Otherwise, the tab key will
1924 insert a tab character into the document (which can be different
1925 from indentation, depending on the indent type).
1928 There are also separate configurable keybindings for indent &
1929 unindent, but this preference allows the tab key to have different
1930 meanings in different contexts - e.g. for snippet completion.
1932 Editor Completions preferences
1933 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1935 .. image:: ./images/pref_dialog_edit_completions.png
1941 Whether to replace special keywords after typing Tab into a
1942 pre-defined text snippet.
1943 See `User-definable snippets`_.
1945 XML tag autocompletion
1946 When you open an XML tag automatically generate its completion tag.
1948 Automatic continuation multi-line comments
1949 Continue automatically multi-line comments in languages like C, C++
1950 and Java when a new line is entered inside such a comment.
1951 With this option enabled, Geany will insert a ``*`` on every new line
1952 inside a multi-line comment, for example when you press return in the
1956 * This is a C multi-line comment, press <Return>
1958 then Geany would insert::
1962 on the next line with the correct indentation based on the previous line,
1963 as long as the multi-line is not closed by ``*/``.
1965 Autocomplete symbols
1966 When you start to type a symbol name, look for the full string to
1967 allow it to be completed for you.
1969 Autocomplete all words in document
1970 When you start to type a word, Geany will search the whole document for
1971 words starting with the typed part to complete it, assuming there
1972 are no tag names to show.
1974 Drop rest of word on completion
1975 Remove any word part to the right of the cursor when choosing a
1976 completion list item.
1978 Characters to type for autocompletion
1979 Number of characters of a word to type before autocompletion is
1982 Completion list height
1983 The number of rows to display for the autocompletion window.
1985 Max. symbol name suggestions
1986 The maximum number of items in the autocompletion list.
1989 Auto-close quotes and brackets
1990 ``````````````````````````````
1992 Geany can automatically insert a closing bracket and quote characters when
1993 you open them. For instance, you type a ``(`` and Geany will automatically
1994 insert ``)``. With the following options, you can define for which
1995 characters this should work.
1998 Auto-close parenthesis when typing an opening one
2001 Auto-close curly brackets (braces) when typing an opening one
2004 Auto-close square brackets when typing an opening one
2007 Auto-close single quotes when typing an opening one
2010 Auto-close double quotes when typing an opening one
2013 Editor Display preferences
2014 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2016 This is for visual elements displayed in the editor window.
2018 .. image:: ./images/pref_dialog_edit_display.png
2023 Invert syntax highlighting colors
2024 Invert all colors, by default this makes white text on a black
2027 Show indendation guides
2028 Show vertical lines to help show how much leading indentation there
2032 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2033 show which kinds of whitespace are used.
2036 Display a symbol everywhere that a carriage return or line feed
2040 Show or hide the Line Number margin.
2043 Show or hide the small margin right of the line numbers, which is used
2046 Stop scrolling at last line
2047 When enabled Geany stops scrolling when at the last line of the document.
2048 Otherwise you can scroll one more page even if there are no real lines.
2054 The long line marker helps to indicate overly-long lines, or as a hint
2055 to the user for when to break the line.
2059 Show a thin vertical line in the editor window at the given column
2062 Change the background color of characters after the given column
2063 position to the color set below. (This is recommended over the
2064 *Line* setting if you use proportional fonts).
2066 Don't mark long lines at all.
2069 Set this value to a value greater than zero to specify the column
2070 where it should appear.
2072 Long line marker color
2073 Set the color of the long line marker.
2079 Virtual space is space beyond the end of each line.
2080 The cursor may be moved into virtual space but no real space will be
2081 added to the document until there is some text typed or some other
2082 text insertion command is used.
2085 Do not show virtual spaces
2087 Only for rectangular selections
2088 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2091 Always show virtual spaces beyond the end of lines
2097 .. image:: ./images/pref_dialog_files.png
2102 Open new documents from the command-line
2103 Whether to create new documents when passing filenames that don't
2104 exist from the command-line.
2106 Default encoding (new files)
2107 The type of file encoding you wish to use when creating files.
2109 Used fixed encoding when opening files
2110 Assume all files you are opening are using the type of encoding specified below.
2112 Default encoding (existing files)
2113 Opens all files with the specified encoding instead of auto-detecting it.
2114 Use this option when it's not possible for Geany to detect the exact encoding.
2116 Default end of line characters
2117 The end of line characters to which should be used for new files.
2118 On Windows systems, you generally want to use CR/LF which are the common
2119 characters to mark line breaks.
2120 On Unix-like systems, LF is default and CR is used on MAC systems.
2124 Perform formatting operations when a document is saved. These
2125 can each be undone with the Undo command.
2127 Ensure newline at file end
2128 Add a newline at the end of the document if one is missing.
2130 Strip trailing spaces
2131 Remove the trailing spaces on each line of the document.
2133 Replace tabs by space
2134 Replace all tabs in the document with the equivalent number of spaces.
2137 It is better to use spaces to indent than use this preference - see
2143 Recent files list length
2144 The number of files to remember in the recently used files list.
2147 The number of seconds to periodically check the current document's
2148 file on disk in case it has changed. Setting it to 0 will disable
2152 These checks are only performed on local files. Remote files are
2153 not checked for changes due to performance issues
2154 (remote files are files in ``~/.gvfs/``).
2160 .. image:: ./images/pref_dialog_tools.png
2166 The location of your terminal executable.
2169 The location of your web browser executable.
2172 The location of the grep executable.
2175 For Windows users: at the time of writing it is recommended to use
2176 the grep.exe from the UnxUtils project
2177 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2178 Mingw project for instance might not work with Geany at the moment.
2184 Set this to a command to execute on the current word.
2185 You can use the "%s" wildcard to pass the current word below the cursor
2186 to the specified command.
2189 Template preferences
2190 ^^^^^^^^^^^^^^^^^^^^
2192 This data is used as meta data for various template text to insert into
2193 a document, such as the file header. You only need to set fields that
2194 you want to use in your template files.
2197 For changes made here to take effect, you must either select
2198 *Tools->Reload Configuration* or restart Geany.
2200 .. image:: ./images/pref_dialog_templ.png
2206 The name of the developer who will be creating files.
2209 The initials of the developer.
2212 The email address of the developer.
2215 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2218 The company the developer is working for.
2221 The initial version of files you will be creating.
2224 Specify a format for the the {year} wildcard. You can use any conversion specifiers
2225 which can be used with the ANSI C strftime function. For details please see
2226 http://man.cx/strftime.
2229 Specify a format for the the {date} wildcard. You can use any conversion specifiers
2230 which can be used with the ANSI C strftime function. For details please see
2231 http://man.cx/strftime.
2234 Specify a format for the the {datetime} wildcard. You can use any conversion specifiers
2235 which can be used with the ANSI C strftime function. For details please see
2236 http://man.cx/strftime.
2239 Keybinding preferences
2240 ^^^^^^^^^^^^^^^^^^^^^^
2242 .. image:: ./images/pref_dialog_keys.png
2244 There are some commands listed in the keybinding dialog that are not, by default,
2245 bound to a key combination, and may not be available as a menu item.
2248 For more information see the section `Keybindings`_.
2251 Printing preferences
2252 ^^^^^^^^^^^^^^^^^^^^
2254 .. image:: ./images/pref_dialog_printing.png
2256 Use external command for printing
2257 Use a system command to print your file out.
2259 Use native GTK printing
2260 Let the GTK GUI toolkit handle your print request.
2263 Print the line numbers on the left of your paper.
2266 Print the page number on the bottom right of your paper.
2269 Print a header on every page that is sent to the printer.
2271 Use base name of the printed file
2272 Don't use the entire path for the header, only the filename.
2275 How the date should be printed. You can use the same format
2276 specifiers as in the ANSI C function strftime(). For details please
2277 see http://man.cx/strftime.
2280 Terminal (VTE) preferences
2281 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2283 See also: `Virtual terminal emulator widget (VTE)`_.
2285 .. image:: ./images/pref_dialog_vte.png
2291 Select the font that will be used in the terminal emulation control.
2294 Select the font color.
2297 Select the background color of the terminal.
2300 The number of lines buffered so that you can scroll though the history.
2303 The location of the shell on your system.
2306 Scroll the terminal to the prompt line when pressing a key.
2309 Scroll the output down.
2312 Let the terminal cursor blink.
2314 Override Geany keybindings
2315 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2317 Disable menu shortcut key (F10 by default)
2318 Disable the menu shortcut when you are in the virtual terminal.
2320 Follow path of the current file
2321 Make the path of the terminal change according to the path of the
2324 Execute programs in VTE
2325 Execute programs in the virtual terminal instead of using the external
2326 terminal tool. Note that if you run multiple execute commands at once
2327 the output may become mixed together in the VTE.
2329 Don't use run script
2330 Don't use the simple run script which is usually used to display
2331 the exit status of the executed program.
2332 This can be useful if you already have a program running in the VTE
2333 like a Python console (e.g. ipython). Use this with care.
2339 Project Management is optional in Geany. Currently it can be used for:
2341 * Storing and opening session files on a project basis.
2342 * Configuring the Build menu on a project basis.
2344 A list of session files can be stored and opened with the project
2345 when the *Use project-based session files* preference is enabled,
2346 in the *Project* group of the `Preferences`_ dialog.
2348 As long as a project is open, the Build menu will use
2349 the items defined in project's settings, instead of the defaults.
2350 See `Build Menu Configuration`_ for information on configuring the menu.
2352 The current project's settings are saved when it is closed, or when
2353 Geany is shutdown. When restarting Geany, the previously opened project
2354 file that was in use at the end of the last session will be reopened.
2356 The project menu items are detailed below.
2362 To create a new project, fill in the *Name* field. By default this
2363 will setup a new project file ``~/projects/name.geany``. Usually it's
2364 best to store all your project files in the same directory (they are
2365 independent of any source directory trees).
2367 The Base path text field is setup to use ``~/projects/name``. This
2368 can safely be set to any existing path -- it will not touch the file
2369 structure contained in it.
2375 You can set an optional description for the project, but it is not
2376 used elsewhere by Geany.
2378 The *Base path* field is used as the directory to run the Build menu commands.
2379 The specified path can be an absolute path or it is considered to be
2380 relative to the project's file name.
2383 Set Base Path Button
2384 ````````````````````
2386 This button is a convenience to set the working directory fields
2387 in the non-filetype Build menu items to %p to use the project base path.
2390 Pressing the 'set' button will override any working directories
2391 you have configured for the project.
2397 The Open command displays a standard file chooser, starting in
2398 ``~/projects``. Choose a project file named with the ``.geany``
2401 When project session support is enabled, Geany will close the currently
2402 open files and open the session files associated with the project.
2408 Project file settings are saved when the project is closed.
2410 When project session support is enabled, Geany will close the project
2411 session files and open any previously closed default session files.
2416 After editing code with Geany, the next step is to compile, link, build,
2417 interpret, run etc. As Geany supports many languages each with a different
2418 approach to such operations, and as there are also many language independent
2419 software building systems, Geany does not have a built-in build system, nor
2420 does it limit which system you can use. Instead the build menu provides
2421 a configurable and flexible means of running any external commands to
2422 execute your preferred build system.
2424 This section provides a description of the default configuration of the
2425 build menu and then covers how to configure it, and where the defaults fit in.
2427 Running the commands from within Geany has two benefits:
2429 * The current file is automatically saved before the command is run.
2430 * The output is captured in the Compiler notebook tab and parsed for
2433 Warnings and errors that can be parsed for line numbers will be shown in
2434 red in the Compiler tab and you can click on them to switch to the relevant
2435 source file (or open it) and mark the line number. Also lines with
2436 warnings or errors are marked in the source, see `Indicators`_ below.
2439 If Geany's default error message parsing does not parse errors for
2440 the tool you're using, you can set a custom regex in the Build Commands
2441 Dialog, see `Build Menu Configuration`_.
2446 Indicators are red squiggly underlines which are used to highlight
2447 errors which occurred while compiling the current file. So you can
2448 easily see where your code failed to compile. You can remove them by
2449 selecting *Remove Error Indicators* in the Document menu.
2451 If you do not like this feature, you can disable it - see `Editor Features
2455 Default Build Menu Items
2456 ^^^^^^^^^^^^^^^^^^^^^^^^
2457 Depending on the current file's filetype, the default Build menu will contain
2458 the following items:
2463 * Make Custom Target
2468 * Set Build Menu Commands
2474 The Compile command has different uses for different kinds of files.
2476 For compilable languages such as C and C++, the Compile command is
2477 set up to compile the current source file into a binary object file.
2479 Java source files will be compiled to class file bytecode.
2481 Interpreted languages such as Perl, Python, Ruby will compile to
2482 bytecode if the language supports it, or will run a syntax check,
2483 or if that is not available will run the file in its language interpreter.
2488 For compilable languages such as C and C++, the Build command will link
2489 the current source file's equivalent object file into an executable. If
2490 the object file does not exist, the source will be compiled and linked
2491 in one step, producing just the executable binary.
2493 Interpreted languages do not use the Build command.
2496 If you need complex settings for your build system, or several
2497 different settings, then writing a Makefile and using the Make
2498 commands is recommended; this will also make it easier for users to
2499 build your software.
2505 This runs "make" in the same directory as the
2511 This is similar to running 'Make' but you will be prompted for
2512 the make target name to be passed to the Make tool. For example,
2513 typing 'clean' in the dialog prompt will run "make clean".
2519 Make object will run "make current_file.o" in the same directory as
2520 the current file, using the filename for 'current_file'. It is useful
2521 for building just the current file without building the whole project.
2526 The next error item will move to the next detected error in the file.
2530 The previous error item will move to the previous detected error in the file.
2535 Execute will run the corresponding executable file, shell script or
2536 interpreted script in a terminal window. Note that the Terminal tool
2537 path must be correctly set in the Tools tab of the Preferences dialog -
2538 you can use any terminal program that runs a Bourne compatible shell
2539 and accept the "-e" command line argument to start a command or can be
2540 selected to use the built-in VTE if it is available - see
2541 `Virtual terminal emulator widget (VTE)`_.
2543 After your program or script has finished executing, you will be
2544 prompted to press the return key. This allows you to review any text
2545 output from the program before the terminal window is closed.
2548 The execute command output is not parsed for errors.
2551 Stopping running processes
2552 ``````````````````````````
2554 When there is a running program, the Execute menu item in the menu and
2555 the Run button in the toolbar
2556 each become a stop button so you can stop the current running program (and
2557 any child processes). This works by sending the SIGQUIT signal to the process.
2559 Depending on the process you started it is possible that the process
2560 cannot be stopped. For example this can happen when the process creates
2561 more than one child process.
2567 Xterm is known to work properly. If you are using "Terminal"
2568 (the terminal program of Xfce), you should add the command line
2569 option ``--disable-server`` otherwise the started process cannot be
2570 stopped. Just add this option in the preferences dialog on the Tools
2571 tab in the terminal field.
2577 By default the Compile and Build commands invoke the GCC compiler and
2578 linker with only the basic arguments needed by all programs. Using
2579 *Set Build Commands* you can add any include paths and compile
2580 flags for the compiler, any library names and paths for the linker,
2581 and any arguments you want to use when running Execute.
2583 Build Menu Configuration
2584 ^^^^^^^^^^^^^^^^^^^^^^^^
2586 The build menu has considerable flexibility and configurability, allowing
2587 both menu labels the commands they execute and the directory they execute
2588 in to be configured.
2590 For example, if you change one of the default make commands to run say 'waf'
2591 you can also change the label to match.
2593 These settings are saved automatically when Geany is shut down.
2595 The build menu is divided into four groups of items each with different
2598 * File items - are configurable and depend on the filetype of the current
2599 document; they capture output in the compiler tab and parse it for
2601 * Non-file items - are configurable and mostly don't depend on the filetype
2602 of the current document; they also capture output in the compiler tab and
2603 parse it for errors.
2604 * Execute items - are configurable and intended for executing your
2605 program or other long running programs. The output is not parsed for errors
2606 and is directed to the terminal selected in preferences.
2607 * Fixed items - these perform built-in actions:
2608 * Go to the next error.
2609 * Go to the previous error.
2610 * Show the build menu commands dialog.
2612 The maximum numbers of items in each of the configurable groups can be
2613 configured when Geany starts using hidden settings (see `Preferences File Format`_).
2614 Even though the maximum number of items may have been increased, only
2615 those menu items that have values configured are shown in the menu.
2617 The groups of menu items obtain their configuration from four potential
2618 sources. The highest priority source that has the menu item defined will
2619 be used. The sources in decreasing priority are:
2621 * A project file if open
2622 * The user preferences
2623 * The system filetype definitions
2626 The detailed relationships between sources and the configurable menu item groups
2627 is shown in the following table.
2629 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2630 | Group | Project File | Preferences | System Filetype | Defaults |
2631 +==============+=====================+==========================+===================+===============================+
2632 | Filetype | Loads From: project | Loads From: | Loads From: | None |
2633 | | file | filetype.xxx file in | filetype.xxx in | |
2634 | | | ~/.config/geany/filedefs | Geany install | |
2635 | | Saves To: project | | | |
2636 | | file | Saves to: as above, | Saves to: as user | |
2637 | | | creating if needed. | preferences left. | |
2638 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2639 | Non-Filetype | Loads From: project | Loads From: | Loads From: | 1: |
2640 | | file | geany.conf file in | filetype.xxx in | Label: _Make |
2641 | | | ~/.config/geany | Geany install | Command: make |
2642 | | Saves To: project | | | |
2643 | | file | Saves to: as above, | Saves to: as user | 2: |
2644 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
2645 | | | | | Command: make |
2648 | | | | | Label: Make _Object |
2649 | | | | | Command: make %e.o |
2650 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2651 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute Command: ./%e |
2652 | | file or else | geany.conf file in | filetype.xxx in | |
2653 | | filetype defined in | ~/.config/geany or else | Geany install | |
2654 | | project file | filetype.xxx file in | | |
2655 | | | ~/.config/geany/filedefs | Saves To: as user | |
2656 | | Saves To: | | preferences left | |
2657 | | project file | Saves To: | | |
2658 | | | filetype.xxx file in | | |
2659 | | | ~/.config/geany/filedefs | | |
2660 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
2662 The following notes on the table reference cells by coordinate as (group,source):
2664 * General - for filetype.xxx substitute the filetype name of the
2665 current document for xxx.
2667 * System Filetypes - Labels loaded from these sources are locale sensitive
2668 and can contain translations.
2670 * (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
2671 filetype file so that users can configure all other filetype preferences
2672 as well. Projects can only configure menu items per filetype. Saving
2673 in the project file means that there is only one file per project not
2676 * (Non-Filetype, System Filetype) - although conceptually strange, defining
2677 non-filetype commands in a filetype file, this provides the ability to
2678 define filetype dependent default menu items.
2680 * (Execute, Project File) and (Execute, Preferences) - the project filetype based execute
2681 configuration and preferences non-filetype based execute can only be set by hand editing the
2682 appropriate file, see `Preferences File Format`_ and `Project File Format`_.
2684 Build Menu Commands Dialog
2685 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2687 Most of the configuration of the build menu is done through the Build Menu
2688 Commands Dialog. You edit the configuration sourced from preferences in the
2689 dialog opened from the Build->Build Menu Commands item and you edit the
2690 configuration from the project in the build tab of the project preferences
2691 dialog. Both use the same form shown below.
2693 .. image:: ./images/build_menu_commands_dialog.png
2695 The dialog is divided into three sections:
2697 * Filetype menu items which will be selected based on the filetype of the
2698 currently open document.
2699 * Non-filetype menu items.
2700 * Execute menu items.
2702 The filetype and non-filetype sections also each contain a field for the regular
2703 expression used for parsing command output for error and warning messages.
2705 The columns in the first three sections allow setting of the label, command,
2706 and working directory to run the command in.
2708 An item with an empty label will not be shown in the menu.
2710 An empty working directory will default to the directory of the current document.
2711 If there is no current document then the command will not run.
2713 The dialog will always show the command selected by priority, not just the
2714 commands configured in this configuration source. This ensures that you always
2715 see what the menu item is going to do if activated.
2717 If the current source of the menu item is higher priority than the
2718 configuration source you are editing then the command will be shown
2719 in the dialog but will be insensitive (greyed out). This can't happen
2720 with the project source but can with the preferences source dialog.
2722 The clear buttons remove the definition from the configuration source you are editing.
2723 When you do this the command from the next lower priority source will be shown.
2724 To hide lower priority menu items without having anything show in the menu
2725 configure with a nothing in the label but at least one character in the command.
2727 Substitutions in Commands and Working Directories
2728 `````````````````````````````````````````````````
2730 The first occurance of each of the following character sequences in each of the
2731 command and working directory fields is substituted by the items specified below
2732 before the command is run.
2734 * %d - substituted by the absolute path to the directory of the current file.
2735 * %e - substituted by the name of the current file without the extension or path.
2736 * %f - substituted by the name of the current file without the path.
2737 * %p - if a project is open, substituted by the base path from the project.
2740 If the basepath set in the project preferences is not an absolute path , then it is
2741 taken as relative to the directory of the project file. This allows a project file
2742 stored in the source tree to specify all commands and working directories relative
2743 to the tree itself, so that the whole tree including the project file, can be moved
2744 and even checked into and out of version control without having to re-configure the
2747 Build Menu Keyboard Shortcuts
2748 `````````````````````````````
2750 Keyboard shortcuts can be defined for the first two filetype menu items, the first three
2751 non-filetype menu items, the first two execute menu items and the fixed menu items.
2752 In the keybindings configuration dialog (see `Keybinding preferences`_)
2753 these items are identified by the default labels shown in the `Build Menu`_ section above.
2755 It is currently not possible to bind keyboard shortcuts to more than these menu items.
2757 You can also use underlines in the labels to set mnemonic characters.
2762 The configurable Build Menu capability was introduced in Geany V0.19 and
2763 required a new section to be added to the configuration files (See
2764 `Preferences File Format`_). Geany will still load older format project,
2765 preferences and filetype file settings and will attempt to map them into the new
2766 configuration format. There is not a simple clean mapping between the formats.
2767 The mapping used produces the most sensible results for the majority of cases.
2768 However, if they do not map the way you want, you may have to manually
2769 configure some settings using the Build Commands
2770 Dialog or the Build tab of the project preferences dialog.
2772 Any setting configured in either of these dialogs will override settings mapped from
2773 older format configuration files.
2778 Since Geany 0.13 there has been printing support using GTK's printing API.
2779 The printed page(s) will look nearly the same as on your screen in Geany.
2780 Additionally, there are some options to modify the printed page(s).
2783 The background text color is set to white, except for text with
2784 a white foreground. This allows dark color schemes to save ink
2787 You can define whether to print line numbers, page numbers at the bottom of
2788 each page and whether to print a page header on each page. This header
2789 contains the filename of the printed document, the current page number and
2790 the date and time of printing. By default, the file name of the document
2791 with full path information is added to the header. If you prefer to add
2792 only the basename of the file(without any path information) you can set it
2793 in the preferences dialog. You can also adjust the format of the date and
2794 time added to the page header. The available conversion specifiers are the
2795 same as the ones which can be used with the ANSI C strftime function.
2797 All of these settings can also be changed in the print dialog just before
2798 actual printing is done.
2799 On Unix-like systems the provided print dialog offers a print preview. The
2800 preview file is opened with a PDF viewer and by default GTK uses ``evince``
2801 for print preview. If you have not installed evince or just want to use
2802 another PDF viewer, you can change the program to use in the file
2803 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
2806 gtk-print-preview-command = "epdfview %f"
2808 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
2809 as the print preview command.
2811 Unfortunately, native GTK printing support is only available if Geany was
2812 built against GTK 2.10 (or above) **and** is running with GTK 2.10 (or above).
2813 If not, Geany provides basic printing support. This means you can print a
2814 file by passing the filename of the current file to a command which
2815 actually prints the file. However, the printed document contains no syntax
2816 highlighting. You can adjust the command to which the filename is
2817 passed in the preferences dialog. The default command is::
2821 ``%f`` will be substituted by the filename of the current file. Geany
2822 will not show errors from the command itself, so you should make
2823 sure that it works before(e.g. by trying to execute it from the
2826 A nicer example, which many prefer is::
2828 % a2ps -1 --medium=A4 -o - %f | xfprint4
2830 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
2831 gtklp or similar programs can be used.
2838 Plugins are loaded at startup, if the *Enable plugin support*
2839 general preference is set. There is also a command-line option,
2840 ``-p``, which prevents plugins being loaded. Plugins are scanned in
2841 the following directories:
2843 * ``$prefix/lib/geany`` (see `Installation prefix`_)
2844 * ``~/.config/geany/plugins``
2846 Most plugins add menu items to the *Tools* menu when they are loaded.
2848 Since Geany 0.13, there is a Plugin Manager to let you choose which plugins
2849 should be loaded at startup. You can also load and unload plugins on the
2850 fly using this dialog. Once you click the checkbox for a specific plugin
2851 in the dialog, it is loaded or unloaded according to its previous state.
2852 By default, no plugins are loaded at startup until you select some.
2853 You can also configure some plugin specific options when the plugin
2856 See also `Plugin documentation`_ for information about single plugins
2857 which are included in Geany.
2863 Geany supports the default keyboard shortcuts for the Scintilla
2864 editing widget. For a list of these commands, see `Scintilla
2865 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
2866 by any custom keybindings with the same keyboard shortcut.
2872 There are a few non-configurable bindings to switch between documents,
2873 listed below. These can also be overridden by custom keybindings.
2875 =============== ==================================
2877 =============== ==================================
2878 Alt-[1-9] Select left-most tab, from 1 to 9.
2879 Alt-0 Select right-most tab.
2880 Ctrl-Shift-PgUp Select left-most tab.
2881 Ctrl-Shift-PgDn Select right-most tab.
2882 =============== ==================================
2885 Configurable keybindings
2886 ^^^^^^^^^^^^^^^^^^^^^^^^
2888 For all actions listed below you can define your own keybindings. Open
2889 the Preferences dialog, select the desired action and click on
2890 change. In the resulting dialog you can press the key combination you
2891 want to assign to the action and it will be saved when you press OK.
2892 You can define only one key combination for each action and each key
2893 combination can only be defined for one action.
2895 Some of the default key combinations are common across many
2896 applications, for example *Ctrl-N* for New and *Ctrl-O* for Open.
2897 Because they are so common it is not advisable to change these, but
2898 you can add other key combinations for these actions. For example
2899 *Ctrl-O* is set to execute menu_open by default, but you can also
2900 define *Alt-O*, so that the file open dialog is shown by pressing
2901 either *Ctrl-O* or *Alt-O*.
2903 The following tables list all customizable keyboard shortcuts, those
2904 which are common to many applications are marked with (C) after the
2909 =============================== ========================= ==================================================
2910 Action Default shortcut Description
2911 =============================== ========================= ==================================================
2912 New Ctrl-N (C) Creates a new file.
2914 Open Ctrl-O (C) Opens a file.
2916 Open selected file Ctrl-Shift-O Opens the selected filename.
2918 Re-open last closed tab Re-opens the last closed document tab.
2920 Save Ctrl-S (C) Saves the current file.
2922 Save As Saves the current file under a new name.
2924 Save all Ctrl-Shift-S Saves all open files.
2926 Close all Ctrl-Shift-W Closes all open files.
2928 Close Ctrl-W (C) Closes the current file.
2930 Reload file Ctrl-R (C) Reloads the current file. All unsaved changes
2933 Print Ctrl-P (C) Prints the current file.
2934 =============================== ========================= ==================================================
2939 =============================== ========================= ==================================================
2940 Action Default shortcut Description
2941 =============================== ========================= ==================================================
2942 Undo Ctrl-Z (C) Un-does the last action.
2944 Redo Ctrl-Y Re-does the last action.
2946 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
2949 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
2950 end of the current line.
2952 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
2954 Transpose current line Ctrl-T Transposes the current line with the previous one.
2956 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
2957 view. The cursor position and or an existing
2958 selection will not be changed.
2960 Scroll up by one line Alt-Up Scrolls the view.
2962 Scroll down by one line Alt-Down Scrolls the view.
2964 Complete word Ctrl-Space Shows the autocompletion list. If already showing
2965 tag completion, it shows document word completion
2966 instead, even if it is not enabled for automatic
2967 completion. Likewise if no tag suggestions are
2968 available, it shows document word completion.
2970 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
2973 Show macro list Ctrl-Return Shows a list of available macros and variables in
2976 Complete snippet Tab If you type a construct like if or for and press
2977 this key, it will be completed with a matching
2980 Suppress snippet completion If you type a construct like if or for and press
2981 this key, it will not be completed, and a space or
2982 tab will be inserted, depending on what the
2983 construct completion keybinding is set to. For
2984 example, if you have set the construct completion
2985 keybinding to space, then setting this to
2986 Shift+space will prevent construct completion and
2989 Context Action Executes a command and passes the current word
2990 (near the cursor position) or selection as an
2991 argument. See the section called `Context
2994 Move cursor in snippet Jumps to the next defined cursor positions in a
2995 completed snippets if multiple cursor positions
2998 Word part completion Tab When the autocompletion list is visible, complete
2999 the currently selected item up to the next word
3002 Move line(s) up Move the current line or selected lines up by
3005 Move line(s) down Move the current line or selected lines down by
3007 =============================== ========================= ==================================================
3010 Clipboard keybindings
3011 `````````````````````
3012 =============================== ========================= ==================================================
3013 Action Default shortcut Description
3014 =============================== ========================= ==================================================
3015 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3017 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3019 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3021 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3022 selection) to the clipboard.
3024 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3025 selection) to the clipboard.
3026 =============================== ========================= ==================================================
3031 =============================== ========================= ==================================================
3032 Action Default shortcut Description
3033 =============================== ========================= ==================================================
3034 Select all Ctrl-A (C) Makes a selection of all text in the current
3037 Select current word Alt-Shift-W Selects the current word under the cursor.
3039 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3040 which is defined by two empty lines around it.
3042 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3043 partially selected lines).
3045 Select to previous word part (Extend) selection to previous word part boundary.
3047 Select to next word part (Extend) selection to next word part boundary.
3048 =============================== ========================= ==================================================
3053 =============================== ========================= ==================================================
3054 Action Default shortcut Description
3055 =============================== ========================= ==================================================
3056 Insert date Shift-Alt-D Inserts a customisable date.
3058 Insert alternative whitespace Inserts a tab character when spaces should
3059 be used for indentation and inserts space
3060 characters of the amount of a tab width when
3061 tabs should be used for indentation.
3062 =============================== ========================= ==================================================
3067 =============================== ========================= ==================================================
3068 Action Default shortcut Description
3069 =============================== ========================= ==================================================
3070 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3071 selection will be changed into uppercase and vice
3072 versa. If the selection contains lower- and
3073 uppercase characters, all will be converted to
3076 Comment line Comments current line or selection.
3078 Uncomment line Uncomments current line or selection.
3080 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3081 a comment if the line is commented.
3083 Increase indent Ctrl-I Indents the current line or selection by one tab
3084 or by spaces in the amount of the tab width
3087 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3088 the tab width setting from the indentation of the
3089 current line or selection.
3091 Increase indent by one space Indents the current line or selection by one
3094 Decrease indent by one space Deindents the current line or selection by one
3097 Smart line indent Indents the current line or all selected lines
3098 with the same indentation as the previous line.
3100 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3101 external command (available for the first
3102 three configured commands, see
3103 `Sending text through custom commands`_ for
3106 Send Selection to Terminal Sends the current selection or the current
3107 line (if there is no selection) to the
3108 embedded Terminal (VTE).
3110 Reflow lines/block Reformat selected lines or current
3111 (indented) text block,
3112 breaking lines at the long line marker or the
3113 line breaking column if line breaking is
3114 enabled for the current document.
3115 =============================== ========================= ==================================================
3118 Settings keybindings
3119 ````````````````````
3120 =============================== ========================= ==================================================
3121 Action Default shortcut Description
3122 =============================== ========================= ==================================================
3123 Preferences Ctrl-Alt-P Opens preferences dialog.
3125 Plugin Preferences Opens plugin preferences dialog.
3126 =============================== ========================= ==================================================
3131 =============================== ========================= ==================================================
3132 Action Default shortcut Description
3133 =============================== ========================= ==================================================
3134 Find Ctrl-F (C) Opens the Find dialog.
3136 Find Next Ctrl-G Finds next result.
3138 Find Previous Ctrl-Shift-G Finds previous result.
3140 Replace Ctrl-H (C) Opens the Replace dialog.
3142 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3144 Next message Jumps to the line with the next message in
3145 the Messages window.
3147 Previous message Jumps to the line with the previous message
3148 in the Messages window.
3150 Find Usage Finds all occurrences of the current word (near
3151 the keyboard cursor) or selection in all open
3152 documents and displays them in the messages
3155 Find Document Usage Finds all occurrences of the current word (near
3156 the keyboard cursor) or selection in the current
3157 document and displays them in the messages
3160 Mark All Ctrl-Shift-M Highlight all matches of the current
3161 word/selection in the current document
3162 with a colored box. If there's nothing to
3163 find, highlighted matches will be cleared.
3164 =============================== ========================= ==================================================
3169 =============================== ========================= ==================================================
3170 Action Default shortcut Description
3171 =============================== ========================= ==================================================
3172 Navigate forward a location Switches to the next location in the navigation
3173 history. See the section called `Code Navigation
3176 Navigate back a location Switches to the previous location in the
3177 navigation history. See the section called
3178 `Code navigation history`_.
3180 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3181 shows the Go to line dialog.
3183 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3184 is moved to the brace which belongs to the current
3185 one. If this keyboard shortcut is pressed again,
3186 the cursor is moved back to the first brace.
3188 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3189 marker if there already is one.
3191 Goto next marker Ctrl-. Goto the next marker in the current document.
3193 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3195 Go to tag definition Jump to the definition of the current word (near
3196 the keyboard cursor). If the definition cannot be
3197 found (e.g. the relevant file is not open) Geany
3198 will beep and do nothing. See the section called
3199 `Go to tag definition`_.
3201 Go to tag declaration Jump to the declaration of the current word (near
3202 the keyboard cursor). If the declaration cannot be
3203 found (e.g. the relevant file is not open) Geany
3204 will beep and do nothing. See the section called
3205 `Go to tag declaration`_.
3207 Go to Start of Line Home Move the caret to the end of the line indentation
3208 unless it is already there, in which case it moves
3209 it to the start of the line.
3211 Go to End of Line End Move the caret to the end of the line.
3213 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3214 This is useful when you use line wrapping and
3215 want to jump to the end of the wrapped, virtual
3216 line, not the real end of the whole line.
3217 If the line is not wrapped, it behaves like
3218 `Go to End of Line`, see above.
3220 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3222 Go to Next Word Part Ctrl-\ Goto the next part of the current word.
3223 =============================== ========================= ==================================================
3227 =============================== ========================= ==================================================
3228 Action Default shortcut Description
3229 =============================== ========================= ==================================================
3230 Fullscreen F11 (C) Switches to fullscreen mode.
3232 Toggle Messages Window Toggles the message window (status and compiler
3233 messages) on and off.
3235 Toggle Sidebar Shows or hides the sidebar.
3237 Toggle all additional widgets Hide and show all additional widgets like the
3238 notebook tabs, the toolbar, the messages window
3241 Zoom In Ctrl-+ (C) Zooms in the text.
3243 Zoom Out Ctrl-- (C) Zooms out the text.
3245 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3246 =============================== ========================= ==================================================
3250 ================================ ========================= ==================================================
3251 Action Default shortcut Description
3252 ================================ ========================= ==================================================
3253 Switch to Editor F2 Switches to editor widget.
3254 Also reshows the document statistics line
3255 (after a short timeout).
3257 Switch to Scribble F6 Switches to scribble widget.
3259 Switch to VTE F4 Switches to VTE widget.
3261 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3264 Switch to Sidebar Focus the Sidebar.
3266 Switch to Compiler Focus the Compiler message window tab.
3268 Switch to Messages Focus the Messages message window tab.
3270 Switch to Message Window Focus the Message Window's current tab.
3272 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3275 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3277 ================================ ========================= ==================================================
3280 Notebook tab keybindings
3281 ````````````````````````
3282 =============================== ========================= ==================================================
3283 Action Default shortcut Description
3284 =============================== ========================= ==================================================
3285 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3287 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3289 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3291 Holding Ctrl (or another modifier if the keybinding
3292 has been changed) will show a dialog, then repeated
3293 presses of the keybinding will switch to the 2nd-last
3294 used document, 3rd-last, etc. Also known as
3295 Most-Recently-Used documents switching.
3297 Move document left Alt-PageUp Changes the current document with the left hand
3300 Move document right Alt-PageDown Changes the current document with the right hand
3303 Move document first Moves the current document to the first position.
3305 Move document last Moves the current document to the last position.
3306 =============================== ========================= ==================================================
3309 Document keybindings
3310 ````````````````````
3311 =============================== ========================= ==================================================
3312 Action Default shortcut Description
3313 =============================== ========================= ==================================================
3314 Replace tabs by space Replaces all tabs with the right amount of spaces.
3316 Replace spaces by tabs Replaces all spaces with tab characters.
3318 Toggle current fold Toggles the folding state of the current code block.
3320 Fold all Folds all contractible code blocks.
3322 Unfold all Unfolds all contracted code blocks.
3324 Reload symbol list Ctrl-Shift-R Reloads the tag/symbol list.
3326 Toggle Line wrapping Enables or disables wrapping of long lines.
3328 Toggle Line breaking Enables or disables automatic breaking of long
3329 lines at a configurable column.
3331 Remove Markers Remove any markers on lines or words which
3332 were set by using 'Mark All' in the
3333 search dialog or by manually marking lines.
3335 Remove Error Indicators Remove any error indicators in the
3337 =============================== ========================= ==================================================
3342 =============================== ========================= ==================================================
3343 Action Default shortcut Description
3344 =============================== ========================= ==================================================
3345 Compile F8 Compiles the current file.
3347 Build F9 Builds (compiles if necessary and links) the
3350 Make all Shift-F9 Builds the current file with the Make tool.
3352 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3355 Make object Compiles the current file with the Make tool.
3357 Next error Jumps to the line with the next error from the
3360 Previous error Jumps to the line with the previous error from
3361 the last build process.
3363 Run F5 Executes the current file in a terminal emulation.
3365 Set Build Commands Opens the build commands dialog.
3366 =============================== ========================= ==================================================
3371 =============================== ========================= ==================================================
3372 Action Default shortcut Description
3373 =============================== ========================= ==================================================
3374 Show Color Chooser Opens the Color Chooser dialog.
3375 =============================== ========================= ==================================================
3380 =============================== ========================= ==================================================
3381 Action Default shortcut Description
3382 =============================== ========================= ==================================================
3383 Help F1 (C) Opens the manual.
3384 =============================== ========================= ==================================================
3392 You must use UTF-8 encoding *without BOM* for configuration files.
3397 There's a *Configuration files* submenu in the *Tools* menu that
3398 contains items for some of the available user configuration files.
3399 Clicking on one opens it in the editor for you to update. Geany will
3400 reload the file after you have saved it.
3403 Other configuration files not shown here will need to be opened
3404 manually, and will not be automatically reloaded when saved.
3405 (see *Reload Configuration* below).
3407 There's also a *Reload Configuration* item which can be used if you
3408 updated one of the other configuration files, or modified or added
3411 *Reload Configuration* is also necessary to update syntax highlighting colors.
3414 Syntax highlighting colors aren't updated in open documents after
3415 saving filetypes.common as this can possibly take a significant
3419 Global configuration file
3420 -------------------------
3422 There is a global configuration file for Geany which will be used for
3423 any settings not defined in the users local configuration file.
3424 Settings present in the local configuration file override those in the global
3427 The global configuration file is read from
3428 ``$prefix/share/geany/geany.conf`` (where ``$prefix`` is the path where
3429 Geany is installed, see `Installation prefix`_) when starting Geany and
3430 an user configuration file does not exist. It can contain any settings
3431 which are found in the usual configuration file created by Geany but
3432 does not have to contain all settings.
3435 This feature is mainly intended for package maintainers or system
3436 admins who want to set up Geany in a multi user environment and
3437 set some sane default values for this environment. Usually users won't
3442 Filetype definition files
3443 -------------------------
3445 All color definitions and other filetype specific settings are
3446 stored in the filetype definition files. Those settings are colors
3447 for syntax highlighting, general settings like comment characters or
3448 word delimiter characters as well as compiler and linker settings.
3452 At startup Geany looks for ``filetypes.*.conf`` files in the system and
3453 user filetype paths, adding any filetypes found with the name matching
3454 the '``*``' wildcard.
3456 Custom filetypes are not as powerful as built-in filetypes, but the following
3457 have been implemented:
3459 * Recognizing and setting the filetype (after the user has manually edited
3460 ``filetype_extensions.conf``).
3461 * Filetype settings in the [settings] section (see `Format`_).
3462 * Using existing tag parsing (``tag_parser`` key).
3463 * Using existing syntax highlighting (``lexer_filetype`` key).
3465 * Loading global tags files (namespace will be shared with tag_parser
3470 The system-wide configuration files can be found in
3471 ``$prefix/share/geany`` and are called ``filetypes.$ext``,
3472 where ``$prefix`` is the path where Geany is installed (see
3473 `Installation prefix`_) and $ext is the name of the filetype. For every
3474 filetype there is a corresponding definition file. There is one
3475 exception: ``filetypes.common`` -- this file is for general settings,
3476 which are not specific to a certain filetype.
3479 It is not recommended that users edit the system-wide files,
3480 because they will be overridden when Geany is updated.
3484 To change the settings, copy a file from ``$prefix/share/geany`` to
3485 the subdirectory filedefs in your configuration directory (usually
3486 ``~/.config/geany/``).
3490 % cp /usr/local/share/geany/filetypes.c /home/username/.config/geany/filedefs/
3492 Then you can edit the file and the changes are also
3493 available after an update of Geany because they reside in your
3494 configuration directory. Alternatively, you can create a file
3495 ``~/.config/geany/filedefs/filetypes.X`` and add only these settings you want
3496 to change. All missing settings will be read from the corresponding
3497 global definition file in ``$prefix/share/geany``.
3499 As well as the sections listed below, each filetype file can contain
3500 a [build-menu] section as described in `[build-menu] Section`_.
3509 In this section the colors for syntax highlighting are defined. The
3512 * ``key=foreground_color;background_color;bold_flag;italic_flag``
3514 Colors have to be specified as RGB hex values prefixed by
3515 0x. For example red is 0xff0000, blue is 0x0000ff. The values are
3516 case-insensitive, but it is a good idea to use small letters. Bold
3517 and italic are flags and should only be "true" or "false". If their
3518 value is something other than "true" or "false", "false" is assumed.
3520 You can omit fields to use the values from the style named ``"default"``.
3522 E.g. ``key=0xff0000;;true``
3524 This makes the key style have red foreground text, default background
3525 color text and bold emphasis.
3529 The second format uses a *named style* name to reference a style
3530 defined in filetypes.common.
3532 * ``key=named_style``
3533 * ``key2=named_style2,bold,italic``
3535 The bold and italic parts are optional, and if present are used to
3536 toggle the bold or italic flags to the opposite of the named style's
3537 flags. In contrast to style definition booleans, they are a literal
3538 ",bold,italic" and commas are used instead of semi-colons.
3540 E.g. ``key=comment,italic``
3542 This makes the key style match the ``"comment"`` named style, but with
3545 To define named styles, see the filetypes.common `[named_styles]
3552 This section contains keys for different keyword lists specific to
3553 the filetype. Some filetypes do not support keywords, so adding a
3554 new key will not work. You can only add or remove keywords to/from
3558 The keywords list must be in one line without line ending characters.
3561 [lexer_properties] Section
3562 ``````````````````````````
3563 Here any special properties for the Scintilla lexer can be set in the
3564 format ``key.name.field=some.value``.
3571 This is the default file extension used when saving files, not
3572 including the period character (``.``). The extension used should
3573 match one of the patterns associated with that filetype (see
3574 `Filetype extensions`_).
3576 *Example:* ``extension=cxx``
3579 These characters define word boundaries when making selections
3580 and searching using word matching options.
3582 *Example:* (look at system filetypes.\* files)
3585 A character or string which is used to comment code. If you want to
3586 use multiline comments, also set comment_close, otherwise leave it
3589 *Example:* ``comment_open=/*``
3592 If multiline comments are used, this is the character or string to
3595 *Example:* ``comment_close=*/``
3598 Set this to false if a comment character or string should start at
3599 column 0 of a line. If set to true it uses any indentation of the
3602 Note: Comment indentation
3604 ``comment_use_indent=true`` would generate this if a line is
3605 commented (e.g. with Ctrl-D)::
3609 ``comment_use_indent=false`` would generate this if a line is
3610 commented (e.g. with Ctrl-D)::
3612 # command_example();
3615 Note: This setting only works for single line comments (like '//',
3618 *Example:* ``comment_use_indent=true``
3621 A command which can be executed on the current word or the current
3624 Example usage: Open the API documentation for the
3625 current function call at the cursor position.
3628 be set for every filetype or if not set, a global command will
3629 be used. The command itself can be specified without the full
3630 path, then it is searched in $PATH. But for security reasons,
3631 it is recommended to specify the full path to the command. The
3632 wildcard %s will be replaced by the current word at the cursor
3633 position or by the current selection.
3635 Hint: for PHP files the following could be quite useful:
3636 context_action_cmd=firefox "http://www.php.net/%s"
3638 *Example:* ``context_action_cmd=devhelp -s "%s"``
3641 The TagManager language name, e.g. "C".
3644 A filetype name to setup syntax highlighting from another filetype.
3645 This must not be recursive, i.e. it should be a filetype name that
3646 doesn't use the lexer_filetype key itself.
3649 [build_settings] Section
3650 ````````````````````````
3652 As of Geany v0.19 this section is supplemented by the `[build-menu] Section`_.
3653 Values that are set in the [build-menu] section will override those in this section.
3656 This is a GNU-style extended regular expression to parse a filename
3657 and line number from build output. If undefined, Geany will fall
3658 back to its default error message parsing.
3660 Only the first two matches will be read by Geany. Geany will look for
3661 a match that is purely digits, and use this for the line number. The
3662 remaining match will be used as the filename.
3664 *Example:* ``error_regex=(.+):([0-9]+):[0-9]+``
3666 This will parse a message such as:
3667 ``test.py:7:24: E202 whitespace before ']'``
3671 If any build menu item settings have been configured in the Build Menu Commands
3672 dialog or the Build tab of the project preferences dialog then these
3673 settings are stored in the [build-menu] section and override the settings in
3674 this section for that item.
3677 This item specifies the command to compile source code files. But
3678 it is also possible to use it with interpreted languages like Perl
3679 or Python. With these filetypes you can use this option as a kind of
3680 syntax parser, which sends output to the compiler message window.
3682 You should quote the filename to also support filenames with
3683 spaces. The following wildcards for filenames are available:
3685 * %f -- complete filename without path
3686 * %e -- filename without path and without extension
3688 *Example:* ``compiler=gcc -Wall -c "%f"``
3691 This item specifies the command to link the file. If the file is not
3692 already compiled, it will be compiled while linking. The -o option
3693 is automatically added by Geany. This item works well with GNU gcc,
3694 but may be problematic with other compilers (esp. with the linker).
3696 *Example:* ``linker=gcc -Wall "%f"``
3699 Use this item to execute your file. It has to have been built
3700 already. Use the %e wildcard to have only the name of the executable
3701 (i.e. without extension) or use the %f wildcard if you need the
3702 complete filename, e.g. for shell scripts.
3704 *Example:* ``run_cmd="./%e"``
3707 Special file filetypes.common
3708 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3710 There is a special filetype definition file called
3711 filetypes.common. This file defines some general non-filetype-specific
3714 See the `Format`_ section for how to define styles.
3717 [named_styles] Section
3718 ``````````````````````
3719 Named styles declared here can be used in the [styling] section of any
3724 *In filetypes.common*::
3727 foo=0xc00000;0xffffff;false;true
3735 This saves copying and pasting the whole style definition into several
3739 You can define aliases for named styles, as shown with the ``bar``
3740 entry in the above example, but they must be declared after the
3747 This is the default style. It is used for styling files without a
3750 *Example:* ``default=0x000000;0xffffff;false;false``
3753 The style for coloring selected text. The format is:
3757 * Use foreground color
3758 * Use background color
3760 The colors are only set if the 3rd or 4th argument is true. When
3761 the colors are not overridden, the default is a dark grey
3762 background with syntax highlighted foreground text.
3764 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
3767 The style for brace highlighting when a matching brace was found.
3769 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
3772 The style for brace highlighting when no matching brace was found.
3774 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
3777 The style for coloring the caret(the blinking cursor). Only first
3778 and third argument is interpreted.
3779 Set the third argument to true to change the caret into a block caret.
3781 *Example:* ``caret=0x000000;0x0;false;false``
3784 The width for the caret(the blinking cursor). Only the first
3785 argument is interpreted. The width is specified in pixels with
3786 a maximum of three pixel. Use the width 0 to make the caret
3789 *Example:* ``caret=1;0;false;false``
3792 The style for coloring the background of the current line. Only
3793 the second and third arguments are interpreted. The second argument
3794 is the background color. Use the third argument to enable or
3795 disable background highlighting for the current line (has to be
3798 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
3801 The style for coloring the indentation guides. Only the first and
3802 second arguments are interpreted.
3804 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
3807 The style for coloring the white space if it is shown. The first
3808 both arguments define the foreground and background colors, the
3809 third argument sets whether to use the defined foreground color
3810 or to use the color defined by each filetype for the white space.
3811 The fourth argument defines whether to use the background color.
3813 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
3815 .. _Folding Settings:
3818 The style of folding icons. Only first and second arguments are
3821 Valid values for the first argument are:
3828 Valid values for the second argument are:
3831 * 1 -- for straight lines
3832 * 2 -- for curved lines
3834 *Default:* ``folding_style=1;1;``
3836 *Arrows:* ``folding_style=3;0;``
3839 Draw a thin horizontal line at the line where text is folded. Only
3840 first argument is used.
3842 Valid values for the first argument are:
3844 * 0 -- disable, do not draw a line
3845 * 1 -- draw the line above folded text
3846 * 2 -- draw the line below folded text
3848 *Example:* ``folding_horiz_line=0;0;false;false``
3851 First argument: drawing of visual flags to indicate a line is wrapped.
3852 This is a bitmask of the values:
3854 * 0 -- No visual flags
3855 * 1 -- Visual flag at end of subline of a wrapped line
3856 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
3857 indented by at least 1 to make room for the flag.
3859 Second argument: wether the visual flags to indicate a line is wrapped
3860 are drawn near the border or near the text. This is a bitmask of the values:
3862 * 0 -- Visual flags drawn near border
3863 * 1 -- Visual flag at end of subline drawn near text
3864 * 2 -- Visual flag at begin of subline drawn near text
3866 Only first and second argument is interpreted.
3868 *Example:* ``line_wrap_visuals=3;0;false;false``
3871 First argument: sets the size of indentation of sublines for wrapped lines
3872 in terms of the width of a space, only used when the second argument is ``0``.
3874 Second argument: wrapped sublines can be indented to the position of their
3875 first subline or one more indent level. Possible values:
3877 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
3878 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
3879 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
3881 Only first and second argument is interpreted.
3883 *Example:* ``line_wrap_indent=0;1;false;false``
3886 Translucency for the current line (first argument) and the selection
3887 (second argument). Values between 0 and 256 are accepted.
3889 Note for Windows 95, 98 and ME users:
3890 keep this value at 256 to disable translucency otherwise Geany might crash.
3892 Only the first and second argument is interpreted.
3894 *Example:* ``translucency=256;256;false;false``
3897 The style for a highlighted line (e.g when using Goto line or goto tag).
3898 The foreground color (first argument) is only used when the Markers margin
3899 is enabled (see View menu).
3901 Only the first and second argument is interpreted.
3903 *Example:* ``marker_line=0x000000;0xffff00;false;false``
3906 The style for a marked search results (when using "Mark" in Search dialogs).
3907 The second argument sets the background colour for the drawn rectangle.
3909 Only the second argument is interpreted.
3911 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
3914 The style for a marked line (e.g when using the "Toggle Marker" keybinding
3915 (Ctrl-M)). The foreground color (first argument) is only used
3916 when the Markers margin is enabled (see View menu).
3918 Only the first and second argument is interpreted.
3920 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
3923 Translucency for the line marker (first argument) and the search marker
3924 (second argument). Values between 0 and 256 are accepted.
3926 Note for Windows 95, 98 and ME users:
3927 keep this value at 256 to disable translucency otherwise Geany might crash.
3929 Only the first and second argument is interpreted.
3931 *Example:* ``marker_translucency=256;256;false;false``
3934 Amount of space to be drawn above and below the line's baseline.
3935 The first argument defines the amount of space to be drawn above the line, the second
3936 argument defines the amount of space to be drawn below.
3938 Only the first and second argument is interpreted.
3940 *Example:* ``line_height=0;0;false;false``
3943 The style for coloring the calltips. The first two arguments
3944 define the foreground and background colors, the third and fourth
3945 arguments set whether to use the defined colors.
3947 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
3953 Characters to treat as whitespace. These characters are ignored
3954 when moving, selecting and deleting across word boundaries
3955 (see `Scintilla keyboard commands`_).
3957 This should include space (\\s) and tab (\\t).
3959 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
3966 To change the default filetype extension used when saving a new file,
3967 see `Filetype definition files`_.
3969 You can override the list of file extensions that Geany uses for each
3970 filetype using the ``filetype_extensions.conf`` file.
3972 To override the system-wide configuration file, copy it from
3973 ``$prefix/share/geany`` to your configuration directory, usually
3974 ``~/.config/geany/``. ``$prefix`` is the path where Geany is installed
3975 (see `Installation prefix`_).
3979 % cp /usr/local/share/geany/filetype_extensions.conf /home/username/.config/geany/
3981 Then edit it and remove all the lines for filetype extensions that
3982 you do not want to override. The remaining lines can be edited after
3983 the ``=`` sign, using a semi-colon separated list of patterns which
3984 should be matched for that filetype.
3986 For example, to set the filetype extensions for Make, the
3987 ``/home/username/.config/geany/filetype_extensions.conf`` file should
3991 Make=Makefile*;*.mk;Buildfile;
3993 Preferences File Format
3994 -----------------------
3996 The preferences file ``~/.config/geany/geany.conf`` holds settings for all the items configured
3997 in the preferences dialog. This file should not be edited while Geany is running
3998 as the file will be overwritten when the preferences in Geany are changed or Geany
4005 There are some rarely used preferences that are not shown in the Preferences
4006 dialog. These can be set by editing the preferences file, then
4007 restarting Geany. Search for the key name, then edit the value. Example:
4009 ``brace_match_ltgt=true``
4011 The table below show the key names of hidden preferences in the
4014 ================================ =========================================== ==================
4015 Key Description Default
4016 ================================ =========================================== ==================
4018 brace_match_ltgt Whether to highlight <, > angle brackets. false
4019 show_editor_scrollbars Whether to display scrollbars. If set to true
4020 false, the horizontal and vertical
4021 scrollbars are hidden completely.
4022 use_gtk_word_boundaries Whether to look for the end of a word when true
4023 using word-boundary related Scintilla
4024 commands (see `Scintilla keyboard
4026 complete_snippets_whilst_editing Whether to allow completion of snippets false
4027 when editing an existing line (i.e. there
4028 is some text after the current cursor
4029 position on the line). Only used when the
4030 keybinding ``Complete snippet`` is set to
4032 **Interface related**
4033 show_symbol_list_expanders Whether to show or hide the small expander true
4034 icons on the symbol list treeview (only
4035 available with GTK 2.12 or above).
4036 allow_always_save Whether files can be saved always, even if false
4037 they don't have any changes. By default,
4038 the Save buttons and menu items are
4039 disabled when a file is unchanged. When
4040 setting this option to true, the Save
4041 buttons and menu items are always active
4042 and files can be saved.
4043 compiler_tab_autoscroll Whether to automatically scroll to the true
4044 last line of the output in the Compiler
4047 emulation Terminal emulation mode. Only change this xterm
4048 if you have VTE termcap files other than
4049 ``vte/termcap/xterm``.
4050 send_selection_unsafe By default, Geany strips any trailing false
4051 newline characters from the current
4052 selection before sending it to the terminal
4053 to not execute arbitrary code. This is
4054 mainly a security feature.
4055 If, for whatever reasons, you really want
4056 it to be executed directly, set this option
4059 use_safe_file_saving Defines the mode how Geany saves files to false
4060 disk. If disabled, Geany directly writes
4061 the content of the document to disk. This
4062 might cause in loss of data when there is
4063 no more free space on disk to save the
4064 file. When set to true, Geany first saves
4065 the contents into a temporary file and if
4066 this succeeded, the temporary file is
4067 moved to the real file to save.
4068 This gives better error checking in case of
4069 no more free disk space. But it also
4070 destroys hard links of the original file
4071 and its permissions (e.g. executable flags
4072 are reset). Use this with care as it can
4073 break things seriously.
4074 The better approach would be to ensure your
4075 disk won't run out of free space.
4076 **Build Menu related**
4077 number_ft_menu_items The maximum number of menu items in the 2
4078 filetype section of the Build menu.
4079 number_non_ft_menu_items The maximum number of menu items in the 3
4080 non-filetype section of the Build menu.
4081 number_exec_menu_items The maximum number of menu items in the 2
4082 execute section of the Build menu.
4083 ================================ =========================================== ==================
4085 [build-menu] Section
4086 ^^^^^^^^^^^^^^^^^^^^
4088 The [build-menu] section contains the configuration of the build menu.
4089 This section can occur in filetype, preferences and project files and
4090 always has the format described here. Different menu items are loaded
4091 from different files, see the table in the `Build Menu Configuration`_
4092 section for details. All the settings can be configured from the dialogs
4093 except the execute command in filetype files and filetype definitions in
4094 the project file, so these are the only ones which need hand editing.
4096 The build-menu section stores one entry for each setting for each menu item that
4097 is configured. The keys for these settings have the format:
4103 * GG - is the menu item group,
4106 - NF for non-filetype
4109 * NN - is a two decimal digit number of the item within the group,
4111 * FF - is the field,
4115 - WD for working directory
4121 The project file contains project related settings and possibly a
4122 record of the current session files.
4125 [build-menu] Additions
4126 ^^^^^^^^^^^^^^^^^^^^^^
4128 The project file also can have extra fields in the [build-menu] section
4129 in addition to those listed in `[build-menu] Section`_ above.
4131 When filetype menu items are configured for the project they are stored
4132 in the project file.
4134 The ``filetypes`` entry is a list of the filetypes which exist in the
4137 For each filetype the entries for that filetype have the format defined in
4138 `[build-menu] Section`_ but the key is prefixed by the name of the filetype
4139 as it appears in the ``filetypes`` entry, eg the entry for the label of
4140 filetype menu item 0 for the C filetype would be
4148 Geany supports the following templates:
4152 * Function description
4157 To use these templates, just open the Edit menu or open the popup menu
4158 by right-clicking in the editor widget, and choose "Insert Comments"
4159 and insert templates as you want.
4161 Some templates (like File header or ChangeLog entry) will always be
4162 inserted at the top of the file.
4164 To insert a function description, the cursor must be inside
4165 of the function, so that the function name can be determined
4166 automatically. The description will be positioned correctly one line
4167 above the function, just check it out. If the cursor is not inside
4168 of a function or the function name cannot be determined, the inserted
4169 function description won't contain the correct function name but "unknown"
4173 Geany automatically reloads template information when it notices you
4174 save a file in the user's template configuration directory. You can
4175 also force this by selecting *Tools->Reload Configuration*.
4181 Meta data can be used with all templates, but by default user set
4182 meta data is only used for the ChangeLog and File header templates.
4184 In the configuration dialog you can find a tab "Templates" (see
4185 `Template preferences`_). You can define the default values
4186 which will be inserted in the templates. You should select
4187 *Tools->Reload Configuration* or restart Geany after making changes.
4193 File templates are templates used as the basis of a new file. To
4194 use them, choose the *New (with Template)* menu item from the *File*
4197 By default, file templates are installed for some filetypes. Custom
4198 file templates can be added by creating the appropriate template file. You can
4199 also edit the default file templates.
4201 The file's contents are just the text to place in the document, with
4202 optional template wildcards like ``{fileheader}``. The fileheader
4203 wildcard can be placed anywhere, but it's usually put on the first
4204 line of the file, followed by a blank line.
4206 Custom file templates
4207 `````````````````````
4209 These are read from the following directories:
4211 * ``$prefix/share/geany/templates/files`` (see `Installation prefix`_)
4212 * ``~/.config/geany/templates/files`` (created the first time
4215 The filetype to use is detected from the template file's extension, if
4216 any. For example, creating a file ``module.c`` would add a menu item
4217 which created a new document with the filetype set to 'C'.
4219 The template file is read from disk when the corresponding menu item is
4226 It's recommended to use custom file templates instead.
4228 Filetype template files are read from the ``~/.config/geany/templates``
4229 directory, and are named "filetype." followed by the filetype
4230 name, e.g. "filetype.python", "filetype.sh", etc. If you are
4231 unsure about the filetype name extensions, they are the same as
4232 the filetype configuration file extensions, commonly installed in
4233 ``/usr/share/geany``, with the prefix "filetypes.".
4235 There is also a template file ``filetype.none`` which is used when
4236 the New command is used without a filetype. This is empty by default.
4239 Customizing templates
4240 ^^^^^^^^^^^^^^^^^^^^^
4242 Each template can be customized to your needs. The templates are
4243 stored in the ``~/.config/geany/templates/`` directory (see the section called
4244 `Command line options`_ for further information about the configuration
4245 directory). Just open the desired template with an editor (ideally,
4246 Geany ;-) ) and edit the template to your needs. There are some
4247 wildcards which will be automatically replaced by Geany at startup.
4253 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4255 **Wildcards for character escaping**
4257 ============== ============================================= =======================================
4258 Wildcard Description Available in
4259 ============== ============================================= =======================================
4260 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4261 wildcards being expanded).
4262 cb } Closing Brace. file templates, file header, snippets.
4263 pc \% Percent (used to escape e.g. %block% in
4264 snippets). snippets.
4265 ============== ============================================= =======================================
4267 **Global wildcards**
4269 These are configurable, see `Template preferences`_.
4271 ============== ============================================= =======================================
4272 Wildcard Description Available in
4273 ============== ============================================= =======================================
4274 developer The name of the developer. file templates, file header,
4275 function description, ChangeLog entry,
4278 initial The developer's initials, e.g. "ET" for file templates, file header,
4279 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4282 mail The email address of the developer. file templates, file header,
4283 function description, ChangeLog entry,
4286 company The company the developer is working for. file templates, file header,
4287 function description, ChangeLog entry,
4290 version The initial version of a new file. file templates, file header,
4291 function description, ChangeLog entry,
4293 ============== ============================================= =======================================
4295 **Date & time wildcards**
4297 The format for these wildcards can be changed in the preferences
4298 dialog, see `Template preferences`_. You can use any conversion
4299 specifiers which can be used with the ANSI C strftime function.
4300 For details please see http://man.cx/strftime.
4302 ============== ============================================= =======================================
4303 Wildcard Description Available in
4304 ============== ============================================= =======================================
4305 year The current year. Default format is: YYYY. file templates, file header,
4306 function description, ChangeLog entry,
4309 date The current date. Default format: file templates, file header,
4310 YYYY-MM-DD. function description, ChangeLog entry,
4313 datetime The current date and time. Default format: file templates, file header,
4314 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4316 ============== ============================================= =======================================
4318 **Dynamic wildcards**
4320 ============== ============================================= =======================================
4321 Wildcard Description Available in
4322 ============== ============================================= =======================================
4323 untitled The string "untitled" (this will be file templates, file header,
4324 translated to your locale), used in function description, ChangeLog entry,
4325 file templates. bsd, gpl, snippets.
4327 geanyversion The actual Geany version, e.g. file templates, file header,
4328 "Geany |(version)|". function description, ChangeLog entry,
4331 filename The filename of the current file. file header, snippets, file
4332 For new files, it's only replaced when templates.
4333 first saving if found on the first 3 lines
4336 project The current project's name, if any. file header, snippets, file templates.
4338 description The current project's description, if any. file header, snippets, file templates.
4340 functionname The function name of the function at the function description.
4341 cursor position. This wildcard will only be
4342 replaced in the function description
4345 command:path Executes the specified command and replace file templates, file header,
4346 the wildcard with the command's standard function description, ChangeLog entry,
4347 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
4349 ============== ============================================= =======================================
4351 **Template insertion wildcards**
4353 ============== ============================================= =======================================
4354 Wildcard Description Available in
4355 ============== ============================================= =======================================
4356 gpl This wildcard inserts a short GPL notice. file header.
4358 bsd This wildcard inserts a BSD licence notice. file header.
4360 fileheader The file header template. This wildcard snippets, file templates.
4361 will only be replaced in filetype
4363 ============== ============================================= =======================================
4366 Special {command:} wildcard
4367 ***************************
4369 The {command:} wildcard is a special one because it can execute
4370 a specified command and put the command's output (stdout) into
4379 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
4381 Using this wildcard you can insert nearly any arbitrary text into the
4384 In the environment of the executed command the variables
4385 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
4386 The value of these variables is filled in only if Geany knows about it.
4387 For example, ``GEANY_FUNCNAME`` is only filled within the function
4388 description template. However, these variables are ``always`` set,
4389 just maybe with an empty value.
4390 You can easily access them e.g. within an executed shell script using::
4396 If the specified command could not be found or not executed, the wildcard is substituted
4397 by an empty string. In such cases, you can find the occurred error message on Geany's
4398 standard error and in the Help->Debug Messages dialog.
4401 Customizing the toolbar
4402 -----------------------
4404 You can add, remove and reorder the elements in the toolbar by using the toolbar editor
4405 by manually editing the file ``ui_toolbar.xml``.
4407 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
4408 by right-clicking on the toolbar itself and choosing it from the menu.
4410 Manually editing of the toolbar layout
4411 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4413 To override the system-wide configuration file, copy it from
4414 ``$prefix/share/geany`` to your configuration directory, usually
4415 ``~/.config/geany/``. ``$prefix`` is the path where Geany is installed
4416 (see `Installation prefix`_).
4420 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
4422 Then edit it and add any of the available elements listed in the file or remove
4423 any of the existing elements. Of course, you can also reorder the elements as
4424 you wish and add or remove additional separators.
4425 This file must be valid XML, otherwise the global toolbar UI definition
4426 will be used instead.
4428 Your changes are applied once you save the file.
4431 (1) You cannot add new actions which are not listed below.
4432 (2) Everything you add or change must be inside the /ui/toolbar/ path.
4435 Available toolbar elements
4436 ^^^^^^^^^^^^^^^^^^^^^^^^^^
4438 ================== ==============================================================================
4439 Element name Description
4440 ================== ==============================================================================
4441 New Create a new file
4442 Open Open an existing file
4443 Save Save the current file
4444 SaveAll Save all open files
4445 Reload Reload the current file from disk
4446 Close Close the current file
4447 CloseAll Close all open files
4448 Print Print the current file
4449 Cut Cut the current selection
4450 Copy Copy the current selection
4451 Paste Paste the contents of the clipboard
4452 Delete Delete the current selection
4453 Undo Undo the last modification
4454 Redo Redo the last modification
4455 NavBack Navigate back a location
4456 NavFor Navigate forward a location
4457 Compile Compile the current file
4458 Build Build the current file, includes a submenu for Make commands. Geany
4459 remembers the last chosen action from the submenu and uses this as default
4460 action when the button itself is clicked.
4461 Run Run or view the current file
4462 Color Open a color chooser dialog, to interactively pick colors from a palette
4463 ZoomIn Zoom in the text
4464 ZoomOut Zoom out the text
4465 UnIndent Decrease indentation
4466 Indent Increase indentation
4467 Replace Replace text in the current document
4468 SearchEntry The search field belonging to the 'Search' element (can be used alone)
4469 Search Find the entered text in the current file (only useful if you also
4471 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
4472 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
4473 Preferences Show the preferences dialog
4475 ================== ==============================================================================
4479 Plugin documentation
4480 ====================
4487 This plugin sets on every new file (File->New or File-> New (with template))
4488 a randomly chosen filename and set its filetype appropriate to the used template
4489 or when no template was used, to a configurable default filetype.
4490 This enables you to quickly compile, build and/or run the new file without the
4491 need to give it an explicit filename using the Save As dialog. This might be
4492 useful when you often create new files just for testing some code or something
4499 This plugin creates a backup copy of the current file in Geany when it is
4500 saved. You can specify the directory where the backup copy is saved and
4501 you can configure the automatically added extension in the configure dialog
4502 in Geany's plugin manager.
4504 After the plugin was loaded in Geany's plugin manager, every file is
4505 copied into the configured backup directory when the file is saved in Geany.
4509 Contributing to this document
4510 =============================
4512 This document (``geany.txt``) is written in `reStructuredText`__
4513 (or "reST"). The source file for it is located in Geany's ``doc``
4514 subdirectory. If you intend on making changes, you should grab the
4515 source right from SVN to make sure you've got the newest version. After
4516 editing the file, to build the HTML document to see how your changes
4517 look, run "``make doc``" in the subdirectory ``doc`` of Geany's source
4518 directory. This regenerates the ``geany.html`` file. To generate a PDF
4519 file, use the command "``make pdf``" which should generate a file called
4520 geany-|(version)|.pdf.
4522 __ http://docutils.sourceforge.net/rst.html
4524 After you are happy with your changes, create a patch::
4526 % svn diff geany.txt > foo.patch
4528 and then submit that file to the mailing list for review.
4530 Note, you will need the Python docutils software package installed
4531 to build the docs. The package is named ``python-docutils`` on Debian
4537 Scintilla keyboard commands
4538 ===========================
4540 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
4542 This appendix is distributed under the terms of the License for
4543 Scintilla and SciTE. A copy of this license can be found in the file
4544 ``scintilla/License.txt`` included with the source code of this
4545 program and in the appendix of this document. See `License for
4546 Scintilla and SciTE`_.
4555 Keyboard commands for Scintilla mostly follow common Windows and GTK+
4556 conventions. All move keys (arrows, page up/down, home and end)
4557 allows to extend or reduce the stream selection when holding the
4558 Shift key, and the rectangular selection when holding the Shift and
4559 Ctrl keys. Some keys may not be available with some national keyboards
4560 or because they are taken by the system such as by a window manager
4561 or GTK. Keyboard equivalents of menu commands are listed in the
4562 menus. Some less common commands with no menu equivalent are:
4564 ============================================= ======================
4566 ============================================= ======================
4567 Magnify text size. Ctrl+Keypad+
4568 Reduce text size. Ctrl+Keypad-
4569 Restore text size to normal. Ctrl+Keypad/
4571 Dedent block. Shift+Tab
4572 Delete to start of word. Ctrl+BackSpace
4573 Delete to end of word. Ctrl+Delete
4574 Delete to start of line. Ctrl+Shift+BackSpace
4575 Go to start of document. Ctrl+Home
4576 Extend selection to start of document. Ctrl+Shift+Home
4577 Go to start of display line. Alt+Home
4578 Extend selection to start of display line. Alt+Shift+Home
4579 Go to end of document. Ctrl+End
4580 Extend selection to end of document. Ctrl+Shift+End
4581 Extend selection to end of display line. Alt+Shift+End
4582 Previous paragraph. Shift extends selection. Ctrl+Up
4583 Next paragraph. Shift extends selection. Ctrl+Down
4584 Previous word. Shift extends selection. Ctrl+Left
4585 Next word. Shift extends selection. Ctrl+Right
4586 ============================================= ======================
4597 * Double-click on empty space in the notebook tab bar to open a
4599 * Middle-click on a document's notebook tab to close the document.
4600 * Hold `Ctrl` and click on any notebook tab to switch to the last used
4602 * Double-click on a document's notebook tab to toggle all additional
4603 widgets (to show them again use the View menu or the keyboard
4604 shortcut). The interface pref must be enabled for this to work.
4609 * Alt-scroll wheel moves up/down a page.
4610 * Ctrl-scroll wheel zooms in/out.
4611 * Shift-scroll wheel scrolls 8 characters right/left.
4612 * Ctrl-click on a word in a document to perform *Go to Tag Definition*.
4613 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
4618 * Double-click on a symbol-list group to expand or compact it.
4623 * Scrolling the mouse wheel over a notebook tab bar will switch
4626 The following are derived from X-Windows features (but GTK still supports
4629 * Middle-click pastes the last selected text.
4630 * Middle-click on a scrollbar moves the scrollbar to that
4631 position without having to drag it.
4635 Compile-time options
4636 ====================
4638 There are some options which can only be changed at compile time,
4639 and some options which are used as the default for configurable
4640 options. To change these options, edit the appropriate source file
4641 in the ``src`` subdirectory. Look for a block of lines starting with
4642 ``#define GEANY_*``. Any definitions which are not listed here should
4646 Most users should not need to change these options.
4651 ============================== ============================================ ==================
4652 Option Description Default
4653 ============================== ============================================ ==================
4654 GEANY_STRING_UNTITLED A string used as the default name for new untitled
4655 files. Be aware that the string can be
4656 translated, so change it only if you know
4658 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
4659 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
4660 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
4662 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
4664 **Windows specific**
4665 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
4666 Windows file open and save dialogs instead
4667 GTK's file open and save dialogs. The
4668 default Windows file dialogs are missing
4669 some nice features like choosing a filetype
4670 or an encoding. *Do not touch this setting
4671 when building on a non-Win32 system.*
4672 ============================== ============================================ ==================
4677 ============================== ============================================ ==================
4678 Option Description Default
4679 ============================== ============================================ ==================
4680 GEANY_PROJECT_EXT The default filename extension for Geany geany
4681 project files. It is used when creating new
4682 projects and as filter mask for the project
4684 ============================== ============================================ ==================
4689 ============================== ============================================ ==================
4690 Option Description Default
4691 ============================== ============================================ ==================
4692 GEANY_WORDCHARS These characters define word boundaries when a string with:
4693 making selections and searching using word a-z, A-Z, 0-9 and
4694 matching options. underscore.
4695 ============================== ============================================ ==================
4700 These are default settings that can be overridden in the `Preferences`_ dialog.
4702 ============================== ============================================ ==================
4703 Option Description Default
4704 ============================== ============================================ ==================
4705 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
4706 trigger the autocompletion list.
4707 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
4709 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
4710 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator. It has to accept the "xterm"
4711 command line option "-e". This can also
4713 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
4714 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
4715 and process plain text files. This can also
4717 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
4718 GNU grep. This can also include a path.
4719 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
4720 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
4722 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
4723 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
4724 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
4726 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
4728 ============================== ============================================ ==================
4733 ============================== ============================================ ==================
4734 Option Description Default
4735 ============================== ============================================ ==================
4736 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
4737 be shown in the editor window.
4738 This affects the special coloring
4739 when Geany detects a compiler output line as
4740 an error message and then highlights the
4741 corresponding line in the source code.
4742 Usually only the first few messages are
4743 interesting because following errors are
4745 All errors in the Compiler window are parsed
4746 and unaffected by this value.
4747 PRINTBUILDCMDS Every time a build menu item priority FALSE
4748 calculation is run, print the state of the
4749 menu item table in the form of the table
4750 in `Build Menu Configuration`_. May be
4751 useful to debug configuration file
4752 overloading. Warning produces a lot of
4753 output. Can also be enabled/disabled by the
4754 debugger by setting printbuildcmds to 1/0
4755 overriding the compile setting.
4756 ============================== ============================================ ==================
4760 GNU General Public License
4761 ==========================
4765 GNU GENERAL PUBLIC LICENSE
4766 Version 2, June 1991
4768 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
4769 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
4770 Everyone is permitted to copy and distribute verbatim copies
4771 of this license document, but changing it is not allowed.
4775 The licenses for most software are designed to take away your
4776 freedom to share and change it. By contrast, the GNU General Public
4777 License is intended to guarantee your freedom to share and change free
4778 software--to make sure the software is free for all its users. This
4779 General Public License applies to most of the Free Software
4780 Foundation's software and to any other program whose authors commit to
4781 using it. (Some other Free Software Foundation software is covered by
4782 the GNU Library General Public License instead.) You can apply it to
4785 When we speak of free software, we are referring to freedom, not
4786 price. Our General Public Licenses are designed to make sure that you
4787 have the freedom to distribute copies of free software (and charge for
4788 this service if you wish), that you receive source code or can get it
4789 if you want it, that you can change the software or use pieces of it
4790 in new free programs; and that you know you can do these things.
4792 To protect your rights, we need to make restrictions that forbid
4793 anyone to deny you these rights or to ask you to surrender the rights.
4794 These restrictions translate to certain responsibilities for you if you
4795 distribute copies of the software, or if you modify it.
4797 For example, if you distribute copies of such a program, whether
4798 gratis or for a fee, you must give the recipients all the rights that
4799 you have. You must make sure that they, too, receive or can get the
4800 source code. And you must show them these terms so they know their
4803 We protect your rights with two steps: (1) copyright the software, and
4804 (2) offer you this license which gives you legal permission to copy,
4805 distribute and/or modify the software.
4807 Also, for each author's protection and ours, we want to make certain
4808 that everyone understands that there is no warranty for this free
4809 software. If the software is modified by someone else and passed on, we
4810 want its recipients to know that what they have is not the original, so
4811 that any problems introduced by others will not reflect on the original
4812 authors' reputations.
4814 Finally, any free program is threatened constantly by software
4815 patents. We wish to avoid the danger that redistributors of a free
4816 program will individually obtain patent licenses, in effect making the
4817 program proprietary. To prevent this, we have made it clear that any
4818 patent must be licensed for everyone's free use or not licensed at all.
4820 The precise terms and conditions for copying, distribution and
4821 modification follow.
4823 GNU GENERAL PUBLIC LICENSE
4824 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
4826 0. This License applies to any program or other work which contains
4827 a notice placed by the copyright holder saying it may be distributed
4828 under the terms of this General Public License. The "Program", below,
4829 refers to any such program or work, and a "work based on the Program"
4830 means either the Program or any derivative work under copyright law:
4831 that is to say, a work containing the Program or a portion of it,
4832 either verbatim or with modifications and/or translated into another
4833 language. (Hereinafter, translation is included without limitation in
4834 the term "modification".) Each licensee is addressed as "you".
4836 Activities other than copying, distribution and modification are not
4837 covered by this License; they are outside its scope. The act of
4838 running the Program is not restricted, and the output from the Program
4839 is covered only if its contents constitute a work based on the
4840 Program (independent of having been made by running the Program).
4841 Whether that is true depends on what the Program does.
4843 1. You may copy and distribute verbatim copies of the Program's
4844 source code as you receive it, in any medium, provided that you
4845 conspicuously and appropriately publish on each copy an appropriate
4846 copyright notice and disclaimer of warranty; keep intact all the
4847 notices that refer to this License and to the absence of any warranty;
4848 and give any other recipients of the Program a copy of this License
4849 along with the Program.
4851 You may charge a fee for the physical act of transferring a copy, and
4852 you may at your option offer warranty protection in exchange for a fee.
4854 2. You may modify your copy or copies of the Program or any portion
4855 of it, thus forming a work based on the Program, and copy and
4856 distribute such modifications or work under the terms of Section 1
4857 above, provided that you also meet all of these conditions:
4859 a) You must cause the modified files to carry prominent notices
4860 stating that you changed the files and the date of any change.
4862 b) You must cause any work that you distribute or publish, that in
4863 whole or in part contains or is derived from the Program or any
4864 part thereof, to be licensed as a whole at no charge to all third
4865 parties under the terms of this License.
4867 c) If the modified program normally reads commands interactively
4868 when run, you must cause it, when started running for such
4869 interactive use in the most ordinary way, to print or display an
4870 announcement including an appropriate copyright notice and a
4871 notice that there is no warranty (or else, saying that you provide
4872 a warranty) and that users may redistribute the program under
4873 these conditions, and telling the user how to view a copy of this
4874 License. (Exception: if the Program itself is interactive but
4875 does not normally print such an announcement, your work based on
4876 the Program is not required to print an announcement.)
4878 These requirements apply to the modified work as a whole. If
4879 identifiable sections of that work are not derived from the Program,
4880 and can be reasonably considered independent and separate works in
4881 themselves, then this License, and its terms, do not apply to those
4882 sections when you distribute them as separate works. But when you
4883 distribute the same sections as part of a whole which is a work based
4884 on the Program, the distribution of the whole must be on the terms of
4885 this License, whose permissions for other licensees extend to the
4886 entire whole, and thus to each and every part regardless of who wrote it.
4888 Thus, it is not the intent of this section to claim rights or contest
4889 your rights to work written entirely by you; rather, the intent is to
4890 exercise the right to control the distribution of derivative or
4891 collective works based on the Program.
4893 In addition, mere aggregation of another work not based on the Program
4894 with the Program (or with a work based on the Program) on a volume of
4895 a storage or distribution medium does not bring the other work under
4896 the scope of this License.
4898 3. You may copy and distribute the Program (or a work based on it,
4899 under Section 2) in object code or executable form under the terms of
4900 Sections 1 and 2 above provided that you also do one of the following:
4902 a) Accompany it with the complete corresponding machine-readable
4903 source code, which must be distributed under the terms of Sections
4904 1 and 2 above on a medium customarily used for software interchange; or,
4906 b) Accompany it with a written offer, valid for at least three
4907 years, to give any third party, for a charge no more than your
4908 cost of physically performing source distribution, a complete
4909 machine-readable copy of the corresponding source code, to be
4910 distributed under the terms of Sections 1 and 2 above on a medium
4911 customarily used for software interchange; or,
4913 c) Accompany it with the information you received as to the offer
4914 to distribute corresponding source code. (This alternative is
4915 allowed only for noncommercial distribution and only if you
4916 received the program in object code or executable form with such
4917 an offer, in accord with Subsection b above.)
4919 The source code for a work means the preferred form of the work for
4920 making modifications to it. For an executable work, complete source
4921 code means all the source code for all modules it contains, plus any
4922 associated interface definition files, plus the scripts used to
4923 control compilation and installation of the executable. However, as a
4924 special exception, the source code distributed need not include
4925 anything that is normally distributed (in either source or binary
4926 form) with the major components (compiler, kernel, and so on) of the
4927 operating system on which the executable runs, unless that component
4928 itself accompanies the executable.
4930 If distribution of executable or object code is made by offering
4931 access to copy from a designated place, then offering equivalent
4932 access to copy the source code from the same place counts as
4933 distribution of the source code, even though third parties are not
4934 compelled to copy the source along with the object code.
4936 4. You may not copy, modify, sublicense, or distribute the Program
4937 except as expressly provided under this License. Any attempt
4938 otherwise to copy, modify, sublicense or distribute the Program is
4939 void, and will automatically terminate your rights under this License.
4940 However, parties who have received copies, or rights, from you under
4941 this License will not have their licenses terminated so long as such
4942 parties remain in full compliance.
4944 5. You are not required to accept this License, since you have not
4945 signed it. However, nothing else grants you permission to modify or
4946 distribute the Program or its derivative works. These actions are
4947 prohibited by law if you do not accept this License. Therefore, by
4948 modifying or distributing the Program (or any work based on the
4949 Program), you indicate your acceptance of this License to do so, and
4950 all its terms and conditions for copying, distributing or modifying
4951 the Program or works based on it.
4953 6. Each time you redistribute the Program (or any work based on the
4954 Program), the recipient automatically receives a license from the
4955 original licensor to copy, distribute or modify the Program subject to
4956 these terms and conditions. You may not impose any further
4957 restrictions on the recipients' exercise of the rights granted herein.
4958 You are not responsible for enforcing compliance by third parties to
4961 7. If, as a consequence of a court judgment or allegation of patent
4962 infringement or for any other reason (not limited to patent issues),
4963 conditions are imposed on you (whether by court order, agreement or
4964 otherwise) that contradict the conditions of this License, they do not
4965 excuse you from the conditions of this License. If you cannot
4966 distribute so as to satisfy simultaneously your obligations under this
4967 License and any other pertinent obligations, then as a consequence you
4968 may not distribute the Program at all. For example, if a patent
4969 license would not permit royalty-free redistribution of the Program by
4970 all those who receive copies directly or indirectly through you, then
4971 the only way you could satisfy both it and this License would be to
4972 refrain entirely from distribution of the Program.
4974 If any portion of this section is held invalid or unenforceable under
4975 any particular circumstance, the balance of the section is intended to
4976 apply and the section as a whole is intended to apply in other
4979 It is not the purpose of this section to induce you to infringe any
4980 patents or other property right claims or to contest validity of any
4981 such claims; this section has the sole purpose of protecting the
4982 integrity of the free software distribution system, which is
4983 implemented by public license practices. Many people have made
4984 generous contributions to the wide range of software distributed
4985 through that system in reliance on consistent application of that
4986 system; it is up to the author/donor to decide if he or she is willing
4987 to distribute software through any other system and a licensee cannot
4990 This section is intended to make thoroughly clear what is believed to
4991 be a consequence of the rest of this License.
4993 8. If the distribution and/or use of the Program is restricted in
4994 certain countries either by patents or by copyrighted interfaces, the
4995 original copyright holder who places the Program under this License
4996 may add an explicit geographical distribution limitation excluding
4997 those countries, so that distribution is permitted only in or among
4998 countries not thus excluded. In such case, this License incorporates
4999 the limitation as if written in the body of this License.
5001 9. The Free Software Foundation may publish revised and/or new versions
5002 of the General Public License from time to time. Such new versions will
5003 be similar in spirit to the present version, but may differ in detail to
5004 address new problems or concerns.
5006 Each version is given a distinguishing version number. If the Program
5007 specifies a version number of this License which applies to it and "any
5008 later version", you have the option of following the terms and conditions
5009 either of that version or of any later version published by the Free
5010 Software Foundation. If the Program does not specify a version number of
5011 this License, you may choose any version ever published by the Free Software
5014 10. If you wish to incorporate parts of the Program into other free
5015 programs whose distribution conditions are different, write to the author
5016 to ask for permission. For software which is copyrighted by the Free
5017 Software Foundation, write to the Free Software Foundation; we sometimes
5018 make exceptions for this. Our decision will be guided by the two goals
5019 of preserving the free status of all derivatives of our free software and
5020 of promoting the sharing and reuse of software generally.
5024 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5025 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5026 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5027 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5028 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5029 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5030 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5031 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5032 REPAIR OR CORRECTION.
5034 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5035 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5036 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5037 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5038 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5039 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5040 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5041 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5042 POSSIBILITY OF SUCH DAMAGES.
5044 END OF TERMS AND CONDITIONS
5046 How to Apply These Terms to Your New Programs
5048 If you develop a new program, and you want it to be of the greatest
5049 possible use to the public, the best way to achieve this is to make it
5050 free software which everyone can redistribute and change under these terms.
5052 To do so, attach the following notices to the program. It is safest
5053 to attach them to the start of each source file to most effectively
5054 convey the exclusion of warranty; and each file should have at least
5055 the "copyright" line and a pointer to where the full notice is found.
5057 <one line to give the program's name and a brief idea of what it does.>
5058 Copyright (C) <year> <name of author>
5060 This program is free software; you can redistribute it and/or modify
5061 it under the terms of the GNU General Public License as published by
5062 the Free Software Foundation; either version 2 of the License, or
5063 (at your option) any later version.
5065 This program is distributed in the hope that it will be useful,
5066 but WITHOUT ANY WARRANTY; without even the implied warranty of
5067 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5068 GNU General Public License for more details.
5070 You should have received a copy of the GNU General Public License
5071 along with this program; if not, write to the Free Software
5072 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
5075 Also add information on how to contact you by electronic and paper mail.
5077 If the program is interactive, make it output a short notice like this
5078 when it starts in an interactive mode:
5080 Gnomovision version 69, Copyright (C) year name of author
5081 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5082 This is free software, and you are welcome to redistribute it
5083 under certain conditions; type `show c' for details.
5085 The hypothetical commands `show w' and `show c' should show the appropriate
5086 parts of the General Public License. Of course, the commands you use may
5087 be called something other than `show w' and `show c'; they could even be
5088 mouse-clicks or menu items--whatever suits your program.
5090 You should also get your employer (if you work as a programmer) or your
5091 school, if any, to sign a "copyright disclaimer" for the program, if
5092 necessary. Here is a sample; alter the names:
5094 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5095 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5097 <signature of Ty Coon>, 1 April 1989
5098 Ty Coon, President of Vice
5100 This General Public License does not permit incorporating your program into
5101 proprietary programs. If your program is a subroutine library, you may
5102 consider it more useful to permit linking proprietary applications with the
5103 library. If this is what you want to do, use the GNU Library General
5104 Public License instead of this License.
5109 License for Scintilla and SciTE
5110 ===============================
5112 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5116 Permission to use, copy, modify, and distribute this software and
5117 its documentation for any purpose and without fee is hereby granted,
5118 provided that the above copyright notice appear in all copies and
5119 that both that copyright notice and this permission notice appear in
5120 supporting documentation.
5122 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5123 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5124 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5125 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5126 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5127 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5128 USE OR PERFORMANCE OF THIS SOFTWARE.