1 .. |(version)| replace:: 1.27
2 .. -*- reStructuredText -*-
8 -------------------------
9 A fast, light, GTK+ IDE
10 -------------------------
12 :Authors: Enrico Tröger,
22 This document is distributed under the terms of the GNU General Public
23 License as published by the Free Software Foundation; either version 2
24 of the License, or (at your option) any later version. A copy of this
25 license can be found in the file COPYING included with the source code
26 of this program, and also in the chapter `GNU General Public License`_.
40 Geany is a small and lightweight Integrated Development Environment. It
41 was developed to provide a small and fast IDE, which has only a few
42 dependencies on other packages. Another goal was to be as independent
43 as possible from a particular Desktop Environment like KDE or GNOME -
44 Geany only requires the GTK+ runtime libraries.
46 Some basic features of Geany:
50 * Autocompletion of symbols/words
51 * Construct completion/snippets
52 * Auto-closing of XML and HTML tags
54 * Many supported filetypes including C, Java, PHP, HTML, Python, Perl,
58 * Build system to compile and execute your code
59 * Simple project management
67 You can obtain Geany from http://www.geany.org/ or perhaps also from
68 your distribution. For a list of available packages, please see
69 http://www.geany.org/Download/ThirdPartyPackages.
76 Geany is distributed under the terms of the GNU General Public License
77 as published by the Free Software Foundation; either version 2 of
78 the License, or (at your option) any later version. A copy of this
79 license can be found in the file COPYING included with the source
80 code of this program and in the chapter, `GNU General Public License`_.
82 The included Scintilla library (found in the subdirectory
83 ``scintilla/``) has its own license, which can be found in the chapter,
84 `License for Scintilla and SciTE`_.
91 This documentation is available in HTML and text formats.
92 The latest version can always be found at http://www.geany.org/.
94 If you want to contribute to it, see `Contributing to this document`_.
106 You will need the GTK (>= 2.24) libraries and their dependencies
107 (Pango, GLib and ATK). Your distro should provide packages for these,
108 usually installed by default. For Windows, you can download an installer
109 from the website which bundles these libraries.
115 There are many binary packages available. For an up-to-date but maybe
116 incomplete list see http://www.geany.org/Download/ThirdPartyPackages.
122 Compiling Geany is quite easy.
123 To do so, you need the GTK (>= 2.24) libraries and header files.
124 You also need the Pango, GLib and ATK libraries and header files.
125 All these files are available at http://www.gtk.org, but very often
126 your distro will provide development packages to save the trouble of
127 building these yourself.
129 Furthermore you need, of course, a C and C++ compiler. The GNU versions
130 of these tools are recommended.
132 Autotools based build system
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135 The Autotools based build system is very mature and has been well tested.
136 To use it, you just need the Make tool, preferably GNU Make.
138 Then run the following commands::
151 Waf based build system
152 ^^^^^^^^^^^^^^^^^^^^^^
154 The Waf build system is still quite young and under heavy development but already in a
155 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
156 to install Python on your system.
157 The advantage of the Waf build system over the Autotools based build system is that the whole
158 build process might be a bit faster. Especially when you use the Waf
159 cache feature for repetitive builds (e.g. when changing only a few source files
160 to test something) will become much faster since Waf will cache and re-use the
161 unchanged built files and only compile the changed code again. See `Waf Cache`_ for details.
162 To build Geany with Waf as run::
174 The Waf build system has a nice and interesting feature which can help to avoid
175 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
176 or trying to debug something in Geany.
177 Waf is able to store and retrieve the object files from a cache. This cache is declared
178 using the environment variable ``WAFCACHE``.
179 A possible location of the cache directory could be ``~/.cache/waf``. In order to make use of
180 this, you first need to create this directory::
182 $ mkdir -p ~/.cache/waf
184 then add the environment variable to your shell configuration (the following example is for
185 Bash and should be adjusted to your used shell)::
187 export WAFCACHE=/home/username/.cache/waf
189 Remember to replace ``username`` with your actual username.
191 More information about the Waf cache feature are available at
192 http://code.google.com/p/waf/wiki/CacheObjectFiles.
196 You should be careful about the size of the cache directory as it may
197 grow rapidly over time.
198 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
200 An easy way to keep it clean is to run the following command regularly to remove old
203 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
205 This will delete all files in the cache directory which are older than 14 days.
207 For details about the ``find`` command and its options, check its manual page.
212 The configure script supports several common options, for a detailed
221 (depending on which build system you use).
223 You may also want to read the INSTALL file for advanced installation
226 * See also `Compile-time options`_.
228 Dynamic linking loader support and VTE
229 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
230 In the case that your system lacks dynamic linking loader support, you
231 probably want to pass the option ``--disable-vte`` to the ``configure``
232 script. This prevents compiling Geany with dynamic linking loader
233 support for automatically loading ``libvte.so.4`` if available.
237 If there are any errors during compilation, check your build
238 environment and try to find the error, otherwise contact the mailing
239 list or one the authors. Sometimes you might need to ask for specific
240 help from your distribution.
245 If you want to find Geany's system files after installation you may
246 want to know the installation prefix.
248 Pass the ``--print-prefix`` option to Geany to check this - see
249 `Command line options`_. The first path is the prefix.
251 On Unix-like systems this is commonly ``/usr`` if you installed from
252 a binary package, or ``/usr/local`` if you build from source.
255 Editing system files is not necessary as you should use the
256 per-user configuration files instead, which don't need root
257 permissions. See `Configuration files`_.
267 You can start Geany in the following ways:
269 * From the Desktop Environment menu:
271 Choose in your application menu of your used Desktop Environment:
272 Development --> Geany.
274 At Windows-systems you will find Geany after installation inside
275 the application menu within its special folder.
277 * From the command line:
279 To start Geany from a command line, type the following and press
287 The Geany window is shown in the following figure:
289 .. image:: ./images/main_window.png
291 The workspace has the following parts:
294 * An optional toolbar.
295 * An optional sidebar that can show the following tabs:
297 * Documents - A document list, and
298 * Symbols - A list of symbols in your code.
300 * The main editor window.
301 * An optional message window which can show the following tabs:
303 * Status - A list of status messages.
304 * Compiler - The output of compiling or building programs.
305 * Messages - Results of 'Find Usage', 'Find in Files' and other actions
306 * Scribble - A text scratchpad for any use.
307 * Terminal - An optional terminal window.
311 Most of these can be configured in the `Interface preferences`_, the
312 `View menu`_, or the popup menu for the relevant area.
314 Additional tabs may be added to the sidebar and message window by plugins.
316 The position of the tabs can be selected in the interface preferences.
318 The sizes of the sidebar and message window can be adjusted by
319 dragging the dividers.
324 ============ ======================= =================================================
325 Short option Long option Function
326 ============ ======================= =================================================
327 *none* +number Set initial line number for the first opened file
328 (same as --line, do not put a space between the + sign
329 and the number). E.g. "geany +7 foo.bar" will open the
330 file foo.bar and place the cursor in line 7.
332 *none* --column Set initial column number for the first opened file.
334 -c dir_name --config=directory_name Use an alternate configuration directory. The default
335 configuration directory is ``~/.config/geany/`` and that
336 is where ``geany.conf`` and other configuration files
339 *none* --ft-names Print a list of Geany's internal filetype names (useful
340 for snippets configuration).
342 -g --generate-tags Generate a global tags file (see
343 `Generating a global tags file`_).
345 -P --no-preprocessing Don't preprocess C/C++ files when generating tags file.
347 -i --new-instance Do not open files in a running instance, force opening
348 a new instance. Only available if Geany was compiled
349 with support for Sockets.
351 -l --line Set initial line number for the first opened file.
353 *none* --list-documents Return a list of open documents in a running Geany
355 This can be used to read the currently opened documents in
356 Geany from an external script or tool. The returned list
357 is separated by newlines (LF) and consists of the full,
358 UTF-8 encoded filenames of the documents.
359 Only available if Geany was compiled with support for
362 -m --no-msgwin Do not show the message window. Use this option if you
363 do not need compiler messages or VTE support.
365 -n --no-ctags Do not load symbol completion and call tip data. Use this
366 option if you do not want to use them.
368 -p --no-plugins Do not load plugins or plugin support.
370 *none* --print-prefix Print installation prefix, the data directory, the lib
371 directory and the locale directory (in that order) to
372 stdout, one line each. This is mainly intended for plugin
373 authors to detect installation paths.
375 -r --read-only Open all files given on the command line in read-only mode.
376 This only applies to files opened explicitly from the command
377 line, so files from previous sessions or project files are
380 -s --no-session Do not load the previous session's files.
382 -t --no-terminal Do not load terminal support. Use this option if you do
383 not want to load the virtual terminal emulator widget
384 at startup. If you do not have ``libvte.so.4`` installed,
385 then terminal-support is automatically disabled. Only
386 available if Geany was compiled with support for VTE.
388 *none* --socket-file Use this socket filename for communication with a
389 running Geany instance. This can be used with the following
390 command to execute Geany on the current workspace::
392 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
394 *none* --vte-lib Specify explicitly the path including filename or only
395 the filename to the VTE library, e.g.
396 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
397 only needed when the auto-detection does not work. Only
398 available if Geany was compiled with support for VTE.
400 -v --verbose Be verbose (print useful status messages).
402 -V --version Show version information and exit.
404 -? --help Show help information and exit.
406 *none* [files ...] Open all given files at startup. This option causes
407 Geany to ignore loading stored files from the last
408 session (if enabled).
409 Geany also recognizes line and column information when
410 appended to the filename with colons, e.g.
411 "geany foo.bar:10:5" will open the file foo.bar and
412 place the cursor in line 10 at column 5.
414 Projects can also be opened but a project file (\*.geany)
415 must be the first non-option argument. All additionally
416 given files are ignored.
417 ============ ======================= =================================================
419 You can also pass line number and column number information, e.g.::
421 geany some_file.foo:55:4
423 Geany supports all generic GTK options, a list is available on the
435 At startup, Geany loads all files from the last time Geany was
436 launched. You can disable this feature in the preferences dialog
437 (see `General Startup preferences`_).
439 You can start several instances of Geany, but only the first will
440 load files from the last session. In the subsequent instances, you
441 can find these files in the file menu under the "Recent files" item.
442 By default this contains the last 10 recently opened files. You can
443 change the number of recently opened files in the preferences dialog.
445 To run a second instance of Geany, do not specify any filenames on
446 the command-line, or disable opening files in a running instance
447 using the appropriate command line option.
450 Opening files from the command-line in a running instance
451 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
453 Geany detects if there is an instance of itself already running and opens files
454 from the command-line in that instance. So, Geany can
455 be used to view and edit files by opening them from other programs
456 such as a file manager.
458 You can also pass line number and column number information, e.g.::
460 geany some_file.foo:55:4
462 This would open the file ``some_file.foo`` with the cursor on line 55,
465 If you do not like this for some reason, you can disable using the first
466 instance by using the appropriate command line option -- see the section
467 called `Command line options`_.
470 Virtual terminal emulator widget (VTE)
471 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
473 If you have installed ``libvte.so`` on your system, it is loaded
474 automatically by Geany, and you will have a terminal widget in the
475 notebook at the bottom.
477 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
478 will not be loaded. So there is no need to install the package containing
479 this file in order to run Geany. Additionally, you can disable the use
480 of the terminal widget by command line option, for more information
481 see the section called `Command line options`_.
483 You can use this terminal (from now on called VTE) much as you would
484 a terminal program like xterm. There is basic clipboard support. You
485 can paste the contents of the clipboard by pressing the right mouse
486 button to open the popup menu, and choosing Paste. To copy text from
487 the VTE, just select the desired text and then press the right mouse
488 button and choose Copy from the popup menu. On systems running the
489 X Window System you can paste the last selected text by pressing the
490 middle mouse button in the VTE (on 2-button mice, the middle button
491 can often be simulated by pressing both mouse buttons together).
493 In the preferences dialog you can specify a shell which should be
494 started in the VTE. To make the specified shell a login shell just
495 use the appropriate command line options for the shell. These options
496 should be found in the manual page of the shell. For zsh and bash
497 you can use the argument ``--login``.
500 Geany tries to load ``libvte.so``. If this fails, it tries to load
501 some other filenames. If this fails too, you should check whether you
502 installed libvte correctly. Again note, Geany will run without this
505 It could be, that the library is called something else than
506 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
507 please set a link to the correct file (as root)::
509 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
511 Obviously, you have to adjust the paths and set X to the number of your
514 You can also specify the filename of the VTE library to use on the command
515 line (see the section called `Command line options`_) or at compile time
516 by specifying the command line option ``--with-vte-module-path`` to
520 Defining own widget styles using .gtkrc-2.0
521 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
523 You can define your widget style for many of Geany's GUI parts. To
524 do this, just edit your ``.gtkrc-2.0`` (usually found in your home
525 directory on UNIX-like systems and in the etc subdirectory of your
526 Geany installation on Windows).
528 To have a defined style used by Geany you must assign it to
529 at least one of Geany's widgets. For example use the following line::
531 widget "Geany*" style "geanyStyle"
533 This would assign your style "geany_style" to all Geany
534 widgets. You can also assign styles only to specific widgets. At the
535 moment you can use the following widgets:
547 An example of a simple ``.gtkrc-2.0``::
553 widget "GeanyMainWindow" style "geanyStyle"
559 widget "GeanyPrefsDialog" style "geanyStyle"
565 Switching between documents
566 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
568 The documents list and the editor tabs are two different ways
569 to switch between documents using the mouse. When you hit the key
570 combination to move between tabs, the order is determined by the tab
571 order. It is not alphabetical as shown in the documents list
572 (regardless of whether or not editor tabs are visible).
574 See the `Notebook tab keybindings`_ section for useful
575 shortcuts including for Most-Recently-Used document switching.
579 The `Document->Clone` menu item copies the current document's text,
580 cursor position and properties into a new untitled document. If
581 there is a selection, only the selected text is copied. This can be
582 useful when making temporary copies of text or for creating
583 documents with similar or identical contents.
586 Character sets and Unicode Byte-Order-Mark (BOM)
587 ------------------------------------------------
593 Geany provides support for detecting and converting character sets. So
594 you can open and save files in different character sets, and even
595 convert a file from one character set to another. To do this,
596 Geany uses the character conversion capabilities of the GLib library.
598 Only text files are supported, i.e. opening files which contain
599 NULL-bytes may fail. Geany will try to open the file anyway but it is
600 likely that the file will be truncated because it can only be read up
601 to the first occurrence of a NULL-byte. All characters after this
602 position are lost and are not written when you save the file.
604 Geany tries to detect the encoding of a file while opening it, but
605 auto-detecting the encoding of a file is not easy and sometimes an
606 encoding might not be detected correctly. In this case you have to
607 set the encoding of the file manually in order to display it
608 correctly. You can this in the file open dialog by selecting an
609 encoding in the drop down box or by reloading the file with the
610 file menu item "Reload as". The auto-detection works well for most
611 encodings but there are also some encodings where it is known that
612 auto-detection has problems.
614 There are different ways to set different encodings in Geany:
616 * Using the file open dialog
618 This opens the file with the encoding specified in the encoding drop
619 down box. If the encoding is set to "Detect from file" auto-detection
620 will be used. If the encoding is set to "Without encoding (None)" the
621 file will be opened without any character conversion and Geany will
622 not try to auto-detect the encoding (see below for more information).
624 * Using the "Reload as" menu item
626 This item reloads the current file with the specified encoding. It can
627 help if you opened a file and found out that the wrong encoding was used.
629 * Using the "Set encoding" menu item
631 Contrary to the above two options, this will not change or reload
632 the current file unless you save it. It is useful when you want to
633 change the encoding of the file.
635 * Specifying the encoding in the file itself
637 As mentioned above, auto-detecting the encoding of a file may fail on
638 some encodings. If you know that Geany doesn't open a certain file,
639 you can add the specification line, described in the next section,
640 to the beginning of the file to force Geany to use a specific
641 encoding when opening the file.
644 In-file encoding specification
645 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
647 Geany detects meta tags of HTML files which contain charset information
650 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
652 and the specified charset is used when opening the file. This is useful if the
653 encoding of the file cannot be detected properly.
654 For non-HTML files you can also define a line like::
656 /* geany_encoding=ISO-8859-15 */
660 # geany_encoding=ISO-8859-15 #
662 to force an encoding to be used. The #, /\* and \*/ are examples
663 of filetype-specific comment characters. It doesn't matter which
664 characters are around the string " geany_encoding=ISO-8859-15 " as long
665 as there is at least one whitespace character before and after this
666 string. Whitespace characters are in this case a space or tab character.
667 An example to use this could be you have a file with ISO-8859-15
668 encoding but Geany constantly detects the file encoding as ISO-8859-1.
669 Then you simply add such a line to the file and Geany will open it
670 correctly the next time.
672 Since Geany 0.15 you can also use lines which match the
673 regular expression used to find the encoding string:
674 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
677 These specifications must be in the first 512 bytes of the file.
678 Anything after the first 512 bytes will not be recognized.
682 # encoding = ISO-8859-15
686 # coding: ISO-8859-15
688 Special encoding "None"
689 ^^^^^^^^^^^^^^^^^^^^^^^
691 There is a special encoding "None" which uses no
692 encoding. It is useful when you know that Geany cannot auto-detect
693 the encoding of a file and it is not displayed correctly. Especially
694 when the file contains NULL-bytes this can be useful to skip auto
695 detection and open the file properly at least until the occurrence
696 of the first NULL-byte. Using this encoding opens the file as it is
697 without any character conversion.
700 Unicode Byte-Order-Mark (BOM)
701 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
703 Furthermore, Geany detects a Unicode Byte Order Mark (see
704 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
705 this feature is only available if the opened file is in a Unicode
706 encoding. The Byte Order Mark helps to detect the encoding of a file,
707 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
708 using a Byte Order Mark could cause some problems for programs not
709 expecting it, e.g. the compiler gcc stops
710 with stray errors, PHP does not parse a script containing a BOM and
711 script files starting with a she-bang maybe cannot be started. In the
712 status bar you can easily see whether the file starts with a BOM or
715 If you want to set a BOM for a file or if you want to remove it
716 from a file, just use the document menu and toggle the checkbox.
719 If you are unsure what a BOM is or if you do not understand where
720 to use it, then it is probably not important for you and you can
732 Geany provides basic code folding support. Folding means the ability to
733 show and hide parts of the text in the current file. You can hide
734 unimportant code sections and concentrate on the parts you are working on
735 and later you can show hidden sections again. In the editor window there is
736 a small grey margin on the left side with [+] and [-] symbols which
737 show hidden parts and hide parts of the file respectively. By
738 clicking on these icons you can simply show and hide sections which are
739 marked by vertical lines within this margin. For many filetypes nested
740 folding is supported, so there may be several fold points within other
744 You can customize the folding icon and line styles - see the
745 filetypes.common `Folding Settings`_.
747 If you don't like it or don't need it at all, you can simply disable
748 folding support completely in the preferences dialog.
750 The folding behaviour can be changed with the "Fold/Unfold all children of
751 a fold point" option in the preference dialog. If activated, Geany will
752 unfold all nested fold points below the current one if they are already
753 folded (when clicking on a [+] symbol).
754 When clicking on a [-] symbol, Geany will fold all nested fold points
755 below the current one if they are unfolded.
757 This option can be inverted by pressing the Shift
758 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
759 children of a fold point" option is enabled, pressing Shift will disable
760 it for this click and vice versa.
763 Column mode editing (rectangular selections)
764 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
766 There is basic support for column mode editing. To use it, create a
767 rectangular selection by holding down the Control and Shift keys
768 (or Alt and Shift on Windows) while selecting some text.
769 Once a rectangular selection exists you can start editing the text within
770 this selection and the modifications will be done for every line in the
773 It is also possible to create a zero-column selection - this is
774 useful to insert text on multiple lines.
776 Drag and drop of text
777 ^^^^^^^^^^^^^^^^^^^^^
779 If you drag selected text in the editor widget of Geany the text is
780 moved to the position where the mouse pointer is when releasing the
781 mouse button. Holding Control when releasing the mouse button will
782 copy the text instead. This behaviour was changed in Geany 0.11 -
783 before the selected text was copied to the new position.
789 Geany allows each document to indent either with a tab character,
790 multiple spaces or a combination of both.
792 The *Tabs* setting indents with one tab character per indent level, and
793 displays tabs as the indent width.
795 The *Spaces* setting indents with the number of spaces set in the indent
796 width for each level.
798 The *Tabs and Spaces* setting indents with spaces as above, then converts
799 as many spaces as it can to tab characters at the rate of one tab for
800 each multiple of the `Various preference` setting
801 *indent_hard_tab_width* (default 8) and displays tabs as the
802 *indent_hard_tab_width* value.
804 The default indent settings are set in `Editor Indentation
805 preferences`_ (see the link for more information).
807 The default settings can be overridden per-document using the
808 Document menu. They can also be overridden by projects - see
809 `Project management`_.
811 The indent mode for the current document is shown on the status bar
815 Indent with Tab characters.
819 Indent with tabs and spaces, depending on how much indentation is
822 Applying new indentation settings
823 `````````````````````````````````
824 After changing the default settings you may wish to apply the new
825 settings to every document in the current session. To do this use the
826 *Project->Apply Default Indentation* menu item.
828 Detecting indent type
829 `````````````````````
830 The *Detect from file* indentation preference can be used to
831 scan each file as it's opened and set the indent type based on
832 how many lines start with a tab vs. 2 or more spaces.
838 When enabled, auto-indentation happens when pressing *Enter* in the
839 Editor. It adds a certain amount of indentation to the new line so the
840 user doesn't always have to indent each line manually.
842 Geany has four types of auto-indentation:
845 Disables auto-indentation completely.
847 Adds the same amount of whitespace on a new line as on the previous line.
848 For the *Tabs* and the *Spaces* indent types the indentation will use the
849 same combination of characters as the previous line. The
850 *Tabs and Spaces* indentation type converts as explained above.
852 Does the same as *Basic* but also indents a new line after an opening
853 brace '{', and de-indents when typing a closing brace '}'. For Python,
854 a new line will be indented after typing ':' at the end of the
857 Similar to *Current chars* but the closing brace will be aligned to
858 match the indentation of the line with the opening brace. This
859 requires the filetype to be one where Geany knows that the Scintilla
860 lexer understands matching braces (C, C++, D, HTML, Pascal, Bash,
863 There is also XML-tag auto-indentation. This is enabled when the
864 mode is more than just Basic, and is also controlled by a filetype
865 setting - see `xml_indent_tags`_.
871 Geany provides a handy bookmarking feature that lets you mark one
872 or more lines in a document, and return the cursor to them using a
875 To place a mark on a line, either left-mouse-click in the left margin
876 of the editor window, or else use Ctrl-m. This will
877 produce a small green plus symbol in the margin. You can have as many
878 marks in a document as you like. Click again (or use Ctrl-m again)
879 to remove the bookmark. To remove all the marks in a given document,
880 use "Remove Markers" in the Document menu.
882 To navigate down your document, jumping from one mark to the next,
883 use Ctrl-. (control period). To go in the opposite direction on
884 the page, use Ctrl-, (control comma). Using the bookmarking feature
885 together with the commands to switch from one editor tab to another
886 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
887 navigate around multiple files.
890 Code navigation history
891 ^^^^^^^^^^^^^^^^^^^^^^^
893 To ease navigation in source files and especially between
894 different files, Geany lets you jump between different navigation
895 points. Currently, this works for the following:
897 * `Go to symbol declaration`_
898 * `Go to symbol definition`_
903 When using one of these actions, Geany remembers your current position
904 and jumps to the new one. If you decide to go back to your previous
905 position in the file, just use "Navigate back a location". To
906 get back to the new position again, just use "Navigate forward a
907 location". This makes it easier to navigate in e.g. foreign code
908 and between different files.
911 Sending text through custom commands
912 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
914 You can define several custom commands in Geany and send the current
915 selection to one of these commands using the *Edit->Format->Send
916 Selection to* menu or keybindings. The output of the command will be
917 used to replace the current selection. This makes it possible to use
918 text formatting tools with Geany in a general way.
920 The selected text will be sent to the standard input of the executed
921 command, so the command should be able to read from it and it should
922 print all results to its standard output which will be read by
923 Geany. To help finding errors in executing the command, the output
924 of the program's standard error will be printed on Geany's standard
927 If there is no selection, the whole current line is used instead.
929 To add a custom command, use the *Send Selection to->Set Custom
930 Commands* menu item. Click on *Add* to get a new item and type the
931 command. You can also specify some command line options. Empty
932 commands are not saved.
934 Normal shell quoting is supported, so you can do things like:
936 * ``sed 's/\./(dot)/g'``
938 The above example would normally be done with the `Replace all`_
939 function, but it can be handy to have common commands already set up.
941 Note that the command is not run in a shell, so if you want to use
942 shell features like pipes and command chains, you need to explicitly
943 launch the shell and pass it your command:
945 * ``sh -c 'sort | uniq'``
951 You can execute the context action command on the current word at the
952 cursor position or the available selection. This word or selection
953 can be used as an argument to the command.
954 The context action is invoked by a menu entry in the popup menu of the
955 editor and also a keyboard shortcut (see the section called
958 The command can be specified in the preferences dialog and also for
959 each filetype (see "context_action_cmd" in the section called
960 `Filetype configuration`_). When the context action is invoked, the filetype
961 specific command is used if available, otherwise the command
962 specified in the preferences dialog is executed.
964 The current word or selection can be referred with the wildcard "%s"
965 in the command, it will be replaced by the current word or
966 selection before the command is executed.
968 For example a context action can be used to open API documentation
969 in a browser window, the command to open the PHP API documentation
972 firefox "http://www.php.net/%s"
974 when executing the command, the %s is substituted by the word near
975 the cursor position or by the current selection. If the cursor is at
976 the word "echo", a browser window will open(assumed your browser is
977 called firefox) and it will open the address: http://www.php.net/echo.
983 Geany can offer a list of possible completions for symbols defined in the
984 tags files and for all words in open documents.
986 The autocompletion list for symbols is presented when the first few
987 characters of the symbol are typed (configurable, see `Editor Completions
988 preferences`_, default 4) or when the *Complete word*
989 keybinding is pressed (configurable, see `Editor keybindings`_,
992 When the defined keybinding is typed and the *Autocomplete all words in
993 document* preference (in `Editor Completions preferences`_)
994 is selected then the autocompletion list will show all matching words
995 in the document, if there are no matching symbols.
997 If you don't want to use autocompletion it can be dismissed until
998 the next symbol by pressing Escape. The autocompletion list is updated
999 as more characters are typed so that it only shows completions that start
1000 with the characters typed so far. If no symbols begin with the sequence,
1001 the autocompletion window is closed.
1003 The up and down arrows will move the selected item. The highlighted
1004 item on the autocompletion list can be chosen from the list by pressing
1005 Enter/Return. You can also double-click to select an item. The sequence
1006 will be completed to match the chosen item, and if the *Drop rest of
1007 word on completion* preference is set (in `Editor Completions
1008 preferences`_) then any characters after the cursor that match
1009 a symbol or word are deleted.
1011 Word part completion
1012 ````````````````````
1013 By default, pressing Tab will complete the selected item by word part;
1014 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
1019 * gtk_combo_box_<e><TAB>
1020 * gtk_combo_box_entry_<s><ENTER>
1021 * gtk_combo_box_entry_set_text_column
1023 The key combination can be changed from Tab - See `Editor keybindings`_.
1024 If you clear/change the key combination for word part completion, Tab
1025 will complete the whole word instead, like Enter.
1027 Scope autocompletion
1028 ````````````````````
1037 When you type ``foo.`` it will show an autocompletion list with 'i' and
1040 It only works for languages that set parent scope names for e.g. struct
1041 members. Currently this means C-like languages. The C parser only
1042 parses global scopes, so this won't work for structs or objects declared
1046 User-definable snippets
1047 ^^^^^^^^^^^^^^^^^^^^^^^
1049 Snippets are small strings or code constructs which can be replaced or
1050 completed to a more complex string. So you can save a lot of time when
1051 typing common strings and letting Geany do the work for you.
1052 To know what to complete or replace Geany reads a configuration file
1053 called ``snippets.conf`` at startup.
1055 Maybe you need to often type your name, so define a snippet like this::
1058 myname=Enrico Tröger
1060 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
1061 with "Enrico Tröger". The key to start autocompletion can be changed
1062 in the preferences dialog, by default it is TAB. The corresponding keybinding
1063 is called `Complete snippet`.
1067 You can override the default snippets using the user
1068 ``snippets.conf`` file. Use the *Tools->Configuration
1069 Files->snippets.conf* menu item. See also `Configuration file paths`_.
1071 This adds the default settings to the user file if the file doesn't
1072 exist. Alternatively the file can be created manually, adding only
1073 the settings you want to change. All missing settings will be read
1074 from the system snippets file.
1078 The file ``snippets.conf`` contains sections defining snippets that
1079 are available for particular filetypes and in general.
1081 The two sections "Default" and "Special" apply to all filetypes.
1082 "Default" contains all snippets which are available for every
1083 filetype and "Special" contains snippets which can only be used in
1084 other snippets. So you can define often used parts of snippets and
1085 just use the special snippet as a placeholder (see the
1086 ``snippets.conf`` for details).
1088 You can define sections with the name of a filetype eg "C++". The
1089 snippets in that section are only available for use in files with that
1090 filetype. Snippets in filetype sections will hide snippets with the
1091 same name in the "Default" section when used in a file of that
1094 **Substitution sequences for snippets**
1096 To define snippets you can use several special character sequences which
1097 will be replaced when using the snippet:
1099 ================ =========================================================
1100 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1101 char(s): LF, CR/LF, or CR).
1103 \\t or %ws% Insert an indentation step, it will be replaced according
1104 to the current document's indent mode.
1106 \\s \\s to force whitespace at beginning or end of a value
1107 ('key= value' won't work, use 'key=\\svalue')
1109 %cursor% Place the cursor at this position after completion has
1110 been done. You can define multiple %cursor% wildcards
1111 and use the keybinding `Move cursor in snippet` to jump
1112 to the next defined cursor position in the completed
1115 %...% "..." means the name of a key in the "Special" section.
1116 If you have defined a key "brace_open" in the "Special"
1117 section you can use %brace_open% in any other snippet.
1118 ================ =========================================================
1120 Snippet names must not contain spaces otherwise they won't
1121 work correctly. But beside that you can define almost any
1122 string as a snippet and use it later in Geany. It is not limited
1123 to existing contructs of certain programming languages(like ``if``,
1124 ``for``, ``switch``). Define whatever you need.
1126 **Template wildcards**
1128 Since Geany 0.15 you can also use most of the available templates wildcards
1129 listed in `Template wildcards`_. All wildcards which are listed as
1130 `available in snippets` can be used. For instance to improve the above example::
1133 myname=My name is {developer}
1134 mysystem=My system: {command:uname -a}
1136 this will replace ``myname`` with "My name is " and the value of the template
1137 preference ``developer``.
1141 You can change the way Geany recognizes the word to complete,
1142 that is how the start and end of a word is recognised when the
1143 snippet completion is requested. The section "Special" may
1144 contain a key "wordchars" which lists all characters a string may contain
1145 to be recognized as a word for completion. Leave it commented to use
1146 default characters or define it to add or remove characters to fit your
1152 Normally you would type the snippet name and press Tab. However, you
1153 can define keybindings for snippets under the *Keybindings* group in
1158 block_cursor=<Ctrl>8
1161 Snippet keybindings may be overridden by Geany's configurable
1165 Inserting Unicode characters
1166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1168 You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1169 Ctrl-Shift, type some hex digits representing the code point for the character
1170 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1171 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1172 insertion is completed, but the typed character is also entered. In the case
1173 of Enter/Return, it is a newline, as you might expect.
1176 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1177 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1178 or restart Geany. Note that it works slightly differently from other GTK
1179 applications, in that you'll need to continue to hold down the Ctrl and Shift
1180 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1183 Search, replace and go to
1184 -------------------------
1186 This section describes search-related commands from the Search menu
1187 and the editor window's popup menu:
1194 * Go to symbol definition
1195 * Go to symbol declaration
1198 See also `Search`_ preferences.
1202 There are also two toolbar entries:
1207 There are keybindings to focus each of these - see `Focus
1208 keybindings`_. Pressing Escape will then focus the editor.
1212 The quickest way to find some text is to use the search bar entry in
1213 the toolbar. This performs a case-insensitive search in the current
1214 document whilst you type. Pressing Enter will search again, and pressing
1215 Shift-Enter will search backwards.
1220 The Find dialog is used for finding text in one or more open documents.
1222 .. image:: ./images/find_dialog.png
1228 The syntax for the *Use regular expressions* option is shown in
1229 `Regular expressions`_.
1232 *Use escape sequences* is implied for regular expressions.
1234 The *Use multi-line matching* option enables multi-line regular
1235 expressions instead of single-line ones. See `Regular expressions`_ for
1236 more details on the differences between the two modes.
1238 The *Use escape sequences* option will transform any escaped characters
1239 into their UTF-8 equivalent. For example, \\t will be transformed into
1240 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1241 (Unicode characters).
1247 To find all matches, click on the Find All expander. This will reveal
1254 Find All In Document will show a list of matching lines in the
1255 current document in the Messages tab of the Message Window. *Find All
1256 In Session* does the same for all open documents.
1258 Mark will highlight all matches in the current document with a
1259 colored box. These markers can be removed by selecting the
1260 Remove Markers command from the Document menu.
1263 Change font in search dialog text fields
1264 ````````````````````````````````````````
1266 All search related dialogs use a Monospace for the text input fields to
1267 increase the readability of input text. This is useful when you are
1268 typing input such as regular expressions with spaces, periods and commas which
1269 might it hard to read with a proportional font.
1271 If you want to change the font, you can do this easily
1272 by inserting the following style into your ``.gtkrc-2.0``
1273 (usually found in your home directory on UNIX-like systems and in the
1274 etc subdirectory of your Geany installation on Windows)::
1276 style "search_style"
1278 font_name="Monospace 8"
1280 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1282 Please note the addition of ":highest" in the last line which sets the priority
1283 of this style to the highest available. Otherwise, the style is ignored
1284 for the search dialogs.
1289 The *Find Next/Previous Selection* commands perform a search for the
1290 current selected text. If nothing is selected, by default the current
1291 word is used instead. This can be customized by the
1292 *find_selection_type* preference - see `Various preferences`_.
1294 ===== =============================================
1295 Value *find_selection_type* behaviour
1296 ===== =============================================
1297 0 Use the current word (default).
1298 1 Try the X selection first, then current word.
1299 2 Repeat last search.
1300 ===== =============================================
1306 *Find Usage* searches all open files. It is similar to the *Find All In
1307 Session* option in the Find dialog.
1309 If there is a selection, then it is used as the search text; otherwise
1310 the current word is used. The current word is either taken from the
1311 word nearest the edit cursor, or the word underneath the popup menu
1312 click position when the popup menu is used. The search results are
1313 shown in the Messages tab of the Message Window.
1316 You can also use Find Usage for symbol list items from the popup
1323 *Find in Files* is a more powerful version of *Find Usage* that searches
1324 all files in a certain directory using the Grep tool. The Grep tool
1325 must be correctly set in Preferences to the path of the system's Grep
1326 utility. GNU Grep is recommended (see note below).
1328 .. image:: ./images/find_in_files_dialog.png
1330 The *Search* field is initially set to the current word in the editor
1331 (depending on `Search`_ preferences).
1333 The *Files* setting allows to choose which files are included in the
1334 search, depending on the mode:
1337 Search in all files;
1339 Use the current project's patterns, see `Project properties`_;
1341 Use custom patterns.
1343 Both project and custom patterns use a glob-style syntax, each
1344 pattern separated by a space. To search all ``.c`` and ``.h`` files,
1346 Note that an empty pattern list searches in all files rather
1349 The *Directory* field is initially set to the current document's directory,
1350 unless this field has already been edited and the current document has
1351 not changed. Otherwise, the current document's directory is prepended to
1352 the drop-down history. This can be disabled - see `Search`_ preferences.
1354 The *Encoding* field can be used to define the encoding of the files
1355 to be searched. The entered search text is converted to the chosen encoding
1356 and the search results are converted back to UTF-8.
1358 The *Extra options* field is used to pass any additional arguments to
1362 The *Files* setting uses ``--include=`` when searching recursively,
1363 *Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
1364 not work with other Grep implementations.
1367 Filtering out version control files
1368 ```````````````````````````````````
1370 When using the *Recurse in subfolders* option with a directory that's
1371 under version control, you can set the *Extra options* field to filter
1372 out version control files.
1374 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1375 argument to filter out CVS and hidden directories like ``.svn``.
1377 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1379 If you have an older Grep, you can try using the ``--exclude`` flag
1380 to filter out filenames.
1382 SVN Example: ``--exclude=*.svn-base``
1384 The --exclude argument only matches the file name part, not the path.
1390 The Replace dialog is used for replacing text in one or more open
1393 .. image:: ./images/replace_dialog.png
1395 The Replace dialog has the same options for matching text as the Find
1396 dialog. See the section `Matching options`_.
1398 The *Use regular expressions* option allows regular expressions to
1399 be used in the search string and back references in the replacement
1400 text -- see the entry for '\\n' in `Regular expressions`_.
1405 To replace several matches, click on the *Replace All* expander. This
1406 will reveal several options:
1412 *Replace All In Document* will replace all matching text in the
1413 current document. *Replace All In Session* does the same for all open
1414 documents. *Replace All In Selection* will replace all matching text
1415 in the current selection of the current document.
1418 Go to symbol definition
1419 ^^^^^^^^^^^^^^^^^^^^^^^
1421 If the current word or selection is the name of a symbol definition
1422 (e.g. a function name) and the file containing the symbol definition is
1423 open, this command will switch to that file and go to the
1424 corresponding line number. The current word is either the word
1425 nearest the edit cursor, or the word underneath the popup menu click
1426 position when the popup menu is used.
1428 If there are more symbols with the same name to which the goto can be performed,
1429 a pop up is shown with a list of all the occurrences. After selecting a symbol
1430 from the list Geany jumps to the corresponding symbol location. Geany tries to
1431 suggest the nearest symbol (symbol from the current file, other open documents
1432 or current directory) as the best candidate for the goto and places this symbol
1433 at the beginning of the list typed in boldface.
1436 If the corresponding symbol is on the current line, Geany will first
1437 look for a symbol declaration instead, as this is more useful.
1438 Likewise *Go to symbol declaration* will search for a symbol definition
1439 first in this case also.
1442 Go to symbol declaration
1443 ^^^^^^^^^^^^^^^^^^^^^^^^
1445 Like *Go to symbol definition*, but for a forward declaration such as a
1446 C function prototype or ``extern`` declaration instead of a function
1453 Go to a particular line number in the current file.
1459 You can use regular expressions in the Find and Replace dialogs
1460 by selecting the *Use regular expressions* check box (see `Matching
1461 options`_). The syntax is Perl compatible. Basic syntax is described
1462 in the table below. For full details, see
1463 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
1465 By default regular expressions are matched on a line-by-line basis.
1466 If you are interested in multi-line regular expressions, matched against
1467 the whole buffer at once, see the section `Multi-line regular expressions`_
1471 1. The *Use escape sequences* dialog option always applies for regular
1473 2. Searching backwards with regular expressions is not supported.
1474 3. The *Use multi-line matching* dialog option to select single or
1475 multi-line matching.
1477 **In a regular expression, the following characters are interpreted:**
1479 ======= ============================================================
1480 . Matches any character.
1482 ( This marks the start of a region for tagging a match.
1484 ) This marks the end of a tagged region.
1486 \\n Where n is 1 through 9 refers to the first through ninth tagged
1487 region when searching or replacing.
1489 Searching for (Wiki)\\1 matches WikiWiki.
1491 If the search string was Fred([1-9])XXX and the
1492 replace string was Sam\\1YYY, when applied to Fred2XXX this
1493 would generate Sam2YYY.
1495 \\0 When replacing, the whole matching text.
1497 \\b This matches a word boundary.
1499 \\c A backslash followed by d, D, s, S, w or W, becomes a
1500 character class (both inside and outside sets []).
1503 * D: any char except decimal digits
1504 * s: whitespace (space, \\t \\n \\r \\f \\v)
1505 * S: any char except whitespace (see above)
1506 * w: alphanumeric & underscore
1507 * W: any char except alphanumeric & underscore
1509 \\x This allows you to use a character x that would otherwise have
1510 a special meaning. For example, \\[ would be interpreted as [
1511 and not as the start of a character set. Use \\\\ for a literal
1514 [...] Matches one of the characters in the set. If the first
1515 character in the set is ^, it matches the characters NOT in
1516 the set, i.e. complements the set. A shorthand S-E (start
1517 dash end) is used to specify a set of characters S up to E,
1520 The special characters ] and - have no special
1521 meaning if they appear first in the set. - can also be last
1522 in the set. To include both, put ] first: []A-Z-].
1526 []|-] matches these 3 chars
1527 []-|] matches from ] to | chars
1528 [a-z] any lowercase alpha
1529 [^]-] any char except - and ]
1530 [^A-Z] any char except uppercase alpha
1533 ^ This matches the start of a line (unless used inside a set, see
1536 $ This matches the end of a line.
1538 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1539 Saam, Saaam and so on.
1541 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1542 Saam, Saaam and so on.
1544 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1545 ======= ============================================================
1548 This table is adapted from Scintilla and SciTE documentation,
1549 distributed under the `License for Scintilla and SciTE`_.
1552 Multi-line regular expressions
1553 ``````````````````````````````
1556 The *Use multi-line matching* dialog option enables multi-line
1557 regular expressions.
1559 Multi-line regular expressions work just like single-line ones but a
1560 match can span several lines.
1562 While the syntax is the same, a few practical differences applies:
1564 ======= ============================================================
1565 . Matches any character but newlines. This behavior can be changed
1566 to also match newlines using the (?s) option, see
1567 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html#idp5671632
1569 [^...] A negative range (see above) *will* match newlines if they are
1570 not explicitly listed in that negative range. For example, range
1571 [^a-z] will match newlines, while range [^a-z\\r\\n] won't.
1572 While this is the expected behavior, it can lead to tricky
1573 problems if one doesn't think about it when writing an expression.
1574 ======= ============================================================
1579 The View menu allows various elements of the main window to be shown
1580 or hidden, and also provides various display-related editor options.
1582 Color schemes dialog
1583 ^^^^^^^^^^^^^^^^^^^^
1584 The Color Schemes dialog is available under the *View->Change Color Scheme*
1585 menu item. It lists various color schemes for editor highlighting
1586 styles, including the default scheme first. Other items are available
1587 based on what color scheme files Geany found at startup.
1589 Color scheme files are read from the `Configuration file paths`_ under
1590 the ``colorschemes`` subdirectory. They should have the extension
1591 ``.conf``. The default color scheme
1592 is read from ``filetypes.common``.
1594 The `[named_styles] section`_ and `[named_colors] section`_ are the
1595 same as for ``filetypes.common``.
1597 The ``[theme_info]`` section can contain information about the
1598 theme. The ``name`` and ``description`` keys are read to set the
1599 menu item text and tooltip, respectively. These keys can have
1600 translations, e.g.::
1606 Symbols and tags files
1607 ----------------------
1609 Upon opening, files of supported filetypes are parsed to extract the symbol
1610 information (aka "workspace symbols"). You can also have Geany automatically
1611 load external files containing the symbol information (aka "global
1612 tags files") upon startup, or manually using *Tools --> Load Tags File*.
1614 Geany uses its own tags file format, similar to what ``ctags`` uses
1615 (but is incompatible with ctags). You use Geany to generate global
1616 tags files, as described below.
1622 Each document is parsed for symbols whenever a file is loaded, saved or
1623 modified (see *Symbol list update frequency* preference in the `Editor
1624 Completions preferences`_). These are shown in the Symbol list in the
1625 Sidebar. These symbols are also used for autocompletion and calltips
1626 for all documents open in the current session that have the same filetype.
1628 The *Go to Symbol* commands can be used with all workspace symbols. See
1629 `Go to symbol definition`_.
1635 Global tags files are used to provide symbols for autocompletion and calltips
1636 without having to open the source files containing these symbols. This is intended
1637 for library APIs, as the tags file only has to be updated when you upgrade
1640 You can load a custom global tags file in two ways:
1642 * Using the *Load Tags File* command in the Tools menu.
1643 * By moving or symlinking tags files to the ``tags`` subdirectory of
1644 one of the `configuration file paths`_ before starting Geany.
1646 You can either download these files or generate your own. They have
1651 *lang_ext* is one of the extensions set for the filetype associated
1652 with the tags parser. See the section called `Filetype extensions`_ for
1656 Default global tags files
1657 `````````````````````````
1659 Some global tags files are distributed with Geany and will be loaded
1660 automatically when the corresponding filetype is first used. Currently
1661 this includes global tags files for these languages:
1666 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1671 Global tags file format
1672 ```````````````````````
1674 Global tags files can have three different formats:
1677 * Pipe-separated format
1680 The first line of global tags files should be a comment, introduced
1681 by ``#`` followed by a space and a string like ``format=pipe``,
1682 ``format=ctags`` or ``format=tagmanager`` respectively, these are
1683 case-sensitive. This helps Geany to read the file properly. If this
1684 line is missing, Geany tries to auto-detect the used format but this
1688 The Tagmanager format is a bit more complex and is used for files
1689 created by the ``geany -g`` command. There is one symbol per line.
1690 Different symbol attributes like the return value or the argument list
1691 are separated with different characters indicating the type of the
1692 following argument. This is the more complete and recommended tags file
1695 Pipe-separated format
1696 *********************
1697 The Pipe-separated format is easier to read and write.
1698 There is one symbol per line and different symbol attributes are separated
1699 by the pipe character (``|``). A line looks like::
1701 basename|string|(string path [, string suffix])|
1703 | The first field is the symbol name (usually a function name).
1704 | The second field is the type of the return value.
1705 | The third field is the argument list for this symbol.
1706 | The fourth field is the description for this symbol but
1707 currently unused and should be left empty.
1709 Except for the first field (symbol name), all other field can be left
1710 empty but the pipe separator must appear for them.
1712 You can easily write your own global tags files using this format.
1713 Just save them in your tags directory, as described earlier in the
1714 section `Global tags files`_.
1718 This is the format that ctags generates, and that is used by Vim.
1719 This format is compatible with the format historically used by Vi.
1721 The format is described at http://ctags.sourceforge.net/FORMAT, but
1722 for the full list of existing extensions please refer to ctags.
1723 However, note that Geany may actually only honor a subset of the
1724 existing extensions.
1726 Generating a global tags file
1727 `````````````````````````````
1729 You can generate your own global tags files by parsing a list of
1730 source files. The command is::
1732 geany -g [-P] <Tags File> <File list>
1734 * Tags File filename should be in the format described earlier --
1735 see the section called `Global tags files`_.
1736 * File list is a list of filenames, each with a full path (unless
1737 you are generating C/C++ tags files and have set the CFLAGS environment
1738 variable appropriately).
1739 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1740 to process ``#include`` directives for C/C++ source files. Use this
1741 option if you want to specify each source file on the command-line
1742 instead of using a 'master' header file. Also can be useful if you
1743 don't want to specify the CFLAGS environment variable.
1745 Example for the wxD library for the D programming language::
1747 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1750 Generating C/C++ tags files
1751 ***************************
1752 You may need to first setup the `C ignore.tags`_ file.
1754 For C/C++ tags files gcc is required by default, so that header files
1755 can be preprocessed to include any other headers they depend upon. If
1756 you do not want this, use the ``-P`` option described above.
1758 For preprocessing, the environment variable CFLAGS should be set with
1759 appropriate ``-I/path`` include paths. The following example works with
1760 the bash shell, generating a tags file for the GnomeUI library::
1762 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1763 /usr/include/libgnomeui-2.0/gnome.h
1765 You can adapt this command to use CFLAGS and header files appropriate
1766 for whichever libraries you want.
1769 Generating tags files on Windows
1770 ********************************
1771 This works basically the same as on other platforms::
1773 "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
1779 You can ignore certain symbols for C-based languages if they would lead
1780 to wrong parsing of the code. Use the *Tools->Configuration
1781 Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
1782 See also `Configuration file paths`_.
1784 List all symbol names you want to ignore in this file, separated by spaces
1789 G_GNUC_NULL_TERMINATED
1791 G_GNUC_WARN_UNUSED_RESULT
1793 This will parse code like:
1795 ``gchar **utils_strv_new(const gchar *first, ...)
1796 G_GNUC_NULL_TERMINATED;``
1798 More detailed information about ignore.tags usage from the Exuberant Ctags
1801 Specifies a list of identifiers which are to be specially handled
1802 while parsing C and C++ source files. This option is specifically
1803 provided to handle special cases arising through the use of
1804 pre-processor macros. When the identifiers listed are simple identifiers,
1805 these identifiers will be ignored during parsing of the source files.
1806 If an identifier is suffixed with a '+' character, ctags will also
1807 ignore any parenthesis-enclosed argument list which may immediately
1808 follow the identifier in the source files.
1809 If two identifiers are separated with the '=' character, the first
1810 identifiers is replaced by the second identifiers for parsing purposes.
1812 For even more detailed information please read the manual page of
1815 Geany extends Ctags with a '*' character suffix - this means use
1816 prefix matching, e.g. G_GNUC_* will match G_GNUC_NULL_TERMINATED, etc.
1817 Note that prefix match items should be put after other items to ensure
1818 that items like G_GNUC_PRINTF+ get parsed correctly.
1824 You may adjust Geany's settings using the Edit --> Preferences
1825 dialog. Any changes you make there can be applied by hitting either
1826 the Apply or the OK button. These settings will persist between Geany
1827 sessions. Note that most settings here have descriptive popup bubble
1828 help -- just hover the mouse over the item in question to get help
1831 You may also adjust some View settings (under the View menu) that
1832 persist between Geany sessions. The settings under the Document menu,
1833 however, are only for the current document and revert to defaults
1834 when restarting Geany.
1837 In the paragraphs that follow, the text describing a dialog tab
1838 comes after the screenshot of that tab.
1841 General Startup preferences
1842 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1844 .. image:: ./images/pref_dialog_gen_startup.png
1849 Load files from the last session
1850 On startup, load the same files you had open the last time you
1853 Load virtual terminal support
1854 Load the library for running a terminal in the message window area.
1856 Enable plugin support
1857 Allow plugins to be used in Geany.
1861 Save window position and geometry
1862 Save the current position and size of the main window so next time
1863 you open Geany it's in the same location.
1866 Have a dialog pop up to confirm that you really want to quit Geany.
1872 Path to start in when opening or saving files.
1873 It must be an absolute path.
1876 Path to start in when opening project files.
1879 By default Geany looks in the system installation and the user
1880 configuration - see `Plugins`_. In addition the path entered here will be
1882 Usually you do not need to set an additional path to search for
1883 plugins. It might be useful when Geany is installed on a multi-user machine
1884 and additional plugins are available in a common location for all users.
1885 Leave blank to not set an additional lookup path.
1888 General Miscellaneous preferences
1889 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1891 .. image:: ./images/pref_dialog_gen_misc.png
1896 Beep on errors when compilation has finished
1897 Have the computer make a beeping sound when compilation of your program
1898 has completed or any errors occurred.
1900 Switch status message list at new message
1901 Switch to the status message tab (in the notebook window at the bottom)
1902 once a new status message arrives.
1904 Suppress status messages in the status bar
1905 Remove all messages from the status bar. The messages are still displayed
1906 in the status messages window.
1909 Another option is to use the *Switch to Editor* keybinding - it
1910 reshows the document statistics on the status bar. See `Focus
1913 Use Windows File Open/Save dialogs
1914 Defines whether to use the native Windows File Open/Save dialogs or
1915 whether to use the GTK default dialogs.
1917 Auto-focus widgets (focus follows mouse)
1918 Give the focus automatically to widgets below the mouse cursor.
1919 This works for the main editor widget, the scribble, the toolbar search field
1920 goto line fields and the VTE.
1926 Always wrap search around the document when finding a match.
1928 Hide the Find dialog
1929 Hide the `Find`_ dialog after clicking Find Next/Previous.
1931 Use the current word under the cursor for Find dialogs
1932 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1933 there is no selection. When this option is disabled, the search term last used in the
1934 appropriate Find dialog is used.
1936 Use the current file's directory for Find in Files
1937 When opening the Find in Files dialog, set the directory to search to the directory of the current
1938 active file. When this option is disabled, the directory of the last use of the Find in Files
1939 dialog is used. See `Find in Files`_ for details.
1944 Use project-based session files
1945 Save your current session when closing projects. You will be able to
1946 resume different project sessions, automatically opening the files
1947 you had open previously.
1949 Store project file inside the project base directory
1950 When creating new projects, the default path for the project file contains
1951 the project base path. Without this option enabled, the default project file
1952 path is one level above the project base path.
1953 In either case, you can easily set the final project file path in the
1954 *New Project* dialog. This option provides the more common
1955 defaults automatically for convenience.
1958 Interface preferences
1959 ^^^^^^^^^^^^^^^^^^^^^
1961 .. image:: ./images/pref_dialog_interface_interface.png
1967 Whether to show the sidebar at all.
1970 Show the list of functions, variables, and other information in the
1971 current document you are editing.
1974 Show all the documents you have open currently. This can be used to
1975 change between documents (see `Switching between documents`_) and
1976 to perform some common operations such as saving, closing and reloading.
1979 Whether to place the sidebar on the left or right of the editor window.
1985 Whether to place the message window on the bottom or right of the editor window.
1991 Change the font used to display documents.
1994 Change the font used for the Symbols sidebar tab.
1997 Change the font used for the message window area.
2003 Show the status bar at the bottom of the main window. It gives information about
2004 the file you are editing like the line and column you are on, whether any
2005 modifications were done, the file encoding, the filetype and other information.
2007 Interface Notebook tab preferences
2008 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2010 .. image:: ./images/pref_dialog_interface_notebook.png
2016 Show a notebook tab for all documents so you can switch between them
2017 using the mouse (instead of using the Documents window).
2020 Make each tab show a close button so you can easily close open
2023 Placement of new file tabs
2024 Whether to create a document with its notebook tab to the left or
2025 right of all existing tabs.
2028 Whether to place file tabs next to the current tab
2029 rather than at the edges of the notebook.
2031 Double-clicking hides all additional widgets
2032 Whether to call the View->Toggle All Additional Widgets command
2033 when double-clicking on a notebook tab.
2039 Set the positioning of the editor's notebook tabs to the right,
2040 left, top, or bottom of the editing window.
2043 Set the positioning of the sidebar's notebook tabs to the right,
2044 left, top, or bottom of the sidebar window.
2047 Set the positioning of the message window's notebook tabs to the
2048 right, left, top, or bottom of the message window.
2051 Interface Toolbar preferences
2052 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2054 Affects the main toolbar underneath the menu bar.
2056 .. image:: ./images/pref_dialog_interface_toolbar.png
2062 Whether to show the toolbar.
2064 Append Toolbar to the Menu
2065 Allows to append the toolbar to the main menu bar instead of placing it below.
2066 This is useful to save vertical space.
2069 See `Customizing the toolbar`_.
2075 Select the toolbar icon style to use - either icons and text, just
2077 The choice System default uses whatever icon style is set by GTK.
2080 Select the size of the icons you see (large, small or very small).
2081 The choice System default uses whatever icon size is set by GTK.
2084 Editor Features preferences
2085 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2087 .. image:: ./images/pref_dialog_edit_features.png
2093 Show long lines wrapped around to new display lines.
2098 Whether to move the cursor to the first non-whitespace character
2099 on the line when you hit the home key on your keyboard. Pressing it
2100 again will go to the very start of the line.
2102 Disable Drag and Drop
2103 Do not allow the dragging and dropping of selected text in documents.
2106 Allow groups of lines in a document to be collapsed for easier
2109 Fold/Unfold all children of a fold point
2110 Whether to fold/unfold all child fold points when a parent line
2113 Use indicators to show compile errors
2114 Underline lines with compile errors using red squiggles to indicate
2115 them in the editor area.
2117 Newline strips trailing spaces
2118 Remove any whitespace at the end of the line when you hit the
2119 Enter/Return key. See also `Strip trailing spaces`_. Note
2120 auto indentation is calculated before stripping, so although this
2121 setting will clear a blank line, it will not set the next line
2122 indentation back to zero.
2124 Line breaking column
2125 The editor column number to insert a newline at when Line Breaking
2126 is enabled for the current document.
2128 Comment toggle marker
2129 A string which is added when toggling a line comment in a source file.
2130 It is used to mark the comment as toggled.
2133 Editor Indentation preferences
2134 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2136 .. image:: ./images/pref_dialog_edit_indentation.png
2141 See `Indentation`_ for more information.
2144 The width of a single indent size in spaces. By default the indent
2145 size is equivalent to 4 spaces.
2147 Detect width from file
2148 Try to detect and set the indent width based on file content, when
2152 When Geany inserts indentation, whether to use:
2156 * Tabs and Spaces, depending on how much indentation is on a line
2158 The *Tabs and Spaces* indent type is also known as *Soft tab
2159 support* in some other editors.
2161 Detect type from file
2162 Try to detect and set the indent type based on file content, when
2166 The type of auto-indentation you wish to use after pressing Enter,
2170 Just add the indentation of the previous line.
2172 Add indentation based on the current filetype and any characters at
2173 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
2175 Like *Current chars* but for C-like languages, make a closing
2176 ``}`` brace line up with the matching opening brace.
2179 If set, pressing tab will indent the current line or selection, and
2180 unindent when pressing Shift-tab. Otherwise, the tab key will
2181 insert a tab character into the document (which can be different
2182 from indentation, depending on the indent type).
2185 There are also separate configurable keybindings for indent &
2186 unindent, but this preference allows the tab key to have different
2187 meanings in different contexts - e.g. for snippet completion.
2189 Editor Completions preferences
2190 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2192 .. image:: ./images/pref_dialog_edit_completions.png
2198 Whether to replace special keywords after typing Tab into a
2199 pre-defined text snippet.
2200 See `User-definable snippets`_.
2202 XML/HTML tag auto-closing
2203 When you open an XML/HTML tag automatically generate its
2206 Automatic continuation multi-line comments
2207 Continue automatically multi-line comments in languages like C, C++
2208 and Java when a new line is entered inside such a comment.
2209 With this option enabled, Geany will insert a ``*`` on every new line
2210 inside a multi-line comment, for example when you press return in the
2214 * This is a C multi-line comment, press <Return>
2216 then Geany would insert::
2220 on the next line with the correct indentation based on the previous line,
2221 as long as the multi-line is not closed by ``*/``.
2223 Autocomplete symbols
2224 When you start to type a symbol name, look for the full string to
2225 allow it to be completed for you.
2227 Autocomplete all words in document
2228 When you start to type a word, Geany will search the whole document for
2229 words starting with the typed part to complete it, assuming there
2230 are no symbol names to show.
2232 Drop rest of word on completion
2233 Remove any word part to the right of the cursor when choosing a
2234 completion list item.
2236 Characters to type for autocompletion
2237 Number of characters of a word to type before autocompletion is
2240 Completion list height
2241 The number of rows to display for the autocompletion window.
2243 Max. symbol name suggestions
2244 The maximum number of items in the autocompletion list.
2246 Symbol list update frequency
2247 The minimum delay (in milliseconds) between two symbol list updates.
2249 This option determines how frequently the symbol list is updated for the
2250 current document. The smaller the delay, the more up-to-date the symbol
2251 list (and then the completions); but rebuilding the symbol list has a
2252 cost in performance, especially with large files.
2254 The default value is 250ms, which means the symbol list will be updated
2255 at most four times per second, even if the document changes continuously.
2257 A value of 0 disables automatic updates, so the symbol list will only be
2258 updated upon document saving.
2261 Auto-close quotes and brackets
2262 ``````````````````````````````
2264 Geany can automatically insert a closing bracket and quote characters when
2265 you open them. For instance, you type a ``(`` and Geany will automatically
2266 insert ``)``. With the following options, you can define for which
2267 characters this should work.
2270 Auto-close parenthesis when typing an opening one
2273 Auto-close curly brackets (braces) when typing an opening one
2276 Auto-close square brackets when typing an opening one
2279 Auto-close single quotes when typing an opening one
2282 Auto-close double quotes when typing an opening one
2285 Editor Display preferences
2286 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2288 This is for visual elements displayed in the editor window.
2290 .. image:: ./images/pref_dialog_edit_display.png
2295 Invert syntax highlighting colors
2296 Invert all colors, by default this makes white text on a black
2299 Show indendation guides
2300 Show vertical lines to help show how much leading indentation there
2304 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2305 show which kinds of whitespace are used.
2308 Display a symbol everywhere that a carriage return or line feed
2312 Show or hide the Line Number margin.
2315 Show or hide the small margin right of the line numbers, which is used
2318 Stop scrolling at last line
2319 When enabled Geany stops scrolling when at the last line of the document.
2320 Otherwise you can scroll one more page even if there are no real lines.
2326 The long line marker helps to indicate overly-long lines, or as a hint
2327 to the user for when to break the line.
2331 Show a thin vertical line in the editor window at the given column
2334 Change the background color of characters after the given column
2335 position to the color set below. (This is recommended over the
2336 *Line* setting if you use proportional fonts).
2338 Don't mark long lines at all.
2341 Set this value to a value greater than zero to specify the column
2342 where it should appear.
2344 Long line marker color
2345 Set the color of the long line marker.
2351 Virtual space is space beyond the end of each line.
2352 The cursor may be moved into virtual space but no real space will be
2353 added to the document until there is some text typed or some other
2354 text insertion command is used.
2357 Do not show virtual spaces
2359 Only for rectangular selections
2360 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2363 Always show virtual spaces beyond the end of lines
2369 .. image:: ./images/pref_dialog_files.png
2374 Open new documents from the command-line
2375 Whether to create new documents when passing filenames that don't
2376 exist from the command-line.
2378 Default encoding (new files)
2379 The type of file encoding you wish to use when creating files.
2381 Used fixed encoding when opening files
2382 Assume all files you are opening are using the type of encoding specified below.
2384 Default encoding (existing files)
2385 Opens all files with the specified encoding instead of auto-detecting it.
2386 Use this option when it's not possible for Geany to detect the exact encoding.
2388 Default end of line characters
2389 The end of line characters to which should be used for new files.
2390 On Windows systems, you generally want to use CR/LF which are the common
2391 characters to mark line breaks.
2392 On Unix-like systems, LF is default and CR is used on MAC systems.
2396 Perform formatting operations when a document is saved. These
2397 can each be undone with the Undo command.
2399 Ensure newline at file end
2400 Add a newline at the end of the document if one is missing.
2402 Ensure consistent line endings
2403 Ensures that newline characters always get converted before
2404 saving, avoiding mixed line endings in the same file.
2406 .. _Strip trailing spaces:
2408 Strip trailing spaces
2409 Remove any whitespace at the end of each document line.
2412 This does not apply to Diff documents, e.g. patch files.
2414 Replace tabs with spaces
2415 Replace all tabs in the document with the equivalent number of spaces.
2418 It is better to use spaces to indent than use this preference - see
2424 Recent files list length
2425 The number of files to remember in the recently used files list.
2428 The number of seconds to periodically check the current document's
2429 file on disk in case it has changed. Setting it to 0 will disable
2433 These checks are only performed on local files. Remote files are
2434 not checked for changes due to performance issues
2435 (remote files are files in ``~/.gvfs/``).
2441 .. image:: ./images/pref_dialog_tools.png
2447 The command to execute a script in a terminal. Occurrences of %c
2448 in the command are substituted with the run script name, see
2449 `Terminal emulators`_.
2452 The location of your web browser executable.
2455 The location of the grep executable.
2458 For Windows users: at the time of writing it is recommended to use
2459 the grep.exe from the UnxUtils project
2460 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2461 Mingw project for instance might not work with Geany at the moment.
2467 Set this to a command to execute on the current word.
2468 You can use the "%s" wildcard to pass the current word below the cursor
2469 to the specified command.
2472 Template preferences
2473 ^^^^^^^^^^^^^^^^^^^^
2475 This data is used as meta data for various template text to insert into
2476 a document, such as the file header. You only need to set fields that
2477 you want to use in your template files.
2479 .. image:: ./images/pref_dialog_templ.png
2485 The name of the developer who will be creating files.
2488 The initials of the developer.
2491 The email address of the developer.
2494 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2497 The company the developer is working for.
2500 The initial version of files you will be creating.
2503 Specify a format for the {year} wildcard. You can use any conversion specifiers
2504 which can be used with the ANSI C strftime function. For details please see
2505 http://man.cx/strftime.
2508 Specify a format for the {date} wildcard. You can use any conversion specifiers
2509 which can be used with the ANSI C strftime function. For details please see
2510 http://man.cx/strftime.
2513 Specify a format for the {datetime} wildcard. You can use any conversion specifiers
2514 which can be used with the ANSI C strftime function. For details please see
2515 http://man.cx/strftime.
2518 Keybinding preferences
2519 ^^^^^^^^^^^^^^^^^^^^^^
2521 .. image:: ./images/pref_dialog_keys.png
2523 There are some commands listed in the keybinding dialog that are not, by default,
2524 bound to a key combination, and may not be available as a menu item.
2527 For more information see the section `Keybindings`_.
2530 Printing preferences
2531 ^^^^^^^^^^^^^^^^^^^^
2533 .. image:: ./images/pref_dialog_printing.png
2535 Use external command for printing
2536 Use a system command to print your file out.
2538 Use native GTK printing
2539 Let the GTK GUI toolkit handle your print request.
2542 Print the line numbers on the left of your paper.
2545 Print the page number on the bottom right of your paper.
2548 Print a header on every page that is sent to the printer.
2550 Use base name of the printed file
2551 Don't use the entire path for the header, only the filename.
2554 How the date should be printed. You can use the same format
2555 specifiers as in the ANSI C function strftime(). For details please
2556 see http://man.cx/strftime.
2562 .. image:: ./images/pref_dialog_various.png
2564 Rarely used preferences, explained in the table below. A few of them require
2565 restart to take effect, and a few other will only affect newly opened or created
2566 documents before restart.
2568 ================================ =========================================== ========== ===========
2569 Key Description Default Applies
2570 ================================ =========================================== ========== ===========
2572 use_gtk_word_boundaries Whether to look for the end of a word true to new
2573 when using word-boundary related documents
2574 Scintilla commands (see `Scintilla
2575 keyboard commands`_).
2576 brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
2577 complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
2578 when editing an existing line (i.e. there
2579 is some text after the current cursor
2580 position on the line). Only used when the
2581 keybinding `Complete snippet` is set to
2583 show_editor_scrollbars Whether to display scrollbars. If set to true immediately
2584 false, the horizontal and vertical
2585 scrollbars are hidden completely.
2586 indent_hard_tab_width The size of a tab character. Don't change 8 immediately
2587 it unless you really need to; use the
2588 indentation settings instead.
2589 **Interface related**
2590 show_symbol_list_expanders Whether to show or hide the small true to new
2591 expander icons on the symbol list documents
2593 allow_always_save Whether files can be saved always, even false immediately
2594 if they don't have any changes.
2595 By default, the Save button and menu
2596 item are disabled when a file is
2597 unchanged. When setting this option to
2598 true, the Save button and menu item are
2599 always active and files can be saved.
2600 compiler_tab_autoscroll Whether to automatically scroll to the true immediately
2601 last line of the output in the Compiler
2603 statusbar_template The status bar statistics line format. See below. immediately
2604 (See `Statusbar Templates`_ for details).
2605 new_document_after_close Whether to open a new document after all false immediately
2606 documents have been closed.
2607 msgwin_status_visible Whether to show the Status tab in the true immediately
2609 msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
2611 msgwin_messages_visible Whether to show the Messages tab in the true immediately
2613 msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
2616 emulation Terminal emulation mode. Only change this xterm immediately
2617 if you have VTE termcap files other than
2618 ``vte/termcap/xterm``.
2619 send_selection_unsafe By default, Geany strips any trailing false immediately
2620 newline characters from the current
2621 selection before sending it to the terminal
2622 to not execute arbitrary code. This is
2623 mainly a security feature.
2624 If, for whatever reasons, you really want
2625 it to be executed directly, set this option
2627 send_cmd_prefix String with which prefix the commands sent Empty immediately
2628 to the shell. This may be used to tell
2629 some shells (BASH with ``HISTCONTROL`` set
2630 to ``ignorespace``, ZSH with
2631 ``HIST_IGNORE_SPACE`` enabled, etc.) from
2632 putting these commands in their history by
2633 setting this to a space. Note that leading
2634 spaces must be escaped using `\s` in the
2637 use_atomic_file_saving Defines the mode how Geany saves files to false immediately
2638 disk. If disabled, Geany directly writes
2639 the content of the document to disk. This
2640 might cause loss of data when there is
2641 no more free space on disk to save the
2642 file. When set to true, Geany first saves
2643 the contents into a temporary file and if
2644 this succeeded, the temporary file is
2645 moved to the real file to save.
2646 This gives better error checking in case of
2647 no more free disk space. But it also
2648 destroys hard links of the original file
2649 and its permissions (e.g. executable flags
2650 are reset). Use this with care as it can
2651 break things seriously.
2652 The better approach would be to ensure your
2653 disk won't run out of free space.
2654 use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
2655 saving backend. It is better on most
2656 situations but is known not to work
2657 correctly on some complex setups.
2658 gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
2659 saving. Backup is named `filename~`.
2660 keep_edit_history_on_reload Whether to maintain the edit history when true immediately
2661 reloading a file, and allow the operation
2663 **Filetype related**
2664 extract_filetype_regex Regex to extract filetype name from file See below. immediately
2665 via capture group one.
2667 find_selection_type See `Find selection`_. 0 immediately
2669 replace_and_find_by_default Set ``Replace & Find`` button as default so true immediately
2670 it will be activated when the Enter key is
2671 pressed while one of the text fields has
2673 **Build Menu related**
2674 number_ft_menu_items The maximum number of menu items in the 2 on restart
2675 filetype section of the Build menu.
2676 number_non_ft_menu_items The maximum number of menu items in the 3 on restart
2677 independent section of the Build menu.
2678 number_exec_menu_items The maximum number of menu items in the 2 on restart
2679 execute section of the Build menu.
2680 ================================ =========================================== ========== ===========
2682 The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX.
2687 The default statusbar template is (note ``\t`` = tab):
2689 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
2691 Settings the preference to an empty string will also cause Geany to use this
2694 The following format characters are available for the statusbar template:
2696 ============ ===========================================================
2697 Placeholder Description
2698 ============ ===========================================================
2699 ``%l`` The current line number starting at 1
2700 ``%L`` The total number of lines
2701 ``%c`` The current column number starting at 0, including virtual
2703 ``%C`` The current column number starting at 1, including virtual
2705 ``%s`` The number of selected characters or if only whole lines
2706 selected, the number of selected lines.
2707 ``%n`` The number of selected characters, even if only whole lines
2709 ``%w`` Shows ``RO`` when the document is in read-only mode,
2710 otherwise shows whether the editor is in overtype (OVR)
2711 or insert (INS) mode.
2712 ``%t`` Shows the indentation mode, either tabs (TAB),
2713 spaces (SP) or both (T/S).
2714 ``%m`` Shows whether the document is modified (MOD) or nothing.
2715 ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
2716 ``%e`` The name of the document's encoding (ex. UTF-8).
2717 ``%f`` The filetype of the document (ex. None, Python, C, etc).
2718 ``%S`` The name of the scope where the caret is located.
2719 ``%p`` The caret position in the entire document starting at 0.
2720 ``%r`` Shows whether the document is read-only (RO) or nothing.
2721 ``%Y`` The Scintilla style number at the caret position. This is
2722 useful if you're debugging color schemes or related code.
2723 ============ ===========================================================
2725 Terminal (VTE) preferences
2726 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2728 See also: `Virtual terminal emulator widget (VTE)`_.
2730 .. image:: ./images/pref_dialog_vte.png
2736 Select the font that will be used in the terminal emulation control.
2739 Select the font color.
2742 Select the background color of the terminal.
2745 Select the background image to show behind the terminal's text.
2748 The number of lines buffered so that you can scroll though the history.
2751 The location of the shell on your system.
2754 Scroll the terminal to the prompt line when pressing a key.
2757 Scroll the output down.
2760 Let the terminal cursor blink.
2762 Override Geany keybindings
2763 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2765 Disable menu shortcut key (F10 by default)
2766 Disable the menu shortcut when you are in the virtual terminal.
2768 Follow path of the current file
2769 Make the path of the terminal change according to the path of the
2772 Execute programs in VTE
2773 Execute programs in the virtual terminal instead of using the external
2774 terminal tool. Note that if you run multiple execute commands at once
2775 the output may become mixed together in the VTE.
2777 Don't use run script
2778 Don't use the simple run script which is usually used to display
2779 the exit status of the executed program.
2780 This can be useful if you already have a program running in the VTE
2781 like a Python console (e.g. ipython). Use this with care.
2787 Project management is optional in Geany. Currently it can be used for:
2789 * Storing and opening session files on a project basis.
2790 * Overriding default settings with project equivalents.
2791 * Configuring the Build menu on a project basis.
2793 A list of session files can be stored and opened with the project
2794 when the *Use project-based session files* preference is enabled,
2795 in the `Projects`_ group of the `General Miscellaneous preferences`_ tab
2796 of the `Preferences`_ dialog.
2798 As long as a project is open, the Build menu will use
2799 the items defined in project's settings, instead of the defaults.
2800 See `Build Menu Configuration`_ for information on configuring the menu.
2802 The current project's settings are saved when it is closed, or when
2803 Geany is shutdown. When restarting Geany, the previously opened project
2804 file that was in use at the end of the last session will be reopened.
2806 The project menu items are detailed below.
2812 To create a new project, fill in the *Name* field. By default this
2813 will setup a new project file ``~/projects/name.geany``. Usually it's
2814 best to store all your project files in the same directory (they are
2815 independent of any source directory trees).
2817 The Base path text field is setup to use ``~/projects/name``. This
2818 can safely be set to any existing path -- it will not touch the file
2819 structure contained in it.
2825 You can set an optional description for the project. Currently it's
2826 only used for a template wildcard - see `Template wildcards`_.
2828 The *Base path* field is used as the directory to run the Build menu commands.
2829 The specified path can be an absolute path or it is considered to be
2830 relative to the project's file name.
2832 The *File patterns* field allows to specify a list of file patterns for the
2833 project, which can be used in the `Find in files`_ dialog.
2835 The *Indentation* tab allows you to override the default
2836 `Indentation`_ settings.
2842 The Open command displays a standard file chooser, starting in
2843 ``~/projects``. Choose a project file named with the ``.geany``
2846 When project session support is enabled, Geany will close the currently
2847 open files and open the session files associated with the project.
2853 Project file settings are saved when the project is closed.
2855 When project session support is enabled, Geany will close the project
2856 session files and open any previously closed default session files.
2861 After editing code with Geany, the next step is to compile, link, build,
2862 interpret, run etc. As Geany supports many languages each with a different
2863 approach to such operations, and as there are also many language independent
2864 software building systems, Geany does not have a built-in build system, nor
2865 does it limit which system you can use. Instead the build menu provides
2866 a configurable and flexible means of running any external commands to
2867 execute your preferred build system.
2869 This section provides a description of the default configuration of the
2870 build menu and then covers how to configure it, and where the defaults fit in.
2872 Running the commands from within Geany has two benefits:
2874 * The current file is automatically saved before the command is run.
2875 * The output is captured in the Compiler notebook tab and parsed for
2878 Warnings and errors that can be parsed for line numbers will be shown in
2879 red in the Compiler tab and you can click on them to switch to the relevant
2880 source file (or open it) and mark the line number. Also lines with
2881 warnings or errors are marked in the source, see `Indicators`_ below.
2884 If Geany's default error message parsing does not parse errors for
2885 the tool you're using, you can set a custom regex in the Build Commands
2886 Dialog, see `Build Menu Configuration`_.
2891 Indicators are red squiggly underlines which are used to highlight
2892 errors which occurred while compiling the current file. So you can
2893 easily see where your code failed to compile. You can remove them by
2894 selecting *Remove Error Indicators* in the Document menu.
2896 If you do not like this feature, you can disable it - see `Editor Features
2900 Default build menu items
2901 ^^^^^^^^^^^^^^^^^^^^^^^^
2902 Depending on the current file's filetype, the default Build menu will contain
2903 the following items:
2909 * Make Custom Target
2914 * Set Build Menu Commands
2920 The Compile command has different uses for different kinds of files.
2922 For compilable languages such as C and C++, the Compile command is
2923 set up to compile the current source file into a binary object file.
2925 Java source files will be compiled to class file bytecode.
2927 Interpreted languages such as Perl, Python, Ruby will compile to
2928 bytecode if the language supports it, or will run a syntax check,
2929 or if that is not available will run the file in its language interpreter.
2934 For compilable languages such as C and C++, the Build command will link
2935 the current source file's equivalent object file into an executable. If
2936 the object file does not exist, the source will be compiled and linked
2937 in one step, producing just the executable binary.
2939 Interpreted languages do not use the Build command.
2942 If you need complex settings for your build system, or several
2943 different settings, then writing a Makefile and using the Make
2944 commands is recommended; this will also make it easier for users to
2945 build your software.
2950 Source code linters are often used to find code that doesn't correspond to
2951 certain style guidelines: non-portable code, common or hard to find
2952 errors, code "smells", variables used before being set, unused functions,
2953 division by zero, constant conditions, etc. Linters inspect the code and
2954 issue warnings much like the compilers do. This is formally referred to as
2955 static code analysis.
2957 Some common linters are pre-configured for you in the Build menu (``pep8``
2958 for Python, ``cppcheck`` for C/C++, JSHint for JavaScript, ``xmllint`` for
2959 XML, ``hlint`` for Haskell, ``shellcheck`` for shell code, ...), but all
2960 these are standalone tools you need to obtain before using.
2965 This runs "make" in the same directory as the
2971 This is similar to running 'Make' but you will be prompted for
2972 the make target name to be passed to the Make tool. For example,
2973 typing 'clean' in the dialog prompt will run "make clean".
2979 Make object will run "make current_file.o" in the same directory as
2980 the current file, using the filename for 'current_file'. It is useful
2981 for building just the current file without building the whole project.
2986 The next error item will move to the next detected error in the file.
2990 The previous error item will move to the previous detected error in the file.
2995 Execute will run the corresponding executable file, shell script or
2996 interpreted script in a terminal window. The command set in the
2997 "Set Build Commands" dialog is run in a script to ensure the terminal
2998 stays open after execution completes. Note: see `Terminal emulators`_
2999 below for the command format. Alternatively the built-in VTE can be used
3000 if it is available - see `Virtual terminal emulator widget (VTE)`_.
3002 After your program or script has finished executing, the run script will
3003 prompt you to press the return key. This allows you to review any text
3004 output from the program before the terminal window is closed.
3007 The execute command output is not parsed for errors.
3010 Stopping running processes
3011 ``````````````````````````
3013 When there is a running program, the Execute menu item in the menu and
3014 the Run button in the toolbar
3015 each become a stop button so you can stop the current running program (and
3016 any child processes). This works by sending the SIGQUIT signal to the process.
3018 Depending on the process you started it is possible that the process
3019 cannot be stopped. For example this can happen when the process creates
3020 more than one child process.
3026 The Terminal field of the tools preferences tab requires a command to
3027 execute the terminal program and to pass it the name of the Geany run
3028 script that it should execute in a Bourne compatible shell (eg /bin/sh).
3029 The marker "%c" is substituted with the name of the Geany run script,
3030 which is created in the temporary directory and which changes the working
3031 directory to the directory set in the Build commands dialog, see
3032 `Build menu commands dialog`_ for details.
3034 As an example the default (Linux) command is::
3036 xterm -e "/bin/sh %c"
3042 By default Compile, Build and Execute are fairly basic commands. You
3043 may wish to customise them using *Set Build Commands*.
3045 E.g. for C you can add any include paths and compile flags for the
3046 compiler, any library names and paths for the linker, and any
3047 arguments you want to use when running Execute.
3049 Build menu configuration
3050 ^^^^^^^^^^^^^^^^^^^^^^^^
3052 The build menu has considerable flexibility and configurability, allowing
3053 both menu labels the commands they execute and the directory they execute
3054 in to be configured.
3056 For example, if you change one of the default make commands to run say 'waf'
3057 you can also change the label to match.
3059 These settings are saved automatically when Geany is shut down.
3061 The build menu is divided into four groups of items each with different
3064 * Filetype build commands - are configurable and depend on the filetype of the
3065 current document; they capture output in the compiler tab and parse it for
3067 * Independent build commands - are configurable and mostly don't depend on the
3068 filetype of the current document; they also capture output in the
3069 compiler tab and parse it for errors.
3070 * Execute commands - are configurable and intended for executing your
3071 program or other long running programs. The output is not parsed for errors
3072 and is directed to the terminal command selected in preferences.
3073 * Fixed commands - these perform built-in actions:
3075 * Go to the next error.
3076 * Go to the previous error.
3077 * Show the build menu commands dialog.
3079 The maximum numbers of items in each of the configurable groups can be
3080 configured in the `Various preferences`_. Even though the maximum number of
3081 items may have been increased, only those menu items that have values
3082 configured are shown in the menu.
3084 The groups of menu items obtain their configuration from four potential
3085 sources. The highest priority source that has the menu item defined will
3086 be used. The sources in decreasing priority are:
3088 * A project file if open
3089 * The user preferences
3090 * The system filetype definitions
3093 The detailed relationships between sources and the configurable menu item groups
3094 is shown in the following table.
3096 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3097 | Group | Project File | Preferences | System Filetype | Defaults |
3098 +==============+=====================+==========================+===================+===============================+
3099 | Filetype | Loads From: project | Loads From: | Loads From: | None |
3100 | | file | filetypes.xxx file in | filetypes.xxx in | |
3101 | | | ~/.config/geany/filedefs | Geany install | |
3102 | | Saves To: project | | | |
3103 | | file | Saves to: as above, | Saves to: as user | |
3104 | | | creating if needed. | preferences left. | |
3105 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3106 | Filetype | Loads From: project | Loads From: | Loads From: | 1: |
3107 | Independent | file | geany.conf file in | filetypes.xxx in | Label: _Make |
3108 | | | ~/.config/geany | Geany install | Command: make |
3109 | | Saves To: project | | | |
3110 | | file | Saves to: as above, | Saves to: as user | 2: |
3111 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
3112 | | | | | Command: make |
3115 | | | | | Label: Make _Object |
3116 | | | | | Command: make %e.o |
3117 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3118 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
3119 | | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
3120 | | filetype defined in | ~/.config/geany or else | Geany install | |
3121 | | project file | filetypes.xxx file in | | |
3122 | | | ~/.config/geany/filedefs | Saves To: as user | |
3123 | | Saves To: | | preferences left. | |
3124 | | project file | Saves To: | | |
3125 | | | filetypes.xxx file in | | |
3126 | | | ~/.config/geany/filedefs | | |
3127 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3129 The following notes on the table reference cells by coordinate as (group,source):
3131 * General - for filetypes.xxx substitute the appropriate extension for
3132 the filetype of the current document for xxx - see `filenames`_.
3134 * System Filetypes - Labels loaded from these sources are locale sensitive
3135 and can contain translations.
3137 * (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
3138 filetype file so that users can configure all other filetype preferences
3139 as well. Projects can only configure menu items per filetype. Saving
3140 in the project file means that there is only one file per project not
3143 * (Filetype-Independent, System Filetype) - although conceptually strange, defining
3144 filetype-independent commands in a filetype file, this provides the ability to
3145 define filetype dependent default menu items.
3147 * (Execute, Project File) and (Execute, Preferences) - the project independent
3148 execute and preferences independent execute commands can only be set by hand
3149 editing the appropriate file, see `Preferences file format`_ and `Project file
3152 Build menu commands dialog
3153 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3155 Most of the configuration of the build menu is done through the Build Menu
3156 Commands Dialog. You edit the configuration sourced from preferences in the
3157 dialog opened from the Build->Build Menu Commands item and you edit the
3158 configuration from the project in the build tab of the project preferences
3159 dialog. Both use the same form shown below.
3161 .. image:: ./images/build_menu_commands_dialog.png
3163 The dialog is divided into three sections:
3165 * Filetype build commands (selected based on the current document's filetype).
3166 * Independent build commands (available regardless of filetype).
3167 * Filetype execute commands.
3169 The filetype and independent sections also each contain a field for the regular
3170 expression used for parsing command output for error and warning messages.
3172 The columns in the first three sections allow setting of the label, command,
3173 and working directory to run the command in.
3175 An item with an empty label will not be shown in the menu.
3177 An empty working directory will default to the directory of the current document.
3178 If there is no current document then the command will not run.
3180 The dialog will always show the command selected by priority, not just the
3181 commands configured in this configuration source. This ensures that you always
3182 see what the menu item is going to do if activated.
3184 If the current source of the menu item is higher priority than the
3185 configuration source you are editing then the command will be shown
3186 in the dialog but will be insensitive (greyed out). This can't happen
3187 with the project source but can with the preferences source dialog.
3189 The clear buttons remove the definition from the configuration source you are editing.
3190 When you do this the command from the next lower priority source will be shown.
3191 To hide lower priority menu items without having anything show in the menu
3192 configure with a nothing in the label but at least one character in the command.
3194 Substitutions in commands and working directories
3195 `````````````````````````````````````````````````
3197 The first occurrence of each of the following character sequences in each of the
3198 command and working directory fields is substituted by the items specified below
3199 before the command is run.
3201 * %d - substituted by the absolute path to the directory of the current file.
3202 * %e - substituted by the name of the current file without the extension or path.
3203 * %f - substituted by the name of the current file without the path.
3204 * %p - if a project is open, substituted by the base path from the project.
3205 * %l - substituted by the line number at the current cursor position.
3208 If the basepath set in the project preferences is not an absolute path , then it is
3209 taken as relative to the directory of the project file. This allows a project file
3210 stored in the source tree to specify all commands and working directories relative
3211 to the tree itself, so that the whole tree including the project file, can be moved
3212 and even checked into and out of version control without having to re-configure the
3215 Build menu keyboard shortcuts
3216 `````````````````````````````
3218 Keyboard shortcuts can be defined for the first two filetype menu items, the first three
3219 independent menu items, the first execute menu item and the fixed menu items.
3220 In the keybindings configuration dialog (see `Keybinding preferences`_)
3221 these items are identified by the default labels shown in the `Build Menu`_ section above.
3223 It is currently not possible to bind keyboard shortcuts to more than these menu items.
3225 You can also use underlines in the labels to set mnemonic characters.
3230 The configurable Build Menu capability was introduced in Geany 0.19 and
3231 required a new section to be added to the configuration files (See
3232 `Preferences file format`_). Geany will still load older format project,
3233 preferences and filetype file settings and will attempt to map them into the new
3234 configuration format. There is not a simple clean mapping between the formats.
3235 The mapping used produces the most sensible results for the majority of cases.
3236 However, if they do not map the way you want, you may have to manually
3237 configure some settings using the Build Commands
3238 Dialog or the Build tab of the project preferences dialog.
3240 Any setting configured in either of these dialogs will override settings mapped from
3241 older format configuration files.
3246 Since Geany 0.13 there has been printing support using GTK's printing API.
3247 The printed page(s) will look nearly the same as on your screen in Geany.
3248 Additionally, there are some options to modify the printed page(s).
3251 The background text color is set to white, except for text with
3252 a white foreground. This allows dark color schemes to save ink
3255 You can define whether to print line numbers, page numbers at the bottom of
3256 each page and whether to print a page header on each page. This header
3257 contains the filename of the printed document, the current page number and
3258 the date and time of printing. By default, the file name of the document
3259 with full path information is added to the header. If you prefer to add
3260 only the basename of the file(without any path information) you can set it
3261 in the preferences dialog. You can also adjust the format of the date and
3262 time added to the page header. The available conversion specifiers are the
3263 same as the ones which can be used with the ANSI C strftime function.
3265 All of these settings can also be changed in the print dialog just before
3266 actual printing is done.
3267 On Unix-like systems the provided print dialog offers a print preview. The
3268 preview file is opened with a PDF viewer and by default GTK uses ``evince``
3269 for print preview. If you have not installed evince or just want to use
3270 another PDF viewer, you can change the program to use in the file
3271 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
3274 gtk-print-preview-command = "epdfview %f"
3276 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3277 as the print preview command.
3279 Geany also provides an alternative basic printing support using a custom
3280 print command. However, the printed document contains no syntax highlighting.
3281 You can adjust the command to which the filename is passed in the preferences
3282 dialog. The default command is::
3286 ``%f`` will be substituted by the filename of the current file. Geany
3287 will not show errors from the command itself, so you should make
3288 sure that it works before(e.g. by trying to execute it from the
3291 A nicer example, which many prefer is::
3293 % a2ps -1 --medium=A4 -o - %f | xfprint4
3295 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3296 gtklp or similar programs can be used.
3303 Plugins are loaded at startup, if the *Enable plugin support*
3304 general preference is set. There is also a command-line option,
3305 ``-p``, which prevents plugins being loaded. Plugins are scanned in
3306 the following directories:
3308 * ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
3309 * The ``lib`` subfolder of the installation path on Windows.
3310 * The ``plugins`` subfolder of the user configuration directory - see
3311 `Configuration file paths`_.
3312 * The `Extra plugin path` preference (usually blank) - see `Paths`_.
3314 Most plugins add menu items to the *Tools* menu when they are loaded.
3316 See also `Plugin documentation`_ for information about single plugins
3317 which are included in Geany.
3321 The Plugin Manager dialog lets you choose which plugins
3322 should be loaded at startup. You can also load and unload plugins on the
3323 fly using this dialog. Once you click the checkbox for a specific plugin
3324 in the dialog, it is loaded or unloaded according to its previous state.
3325 By default, no plugins are loaded at startup until you select some.
3326 You can also configure some plugin specific options if the plugin
3333 Geany supports the default keyboard shortcuts for the Scintilla
3334 editing widget. For a list of these commands, see `Scintilla
3335 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
3336 by any custom keybindings with the same keyboard shortcut.
3342 There are some non-configurable bindings to switch between documents,
3343 listed below. These can also be overridden by custom keybindings.
3345 =============== ==================================
3347 =============== ==================================
3348 Alt-[1-9] Select left-most tab, from 1 to 9.
3349 Alt-0 Select right-most tab.
3350 =============== ==================================
3352 See also `Notebook tab keybindings`_.
3355 Configurable keybindings
3356 ^^^^^^^^^^^^^^^^^^^^^^^^
3358 For all actions listed below you can define your own keybindings. Open
3359 the Preferences dialog, select the desired action and click on
3360 change. In the resulting dialog you can press the key combination you
3361 want to assign to the action and it will be saved when you press OK.
3362 You can define only one key combination for each action and each key
3363 combination can only be defined for one action.
3365 The following tables list all customizable keyboard shortcuts, those
3366 which are common to many applications are marked with (C) after the
3371 =============================== ========================= ==================================================
3372 Action Default shortcut Description
3373 =============================== ========================= ==================================================
3374 New Ctrl-N (C) Creates a new file.
3376 Open Ctrl-O (C) Opens a file.
3378 Open selected file Ctrl-Shift-O Opens the selected filename.
3380 Re-open last closed tab Re-opens the last closed document tab.
3382 Save Ctrl-S (C) Saves the current file.
3384 Save As Saves the current file under a new name.
3386 Save all Ctrl-Shift-S Saves all open files.
3388 Close all Ctrl-Shift-W Closes all open files.
3390 Close Ctrl-W (C) Closes the current file.
3392 Reload file Ctrl-R (C) Reloads the current file.
3394 Print Ctrl-P (C) Prints the current file.
3396 Quit Ctrl-Q (C) Quits Geany.
3397 =============================== ========================= ==================================================
3402 =============================== ========================= ==================================================
3403 Action Default shortcut Description
3404 =============================== ========================= ==================================================
3405 Undo Ctrl-Z (C) Un-does the last action.
3407 Redo Ctrl-Y Re-does the last action.
3409 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3412 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3413 end of the current line.
3415 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3417 Transpose current line Transposes the current line with the previous one.
3419 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3420 view. The cursor position and or an existing
3421 selection will not be changed.
3423 Scroll up by one line Alt-Up Scrolls the view.
3425 Scroll down by one line Alt-Down Scrolls the view.
3427 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3428 symbol completion, it shows document word completion
3429 instead, even if it is not enabled for automatic
3430 completion. Likewise if no symbol suggestions are
3431 available, it shows document word completion.
3433 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3436 Complete snippet Tab If you type a construct like if or for and press
3437 this key, it will be completed with a matching
3440 Suppress snippet completion If you type a construct like if or for and press
3441 this key, it will not be completed, and a space or
3442 tab will be inserted, depending on what the
3443 construct completion keybinding is set to. For
3444 example, if you have set the construct completion
3445 keybinding to space, then setting this to
3446 Shift+space will prevent construct completion and
3449 Context Action Executes a command and passes the current word
3450 (near the cursor position) or selection as an
3451 argument. See the section called `Context
3454 Move cursor in snippet Jumps to the next defined cursor positions in a
3455 completed snippets if multiple cursor positions
3458 Word part completion Tab When the autocompletion list is visible, complete
3459 the currently selected item up to the next word
3462 Move line(s) up Alt-PageUp Move the current line or selected lines up by
3465 Move line(s) down Alt-PageDown Move the current line or selected lines down by
3467 =============================== ========================= ==================================================
3470 Clipboard keybindings
3471 `````````````````````
3472 =============================== ========================= ==================================================
3473 Action Default shortcut Description
3474 =============================== ========================= ==================================================
3475 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3477 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3479 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3481 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3482 selection) to the clipboard.
3484 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3485 selection) to the clipboard.
3486 =============================== ========================= ==================================================
3491 =============================== ========================= ==================================================
3492 Action Default shortcut Description
3493 =============================== ========================= ==================================================
3494 Select all Ctrl-A (C) Makes a selection of all text in the current
3497 Select current word Alt-Shift-W Selects the current word under the cursor.
3499 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3500 which is defined by two empty lines around it.
3502 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3503 partially selected lines).
3505 Select to previous word part (Extend) selection to previous word part boundary.
3507 Select to next word part (Extend) selection to next word part boundary.
3508 =============================== ========================= ==================================================
3513 =============================== ========================= ==================================================
3514 Action Default shortcut Description
3515 =============================== ========================= ==================================================
3516 Insert date Shift-Alt-D Inserts a customisable date.
3518 Insert alternative whitespace Inserts a tab character when spaces should
3519 be used for indentation and inserts space
3520 characters of the amount of a tab width when
3521 tabs should be used for indentation.
3523 Insert New Line Before Current Inserts a new line with indentation.
3525 Insert New Line After Current Inserts a new line with indentation.
3526 =============================== ========================= ==================================================
3531 =============================== ========================= ==================================================
3532 Action Default shortcut Description
3533 =============================== ========================= ==================================================
3534 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3535 selection will be changed into uppercase and vice
3536 versa. If the selection contains lower- and
3537 uppercase characters, all will be converted to
3540 Comment line Comments current line or selection.
3542 Uncomment line Uncomments current line or selection.
3544 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3545 a comment if the line is commented.
3547 Increase indent Ctrl-I Indents the current line or selection by one tab
3548 or with spaces in the amount of the tab width
3551 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3552 the tab width setting from the indentation of the
3553 current line or selection.
3555 Increase indent by one space Indents the current line or selection by one
3558 Decrease indent by one space Deindents the current line or selection by one
3561 Smart line indent Indents the current line or all selected lines
3562 with the same indentation as the previous line.
3564 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3565 external command (available for the first
3566 9 configured commands, see
3567 `Sending text through custom commands`_ for
3570 Send Selection to Terminal Sends the current selection or the current
3571 line (if there is no selection) to the
3572 embedded Terminal (VTE).
3574 Reflow lines/block Reformat selected lines or current
3575 (indented) text block,
3576 breaking lines at the long line marker or the
3577 line breaking column if line breaking is
3578 enabled for the current document.
3579 =============================== ========================= ==================================================
3582 Settings keybindings
3583 ````````````````````
3584 =============================== ========================= ==================================================
3585 Action Default shortcut Description
3586 =============================== ========================= ==================================================
3587 Preferences Ctrl-Alt-P Opens preferences dialog.
3589 Plugin Preferences Opens plugin preferences dialog.
3590 =============================== ========================= ==================================================
3595 =============================== ========================= ==================================================
3596 Action Default shortcut Description
3597 =============================== ========================= ==================================================
3598 Find Ctrl-F (C) Opens the Find dialog.
3600 Find Next Ctrl-G Finds next result.
3602 Find Previous Ctrl-Shift-G Finds previous result.
3604 Find Next Selection Finds next occurrence of selected text.
3606 Find Previous Selection Finds previous occurrence of selected text.
3608 Replace Ctrl-H (C) Opens the Replace dialog.
3610 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3612 Next message Jumps to the line with the next message in
3613 the Messages window.
3615 Previous message Jumps to the line with the previous message
3616 in the Messages window.
3618 Find Usage Ctrl-Shift-E Finds all occurrences of the current word (near
3619 the keyboard cursor) or selection in all open
3620 documents and displays them in the messages
3623 Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word (near
3624 the keyboard cursor) or selection in the current
3625 document and displays them in the messages
3628 Mark All Ctrl-Shift-M Highlight all matches of the current
3629 word/selection in the current document
3630 with a colored box. If there's nothing to
3631 find, or the cursor is next to an existing match,
3632 the highlighted matches will be cleared.
3633 =============================== ========================= ==================================================
3638 =============================== ========================= ==================================================
3639 Action Default shortcut Description
3640 =============================== ========================= ==================================================
3641 Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
3642 history. See the section called `Code Navigation
3645 Navigate back a location Alt-Left (C) Switches to the previous location in the
3646 navigation history. See the section called
3647 `Code navigation history`_.
3649 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3650 shows the Go to line dialog.
3652 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3653 is moved to the brace which belongs to the current
3654 one. If this keyboard shortcut is pressed again,
3655 the cursor is moved back to the first brace.
3657 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3658 marker if there already is one.
3660 Goto next marker Ctrl-. Goto the next marker in the current document.
3662 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3664 Go to symbol definition Ctrl-T Jump to the definition of the current word or
3665 selection. See `Go to symbol definition`_.
3667 Go to symbol declaration Ctrl-Shift-T Jump to the declaration of the current word or
3668 selection. See `Go to symbol declaration`_.
3670 Go to Start of Line Home Move the caret to the start of the line.
3671 Behaves differently if smart_home_key_ is set.
3673 Go to End of Line End Move the caret to the end of the line.
3675 Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
3676 This is useful when you use line wrapping and
3677 want to jump to the start of the wrapped, virtual
3678 line, not the real start of the whole line.
3679 If the line is not wrapped, it behaves like
3680 `Go to Start of Line`.
3682 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3683 If the line is not wrapped, it behaves like
3684 `Go to End of Line`.
3686 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3688 Go to Next Word Part Ctrl-\\ Goto the next part of the current word.
3689 =============================== ========================= ==================================================
3693 =============================== ========================= ==================================================
3694 Action Default shortcut Description
3695 =============================== ========================= ==================================================
3696 Fullscreen F11 (C) Switches to fullscreen mode.
3698 Toggle Messages Window Toggles the message window (status and compiler
3699 messages) on and off.
3701 Toggle Sidebar Shows or hides the sidebar.
3703 Toggle all additional widgets Hide and show all additional widgets like the
3704 notebook tabs, the toolbar, the messages window
3707 Zoom In Ctrl-+ (C) Zooms in the text.
3709 Zoom Out Ctrl-- (C) Zooms out the text.
3711 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3712 =============================== ========================= ==================================================
3716 ================================ ========================= ==================================================
3717 Action Default shortcut Description
3718 ================================ ========================= ==================================================
3719 Switch to Editor F2 Switches to editor widget.
3720 Also reshows the document statistics line
3721 (after a short timeout).
3723 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3726 Switch to Message Window Focus the Message Window's current tab.
3728 Switch to Compiler Focus the Compiler message window tab.
3730 Switch to Messages Focus the Messages message window tab.
3732 Switch to Scribble F6 Switches to scribble widget.
3734 Switch to VTE F4 Switches to VTE widget.
3736 Switch to Sidebar Focus the Sidebar.
3738 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3741 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3743 ================================ ========================= ==================================================
3746 Notebook tab keybindings
3747 ````````````````````````
3748 =============================== ========================= ==================================================
3749 Action Default shortcut Description
3750 =============================== ========================= ==================================================
3751 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3753 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3755 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3757 Holding Ctrl (or another modifier if the keybinding
3758 has been changed) will show a dialog, then repeated
3759 presses of the keybinding will switch to the 2nd-last
3760 used document, 3rd-last, etc. Also known as
3761 Most-Recently-Used documents switching.
3763 Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
3766 Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
3769 Move document first Moves the current document to the first position.
3771 Move document last Moves the current document to the last position.
3772 =============================== ========================= ==================================================
3775 Document keybindings
3776 ````````````````````
3777 ==================================== ==================== ==================================================
3778 Action Default shortcut Description
3779 ==================================== ==================== ==================================================
3780 Clone See `Cloning documents`_.
3782 Replace tabs with space Replaces all tabs with the right amount of spaces
3783 in the whole document, or the current selection.
3785 Replace spaces with tabs Replaces leading spaces with tab characters in the
3786 whole document, or the current selection.
3788 Toggle current fold Toggles the folding state of the current code block.
3790 Fold all Folds all contractible code blocks.
3792 Unfold all Unfolds all contracted code blocks.
3794 Reload symbol list Ctrl-Shift-R Reloads the symbol list.
3796 Toggle Line wrapping Enables or disables wrapping of long lines.
3798 Toggle Line breaking Enables or disables automatic breaking of long
3799 lines at a configurable column.
3801 Remove Markers Remove any markers on lines or words which
3802 were set by using 'Mark All' in the
3803 search dialog or by manually marking lines.
3805 Remove Error Indicators Remove any error indicators in the
3808 Remove Markers and Error Indicators Combines ``Remove Markers`` and
3809 ``Remove Error Indicators``.
3810 ==================================== ==================== ==================================================
3815 =============================== ========================= ==================================================
3816 Action Default shortcut Description
3817 =============================== ========================= ==================================================
3818 New Create a new project.
3819 Open Opens a project file.
3820 Properties Shows project properties.
3821 Close Close the current project.
3822 =============================== ========================= ==================================================
3827 =============================== ========================= ==================================================
3828 Action Default shortcut Description
3829 =============================== ========================= ==================================================
3830 Compile F8 Compiles the current file.
3832 Build F9 Builds (compiles if necessary and links) the
3835 Make all Shift-F9 Builds the current file with the Make tool.
3837 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3840 Make object Shift-F8 Compiles the current file with the Make tool.
3842 Next error Jumps to the line with the next error from the
3845 Previous error Jumps to the line with the previous error from
3846 the last build process.
3848 Run F5 Executes the current file in a terminal emulation.
3850 Set Build Commands Opens the build commands dialog.
3851 =============================== ========================= ==================================================
3856 =============================== ========================= ==================================================
3857 Action Default shortcut Description
3858 =============================== ========================= ==================================================
3859 Show Color Chooser Opens the Color Chooser dialog.
3860 =============================== ========================= ==================================================
3865 =============================== ========================= ==================================================
3866 Action Default shortcut Description
3867 =============================== ========================= ==================================================
3868 Help F1 (C) Opens the manual.
3869 =============================== ========================= ==================================================
3877 You must use UTF-8 encoding *without BOM* for configuration files.
3880 Configuration file paths
3881 ------------------------
3882 Geany has default configuration files installed for the system and
3883 also per-user configuration files.
3885 The system files should not normally be edited because they will be
3886 overwritten when upgrading Geany.
3888 The user configuration directory can be overridden with the ``-c``
3889 switch, but this is not normally done. See `Command line options`_.
3892 Any missing subdirectories in the user configuration directory
3893 will be created when Geany starts.
3895 You can check the paths Geany is using with *Help->Debug Messages*.
3896 Near the top there should be 2 lines with something like::
3898 Geany-INFO: System data dir: /usr/share/geany
3899 Geany-INFO: User config dir: /home/username/.config/geany
3902 Paths on Unix-like systems
3903 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3904 The system path is ``$prefix/share/geany``, where ``$prefix`` is the
3905 path where Geany is installed (see `Installation prefix`_).
3907 The user configuration directory is normally:
3908 ``/home/username/.config/geany``
3912 The system path is the ``data`` subfolder of the installation path
3915 The user configuration directory might vary, but on Windows XP it's:
3916 ``C:\Documents and Settings\UserName\Application Data\geany``
3917 On Windows 7 and above you most likely will find it at:
3918 ``C:\users\UserName\Roaming\geany``
3923 There's a *Configuration files* submenu in the *Tools* menu that
3924 contains items for some of the available user configuration files.
3925 Clicking on one opens it in the editor for you to update. Geany will
3926 reload the file after you have saved it.
3929 Other configuration files not shown here will need to be opened
3930 manually, and will not be automatically reloaded when saved.
3931 (see *Reload Configuration* below).
3933 There's also a *Reload Configuration* item which can be used if you
3934 updated one of the other configuration files, or modified or added
3937 *Reload Configuration* is also necessary to update syntax highlighting colors.
3940 Syntax highlighting colors aren't updated in open documents after
3941 saving filetypes.common as this may take a significant
3945 Global configuration file
3946 -------------------------
3948 System administrators can add a global configuration file for Geany
3949 which will be used when starting Geany and a user configuration file
3952 The global configuration file is read from ``geany.conf`` in the
3953 system configuration path - see `Configuration file paths`_. It can
3954 contain any settings which are found in the usual configuration file
3955 created by Geany, but does not have to contain all settings.
3958 This feature is mainly intended for package maintainers or system
3959 admins who want to set up Geany in a multi user environment and
3960 set some sane default values for this environment. Usually users won't
3965 Filetype definition files
3966 -------------------------
3968 All color definitions and other filetype specific settings are
3969 stored in the filetype definition files. Those settings are colors
3970 for syntax highlighting, general settings like comment characters or
3971 word delimiter characters as well as compiler and linker settings.
3973 See also `Configuration file paths`_.
3977 Each filetype has a corresponding filetype definition file. The format
3978 for built-in filetype `Foo` is::
3982 The extension is normally just the filetype name in lower case.
3984 However there are some exceptions:
3986 =============== =========
3988 =============== =========
3992 Matlab/Octave matlab
3993 =============== =========
3995 There is also the `special file filetypes.common`_.
3997 For `custom filetypes`_, the filename for `Foo` is different::
4001 See the link for details.
4005 The system-wide filetype configuration files can be found in the
4006 system configuration path and are called ``filetypes.$ext``,
4007 where $ext is the name of the filetype. For every
4008 filetype there is a corresponding definition file. There is one
4009 exception: ``filetypes.common`` -- this file is for general settings,
4010 which are not specific to a certain filetype.
4013 It is not recommended that users edit the system-wide files,
4014 because they will be overridden when Geany is updated.
4018 To change the settings, copy a file from the system configuration
4019 path to the subdirectory ``filedefs`` in your user configuration
4020 directory. Then you can edit the file and the changes will still be
4021 available after an update of Geany.
4023 Alternatively, you can create the file yourself and add only the
4024 settings you want to change. All missing settings will be read from
4025 the corresponding system configuration file.
4029 At startup Geany looks for ``filetypes.*.conf`` files in the system and
4030 user filetype paths, adding any filetypes found with the name matching
4031 the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
4033 Custom filetypes are not as powerful as built-in filetypes, but
4034 support for the following has been implemented:
4036 * Recognizing and setting the filetype (after the user has manually updated
4037 the `filetype extensions`_ file).
4038 * `Filetype group membership`_.
4039 * Reading filetype settings in the ``[settings]`` section, including:
4040 * Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
4041 * Using an existing tags parser (`tag_parser`_ key).
4042 * Build commands (``[build-menu]`` section).
4043 * Loading global tags files (sharing the ``tag_parser`` filetype's namespace).
4045 See `Filetype configuration`_ for details on each setting.
4047 Creating a custom filetype from an existing filetype
4048 ````````````````````````````````````````````````````
4049 Because most filetype settings will relate to the syntax
4050 highlighting (e.g. styling, keywords, ``lexer_properties``
4051 sections), it is best to copy an existing filetype file that uses
4052 the lexer you wish to use as the basis of a custom filetype, using
4053 the correct filename extension format shown above, e.g.::
4055 cp filetypes.foo filetypes.Bar.conf
4057 Then add the ``lexer_filetype=Foo`` setting (if not already present)
4058 and add/adjust other settings.
4061 The ``[styling]`` and ``[keywords]`` sections have key names
4062 specific to each filetype/lexer. You must follow the same
4063 names - in particular, some lexers only support one keyword
4067 Filetype configuration
4068 ^^^^^^^^^^^^^^^^^^^^^^
4070 As well as the sections listed below, each filetype file can contain
4071 a [build-menu] section as described in `[build-menu] section`_.
4076 In this section the colors for syntax highlighting are defined. The
4079 * ``key=foreground_color;background_color;bold_flag;italic_flag``
4081 Colors have to be specified as RGB hex values prefixed by
4082 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4083 are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
4084 values are case-insensitive but it is a good idea to use lower-case.
4085 Note that you can also use *named colors* as well by substituting the
4086 color value with the name of a color as defined in the ``[named_colors]``
4087 section, see the `[named_colors] Section`_ for more information.
4089 Bold and italic are flags and should only be "true" or "false". If their
4090 value is something other than "true" or "false", "false" is assumed.
4092 You can omit fields to use the values from the style named ``"default"``.
4094 E.g. ``key=0xff0000;;true``
4096 This makes the key style have red foreground text, default background
4097 color text and bold emphasis.
4101 The second format uses a *named style* name to reference a style
4102 defined in filetypes.common.
4104 * ``key=named_style``
4105 * ``key2=named_style2,bold,italic``
4107 The bold and italic parts are optional, and if present are used to
4108 toggle the bold or italic flags to the opposite of the named style's
4109 flags. In contrast to style definition booleans, they are a literal
4110 ",bold,italic" and commas are used instead of semi-colons.
4112 E.g. ``key=comment,italic``
4114 This makes the key style match the ``"comment"`` named style, but with
4117 To define named styles, see the filetypes.common `[named_styles]
4120 Reading styles from another filetype
4121 ************************************
4122 You can automatically copy all of the styles from another filetype
4123 definition file by using the following syntax for the ``[styling]``
4128 Where Foo is a filetype name. The corresponding ``[styling]``
4129 section from ``filetypes.foo`` will be read.
4131 This is useful when the same lexer is being used for multiple
4132 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4133 styling the same as the C styling, you would put the following in
4142 This section contains keys for different keyword lists specific to
4143 the filetype. Some filetypes do not support keywords, so adding a
4144 new key will not work. You can only add or remove keywords to/from
4148 The keywords list must be in one line without line ending characters.
4151 [lexer_properties] section
4152 ``````````````````````````
4153 Here any special properties for the Scintilla lexer can be set in the
4154 format ``key.name.field=some.value``.
4156 Properties Geany uses are listed in the system filetype files. To find
4157 other properties you need Geany's source code::
4159 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
4166 This is the default file extension used when saving files, not
4167 including the period character (``.``). The extension used should
4168 match one of the patterns associated with that filetype (see
4169 `Filetype extensions`_).
4171 *Example:* ``extension=cxx``
4174 These characters define word boundaries when making selections
4175 and searching using word matching options.
4177 *Example:* (look at system filetypes.\* files)
4180 This overrides the *wordchars* filetypes.common setting, and
4181 has precedence over the *whitespace_chars* setting.
4184 A character or string which is used to comment code. If you want to use
4185 multiline comments only, don't set this but rather comment_open and
4188 Single-line comments are used in priority over multiline comments to
4189 comment a line, e.g. with the `Comment/Uncomment line` command.
4191 *Example:* ``comment_single=//``
4194 A character or string which is used to comment code. You need to also
4195 set comment_close to really use multiline comments. If you want to use
4196 single-line comments, prefer setting comment_single.
4198 Multiline comments are used in priority over single-line comments to
4199 comment a block, e.g. template comments.
4201 *Example:* ``comment_open=/*``
4204 If multiline comments are used, this is the character or string to
4207 *Example:* ``comment_close=*/``
4210 Set this to false if a comment character or string should start at
4211 column 0 of a line. If set to true it uses any indentation of the
4214 Note: Comment indentation
4216 ``comment_use_indent=true`` would generate this if a line is
4217 commented (e.g. with Ctrl-D)::
4221 ``comment_use_indent=false`` would generate this if a line is
4222 commented (e.g. with Ctrl-D)::
4224 # command_example();
4227 Note: This setting only works for single line comments (like '//',
4230 *Example:* ``comment_use_indent=true``
4233 A command which can be executed on the current word or the current
4236 Example usage: Open the API documentation for the
4237 current function call at the cursor position.
4240 be set for every filetype or if not set, a global command will
4241 be used. The command itself can be specified without the full
4242 path, then it is searched in $PATH. But for security reasons,
4243 it is recommended to specify the full path to the command. The
4244 wildcard %s will be replaced by the current word at the cursor
4245 position or by the current selection.
4247 Hint: for PHP files the following could be quite useful:
4248 context_action_cmd=firefox "http://www.php.net/%s"
4250 *Example:* ``context_action_cmd=devhelp -s "%s"``
4255 The TagManager language name, e.g. "C". Usually the same as the
4261 A filetype name to setup syntax highlighting from another filetype.
4262 This must not be recursive, i.e. it should be a filetype name that
4263 doesn't use the *lexer_filetype* key itself, e.g.::
4268 The second line is wrong, because ``filetypes.cpp`` itself uses
4269 ``lexer_filetype=C``, which would be recursive.
4271 symbol_list_sort_mode
4272 What the default symbol list sort order should be.
4274 ===== ========================================
4276 ===== ========================================
4277 0 Sort symbols by name
4278 1 Sort symbols by appearance (line number)
4279 ===== ========================================
4281 .. _xml_indent_tags:
4284 If this setting is set to *true*, a new line after a line ending with an
4285 unclosed XML/HTML tag will be automatically indented. This only applies
4286 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4287 this setting in their system configuration files.
4290 The MIME type for this file type, e.g. "text/x-csrc". This is used
4291 for example to chose the icon to display for this file type.
4294 [indentation] section
4295 `````````````````````
4297 This section allows definition of default indentation settings specific to
4298 the file type, overriding the ones configured in the preferences. This can
4299 be useful for file types requiring specific indentation settings (e.g. tabs
4300 only for Makefile). These settings don't override auto-detection if activated.
4303 The forced indentation width.
4306 The forced indentation type.
4308 ===== =======================
4309 Value Indentation type
4310 ===== =======================
4313 2 Mixed (tabs and spaces)
4314 ===== =======================
4317 [build_settings] section
4318 ````````````````````````
4320 As of Geany 0.19 this section is supplemented by the `[build-menu] section`_.
4321 Values that are set in the [build-menu] section will override those in this section.
4324 This is a Perl-compatible regular expression (PCRE) to parse a filename
4325 (absolute or relative) and line number from the build output.
4326 If undefined, Geany will fall back to its default error message parsing.
4328 Only the first two match groups will be read by Geany. These groups can
4329 occur in any order: the match group consisting of only digits will be used
4330 as the line number, and the other group as the filename. In no group
4331 consists of only digits, the match will fail.
4333 *Example:* ``error_regex=^(.+):([0-9]+):[0-9]+``
4335 This will parse a message such as:
4336 ``test.py:7:24: E202 whitespace before ']'``
4340 If any build menu item settings have been configured in the Build Menu Commands
4341 dialog or the Build tab of the project preferences dialog then these
4342 settings are stored in the [build-menu] section and override the settings in
4343 this section for that item.
4346 This item specifies the command to compile source code files. But
4347 it is also possible to use it with interpreted languages like Perl
4348 or Python. With these filetypes you can use this option as a kind of
4349 syntax parser, which sends output to the compiler message window.
4351 You should quote the filename to also support filenames with
4352 spaces. The following wildcards for filenames are available:
4354 * %f -- complete filename without path
4355 * %e -- filename without path and without extension
4357 *Example:* ``compiler=gcc -Wall -c "%f"``
4360 This item specifies the command to link the file. If the file is not
4361 already compiled, it will be compiled while linking. The -o option
4362 is automatically added by Geany. This item works well with GNU gcc,
4363 but may be problematic with other compilers (esp. with the linker).
4365 *Example:* ``linker=gcc -Wall "%f"``
4368 Use this item to execute your file. It has to have been built
4369 already. Use the %e wildcard to have only the name of the executable
4370 (i.e. without extension) or use the %f wildcard if you need the
4371 complete filename, e.g. for shell scripts.
4373 *Example:* ``run_cmd="./%e"``
4376 Special file filetypes.common
4377 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4379 There is a special filetype definition file called
4380 filetypes.common. This file defines some general non-filetype-specific
4383 You can open the user filetypes.common with the
4384 *Tools->Configuration Files->filetypes.common* menu item. This adds
4385 the default settings to the user file if the file doesn't exist.
4386 Alternatively the file can be created manually, adding only the
4387 settings you want to change. All missing settings will be read from
4391 See the `Filetype configuration`_ section for how to define styles.
4394 [named_styles] section
4395 ``````````````````````
4396 Named styles declared here can be used in the [styling] section of any
4401 *In filetypes.common*::
4404 foo=0xc00000;0xffffff;false;true
4412 This saves copying and pasting the whole style definition into several
4416 You can define aliases for named styles, as shown with the ``bar``
4417 entry in the above example, but they must be declared after the
4421 [named_colors] section
4422 ``````````````````````
4423 Named colors declared here can be used in the ``[styling]`` or
4424 ``[named_styles]`` section of any filetypes.* file or color scheme.
4429 my_red_color=#FF0000
4430 my_blue_color=#0000FF
4433 foo=my_red_color;my_blue_color;false;true
4435 This allows to define a color palette by name so that to change a color
4436 scheme-wide only involves changing the hex value in a single location.
4441 This is the default style. It is used for styling files without a
4444 *Example:* ``default=0x000000;0xffffff;false;false``
4447 The style for coloring selected text. The format is:
4451 * Use foreground color
4452 * Use background color
4454 The colors are only set if the 3rd or 4th argument is true. When
4455 the colors are not overridden, the default is a dark grey
4456 background with syntax highlighted foreground text.
4458 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
4461 The style for brace highlighting when a matching brace was found.
4463 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
4466 The style for brace highlighting when no matching brace was found.
4468 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
4471 The style for coloring the caret(the blinking cursor). Only first
4472 and third argument is interpreted.
4473 Set the third argument to true to change the caret into a block caret.
4475 *Example:* ``caret=0x000000;0x0;false;false``
4478 The width for the caret(the blinking cursor). Only the first
4479 argument is interpreted. The width is specified in pixels with
4480 a maximum of three pixel. Use the width 0 to make the caret
4483 *Example:* ``caret_width=3``
4486 The style for coloring the background of the current line. Only
4487 the second and third arguments are interpreted. The second argument
4488 is the background color. Use the third argument to enable or
4489 disable background highlighting for the current line (has to be
4492 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
4495 The style for coloring the indentation guides. Only the first and
4496 second arguments are interpreted.
4498 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
4501 The style for coloring the white space if it is shown. The first
4502 both arguments define the foreground and background colors, the
4503 third argument sets whether to use the defined foreground color
4504 or to use the color defined by each filetype for the white space.
4505 The fourth argument defines whether to use the background color.
4507 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
4510 Line number margin foreground and background colors.
4512 .. _Folding Settings:
4515 Fold margin foreground and background colors.
4517 fold_symbol_highlight
4518 Highlight color of folding symbols.
4521 The style of folding icons. Only first and second arguments are
4524 Valid values for the first argument are:
4531 Valid values for the second argument are:
4534 * 1 -- for straight lines
4535 * 2 -- for curved lines
4537 *Default:* ``folding_style=1;1;``
4539 *Arrows:* ``folding_style=3;0;``
4542 Draw a thin horizontal line at the line where text is folded. Only
4543 first argument is used.
4545 Valid values for the first argument are:
4547 * 0 -- disable, do not draw a line
4548 * 1 -- draw the line above folded text
4549 * 2 -- draw the line below folded text
4551 *Example:* ``folding_horiz_line=0;0;false;false``
4554 First argument: drawing of visual flags to indicate a line is wrapped.
4555 This is a bitmask of the values:
4557 * 0 -- No visual flags
4558 * 1 -- Visual flag at end of subline of a wrapped line
4559 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
4560 indented by at least 1 to make room for the flag.
4562 Second argument: wether the visual flags to indicate a line is wrapped
4563 are drawn near the border or near the text. This is a bitmask of the values:
4565 * 0 -- Visual flags drawn near border
4566 * 1 -- Visual flag at end of subline drawn near text
4567 * 2 -- Visual flag at begin of subline drawn near text
4569 Only first and second arguments are interpreted.
4571 *Example:* ``line_wrap_visuals=3;0;false;false``
4574 First argument: sets the size of indentation of sublines for wrapped lines
4575 in terms of the width of a space, only used when the second argument is ``0``.
4577 Second argument: wrapped sublines can be indented to the position of their
4578 first subline or one more indent level. Possible values:
4580 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4581 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4582 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4584 Only first and second arguments are interpreted.
4586 *Example:* ``line_wrap_indent=0;1;false;false``
4589 Translucency for the current line (first argument) and the selection
4590 (second argument). Values between 0 and 256 are accepted.
4592 Note for Windows 95, 98 and ME users:
4593 keep this value at 256 to disable translucency otherwise Geany might crash.
4595 Only the first and second arguments are interpreted.
4597 *Example:* ``translucency=256;256;false;false``
4600 The style for a highlighted line (e.g when using Goto line or goto symbol).
4601 The foreground color (first argument) is only used when the Markers margin
4602 is enabled (see View menu).
4604 Only the first and second arguments are interpreted.
4606 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4609 The style for a marked search results (when using "Mark" in Search dialogs).
4610 The second argument sets the background color for the drawn rectangle.
4612 Only the second argument is interpreted.
4614 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4617 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4618 (Ctrl-M)). The foreground color (first argument) is only used
4619 when the Markers margin is enabled (see View menu).
4621 Only the first and second arguments are interpreted.
4623 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4626 Translucency for the line marker (first argument) and the search marker
4627 (second argument). Values between 0 and 256 are accepted.
4629 Note for Windows 95, 98 and ME users:
4630 keep this value at 256 to disable translucency otherwise Geany might crash.
4632 Only the first and second arguments are interpreted.
4634 *Example:* ``marker_translucency=256;256;false;false``
4637 Amount of space to be drawn above and below the line's baseline.
4638 The first argument defines the amount of space to be drawn above the line, the second
4639 argument defines the amount of space to be drawn below.
4641 Only the first and second arguments are interpreted.
4643 *Example:* ``line_height=0;0;false;false``
4646 The style for coloring the calltips. The first two arguments
4647 define the foreground and background colors, the third and fourth
4648 arguments set whether to use the defined colors.
4650 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4656 Characters to treat as whitespace. These characters are ignored
4657 when moving, selecting and deleting across word boundaries
4658 (see `Scintilla keyboard commands`_).
4660 This should include space (\\s) and tab (\\t).
4662 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4665 These characters define word boundaries when making selections
4666 and searching using word matching options.
4668 *Example:* ``wordchars=_abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``
4671 This has precedence over the *whitespace_chars* setting.
4679 To change the default filetype extension used when saving a new file,
4680 see `Filetype definition files`_.
4682 You can override the list of file extensions that Geany uses to detect
4683 filetypes using the user ``filetype_extensions.conf`` file. Use the
4684 *Tools->Configuration Files->filetype_extensions.conf* menu item. See
4685 also `Configuration file paths`_.
4687 You should only list lines for filetype extensions that you want to
4688 override in the user configuration file and remove or comment out
4689 others. The patterns are listed after the ``=`` sign, using a
4690 semi-colon separated list of patterns which should be matched for
4693 For example, to override the filetype extensions for Make, the file
4697 Make=Makefile*;*.mk;Buildfile;
4699 Filetype group membership
4700 ^^^^^^^^^^^^^^^^^^^^^^^^^
4701 Group membership is also stored in ``filetype_extensions.conf``. This
4702 file is used to store information Geany needs at startup, whereas the
4703 separate filetype definition files hold information only needed when
4704 a document with their filetype is used.
4706 The format looks like::
4715 The key names cannot be configured.
4718 Group membership is only read at startup.
4720 Preferences file format
4721 -----------------------
4723 The user preferences file ``geany.conf`` holds settings for all the items configured
4724 in the preferences dialog. This file should not be edited while Geany is running
4725 as the file will be overwritten when the preferences in Geany are changed or Geany
4729 [build-menu] section
4730 ^^^^^^^^^^^^^^^^^^^^
4732 The [build-menu] section contains the configuration of the build menu.
4733 This section can occur in filetype, preferences and project files and
4734 always has the format described here. Different menu items are loaded
4735 from different files, see the table in the `Build Menu Configuration`_
4736 section for details. All the settings can be configured from the dialogs
4737 except the execute command in filetype files and filetype definitions in
4738 the project file, so these are the only ones which need hand editing.
4740 The build-menu section stores one entry for each setting for each menu item that
4741 is configured. The keys for these settings have the format:
4747 * GG - is the menu item group,
4750 - NF for independent (non-filetype)
4753 * NN - is a two decimal digit number of the item within the group,
4755 * FF - is the field,
4759 - WD for working directory
4765 The project file contains project related settings and possibly a
4766 record of the current session files.
4769 [build-menu] additions
4770 ^^^^^^^^^^^^^^^^^^^^^^
4772 The project file also can have extra fields in the [build-menu] section
4773 in addition to those listed in `[build-menu] section`_ above.
4775 When filetype menu items are configured for the project they are stored
4776 in the project file.
4778 The ``filetypes`` entry is a list of the filetypes which exist in the
4781 For each filetype the entries for that filetype have the format defined in
4782 `[build-menu] section`_ but the key is prefixed by the name of the filetype
4783 as it appears in the ``filetypes`` entry, eg the entry for the label of
4784 filetype menu item 0 for the C filetype would be
4792 Geany supports the following templates:
4796 * Function description
4801 To use these templates, just open the Edit menu or open the popup menu
4802 by right-clicking in the editor widget, and choose "Insert Comments"
4803 and insert templates as you want.
4805 Some templates (like File header or ChangeLog entry) will always be
4806 inserted at the top of the file.
4808 To insert a function description, the cursor must be inside
4809 of the function, so that the function name can be determined
4810 automatically. The description will be positioned correctly one line
4811 above the function, just check it out. If the cursor is not inside
4812 of a function or the function name cannot be determined, the inserted
4813 function description won't contain the correct function name but "unknown"
4817 Geany automatically reloads template information when it notices you
4818 save a file in the user's template configuration directory. You can
4819 also force this by selecting *Tools->Reload Configuration*.
4825 Meta data can be used with all templates, but by default user set
4826 meta data is only used for the ChangeLog and File header templates.
4828 In the configuration dialog you can find a tab "Templates" (see
4829 `Template preferences`_). You can define the default values
4830 which will be inserted in the templates.
4836 File templates are templates used as the basis of a new file. To
4837 use them, choose the *New (with Template)* menu item from the *File*
4840 By default, file templates are installed for some filetypes. Custom
4841 file templates can be added by creating the appropriate template file. You can
4842 also edit the default file templates.
4844 The file's contents are just the text to place in the document, with
4845 optional template wildcards like ``{fileheader}``. The fileheader
4846 wildcard can be placed anywhere, but it's usually put on the first
4847 line of the file, followed by a blank line.
4849 Adding file templates
4850 `````````````````````
4852 File templates are read from ``templates/files`` under the
4853 `Configuration file paths`_.
4855 The filetype to use is detected from the template file's extension, if
4856 any. For example, creating a file ``module.c`` would add a menu item
4857 which created a new document with the filetype set to 'C'.
4859 The template file is read from disk when the corresponding menu item is
4863 Customizing templates
4864 ^^^^^^^^^^^^^^^^^^^^^
4866 Each template can be customized to your needs. The templates are
4867 stored in the ``~/.config/geany/templates/`` directory (see the section called
4868 `Command line options`_ for further information about the configuration
4869 directory). Just open the desired template with an editor (ideally,
4870 Geany ;-) ) and edit the template to your needs. There are some
4871 wildcards which will be automatically replaced by Geany at startup.
4877 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4879 **Wildcards for character escaping**
4881 ============== ============================================= =======================================
4882 Wildcard Description Available in
4883 ============== ============================================= =======================================
4884 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4885 wildcards being expanded).
4886 cb } Closing Brace. file templates, file header, snippets.
4887 pc \% Percent (used to escape e.g. %block% in
4888 snippets). snippets.
4889 ============== ============================================= =======================================
4891 **Global wildcards**
4893 These are configurable, see `Template preferences`_.
4895 ============== ============================================= =======================================
4896 Wildcard Description Available in
4897 ============== ============================================= =======================================
4898 developer The name of the developer. file templates, file header,
4899 function description, ChangeLog entry,
4902 initial The developer's initials, e.g. "ET" for file templates, file header,
4903 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4906 mail The email address of the developer. file templates, file header,
4907 function description, ChangeLog entry,
4910 company The company the developer is working for. file templates, file header,
4911 function description, ChangeLog entry,
4914 version The initial version of a new file. file templates, file header,
4915 function description, ChangeLog entry,
4917 ============== ============================================= =======================================
4919 **Date & time wildcards**
4921 The format for these wildcards can be changed in the preferences
4922 dialog, see `Template preferences`_. You can use any conversion
4923 specifiers which can be used with the ANSI C strftime function.
4924 For details please see http://man.cx/strftime.
4926 ============== ============================================= =======================================
4927 Wildcard Description Available in
4928 ============== ============================================= =======================================
4929 year The current year. Default format is: YYYY. file templates, file header,
4930 function description, ChangeLog entry,
4933 date The current date. Default format: file templates, file header,
4934 YYYY-MM-DD. function description, ChangeLog entry,
4937 datetime The current date and time. Default format: file templates, file header,
4938 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4940 ============== ============================================= =======================================
4942 **Dynamic wildcards**
4944 ============== ============================================= =======================================
4945 Wildcard Description Available in
4946 ============== ============================================= =======================================
4947 untitled The string "untitled" (this will be file templates, file header,
4948 translated to your locale), used in function description, ChangeLog entry,
4949 file templates. bsd, gpl, snippets.
4951 geanyversion The actual Geany version, e.g. file templates, file header,
4952 "Geany |(version)|". function description, ChangeLog entry,
4955 filename The filename of the current file. file header, snippets, file
4956 For new files, it's only replaced when templates.
4957 first saving if found on the first 4 lines
4960 project The current project's name, if any. file header, snippets, file templates.
4962 description The current project's description, if any. file header, snippets, file templates.
4964 functionname The function name of the function at the function description.
4965 cursor position. This wildcard will only be
4966 replaced in the function description
4969 command:path Executes the specified command and replace file templates, file header,
4970 the wildcard with the command's standard function description, ChangeLog entry,
4971 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
4973 ============== ============================================= =======================================
4975 **Template insertion wildcards**
4977 ============== ============================================= =======================================
4978 Wildcard Description Available in
4979 ============== ============================================= =======================================
4980 gpl This wildcard inserts a short GPL notice. file header.
4982 bsd This wildcard inserts a BSD licence notice. file header.
4984 fileheader The file header template. This wildcard snippets, file templates.
4985 will only be replaced in file templates.
4986 ============== ============================================= =======================================
4989 Special {command:} wildcard
4990 ***************************
4992 The {command:} wildcard is a special one because it can execute
4993 a specified command and put the command's output (stdout) into
5002 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
5004 Using this wildcard you can insert nearly any arbitrary text into the
5007 In the environment of the executed command the variables
5008 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
5009 The value of these variables is filled in only if Geany knows about it.
5010 For example, ``GEANY_FUNCNAME`` is only filled within the function
5011 description template. However, these variables are ``always`` set,
5012 just maybe with an empty value.
5013 You can easily access them e.g. within an executed shell script using::
5019 If the specified command could not be found or not executed, the wildcard is substituted
5020 by an empty string. In such cases, you can find the occurred error message on Geany's
5021 standard error and in the Help->Debug Messages dialog.
5024 Customizing the toolbar
5025 -----------------------
5027 You can add, remove and reorder the elements in the toolbar by using
5028 the toolbar editor, or by manually editing the configuration file
5031 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5032 by right-clicking on the toolbar itself and choosing it from the menu.
5034 Manually editing the toolbar layout
5035 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5037 To override the system-wide configuration file, copy it to your user
5038 configuration directory (see `Configuration file paths`_).
5042 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5044 Then edit it and add any of the available elements listed in the file or remove
5045 any of the existing elements. Of course, you can also reorder the elements as
5046 you wish and add or remove additional separators.
5047 This file must be valid XML, otherwise the global toolbar UI definition
5048 will be used instead.
5050 Your changes are applied once you save the file.
5053 (1) You cannot add new actions which are not listed below.
5054 (2) Everything you add or change must be inside the /ui/toolbar/ path.
5057 Available toolbar elements
5058 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5060 ================== ==============================================================================
5061 Element name Description
5062 ================== ==============================================================================
5063 New Create a new file
5064 Open Open an existing file
5065 Save Save the current file
5066 SaveAll Save all open files
5067 Reload Reload the current file from disk
5068 Close Close the current file
5069 CloseAll Close all open files
5070 Print Print the current file
5071 Cut Cut the current selection
5072 Copy Copy the current selection
5073 Paste Paste the contents of the clipboard
5074 Delete Delete the current selection
5075 Undo Undo the last modification
5076 Redo Redo the last modification
5077 NavBack Navigate back a location
5078 NavFor Navigate forward a location
5079 Compile Compile the current file
5080 Build Build the current file, includes a submenu for Make commands. Geany
5081 remembers the last chosen action from the submenu and uses this as default
5082 action when the button itself is clicked.
5083 Run Run or view the current file
5084 Color Open a color chooser dialog, to interactively pick colors from a palette
5085 ZoomIn Zoom in the text
5086 ZoomOut Zoom out the text
5087 UnIndent Decrease indentation
5088 Indent Increase indentation
5089 Replace Replace text in the current document
5090 SearchEntry The search field belonging to the 'Search' element (can be used alone)
5091 Search Find the entered text in the current file (only useful if you also
5093 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
5094 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
5095 Preferences Show the preferences dialog
5097 ================== ==============================================================================
5101 Plugin documentation
5102 ====================
5107 The HTML Characters plugin helps when working with special
5108 characters in XML/HTML, e.g. German Umlauts ü and ä.
5111 Insert entity dialog
5112 ^^^^^^^^^^^^^^^^^^^^
5114 When the plugin is enabled, you can insert special character
5115 entities using *Tools->Insert Special HTML Characters*.
5117 This opens up a dialog where you can find a huge amount of special
5118 characters sorted by category that you might like to use inside your
5119 document. You can expand and collapse the categories by clicking on
5120 the little arrow on the left hand side. Once you have found the
5121 desired character click on it and choose "Insert". This will insert
5122 the entity for the character at the current cursor position. You
5123 might also like to double click the chosen entity instead.
5126 Replace special chars by its entity
5127 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5129 To help make a XML/HTML document valid the plugin supports
5130 replacement of special chars known by the plugin. Both bulk
5131 replacement and immediate replacement during typing are supported.
5133 A few characters will not be replaced. These are
5144 You can activate/deactivate this feature using the *Tools->HTML
5145 Replacement->Auto-replace Special Characters* menu item. If it's
5146 activated, all special characters (beside the given exceptions from
5147 above) known by the plugin will be replaced by their entities.
5149 You could also set a keybinding for the plugin to toggle the status
5156 After inserting a huge amount of text, e.g. by using copy & paste, the
5157 plugin allows bulk replacement of all known characters (beside the
5158 mentioned exceptions). You can find the function under the same
5159 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
5160 configure a keybinding for the plugin.
5169 This plugin provides an option to automatically save documents.
5170 You can choose to save the current document, or all of your documents, at
5177 You can save the current document when the editor's focus goes out.
5178 Every pop-up, menu dialogs, or anything else that can make the editor lose the focus,
5179 will make the current document to be saved.
5184 This plugin sets on every new file (*File->New* or *File->New (with template)*)
5185 a randomly chosen filename and set its filetype appropriate to the used template
5186 or when no template was used, to a configurable default filetype.
5187 This enables you to quickly compile, build and/or run the new file without the
5188 need to give it an explicit filename using the Save As dialog. This might be
5189 useful when you often create new files just for testing some code or something
5196 This plugin creates a backup copy of the current file in Geany when it is
5197 saved. You can specify the directory where the backup copy is saved and
5198 you can configure the automatically added extension in the configure dialog
5199 in Geany's plugin manager.
5201 After the plugin was loaded in Geany's plugin manager, every file is
5202 copied into the configured backup directory *after* the file has been saved
5205 The created backup copy file permissions are set to read-write only for
5206 the user. This should help to not create world-readable files on possibly
5207 unsecure destination directories like /tmp (especially useful
5208 on multi-user systems).
5209 This applies only to non-Windows systems. On Windows, no explicit file
5210 permissions are set.
5213 Additionally, you can define how many levels of the original file's
5214 directory structure should be replicated in the backup copy path.
5215 For example, setting the option
5216 *Directory levels to include in the backup destination* to *2*
5217 cause the plugin to create the last two components of the original
5218 file's path in the backup copy path and place the new file there.
5221 Contributing to this document
5222 =============================
5224 This document (``geany.txt``) is written in `reStructuredText`__
5225 (or "reST"). The source file for it is located in Geany's ``doc``
5226 subdirectory. If you intend on making changes, you should grab the
5227 source right from Git to make sure you've got the newest version.
5228 First, you need to configure the build system to generate the HTML
5229 documentation passing the *--enable-html-docs* option to the *configure*
5230 script. Then after editing the file, run ``make`` (from the root build
5231 directory or from the *doc* subdirectory) to build the HTML documentation
5232 and see how your changes look. This regenerates the ``geany.html`` file
5233 inside the *doc* subdirectory. To generate a PDF file, configure with
5234 *--enable-pdf-docs* and run ``make`` as for the HTML version. The generated
5235 PDF file is named geany-|(version)|.pdf and is located inside the *doc*
5238 __ http://docutils.sourceforge.net/rst.html
5240 After you are happy with your changes, create a patch e.g. by using::
5242 % git diff geany.txt > foo.patch
5244 or even better, by creating a Git-formatted patch which will keep authoring
5245 and description data, by first committing your changes (doing so in a fresh
5246 new branch is recommended for `master` not to diverge from upstream) and then
5247 using git format-patch::
5249 % git checkout -b my-documentation-changes # create a fresh branch
5250 % git commit geany.txt
5251 Write a good commit message...
5252 % git format-patch HEAD^
5253 % git checkout master # go back to master
5255 and then submit that file to the mailing list for review.
5257 Also you can clone the Geany repository at GitHub and send a pull request.
5259 Note, you will need the Python docutils software package installed
5260 to build the docs. The package is named ``python-docutils`` on Debian
5266 Scintilla keyboard commands
5267 ===========================
5269 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
5271 This appendix is distributed under the terms of the License for
5272 Scintilla and SciTE. A copy of this license can be found in the file
5273 ``scintilla/License.txt`` included with the source code of this
5274 program and in the appendix of this document. See `License for
5275 Scintilla and SciTE`_.
5284 Keyboard commands for Scintilla mostly follow common Windows and GTK+
5285 conventions. All move keys (arrows, page up/down, home and end)
5286 allows to extend or reduce the stream selection when holding the
5287 Shift key, and the rectangular selection when holding the
5288 appropriate keys (see `Column mode editing (rectangular selections)`_).
5290 Some keys may not be available with some national keyboards
5291 or because they are taken by the system such as by a window manager
5292 or GTK. Keyboard equivalents of menu commands are listed in the
5293 menus. Some less common commands with no menu equivalent are:
5295 ============================================= ======================
5297 ============================================= ======================
5298 Magnify text size. Ctrl-Keypad+
5299 Reduce text size. Ctrl-Keypad-
5300 Restore text size to normal. Ctrl-Keypad/
5302 Dedent block. Shift-Tab
5303 Delete to start of word. Ctrl-BackSpace
5304 Delete to end of word. Ctrl-Delete
5305 Delete to start of line. Ctrl-Shift-BackSpace
5306 Go to start of document. Ctrl-Home
5307 Extend selection to start of document. Ctrl-Shift-Home
5308 Go to start of display line. Alt-Home
5309 Extend selection to start of display line. Alt-Shift-Home
5310 Go to end of document. Ctrl-End
5311 Extend selection to end of document. Ctrl-Shift-End
5312 Extend selection to end of display line. Alt-Shift-End
5313 Previous paragraph. Shift extends selection. Ctrl-Up
5314 Next paragraph. Shift extends selection. Ctrl-Down
5315 Previous word. Shift extends selection. Ctrl-Left
5316 Next word. Shift extends selection. Ctrl-Right
5317 ============================================= ======================
5328 * Double-click on empty space in the notebook tab bar to open a
5330 * Middle-click on a document's notebook tab to close the document.
5331 * Hold `Ctrl` and click on any notebook tab to switch to the last used
5333 * Double-click on a document's notebook tab to toggle all additional
5334 widgets (to show them again use the View menu or the keyboard
5335 shortcut). The interface pref must be enabled for this to work.
5340 * Alt-scroll wheel moves up/down a page.
5341 * Ctrl-scroll wheel zooms in/out.
5342 * Shift-scroll wheel scrolls 8 characters right/left.
5343 * Ctrl-click on a word in a document to perform *Go to Symbol Definition*.
5344 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
5349 * Double-click on a symbol-list group to expand or compact it.
5354 * Scrolling the mouse wheel over a notebook tab bar will switch
5357 The following are derived from X-Windows features (but GTK still supports
5360 * Middle-click pastes the last selected text.
5361 * Middle-click on a scrollbar moves the scrollbar to that
5362 position without having to drag it.
5366 Compile-time options
5367 ====================
5369 There are some options which can only be changed at compile time,
5370 and some options which are used as the default for configurable
5371 options. To change these options, edit the appropriate source file
5372 in the ``src`` subdirectory. Look for a block of lines starting with
5373 ``#define GEANY_*``. Any definitions which are not listed here should
5377 Most users should not need to change these options.
5382 ============================== ============================================ ==================
5383 Option Description Default
5384 ============================== ============================================ ==================
5385 GEANY_STRING_UNTITLED A string used as the default name for new untitled
5386 files. Be aware that the string can be
5387 translated, so change it only if you know
5389 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
5390 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
5391 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
5393 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
5395 **Windows specific**
5396 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
5397 Windows file open and save dialogs instead
5398 GTK's file open and save dialogs. The
5399 default Windows file dialogs are missing
5400 some nice features like choosing a filetype
5401 or an encoding. *Do not touch this setting
5402 when building on a non-Win32 system.*
5403 ============================== ============================================ ==================
5408 ============================== ============================================ ==================
5409 Option Description Default
5410 ============================== ============================================ ==================
5411 GEANY_PROJECT_EXT The default filename extension for Geany geany
5412 project files. It is used when creating new
5413 projects and as filter mask for the project
5415 ============================== ============================================ ==================
5420 ============================== ============================================ ==================
5421 Option Description Default
5422 ============================== ============================================ ==================
5423 GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
5424 filetype with the extract filetype regex.
5425 ============================== ============================================ ==================
5430 ============================== ============================================ ==================
5431 Option Description Default
5432 ============================== ============================================ ==================
5433 GEANY_WORDCHARS These characters define word boundaries when a string with:
5434 making selections and searching using word a-z, A-Z, 0-9 and
5435 matching options. underscore.
5436 ============================== ============================================ ==================
5441 These are default settings that can be overridden in the `Preferences`_ dialog.
5443 ============================== ============================================ ==================
5444 Option Description Default
5445 ============================== ============================================ ==================
5446 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
5447 trigger the autocompletion list.
5448 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
5450 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
5451 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator command, see See below.
5452 `Terminal emulators`_.
5453 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
5454 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
5455 and process plain text files. This can also
5457 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
5458 GNU grep. This can also include a path.
5459 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
5460 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
5462 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
5463 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
5464 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
5466 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
5468 GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
5470 ============================== ============================================ ==================
5472 The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
5474 The GEANY_DEFAULT_TOOLS_TERMINAL default value on Windows is::
5478 and on any non-Windows system is::
5480 xterm -e "/bin/sh %c"
5486 ============================== ============================================ ==================
5487 Option Description Default
5488 ============================== ============================================ ==================
5489 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
5490 be shown in the editor window.
5491 This affects the special coloring
5492 when Geany detects a compiler output line as
5493 an error message and then highlights the
5494 corresponding line in the source code.
5495 Usually only the first few messages are
5496 interesting because following errors are
5498 All errors in the Compiler window are parsed
5499 and unaffected by this value.
5500 PRINTBUILDCMDS Every time a build menu item priority FALSE
5501 calculation is run, print the state of the
5502 menu item table in the form of the table
5503 in `Build Menu Configuration`_. May be
5504 useful to debug configuration file
5505 overloading. Warning produces a lot of
5506 output. Can also be enabled/disabled by the
5507 debugger by setting printbuildcmds to 1/0
5508 overriding the compile setting.
5509 ============================== ============================================ ==================
5513 GNU General Public License
5514 ==========================
5518 GNU GENERAL PUBLIC LICENSE
5519 Version 2, June 1991
5521 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5522 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5523 Everyone is permitted to copy and distribute verbatim copies
5524 of this license document, but changing it is not allowed.
5528 The licenses for most software are designed to take away your
5529 freedom to share and change it. By contrast, the GNU General Public
5530 License is intended to guarantee your freedom to share and change free
5531 software--to make sure the software is free for all its users. This
5532 General Public License applies to most of the Free Software
5533 Foundation's software and to any other program whose authors commit to
5534 using it. (Some other Free Software Foundation software is covered by
5535 the GNU Library General Public License instead.) You can apply it to
5538 When we speak of free software, we are referring to freedom, not
5539 price. Our General Public Licenses are designed to make sure that you
5540 have the freedom to distribute copies of free software (and charge for
5541 this service if you wish), that you receive source code or can get it
5542 if you want it, that you can change the software or use pieces of it
5543 in new free programs; and that you know you can do these things.
5545 To protect your rights, we need to make restrictions that forbid
5546 anyone to deny you these rights or to ask you to surrender the rights.
5547 These restrictions translate to certain responsibilities for you if you
5548 distribute copies of the software, or if you modify it.
5550 For example, if you distribute copies of such a program, whether
5551 gratis or for a fee, you must give the recipients all the rights that
5552 you have. You must make sure that they, too, receive or can get the
5553 source code. And you must show them these terms so they know their
5556 We protect your rights with two steps: (1) copyright the software, and
5557 (2) offer you this license which gives you legal permission to copy,
5558 distribute and/or modify the software.
5560 Also, for each author's protection and ours, we want to make certain
5561 that everyone understands that there is no warranty for this free
5562 software. If the software is modified by someone else and passed on, we
5563 want its recipients to know that what they have is not the original, so
5564 that any problems introduced by others will not reflect on the original
5565 authors' reputations.
5567 Finally, any free program is threatened constantly by software
5568 patents. We wish to avoid the danger that redistributors of a free
5569 program will individually obtain patent licenses, in effect making the
5570 program proprietary. To prevent this, we have made it clear that any
5571 patent must be licensed for everyone's free use or not licensed at all.
5573 The precise terms and conditions for copying, distribution and
5574 modification follow.
5576 GNU GENERAL PUBLIC LICENSE
5577 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5579 0. This License applies to any program or other work which contains
5580 a notice placed by the copyright holder saying it may be distributed
5581 under the terms of this General Public License. The "Program", below,
5582 refers to any such program or work, and a "work based on the Program"
5583 means either the Program or any derivative work under copyright law:
5584 that is to say, a work containing the Program or a portion of it,
5585 either verbatim or with modifications and/or translated into another
5586 language. (Hereinafter, translation is included without limitation in
5587 the term "modification".) Each licensee is addressed as "you".
5589 Activities other than copying, distribution and modification are not
5590 covered by this License; they are outside its scope. The act of
5591 running the Program is not restricted, and the output from the Program
5592 is covered only if its contents constitute a work based on the
5593 Program (independent of having been made by running the Program).
5594 Whether that is true depends on what the Program does.
5596 1. You may copy and distribute verbatim copies of the Program's
5597 source code as you receive it, in any medium, provided that you
5598 conspicuously and appropriately publish on each copy an appropriate
5599 copyright notice and disclaimer of warranty; keep intact all the
5600 notices that refer to this License and to the absence of any warranty;
5601 and give any other recipients of the Program a copy of this License
5602 along with the Program.
5604 You may charge a fee for the physical act of transferring a copy, and
5605 you may at your option offer warranty protection in exchange for a fee.
5607 2. You may modify your copy or copies of the Program or any portion
5608 of it, thus forming a work based on the Program, and copy and
5609 distribute such modifications or work under the terms of Section 1
5610 above, provided that you also meet all of these conditions:
5612 a) You must cause the modified files to carry prominent notices
5613 stating that you changed the files and the date of any change.
5615 b) You must cause any work that you distribute or publish, that in
5616 whole or in part contains or is derived from the Program or any
5617 part thereof, to be licensed as a whole at no charge to all third
5618 parties under the terms of this License.
5620 c) If the modified program normally reads commands interactively
5621 when run, you must cause it, when started running for such
5622 interactive use in the most ordinary way, to print or display an
5623 announcement including an appropriate copyright notice and a
5624 notice that there is no warranty (or else, saying that you provide
5625 a warranty) and that users may redistribute the program under
5626 these conditions, and telling the user how to view a copy of this
5627 License. (Exception: if the Program itself is interactive but
5628 does not normally print such an announcement, your work based on
5629 the Program is not required to print an announcement.)
5631 These requirements apply to the modified work as a whole. If
5632 identifiable sections of that work are not derived from the Program,
5633 and can be reasonably considered independent and separate works in
5634 themselves, then this License, and its terms, do not apply to those
5635 sections when you distribute them as separate works. But when you
5636 distribute the same sections as part of a whole which is a work based
5637 on the Program, the distribution of the whole must be on the terms of
5638 this License, whose permissions for other licensees extend to the
5639 entire whole, and thus to each and every part regardless of who wrote it.
5641 Thus, it is not the intent of this section to claim rights or contest
5642 your rights to work written entirely by you; rather, the intent is to
5643 exercise the right to control the distribution of derivative or
5644 collective works based on the Program.
5646 In addition, mere aggregation of another work not based on the Program
5647 with the Program (or with a work based on the Program) on a volume of
5648 a storage or distribution medium does not bring the other work under
5649 the scope of this License.
5651 3. You may copy and distribute the Program (or a work based on it,
5652 under Section 2) in object code or executable form under the terms of
5653 Sections 1 and 2 above provided that you also do one of the following:
5655 a) Accompany it with the complete corresponding machine-readable
5656 source code, which must be distributed under the terms of Sections
5657 1 and 2 above on a medium customarily used for software interchange; or,
5659 b) Accompany it with a written offer, valid for at least three
5660 years, to give any third party, for a charge no more than your
5661 cost of physically performing source distribution, a complete
5662 machine-readable copy of the corresponding source code, to be
5663 distributed under the terms of Sections 1 and 2 above on a medium
5664 customarily used for software interchange; or,
5666 c) Accompany it with the information you received as to the offer
5667 to distribute corresponding source code. (This alternative is
5668 allowed only for noncommercial distribution and only if you
5669 received the program in object code or executable form with such
5670 an offer, in accord with Subsection b above.)
5672 The source code for a work means the preferred form of the work for
5673 making modifications to it. For an executable work, complete source
5674 code means all the source code for all modules it contains, plus any
5675 associated interface definition files, plus the scripts used to
5676 control compilation and installation of the executable. However, as a
5677 special exception, the source code distributed need not include
5678 anything that is normally distributed (in either source or binary
5679 form) with the major components (compiler, kernel, and so on) of the
5680 operating system on which the executable runs, unless that component
5681 itself accompanies the executable.
5683 If distribution of executable or object code is made by offering
5684 access to copy from a designated place, then offering equivalent
5685 access to copy the source code from the same place counts as
5686 distribution of the source code, even though third parties are not
5687 compelled to copy the source along with the object code.
5689 4. You may not copy, modify, sublicense, or distribute the Program
5690 except as expressly provided under this License. Any attempt
5691 otherwise to copy, modify, sublicense or distribute the Program is
5692 void, and will automatically terminate your rights under this License.
5693 However, parties who have received copies, or rights, from you under
5694 this License will not have their licenses terminated so long as such
5695 parties remain in full compliance.
5697 5. You are not required to accept this License, since you have not
5698 signed it. However, nothing else grants you permission to modify or
5699 distribute the Program or its derivative works. These actions are
5700 prohibited by law if you do not accept this License. Therefore, by
5701 modifying or distributing the Program (or any work based on the
5702 Program), you indicate your acceptance of this License to do so, and
5703 all its terms and conditions for copying, distributing or modifying
5704 the Program or works based on it.
5706 6. Each time you redistribute the Program (or any work based on the
5707 Program), the recipient automatically receives a license from the
5708 original licensor to copy, distribute or modify the Program subject to
5709 these terms and conditions. You may not impose any further
5710 restrictions on the recipients' exercise of the rights granted herein.
5711 You are not responsible for enforcing compliance by third parties to
5714 7. If, as a consequence of a court judgment or allegation of patent
5715 infringement or for any other reason (not limited to patent issues),
5716 conditions are imposed on you (whether by court order, agreement or
5717 otherwise) that contradict the conditions of this License, they do not
5718 excuse you from the conditions of this License. If you cannot
5719 distribute so as to satisfy simultaneously your obligations under this
5720 License and any other pertinent obligations, then as a consequence you
5721 may not distribute the Program at all. For example, if a patent
5722 license would not permit royalty-free redistribution of the Program by
5723 all those who receive copies directly or indirectly through you, then
5724 the only way you could satisfy both it and this License would be to
5725 refrain entirely from distribution of the Program.
5727 If any portion of this section is held invalid or unenforceable under
5728 any particular circumstance, the balance of the section is intended to
5729 apply and the section as a whole is intended to apply in other
5732 It is not the purpose of this section to induce you to infringe any
5733 patents or other property right claims or to contest validity of any
5734 such claims; this section has the sole purpose of protecting the
5735 integrity of the free software distribution system, which is
5736 implemented by public license practices. Many people have made
5737 generous contributions to the wide range of software distributed
5738 through that system in reliance on consistent application of that
5739 system; it is up to the author/donor to decide if he or she is willing
5740 to distribute software through any other system and a licensee cannot
5743 This section is intended to make thoroughly clear what is believed to
5744 be a consequence of the rest of this License.
5746 8. If the distribution and/or use of the Program is restricted in
5747 certain countries either by patents or by copyrighted interfaces, the
5748 original copyright holder who places the Program under this License
5749 may add an explicit geographical distribution limitation excluding
5750 those countries, so that distribution is permitted only in or among
5751 countries not thus excluded. In such case, this License incorporates
5752 the limitation as if written in the body of this License.
5754 9. The Free Software Foundation may publish revised and/or new versions
5755 of the General Public License from time to time. Such new versions will
5756 be similar in spirit to the present version, but may differ in detail to
5757 address new problems or concerns.
5759 Each version is given a distinguishing version number. If the Program
5760 specifies a version number of this License which applies to it and "any
5761 later version", you have the option of following the terms and conditions
5762 either of that version or of any later version published by the Free
5763 Software Foundation. If the Program does not specify a version number of
5764 this License, you may choose any version ever published by the Free Software
5767 10. If you wish to incorporate parts of the Program into other free
5768 programs whose distribution conditions are different, write to the author
5769 to ask for permission. For software which is copyrighted by the Free
5770 Software Foundation, write to the Free Software Foundation; we sometimes
5771 make exceptions for this. Our decision will be guided by the two goals
5772 of preserving the free status of all derivatives of our free software and
5773 of promoting the sharing and reuse of software generally.
5777 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5778 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5779 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5780 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5781 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5782 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5783 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5784 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5785 REPAIR OR CORRECTION.
5787 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5788 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5789 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5790 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5791 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5792 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5793 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5794 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5795 POSSIBILITY OF SUCH DAMAGES.
5797 END OF TERMS AND CONDITIONS
5799 How to Apply These Terms to Your New Programs
5801 If you develop a new program, and you want it to be of the greatest
5802 possible use to the public, the best way to achieve this is to make it
5803 free software which everyone can redistribute and change under these terms.
5805 To do so, attach the following notices to the program. It is safest
5806 to attach them to the start of each source file to most effectively
5807 convey the exclusion of warranty; and each file should have at least
5808 the "copyright" line and a pointer to where the full notice is found.
5810 <one line to give the program's name and a brief idea of what it does.>
5811 Copyright (C) <year> <name of author>
5813 This program is free software; you can redistribute it and/or modify
5814 it under the terms of the GNU General Public License as published by
5815 the Free Software Foundation; either version 2 of the License, or
5816 (at your option) any later version.
5818 This program is distributed in the hope that it will be useful,
5819 but WITHOUT ANY WARRANTY; without even the implied warranty of
5820 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5821 GNU General Public License for more details.
5823 You should have received a copy of the GNU General Public License along
5824 with this program; if not, write to the Free Software Foundation, Inc.,
5825 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5828 Also add information on how to contact you by electronic and paper mail.
5830 If the program is interactive, make it output a short notice like this
5831 when it starts in an interactive mode:
5833 Gnomovision version 69, Copyright (C) year name of author
5834 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5835 This is free software, and you are welcome to redistribute it
5836 under certain conditions; type `show c' for details.
5838 The hypothetical commands `show w' and `show c' should show the appropriate
5839 parts of the General Public License. Of course, the commands you use may
5840 be called something other than `show w' and `show c'; they could even be
5841 mouse-clicks or menu items--whatever suits your program.
5843 You should also get your employer (if you work as a programmer) or your
5844 school, if any, to sign a "copyright disclaimer" for the program, if
5845 necessary. Here is a sample; alter the names:
5847 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5848 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5850 <signature of Ty Coon>, 1 April 1989
5851 Ty Coon, President of Vice
5853 This General Public License does not permit incorporating your program into
5854 proprietary programs. If your program is a subroutine library, you may
5855 consider it more useful to permit linking proprietary applications with the
5856 library. If this is what you want to do, use the GNU Library General
5857 Public License instead of this License.
5862 License for Scintilla and SciTE
5863 ===============================
5865 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5869 Permission to use, copy, modify, and distribute this software and
5870 its documentation for any purpose and without fee is hereby granted,
5871 provided that the above copyright notice appear in all copies and
5872 that both that copyright notice and this permission notice appear in
5873 supporting documentation.
5875 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5876 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5877 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5878 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5879 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5880 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5881 USE OR PERFORMANCE OF THIS SOFTWARE.