1 .. |(version)| replace:: 1.25
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 GTK2 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.16.0) 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.16.0) libraries and header files.
124 You also need the Pango, GLib and ATK libraries and header files.
125 All these files are available at http://www.gtk.org, but very often
126 your distro will provide development packages to save the trouble of
127 building these yourself.
129 Furthermore you need, of course, a C and C++ compiler. The GNU versions
130 of these tools are recommended.
132 Autotools based build system
133 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135 The Autotools based build system is very mature and has been well tested.
136 To use it, you just need the Make tool, preferably GNU Make.
138 Then run the following commands::
151 Waf based build system
152 ^^^^^^^^^^^^^^^^^^^^^^
154 The Waf build system is still quite young and under heavy development but already in a
155 usable state. In contrast to the Autotools system, Waf needs Python. So before using Waf, you need
156 to install Python on your system.
157 The advantage of the Waf build system over the Autotools based build system is that the whole
158 build process might be a bit faster. Especially when you use the Waf
159 cache feature for repetitive builds (e.g. when changing only a few source files
160 to test something) will become much faster since Waf will cache and re-use the
161 unchanged built files and only compile the changed code again. See `Waf Cache`_ for details.
162 To build Geany with Waf as run::
174 The Waf build system has a nice and interesting feature which can help to avoid
175 a lot of unnecessary rebuilding of unchanged code. This often happens when developing new features
176 or trying to debug something in Geany.
177 Waf is able to store and retrieve the object files from a cache. This cache is declared
178 using the environment variable ``WAFCACHE``.
179 A possible location of the cache directory could be ``~/.cache/waf``. In order to make use of
180 this, you first need to create this directory::
182 $ mkdir -p ~/.cache/waf
184 then add the environment variable to your shell configuration (the following example is for
185 Bash and should be adjusted to your used shell)::
187 export WAFCACHE=/home/username/.cache/waf
189 Remember to replace ``username`` with your actual username.
191 More information about the Waf cache feature are available at
192 http://code.google.com/p/waf/wiki/CacheObjectFiles.
196 You should be careful about the size of the cache directory as it may
197 grow rapidly over time.
198 Waf doesn't do any cleaning or other house-keeping of the cache yet, so you need to keep it
200 An easy way to keep it clean is to run the following command regularly to remove old
203 $ find /home/username/.cache/waf -mtime +14 -exec rm {} \;
205 This will delete all files in the cache directory which are older than 14 days.
207 For details about the ``find`` command and its options, check its manual page.
212 The configure script supports several common options, for a detailed
221 (depending on which build system you use).
223 You may also want to read the INSTALL file for advanced installation
226 * See also `Compile-time options`_.
228 Dynamic linking loader support and VTE
229 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
230 In the case that your system lacks dynamic linking loader support, you
231 probably want to pass the option ``--disable-vte`` to the ``configure``
232 script. This prevents compiling Geany with dynamic linking loader
233 support for automatically loading ``libvte.so.4`` if available.
237 If there are any errors during compilation, check your build
238 environment and try to find the error, otherwise contact the mailing
239 list or one the authors. Sometimes you might need to ask for specific
240 help from your distribution.
245 If you want to find Geany's system files after installation you may
246 want to know the installation prefix.
248 Pass the ``--print-prefix`` option to Geany to check this - see
249 `Command line options`_. The first path is the prefix.
251 On Unix-like systems this is commonly ``/usr`` if you installed from
252 a binary package, or ``/usr/local`` if you build from source.
255 Editing system files is not necessary as you should use the
256 per-user configuration files instead, which don't need root
257 permissions. See `Configuration files`_.
267 You can start Geany in the following ways:
269 * From the Desktop Environment menu:
271 Choose in your application menu of your used Desktop Environment:
272 Development --> Geany.
274 At Windows-systems you will find Geany after installation inside
275 the application menu within its special folder.
277 * From the command line:
279 To start Geany from a command line, type the following and press
287 The Geany window is shown in the following figure:
289 .. image:: ./images/main_window.png
291 The workspace has the following parts:
294 * An optional toolbar.
295 * An optional sidebar that can show the following tabs:
297 * Documents - A document list, and
298 * Symbols - A list of symbols in your code.
300 * The main editor window.
301 * An optional message window which can show the following tabs:
303 * Status - A list of status messages.
304 * Compiler - The output of compiling or building programs.
305 * Messages - Results of 'Find Usage', 'Find in Files' and other actions
306 * Scribble - A text scratchpad for any use.
307 * Terminal - An optional terminal window.
311 Most of these can be configured in the `Interface preferences`_, the
312 `View menu`_, or the popup menu for the relevant area.
314 Additional tabs may be added to the sidebar and message window by plugins.
316 The position of the tabs can be selected in the interface preferences.
318 The sizes of the sidebar and message window can be adjusted by
319 dragging the dividers.
324 ============ ======================= =================================================
325 Short option Long option Function
326 ============ ======================= =================================================
327 *none* +number Set initial line number for the first opened file
328 (same as --line, do not put a space between the + sign
329 and the number). E.g. "geany +7 foo.bar" will open the
330 file foo.bar and place the cursor in line 7.
332 *none* --column Set initial column number for the first opened file.
334 -c dir_name --config=directory_name Use an alternate configuration directory. The default
335 configuration directory is ``~/.config/geany/`` and that
336 is where ``geany.conf`` and other configuration files
339 *none* --ft-names Print a list of Geany's internal filetype names (useful
340 for snippets configuration).
342 -g --generate-tags Generate a global tags file (see
343 `Generating a global tags file`_).
345 -P --no-preprocessing Don't preprocess C/C++ files when generating tags.
347 -i --new-instance Do not open files in a running instance, force opening
348 a new instance. Only available if Geany was compiled
349 with support for Sockets.
351 -l --line Set initial line number for the first opened file.
353 *none* --list-documents Return a list of open documents in a running Geany
355 This can be used to read the currently opened documents in
356 Geany from an external script or tool. The returned list
357 is separated by newlines (LF) and consists of the full,
358 UTF-8 encoded filenames of the documents.
359 Only available if Geany was compiled with support for
362 -m --no-msgwin Do not show the message window. Use this option if you
363 do not need compiler messages or VTE support.
365 -n --no-ctags Do not load symbol completion and call tip data. Use this
366 option if you do not want to use them.
368 -p --no-plugins Do not load plugins or plugin support.
370 *none* --print-prefix Print installation prefix, the data directory, the lib
371 directory and the locale directory (in that order) to
372 stdout, one line each. This is mainly intended for plugin
373 authors to detect installation paths.
375 -r --read-only Open all files given on the command line in read-only mode.
376 This only applies to files opened explicitly from the command
377 line, so files from previous sessions or project files are
380 -s --no-session Do not load the previous session's files.
382 -t --no-terminal Do not load terminal support. Use this option if you do
383 not want to load the virtual terminal emulator widget
384 at startup. If you do not have ``libvte.so.4`` installed,
385 then terminal-support is automatically disabled. Only
386 available if Geany was compiled with support for VTE.
388 *none* --socket-file Use this socket filename for communication with a
389 running Geany instance. This can be used with the following
390 command to execute Geany on the current workspace::
392 geany --socket-file=/tmp/geany-sock-$(xprop -root _NET_CURRENT_DESKTOP | awk '{print $3}')
394 *none* --vte-lib Specify explicitly the path including filename or only
395 the filename to the VTE library, e.g.
396 ``/usr/lib/libvte.so`` or ``libvte.so``. This option is
397 only needed when the auto-detection does not work. Only
398 available if Geany was compiled with support for VTE.
400 -v --verbose Be verbose (print useful status messages).
402 -V --version Show version information and exit.
404 -? --help Show help information and exit.
406 *none* [files ...] Open all given files at startup. This option causes
407 Geany to ignore loading stored files from the last
408 session (if enabled).
409 Geany also recognizes line and column information when
410 appended to the filename with colons, e.g.
411 "geany foo.bar:10:5" will open the file foo.bar and
412 place the cursor in line 10 at column 5.
414 Projects can also be opened but a project file (\*.geany)
415 must be the first non-option argument. All additionally
416 given files are ignored.
417 ============ ======================= =================================================
419 You can also pass line number and column number information, e.g.::
421 geany some_file.foo:55:4
423 Geany supports all generic GTK options, a list is available on the
435 At startup, Geany loads all files from the last time Geany was
436 launched. You can disable this feature in the preferences dialog
437 (see `General Startup preferences`_).
439 You can start several instances of Geany, but only the first will
440 load files from the last session. In the subsequent instances, you
441 can find these files in the file menu under the "Recent files" item.
442 By default this contains the last 10 recently opened files. You can
443 change the number of recently opened files in the preferences dialog.
445 To run a second instance of Geany, do not specify any filenames on
446 the command-line, or disable opening files in a running instance
447 using the appropriate command line option.
450 Opening files from the command-line in a running instance
451 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
453 Geany detects if there is an instance of itself already running and opens files
454 from the command-line in that instance. So, Geany can
455 be used to view and edit files by opening them from other programs
456 such as a file manager.
458 You can also pass line number and column number information, e.g.::
460 geany some_file.foo:55:4
462 This would open the file ``some_file.foo`` with the cursor on line 55,
465 If you do not like this for some reason, you can disable using the first
466 instance by using the appropriate command line option -- see the section
467 called `Command line options`_.
470 Virtual terminal emulator widget (VTE)
471 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
473 If you have installed ``libvte.so`` on your system, it is loaded
474 automatically by Geany, and you will have a terminal widget in the
475 notebook at the bottom.
477 If Geany cannot find any ``libvte.so`` at startup, the terminal widget
478 will not be loaded. So there is no need to install the package containing
479 this file in order to run Geany. Additionally, you can disable the use
480 of the terminal widget by command line option, for more information
481 see the section called `Command line options`_.
483 You can use this terminal (from now on called VTE) much as you would
484 a terminal program like xterm. There is basic clipboard support. You
485 can paste the contents of the clipboard by pressing the right mouse
486 button to open the popup menu, and choosing Paste. To copy text from
487 the VTE, just select the desired text and then press the right mouse
488 button and choose Copy from the popup menu. On systems running the
489 X Window System you can paste the last selected text by pressing the
490 middle mouse button in the VTE (on 2-button mice, the middle button
491 can often be simulated by pressing both mouse buttons together).
493 In the preferences dialog you can specify a shell which should be
494 started in the VTE. To make the specified shell a login shell just
495 use the appropriate command line options for the shell. These options
496 should be found in the manual page of the shell. For zsh and bash
497 you can use the argument ``--login``.
500 Geany tries to load ``libvte.so``. If this fails, it tries to load
501 some other filenames. If this fails too, you should check whether you
502 installed libvte correctly. Again note, Geany will run without this
505 It could be, that the library is called something else than
506 ``libvte.so`` (e.g. on FreeBSD 6.0 it is called ``libvte.so.8``). If so
507 please set a link to the correct file (as root)::
509 # ln -s /usr/lib/libvte.so.X /usr/lib/libvte.so
511 Obviously, you have to adjust the paths and set X to the number of your
514 You can also specify the filename of the VTE library to use on the command
515 line (see the section called `Command line options`_) or at compile time
516 by specifying the command line option ``--with-vte-module-path`` to
520 Defining own widget styles using .gtkrc-2.0
521 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
523 You can define your widget style for many of Geany's GUI parts. To
524 do this, just edit your ``.gtkrc-2.0`` (usually found in your home
525 directory on UNIX-like systems and in the etc subdirectory of your
526 Geany installation on Windows).
528 To have a defined style used by Geany you must assign it to
529 at least one of Geany's widgets. For example use the following line::
531 widget "Geany*" style "geanyStyle"
533 This would assign your style "geany_style" to all Geany
534 widgets. You can also assign styles only to specific widgets. At the
535 moment you can use the following widgets:
547 An example of a simple ``.gtkrc-2.0``::
553 widget "GeanyMainWindow" style "geanyStyle"
559 widget "GeanyPrefsDialog" style "geanyStyle"
565 Switching between documents
566 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
568 The documents list and the editor tabs are two different ways
569 to switch between documents using the mouse. When you hit the key
570 combination to move between tabs, the order is determined by the tab
571 order. It is not alphabetical as shown in the documents list
572 (regardless of whether or not editor tabs are visible).
574 See the `Notebook tab keybindings`_ section for useful
575 shortcuts including for Most-Recently-Used document switching.
579 The `Document->Clone` menu item copies the current document's text,
580 cursor position and properties into a new untitled document. If
581 there is a selection, only the selected text is copied. This can be
582 useful when making temporary copies of text or for creating
583 documents with similar or identical contents.
586 Character sets and Unicode Byte-Order-Mark (BOM)
587 ------------------------------------------------
593 Geany provides support for detecting and converting character sets. So
594 you can open and save files in different character sets, and even
595 convert a file from one character set to another. To do this,
596 Geany uses the character conversion capabilities of the GLib library.
598 Only text files are supported, i.e. opening files which contain
599 NULL-bytes may fail. Geany will try to open the file anyway but it is
600 likely that the file will be truncated because it can only be read up
601 to the first occurrence of a NULL-byte. All characters after this
602 position are lost and are not written when you save the file.
604 Geany tries to detect the encoding of a file while opening it, but
605 auto-detecting the encoding of a file is not easy and sometimes an
606 encoding might not be detected correctly. In this case you have to
607 set the encoding of the file manually in order to display it
608 correctly. You can this in the file open dialog by selecting an
609 encoding in the drop down box or by reloading the file with the
610 file menu item "Reload as". The auto-detection works well for most
611 encodings but there are also some encodings where it is known that
612 auto-detection has problems.
614 There are different ways to set different encodings in Geany:
616 * Using the file open dialog
618 This opens the file with the encoding specified in the encoding drop
619 down box. If the encoding is set to "Detect from file" auto-detection
620 will be used. If the encoding is set to "Without encoding (None)" the
621 file will be opened without any character conversion and Geany will
622 not try to auto-detect the encoding (see below for more information).
624 * Using the "Reload as" menu item
626 This item reloads the current file with the specified encoding. It can
627 help if you opened a file and found out that the wrong encoding was used.
629 * Using the "Set encoding" menu item
631 Contrary to the above two options, this will not change or reload
632 the current file unless you save it. It is useful when you want to
633 change the encoding of the file.
635 * Specifying the encoding in the file itself
637 As mentioned above, auto-detecting the encoding of a file may fail on
638 some encodings. If you know that Geany doesn't open a certain file,
639 you can add the specification line, described in the next section,
640 to the beginning of the file to force Geany to use a specific
641 encoding when opening the file.
644 In-file encoding specification
645 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
647 Geany detects meta tags of HTML files which contain charset information
650 <meta http-equiv="content-type" content="text/html; charset=ISO-8859-15" />
652 and the specified charset is used when opening the file. This is useful if the
653 encoding of the file cannot be detected properly.
654 For non-HTML files you can also define a line like::
656 /* geany_encoding=ISO-8859-15 */
660 # geany_encoding=ISO-8859-15 #
662 to force an encoding to be used. The #, /\* and \*/ are examples
663 of filetype-specific comment characters. It doesn't matter which
664 characters are around the string " geany_encoding=ISO-8859-15 " as long
665 as there is at least one whitespace character before and after this
666 string. Whitespace characters are in this case a space or tab character.
667 An example to use this could be you have a file with ISO-8859-15
668 encoding but Geany constantly detects the file encoding as ISO-8859-1.
669 Then you simply add such a line to the file and Geany will open it
670 correctly the next time.
672 Since Geany 0.15 you can also use lines which match the
673 regular expression used to find the encoding string:
674 ``coding[\t ]*[:=][\t ]*([a-z0-9-]+)[\t ]*``
677 These specifications must be in the first 512 bytes of the file.
678 Anything after the first 512 bytes will not be recognized.
682 # encoding = ISO-8859-15
686 # coding: ISO-8859-15
688 Special encoding "None"
689 ^^^^^^^^^^^^^^^^^^^^^^^
691 There is a special encoding "None" which uses no
692 encoding. It is useful when you know that Geany cannot auto-detect
693 the encoding of a file and it is not displayed correctly. Especially
694 when the file contains NULL-bytes this can be useful to skip auto
695 detection and open the file properly at least until the occurrence
696 of the first NULL-byte. Using this encoding opens the file as it is
697 without any character conversion.
700 Unicode Byte-Order-Mark (BOM)
701 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
703 Furthermore, Geany detects a Unicode Byte Order Mark (see
704 http://en.wikipedia.org/wiki/Byte_Order_Mark for details). Of course,
705 this feature is only available if the opened file is in a Unicode
706 encoding. The Byte Order Mark helps to detect the encoding of a file,
707 e.g. whether it is UTF-16LE or UTF-16BE and so on. On Unix-like systems
708 using a Byte Order Mark could cause some problems for programs not
709 expecting it, e.g. the compiler gcc stops
710 with stray errors, PHP does not parse a script containing a BOM and
711 script files starting with a she-bang maybe cannot be started. In the
712 status bar you can easily see whether the file starts with a BOM or
715 If you want to set a BOM for a file or if you want to remove it
716 from a file, just use the document menu and toggle the checkbox.
719 If you are unsure what a BOM is or if you do not understand where
720 to use it, then it is probably not important for you and you can
732 Geany provides basic code folding support. Folding means the ability to
733 show and hide parts of the text in the current file. You can hide
734 unimportant code sections and concentrate on the parts you are working on
735 and later you can show hidden sections again. In the editor window there is
736 a small grey margin on the left side with [+] and [-] symbols which
737 show hidden parts and hide parts of the file respectively. By
738 clicking on these icons you can simply show and hide sections which are
739 marked by vertical lines within this margin. For many filetypes nested
740 folding is supported, so there may be several fold points within other
744 You can customize the folding icon and line styles - see the
745 filetypes.common `Folding Settings`_.
747 If you don't like it or don't need it at all, you can simply disable
748 folding support completely in the preferences dialog.
750 The folding behaviour can be changed with the "Fold/Unfold all children of
751 a fold point" option in the preference dialog. If activated, Geany will
752 unfold all nested fold points below the current one if they are already
753 folded (when clicking on a [+] symbol).
754 When clicking on a [-] symbol, Geany will fold all nested fold points
755 below the current one if they are unfolded.
757 This option can be inverted by pressing the Shift
758 key while clicking on a fold symbol. That means, if the "Fold/Unfold all
759 children of a fold point" option is enabled, pressing Shift will disable
760 it for this click and vice versa.
763 Column mode editing (rectangular selections)
764 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
766 There is basic support for column mode editing. To use it, create a
767 rectangular selection by holding down the Control and Shift keys
768 (or Alt and Shift on Windows) while selecting some text.
769 Once a rectangular selection exists you can start editing the text within
770 this selection and the modifications will be done for every line in the
773 It is also possible to create a zero-column selection - this is
774 useful to insert text on multiple lines.
776 Drag and drop of text
777 ^^^^^^^^^^^^^^^^^^^^^
779 If you drag selected text in the editor widget of Geany the text is
780 moved to the position where the mouse pointer is when releasing the
781 mouse button. Holding Control when releasing the mouse button will
782 copy the text instead. This behaviour was changed in Geany 0.11 -
783 before the selected text was copied to the new position.
789 Geany allows each document to indent either with a tab character,
790 multiple spaces or a combination of both.
792 The *Tabs* setting indents with one tab character per indent level, and
793 displays tabs as the indent width.
795 The *Spaces* setting indents with the number of spaces set in the indent
796 width for each level.
798 The *Tabs and Spaces* setting indents with spaces as above, then converts
799 as many spaces as it can to tab characters at the rate of one tab for
800 each multiple of the `Various preference` setting
801 *indent_hard_tab_width* (default 8) and displays tabs as the
802 *indent_hard_tab_width* value.
804 The default indent settings are set in `Editor Indentation
805 preferences`_ (see the link for more information).
807 The default settings can be overridden per-document using the
808 Document menu. They can also be overridden by projects - see
809 `Project management`_.
811 The indent mode for the current document is shown on the status bar
815 Indent with Tab characters.
819 Indent with tabs and spaces, depending on how much indentation is
822 Applying new indentation settings
823 `````````````````````````````````
824 After changing the default settings you may wish to apply the new
825 settings to every document in the current session. To do this use the
826 *Project->Apply Default Indentation* menu item.
828 Detecting indent type
829 `````````````````````
830 The *Detect from file* indentation preference can be used to
831 scan each file as it's opened and set the indent type based on
832 how many lines start with a tab vs. 2 or more spaces.
838 When enabled, auto-indentation happens when pressing *Enter* in the
839 Editor. It adds a certain amount of indentation to the new line so the
840 user doesn't always have to indent each line manually.
842 Geany has four types of auto-indentation:
845 Disables auto-indentation completely.
847 Adds the same amount of whitespace on a new line as on the previous line.
848 For the *Tabs* and the *Spaces* indent types the indentation will use the
849 same combination of characters as the previous line. The
850 *Tabs and Spaces* indentation type converts as explained above.
852 Does the same as *Basic* but also indents a new line after an opening
853 brace '{', and de-indents when typing a closing brace '}'. For Python,
854 a new line will be indented after typing ':' at the end of the
857 Similar to *Current chars* but the closing brace will be aligned to
858 match the indentation of the line with the opening brace. This
859 requires the filetype to be one where Geany knows that the Scintilla
860 lexer understands matching braces (C, C++, D, HTML, Pascal, Bash,
863 There is also XML-tag auto-indentation. This is enabled when the
864 mode is more than just Basic, and is also controlled by a filetype
865 setting - see `xml_indent_tags`_.
871 Geany provides a handy bookmarking feature that lets you mark one
872 or more lines in a document, and return the cursor to them using a
875 To place a mark on a line, either left-mouse-click in the left margin
876 of the editor window, or else use Ctrl-m. This will
877 produce a small green plus symbol in the margin. You can have as many
878 marks in a document as you like. Click again (or use Ctrl-m again)
879 to remove the bookmark. To remove all the marks in a given document,
880 use "Remove Markers" in the Document menu.
882 To navigate down your document, jumping from one mark to the next,
883 use Ctrl-. (control period). To go in the opposite direction on
884 the page, use Ctrl-, (control comma). Using the bookmarking feature
885 together with the commands to switch from one editor tab to another
886 (Ctrl-PgUp/PgDn and Ctrl-Tab) provides a particularly fast way to
887 navigate around multiple files.
890 Code navigation history
891 ^^^^^^^^^^^^^^^^^^^^^^^
893 To ease navigation in source files and especially between
894 different files, Geany lets you jump between different navigation
895 points. Currently, this works for the following:
897 * `Go to tag declaration`_
898 * `Go to tag definition`_
903 When using one of these actions, Geany remembers your current position
904 and jumps to the new one. If you decide to go back to your previous
905 position in the file, just use "Navigate back a location". To
906 get back to the new position again, just use "Navigate forward a
907 location". This makes it easier to navigate in e.g. foreign code
908 and between different files.
911 Sending text through custom commands
912 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
914 You can define several custom commands in Geany and send the current
915 selection to one of these commands using the *Edit->Format->Send
916 Selection to* menu or keybindings. The output of the command will be
917 used to replace the current selection. This makes it possible to use
918 text formatting tools with Geany in a general way.
920 The selected text will be sent to the standard input of the executed
921 command, so the command should be able to read from it and it should
922 print all results to its standard output which will be read by
923 Geany. To help finding errors in executing the command, the output
924 of the program's standard error will be printed on Geany's standard
927 If there is no selection, the whole current line is used instead.
929 To add a custom command, use the *Send Selection to->Set Custom
930 Commands* menu item. Click on *Add* to get a new item and type the
931 command. You can also specify some command line options. Empty
932 commands are not saved.
934 Normal shell quoting is supported, so you can do things like:
936 * ``sed 's/\./(dot)/g'``
938 The above example would normally be done with the `Replace all`_
939 function, but it can be handy to have common commands already set up.
941 Note that the command is not run in a shell, so if you want to use
942 shell features like pipes and command chains, you need to explicitly
943 launch the shell and pass it your command:
945 * ``sh -c 'sort | uniq'``
951 You can execute the context action command on the current word at the
952 cursor position or the available selection. This word or selection
953 can be used as an argument to the command.
954 The context action is invoked by a menu entry in the popup menu of the
955 editor and also a keyboard shortcut (see the section called
958 The command can be specified in the preferences dialog and also for
959 each filetype (see "context_action_cmd" in the section called
960 `Filetype configuration`_). When the context action is invoked, the filetype
961 specific command is used if available, otherwise the command
962 specified in the preferences dialog is executed.
964 The current word or selection can be referred with the wildcard "%s"
965 in the command, it will be replaced by the current word or
966 selection before the command is executed.
968 For example a context action can be used to open API documentation
969 in a browser window, the command to open the PHP API documentation
972 firefox "http://www.php.net/%s"
974 when executing the command, the %s is substituted by the word near
975 the cursor position or by the current selection. If the cursor is at
976 the word "echo", a browser window will open(assumed your browser is
977 called firefox) and it will open the address: http://www.php.net/echo.
983 Geany can offer a list of possible completions for symbols defined in the
984 tags and for all words in a document.
986 The autocompletion list for symbols is presented when the first few
987 characters of the symbol are typed (configurable, see `Editor Completions
988 preferences`_, default 4) or when the *Complete word*
989 keybinding is pressed (configurable, see `Editor keybindings`_,
992 When the defined keybinding is typed and the *Autocomplete all words in
993 document* preference (in `Editor Completions preferences`_)
994 is selected then the autocompletion list will show all matching words
995 in the document, if there are no matching symbols.
997 If you don't want to use autocompletion it can be dismissed until
998 the next symbol by pressing Escape. The autocompletion list is updated
999 as more characters are typed so that it only shows completions that start
1000 with the characters typed so far. If no symbols begin with the sequence,
1001 the autocompletion window is closed.
1003 The up and down arrows will move the selected item. The highlighted
1004 item on the autocompletion list can be chosen from the list by pressing
1005 Enter/Return. You can also double-click to select an item. The sequence
1006 will be completed to match the chosen item, and if the *Drop rest of
1007 word on completion* preference is set (in `Editor Completions
1008 preferences`_) then any characters after the cursor that match
1009 a symbol or word are deleted.
1011 Word part completion
1012 ````````````````````
1013 By default, pressing Tab will complete the selected item by word part;
1014 useful e.g. for adding the prefix ``gtk_combo_box_entry_`` without typing it
1019 * gtk_combo_box_<e><TAB>
1020 * gtk_combo_box_entry_<s><ENTER>
1021 * gtk_combo_box_entry_set_text_column
1023 The key combination can be changed from Tab - See `Editor keybindings`_.
1024 If you clear/change the key combination for word part completion, Tab
1025 will complete the whole word instead, like Enter.
1027 Scope autocompletion
1028 ````````````````````
1037 When you type ``foo.`` it will show an autocompletion list with 'i' and
1040 It only works for languages that set parent scope names for e.g. struct
1041 members. Currently this means C-like languages. The C tag parser only
1042 parses global scopes, so this won't work for structs or objects declared
1046 User-definable snippets
1047 ^^^^^^^^^^^^^^^^^^^^^^^
1049 Snippets are small strings or code constructs which can be replaced or
1050 completed to a more complex string. So you can save a lot of time when
1051 typing common strings and letting Geany do the work for you.
1052 To know what to complete or replace Geany reads a configuration file
1053 called ``snippets.conf`` at startup.
1055 Maybe you need to often type your name, so define a snippet like this::
1058 myname=Enrico Tröger
1060 Every time you write ``myname`` <TAB> in Geany, it will replace "myname"
1061 with "Enrico Tröger". The key to start autocompletion can be changed
1062 in the preferences dialog, by default it is TAB. The corresponding keybinding
1063 is called `Complete snippet`.
1067 You can override the default snippets using the user
1068 ``snippets.conf`` file. Use the *Tools->Configuration
1069 Files->snippets.conf* menu item. See also `Configuration file paths`_.
1071 This adds the default settings to the user file if the file doesn't
1072 exist. Alternatively the file can be created manually, adding only
1073 the settings you want to change. All missing settings will be read
1074 from the system snippets file.
1078 The file ``snippets.conf`` contains sections defining snippets that
1079 are available for particular filetypes and in general.
1081 The two sections "Default" and "Special" apply to all filetypes.
1082 "Default" contains all snippets which are available for every
1083 filetype and "Special" contains snippets which can only be used in
1084 other snippets. So you can define often used parts of snippets and
1085 just use the special snippet as a placeholder (see the
1086 ``snippets.conf`` for details).
1088 You can define sections with the name of a filetype eg "C++". The
1089 snippets in that section are only available for use in files with that
1090 filetype. Snippets in filetype sections will hide snippets with the
1091 same name in the "Default" section when used in a file of that
1094 **Substitution sequences for snippets**
1096 To define snippets you can use several special character sequences which
1097 will be replaced when using the snippet:
1099 ================ =========================================================
1100 \\n or %newline% Insert a new line (it will be replaced by the used EOL
1101 char(s): LF, CR/LF, or CR).
1103 \\t or %ws% Insert an indentation step, it will be replaced according
1104 to the current document's indent mode.
1106 \\s \\s to force whitespace at beginning or end of a value
1107 ('key= value' won't work, use 'key=\\svalue')
1109 %cursor% Place the cursor at this position after completion has
1110 been done. You can define multiple %cursor% wildcards
1111 and use the keybinding `Move cursor in snippet` to jump
1112 to the next defined cursor position in the completed
1115 %...% "..." means the name of a key in the "Special" section.
1116 If you have defined a key "brace_open" in the "Special"
1117 section you can use %brace_open% in any other snippet.
1118 ================ =========================================================
1120 Snippet names must not contain spaces otherwise they won't
1121 work correctly. But beside that you can define almost any
1122 string as a snippet and use it later in Geany. It is not limited
1123 to existing contructs of certain programming languages(like ``if``,
1124 ``for``, ``switch``). Define whatever you need.
1126 **Template wildcards**
1128 Since Geany 0.15 you can also use most of the available templates wildcards
1129 listed in `Template wildcards`_. All wildcards which are listed as
1130 `available in snippets` can be used. For instance to improve the above example::
1133 myname=My name is {developer}
1134 mysystem=My system: {command:uname -a}
1136 this will replace ``myname`` with "My name is " and the value of the template
1137 preference ``developer``.
1141 You can change the way Geany recognizes the word to complete,
1142 that is how the start and end of a word is recognised when the
1143 snippet completion is requested. The section "Special" may
1144 contain a key "wordchars" which lists all characters a string may contain
1145 to be recognized as a word for completion. Leave it commented to use
1146 default characters or define it to add or remove characters to fit your
1152 Normally you would type the snippet name and press Tab. However, you
1153 can define keybindings for snippets under the *Keybindings* group in
1158 block_cursor=<Ctrl>8
1161 Snippet keybindings may be overridden by Geany's configurable
1165 Inserting Unicode characters
1166 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1168 You can insert Unicode code points by hitting Ctrl-Shift-u, then still holding
1169 Ctrl-Shift, type some hex digits representing the code point for the character
1170 you want and hit Enter or Return (still holding Ctrl-Shift). If you release
1171 Ctrl-Shift before hitting Enter or Return (or any other character), the code
1172 insertion is completed, but the typed character is also entered. In the case
1173 of Enter/Return, it is a newline, as you might expect.
1176 In some earlier versions of Geany, you might need to first unbind Ctrl-Shift-u
1177 in the `keybinding preferences`_, then select *Tools->Reload Configuration*
1178 or restart Geany. Note that it works slightly differently from other GTK
1179 applications, in that you'll need to continue to hold down the Ctrl and Shift
1180 keys while typing the code point hex digits (and the Enter or Return to finish the code point).
1183 Search, replace and go to
1184 -------------------------
1186 This section describes search-related commands from the Search menu
1187 and the editor window's popup menu:
1194 * Go to tag definition
1195 * Go to tag declaration
1198 See also `Search`_ preferences.
1202 There are also two toolbar entries:
1207 There are keybindings to focus each of these - see `Focus
1208 keybindings`_. Pressing Escape will then focus the editor.
1212 The quickest way to find some text is to use the search bar entry in
1213 the toolbar. This performs a case-insensitive search in the current
1214 document whilst you type. Pressing Enter will search again, and pressing
1215 Shift-Enter will search backwards.
1220 The Find dialog is used for finding text in one or more open documents.
1222 .. image:: ./images/find_dialog.png
1228 The syntax for the *Use regular expressions* option is shown in
1229 `Regular expressions`_.
1232 *Use escape sequences* is implied for regular expressions.
1234 The *Use multi-line matching* option enables multi-line regular
1235 expressions instead of single-line ones. See `Regular expressions`_ for
1236 more details on the differences between the two modes.
1238 The *Use escape sequences* option will transform any escaped characters
1239 into their UTF-8 equivalent. For example, \\t will be transformed into
1240 a tab character. Other recognized symbols are: \\\\, \\n, \\r, \\uXXXX
1241 (Unicode characters).
1247 To find all matches, click on the Find All expander. This will reveal
1254 Find All In Document will show a list of matching lines in the
1255 current document in the Messages tab of the Message Window. *Find All
1256 In Session* does the same for all open documents.
1258 Mark will highlight all matches in the current document with a
1259 colored box. These markers can be removed by selecting the
1260 Remove Markers command from the Document menu.
1263 Change font in search dialog text fields
1264 ````````````````````````````````````````
1266 All search related dialogs use a Monospace for the text input fields to
1267 increase the readability of input text. This is useful when you are
1268 typing input such as regular expressions with spaces, periods and commas which
1269 might it hard to read with a proportional font.
1271 If you want to change the font, you can do this easily
1272 by inserting the following style into your ``.gtkrc-2.0``
1273 (usually found in your home directory on UNIX-like systems and in the
1274 etc subdirectory of your Geany installation on Windows)::
1276 style "search_style"
1278 font_name="Monospace 8"
1280 widget "GeanyDialogSearch.*.GtkEntry" style:highest "search_style"
1282 Please note the addition of ":highest" in the last line which sets the priority
1283 of this style to the highest available. Otherwise, the style is ignored
1284 for the search dialogs.
1289 The *Find Next/Previous Selection* commands perform a search for the
1290 current selected text. If nothing is selected, by default the current
1291 word is used instead. This can be customized by the
1292 *find_selection_type* preference - see `Various preferences`_.
1294 ===== =============================================
1295 Value *find_selection_type* behaviour
1296 ===== =============================================
1297 0 Use the current word (default).
1298 1 Try the X selection first, then current word.
1299 2 Repeat last search.
1300 ===== =============================================
1306 *Find Usage* searches all open files. It is similar to the *Find All In
1307 Session* option in the Find dialog.
1309 If there is a selection, then it is used as the search text; otherwise
1310 the current word is used. The current word is either taken from the
1311 word nearest the edit cursor, or the word underneath the popup menu
1312 click position when the popup menu is used. The search results are
1313 shown in the Messages tab of the Message Window.
1316 You can also use Find Usage for symbol list items from the popup
1323 *Find in Files* is a more powerful version of *Find Usage* that searches
1324 all files in a certain directory using the Grep tool. The Grep tool
1325 must be correctly set in Preferences to the path of the system's Grep
1326 utility. GNU Grep is recommended (see note below).
1328 .. image:: ./images/find_in_files_dialog.png
1330 The *Search* field is initially set to the current word in the editor
1331 (depending on `Search`_ preferences).
1333 The *Files* setting allows to choose which files are included in the
1334 search, depending on the mode:
1337 Search in all files;
1339 Use the current project's patterns, see `Project properties`_;
1341 Use custom patterns.
1343 Both project and custom patterns use a glob-style syntax, each
1344 pattern separated by a space. To search all ``.c`` and ``.h`` files,
1346 Note that an empty pattern list searches in all files rather
1349 The *Directory* field is initially set to the current document's directory,
1350 unless this field has already been edited and the current document has
1351 not changed. Otherwise, the current document's directory is prepended to
1352 the drop-down history. This can be disabled - see `Search`_ preferences.
1354 The *Encoding* field can be used to define the encoding of the files
1355 to be searched. The entered search text is converted to the chosen encoding
1356 and the search results are converted back to UTF-8.
1358 The *Extra options* field is used to pass any additional arguments to
1362 The *Files* setting uses ``--include=`` when searching recursively,
1363 *Recurse in subfolders* uses ``-r``; both are GNU Grep options and may
1364 not work with other Grep implementations.
1367 Filtering out version control files
1368 ```````````````````````````````````
1370 When using the *Recurse in subfolders* option with a directory that's
1371 under version control, you can set the *Extra options* field to filter
1372 out version control files.
1374 If you have GNU Grep >= 2.5.2 you can use the ``--exclude-dir``
1375 argument to filter out CVS and hidden directories like ``.svn``.
1377 Example: ``--exclude-dir=.svn --exclude-dir=CVS``
1379 If you have an older Grep, you can try using the ``--exclude`` flag
1380 to filter out filenames.
1382 SVN Example: ``--exclude=*.svn-base``
1384 The --exclude argument only matches the file name part, not the path.
1390 The Replace dialog is used for replacing text in one or more open
1393 .. image:: ./images/replace_dialog.png
1395 The Replace dialog has the same options for matching text as the Find
1396 dialog. See the section `Matching options`_.
1398 The *Use regular expressions* option allows regular expressions to
1399 be used in the search string and back references in the replacement
1400 text -- see the entry for '\\n' in `Regular expressions`_.
1405 To replace several matches, click on the *Replace All* expander. This
1406 will reveal several options:
1412 *Replace All In Document* will replace all matching text in the
1413 current document. *Replace All In Session* does the same for all open
1414 documents. *Replace All In Selection* will replace all matching text
1415 in the current selection of the current document.
1418 Go to tag definition
1419 ^^^^^^^^^^^^^^^^^^^^
1421 If the current word or selection is the name of a tag definition
1422 (e.g. a function name) and the file containing the tag definition is
1423 open, this command will switch to that file and go to the
1424 corresponding line number. The current word is either the word
1425 nearest the edit cursor, or the word underneath the popup menu click
1426 position when the popup menu is used.
1429 If the corresponding tag is on the current line, Geany will first
1430 look for a tag declaration instead, as this is more useful.
1431 Likewise *Go to tag declaration* will search for a tag definition
1432 first in this case also.
1435 Go to tag declaration
1436 ^^^^^^^^^^^^^^^^^^^^^
1438 Like *Go to tag definition*, but for a forward declaration such as a
1439 C function prototype or ``extern`` declaration instead of a function
1446 Go to a particular line number in the current file.
1452 You can use regular expressions in the Find and Replace dialogs
1453 by selecting the *Use regular expressions* check box (see `Matching
1454 options`_). The syntax is Perl compatible. Basic syntax is described
1455 in the table below. For full details, see
1456 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html.
1458 By default regular expressions are matched on a line-by-line basis.
1459 If you are interested in multi-line regular expressions, matched against
1460 the whole buffer at once, see the section `Multi-line regular expressions`_
1464 1. The *Use escape sequences* dialog option always applies for regular
1466 2. Searching backwards with regular expressions is not supported.
1467 3. The *Use multi-line matching* dialog option to select single or
1468 multi-line matching.
1470 **In a regular expression, the following characters are interpreted:**
1472 ======= ============================================================
1473 . Matches any character.
1475 ( This marks the start of a region for tagging a match.
1477 ) This marks the end of a tagged region.
1479 \\n Where n is 1 through 9 refers to the first through ninth tagged
1480 region when searching or replacing.
1482 Searching for (Wiki)\\1 matches WikiWiki.
1484 If the search string was Fred([1-9])XXX and the
1485 replace string was Sam\\1YYY, when applied to Fred2XXX this
1486 would generate Sam2YYY.
1488 \\0 When replacing, the whole matching text.
1490 \\b This matches a word boundary.
1492 \\c A backslash followed by d, D, s, S, w or W, becomes a
1493 character class (both inside and outside sets []).
1496 * D: any char except decimal digits
1497 * s: whitespace (space, \\t \\n \\r \\f \\v)
1498 * S: any char except whitespace (see above)
1499 * w: alphanumeric & underscore
1500 * W: any char except alphanumeric & underscore
1502 \\x This allows you to use a character x that would otherwise have
1503 a special meaning. For example, \\[ would be interpreted as [
1504 and not as the start of a character set. Use \\\\ for a literal
1507 [...] Matches one of the characters in the set. If the first
1508 character in the set is ^, it matches the characters NOT in
1509 the set, i.e. complements the set. A shorthand S-E (start
1510 dash end) is used to specify a set of characters S up to E,
1513 The special characters ] and - have no special
1514 meaning if they appear first in the set. - can also be last
1515 in the set. To include both, put ] first: []A-Z-].
1519 []|-] matches these 3 chars
1520 []-|] matches from ] to | chars
1521 [a-z] any lowercase alpha
1522 [^]-] any char except - and ]
1523 [^A-Z] any char except uppercase alpha
1526 ^ This matches the start of a line (unless used inside a set, see
1529 $ This matches the end of a line.
1531 \* This matches 0 or more times. For example, Sa*m matches Sm, Sam,
1532 Saam, Saaam and so on.
1534 \+ This matches 1 or more times. For example, Sa+m matches Sam,
1535 Saam, Saaam and so on.
1537 \? This matches 0 or 1 time(s). For example, Joh?n matches John, Jon.
1538 ======= ============================================================
1541 This table is adapted from Scintilla and SciTE documentation,
1542 distributed under the `License for Scintilla and SciTE`_.
1545 Multi-line regular expressions
1546 ``````````````````````````````
1549 The *Use multi-line matching* dialog option enables multi-line
1550 regular expressions.
1552 Multi-line regular expressions work just like single-line ones but a
1553 match can span several lines.
1555 While the syntax is the same, a few practical differences applies:
1557 ======= ============================================================
1558 . Matches any character but newlines. This behavior can be changed
1559 to also match newlines using the (?s) option, see
1560 http://www.geany.org/manual/gtk/glib/glib-regex-syntax.html#idp5671632
1562 [^...] A negative range (see above) *will* match newlines if they are
1563 not explicitly listed in that negative range. For example, range
1564 [^a-z] will match newlines, while range [^a-z\\r\\n] won't.
1565 While this is the expected behavior, it can lead to tricky
1566 problems if one doesn't think about it when writing an expression.
1567 ======= ============================================================
1572 The View menu allows various elements of the main window to be shown
1573 or hidden, and also provides various display-related editor options.
1577 The Color schemes menu is available under the *View->Editor* submenu.
1578 It lists various color schemes for editor highlighting styles,
1579 including the default scheme first. Other items are available based
1580 on what color scheme files Geany found at startup.
1582 Color scheme files are read from the `Configuration file paths`_ under
1583 the ``colorschemes`` subdirectory. They should have the extension
1584 ``.conf``. The default color scheme
1585 is read from ``filetypes.common``.
1587 The `[named_styles] section`_ and `[named_colors] section`_ are the
1588 same as for ``filetypes.common``.
1590 The ``[theme_info]`` section can contain information about the
1591 theme. The ``name`` and ``description`` keys are read to set the
1592 menu item text and tooltip, respectively. These keys can have
1593 translations, e.g.::
1602 Tags are information that relates symbols in a program with the
1603 source file location of the declaration and definition.
1605 Geany has built-in functionality for generating tag information (aka
1606 "workspace tags") for supported filetypes when you open a file. You
1607 can also have Geany automatically load external tag files (aka "global
1608 tags files") upon startup, or manually using *Tools --> Load Tags*.
1610 Geany uses its own tag file format, similar to what ``ctags`` uses
1611 (but is incompatible with ctags). You use Geany to generate global
1612 tags files, as described below.
1618 Tags for each document are parsed whenever a file is loaded, saved or
1619 modified (see *Symbol list update frequency* preference in the `Editor
1620 Completions preferences`_). These are shown in the Symbol list in the
1621 Sidebar. These tags are also used for autocompletion of symbols and calltips
1622 for all documents open in the current session that have the same filetype.
1624 The *Go to Tag* commands can be used with all workspace tags. See
1625 `Go to tag definition`_.
1631 Global tags are used to provide autocompletion of symbols and calltips
1632 without having to open the corresponding source files. This is intended
1633 for library APIs, as the tags file only has to be updated when you upgrade
1636 You can load a custom global tags file in two ways:
1638 * Using the *Load Tags* command in the Tools menu.
1639 * By moving or symlinking tags files to the ``tags`` subdirectory of
1640 one of the `configuration file paths`_ before starting Geany.
1642 You can either download these files or generate your own. They have
1647 *lang_ext* is one of the extensions set for the filetype associated
1648 with the tags. See the section called `Filetype extensions`_ for
1652 Default global tags files
1653 `````````````````````````
1655 For some languages, a list of global tags is loaded when the
1656 corresponding filetype is first used. Currently these are for:
1661 * HTML -- &symbol; completion, e.g. for ampersand, copyright, etc.
1666 Global tags file format
1667 ```````````````````````
1669 Global tags files can have three different formats:
1672 * Pipe-separated format
1675 The first line of global tags files should be a comment, introduced
1676 by ``#`` followed by a space and a string like ``format=pipe``,
1677 ``format=ctags`` or ``format=tagmanager`` respectively, these are
1678 case-sensitive. This helps Geany to read the file properly. If this
1679 line is missing, Geany tries to auto-detect the used format but this
1683 The Tagmanager format is a bit more complex and is used for files
1684 created by the ``geany -g`` command. There is one tag per line.
1685 Different tag attributes like the return value or the argument list
1686 are separated with different characters indicating the type of the
1687 following argument. This is the more complete and recommended tag
1690 Pipe-separated format
1691 *********************
1692 The Pipe-separated format is easier to read and write.
1693 There is one tag per line and different tag attributes are separated
1694 by the pipe character (``|``). A line looks like::
1696 basename|string|(string path [, string suffix])|
1698 | The first field is the tag name (usually a function name).
1699 | The second field is the type of the return value.
1700 | The third field is the argument list for this tag.
1701 | The fourth field is the description for this tag but
1702 currently unused and should be left empty.
1704 Except for the first field (tag name), all other field can be left
1705 empty but the pipe separator must appear for them.
1707 You can easily write your own global tag files using this format.
1708 Just save them in your tags directory, as described earlier in the
1709 section `Global tags`_.
1713 This is the format that ctags generates, and that is used by Vim.
1714 This format is compatible with the format historically used by Vi.
1716 The format is described at http://ctags.sourceforge.net/FORMAT, but
1717 for the full list of existing extensions please refer to ctags.
1718 However, note that Geany may actually only honor a subset of the
1719 existing extensions.
1721 Generating a global tags file
1722 `````````````````````````````
1724 You can generate your own global tags files by parsing a list of
1725 source files. The command is::
1727 geany -g [-P] <Tag File> <File list>
1729 * Tag File filename should be in the format described earlier --
1730 see the section called `Global tags`_.
1731 * File list is a list of filenames, each with a full path (unless
1732 you are generating C/C++ tags and have set the CFLAGS environment
1733 variable appropriately).
1734 * ``-P`` or ``--no-preprocessing`` disables using the C pre-processor
1735 to process ``#include`` directives for C/C++ source files. Use this
1736 option if you want to specify each source file on the command-line
1737 instead of using a 'master' header file. Also can be useful if you
1738 don't want to specify the CFLAGS environment variable.
1740 Example for the wxD library for the D programming language::
1742 geany -g wxd.d.tags /home/username/wxd/wx/*.d
1745 Generating C/C++ tag files
1746 **************************
1747 You may need to first setup the `C ignore.tags`_ file.
1749 For C/C++ tag files gcc is required by default, so that header files
1750 can be preprocessed to include any other headers they depend upon. If
1751 you do not want this, use the ``-P`` option described above.
1753 For preprocessing, the environment variable CFLAGS should be set with
1754 appropriate ``-I/path`` include paths. The following example works with
1755 the bash shell, generating tags for the GnomeUI library::
1757 CFLAGS=`pkg-config --cflags libgnomeui-2.0` geany -g gnomeui.c.tags \
1758 /usr/include/libgnomeui-2.0/gnome.h
1760 You can adapt this command to use CFLAGS and header files appropriate
1761 for whichever libraries you want.
1764 Generating tag files on Windows
1765 *******************************
1766 This works basically the same as on other platforms::
1768 "c:\program files\geany\bin\geany" -g c:\mytags.php.tags c:\code\somefile.php
1774 You can ignore certain tags for C-based languages if they would lead
1775 to wrong parsing of the code. Use the *Tools->Configuration
1776 Files->ignore.tags* menu item to open the user ``ignore.tags`` file.
1777 See also `Configuration file paths`_.
1779 List all tag names you want to ignore in this file, separated by spaces
1784 G_GNUC_NULL_TERMINATED
1786 G_GNUC_WARN_UNUSED_RESULT
1788 This will parse code like:
1790 ``gchar **utils_strv_new(const gchar *first, ...)
1791 G_GNUC_NULL_TERMINATED;``
1793 More detailed information about ignore tags usage from the Exuberant Ctags
1796 Specifies a list of identifiers which are to be specially handled
1797 while parsing C and C++ source files. This option is specifically
1798 provided to handle special cases arising through the use of
1799 pre-processor macros. When the identifiers listed are simple identifiers,
1800 these identifiers will be ignored during parsing of the source files.
1801 If an identifier is suffixed with a '+' character, ctags will also
1802 ignore any parenthesis-enclosed argument list which may immediately
1803 follow the identifier in the source files.
1804 If two identifiers are separated with the '=' character, the first
1805 identifiers is replaced by the second identifiers for parsing purposes.
1807 For even more detailed information please read the manual page of
1810 Geany extends Ctags with a '*' character suffix - this means use
1811 prefix matching, e.g. G_GNUC_* will match G_GNUC_NULL_TERMINATED, etc.
1812 Note that prefix match items should be put after other items to ensure
1813 that items like G_GNUC_PRINTF+ get parsed correctly.
1819 You may adjust Geany's settings using the Edit --> Preferences
1820 dialog. Any changes you make there can be applied by hitting either
1821 the Apply or the OK button. These settings will persist between Geany
1822 sessions. Note that most settings here have descriptive popup bubble
1823 help -- just hover the mouse over the item in question to get help
1826 You may also adjust some View settings (under the View menu) that
1827 persist between Geany sessions. The settings under the Document menu,
1828 however, are only for the current document and revert to defaults
1829 when restarting Geany.
1832 In the paragraphs that follow, the text describing a dialog tab
1833 comes after the screenshot of that tab.
1836 General Startup preferences
1837 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1839 .. image:: ./images/pref_dialog_gen_startup.png
1844 Load files from the last session
1845 On startup, load the same files you had open the last time you
1848 Load virtual terminal support
1849 Load the library for running a terminal in the message window area.
1851 Enable plugin support
1852 Allow plugins to be used in Geany.
1856 Save window position and geometry
1857 Save the current position and size of the main window so next time
1858 you open Geany it's in the same location.
1861 Have a dialog pop up to confirm that you really want to quit Geany.
1867 Path to start in when opening or saving files.
1868 It must be an absolute path.
1871 Path to start in when opening project files.
1874 By default Geany looks in the system installation and the user
1875 configuration - see `Plugins`_. In addition the path entered here will be
1877 Usually you do not need to set an additional path to search for
1878 plugins. It might be useful when Geany is installed on a multi-user machine
1879 and additional plugins are available in a common location for all users.
1880 Leave blank to not set an additional lookup path.
1883 General Miscellaneous preferences
1884 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1886 .. image:: ./images/pref_dialog_gen_misc.png
1891 Beep on errors when compilation has finished
1892 Have the computer make a beeping sound when compilation of your program
1893 has completed or any errors occurred.
1895 Switch status message list at new message
1896 Switch to the status message tab (in the notebook window at the bottom)
1897 once a new status message arrives.
1899 Suppress status messages in the status bar
1900 Remove all messages from the status bar. The messages are still displayed
1901 in the status messages window.
1904 Another option is to use the *Switch to Editor* keybinding - it
1905 reshows the document statistics on the status bar. See `Focus
1908 Use Windows File Open/Save dialogs
1909 Defines whether to use the native Windows File Open/Save dialogs or
1910 whether to use the GTK default dialogs.
1912 Auto-focus widgets (focus follows mouse)
1913 Give the focus automatically to widgets below the mouse cursor.
1914 This works for the main editor widget, the scribble, the toolbar search field
1915 goto line fields and the VTE.
1921 Always wrap search around the document when finding a match.
1923 Hide the Find dialog
1924 Hide the `Find`_ dialog after clicking Find Next/Previous.
1926 Use the current word under the cursor for Find dialogs
1927 Use current word under the cursor when opening the Find, Find in Files or Replace dialog and
1928 there is no selection. When this option is disabled, the search term last used in the
1929 appropriate Find dialog is used.
1931 Use the current file's directory for Find in Files
1932 When opening the Find in Files dialog, set the directory to search to the directory of the current
1933 active file. When this option is disabled, the directory of the last use of the Find in Files
1934 dialog is used. See `Find in Files`_ for details.
1939 Use project-based session files
1940 Save your current session when closing projects. You will be able to
1941 resume different project sessions, automatically opening the files
1942 you had open previously.
1944 Store project file inside the project base directory
1945 When creating new projects, the default path for the project file contains
1946 the project base path. Without this option enabled, the default project file
1947 path is one level above the project base path.
1948 In either case, you can easily set the final project file path in the
1949 *New Project* dialog. This option provides the more common
1950 defaults automatically for convenience.
1953 Interface preferences
1954 ^^^^^^^^^^^^^^^^^^^^^
1956 .. image:: ./images/pref_dialog_interface_interface.png
1962 Whether to show the sidebar at all.
1965 Show the list of functions, variables, and other information in the
1966 current document you are editing.
1969 Show all the documents you have open currently. This can be used to
1970 change between documents (see `Switching between documents`_) and
1971 to perform some common operations such as saving, closing and reloading.
1974 Whether to place the sidebar on the left or right of the editor window.
1980 Change the font used to display documents.
1983 Change the font used for the Symbols sidebar tab.
1986 Change the font used for the message window area.
1992 Show the status bar at the bottom of the main window. It gives information about
1993 the file you are editing like the line and column you are on, whether any
1994 modifications were done, the file encoding, the filetype and other information.
1996 Interface Notebook tab preferences
1997 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1999 .. image:: ./images/pref_dialog_interface_notebook.png
2005 Show a notebook tab for all documents so you can switch between them
2006 using the mouse (instead of using the Documents window).
2009 Make each tab show a close button so you can easily close open
2012 Placement of new file tabs
2013 Whether to create a document with its notebook tab to the left or
2014 right of all existing tabs.
2017 Whether to place file tabs next to the current tab
2018 rather than at the edges of the notebook.
2020 Double-clicking hides all additional widgets
2021 Whether to call the View->Toggle All Additional Widgets command
2022 when double-clicking on a notebook tab.
2028 Set the positioning of the editor's notebook tabs to the right,
2029 left, top, or bottom of the editing window.
2032 Set the positioning of the sidebar's notebook tabs to the right,
2033 left, top, or bottom of the sidebar window.
2036 Set the positioning of the message window's notebook tabs to the
2037 right, left, top, or bottom of the message window.
2040 Interface Toolbar preferences
2041 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2043 Affects the main toolbar underneath the menu bar.
2045 .. image:: ./images/pref_dialog_interface_toolbar.png
2051 Whether to show the toolbar.
2053 Append Toolbar to the Menu
2054 Allows to append the toolbar to the main menu bar instead of placing it below.
2055 This is useful to save vertical space.
2058 See `Customizing the toolbar`_.
2064 Select the toolbar icon style to use - either icons and text, just
2066 The choice System default uses whatever icon style is set by GTK.
2069 Select the size of the icons you see (large, small or very small).
2070 The choice System default uses whatever icon size is set by GTK.
2073 Editor Features preferences
2074 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2076 .. image:: ./images/pref_dialog_edit_features.png
2082 Show long lines wrapped around to new display lines.
2087 Whether to move the cursor to the first non-whitespace character
2088 on the line when you hit the home key on your keyboard. Pressing it
2089 again will go to the very start of the line.
2091 Disable Drag and Drop
2092 Do not allow the dragging and dropping of selected text in documents.
2095 Allow groups of lines in a document to be collapsed for easier
2098 Fold/Unfold all children of a fold point
2099 Whether to fold/unfold all child fold points when a parent line
2102 Use indicators to show compile errors
2103 Underline lines with compile errors using red squiggles to indicate
2104 them in the editor area.
2106 Newline strips trailing spaces
2107 Remove any whitespace at the end of the line when you hit the
2108 Enter/Return key. See also `Strip trailing spaces`_. Note
2109 auto indentation is calculated before stripping, so although this
2110 setting will clear a blank line, it will not set the next line
2111 indentation back to zero.
2113 Line breaking column
2114 The editor column number to insert a newline at when Line Breaking
2115 is enabled for the current document.
2117 Comment toggle marker
2118 A string which is added when toggling a line comment in a source file.
2119 It is used to mark the comment as toggled.
2122 Editor Indentation preferences
2123 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2125 .. image:: ./images/pref_dialog_edit_indentation.png
2130 See `Indentation`_ for more information.
2133 The width of a single indent size in spaces. By default the indent
2134 size is equivalent to 4 spaces.
2136 Detect width from file
2137 Try to detect and set the indent width based on file content, when
2141 When Geany inserts indentation, whether to use:
2145 * Tabs and Spaces, depending on how much indentation is on a line
2147 The *Tabs and Spaces* indent type is also known as *Soft tab
2148 support* in some other editors.
2150 Detect type from file
2151 Try to detect and set the indent type based on file content, when
2155 The type of auto-indentation you wish to use after pressing Enter,
2159 Just add the indentation of the previous line.
2161 Add indentation based on the current filetype and any characters at
2162 the end of the line such as ``{``, ``}`` for C, ``:`` for Python.
2164 Like *Current chars* but for C-like languages, make a closing
2165 ``}`` brace line up with the matching opening brace.
2168 If set, pressing tab will indent the current line or selection, and
2169 unindent when pressing Shift-tab. Otherwise, the tab key will
2170 insert a tab character into the document (which can be different
2171 from indentation, depending on the indent type).
2174 There are also separate configurable keybindings for indent &
2175 unindent, but this preference allows the tab key to have different
2176 meanings in different contexts - e.g. for snippet completion.
2178 Editor Completions preferences
2179 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2181 .. image:: ./images/pref_dialog_edit_completions.png
2187 Whether to replace special keywords after typing Tab into a
2188 pre-defined text snippet.
2189 See `User-definable snippets`_.
2191 XML/HTML tag auto-closing
2192 When you open an XML/HTML tag automatically generate its
2195 Automatic continuation multi-line comments
2196 Continue automatically multi-line comments in languages like C, C++
2197 and Java when a new line is entered inside such a comment.
2198 With this option enabled, Geany will insert a ``*`` on every new line
2199 inside a multi-line comment, for example when you press return in the
2203 * This is a C multi-line comment, press <Return>
2205 then Geany would insert::
2209 on the next line with the correct indentation based on the previous line,
2210 as long as the multi-line is not closed by ``*/``.
2212 Autocomplete symbols
2213 When you start to type a symbol name, look for the full string to
2214 allow it to be completed for you.
2216 Autocomplete all words in document
2217 When you start to type a word, Geany will search the whole document for
2218 words starting with the typed part to complete it, assuming there
2219 are no tag names to show.
2221 Drop rest of word on completion
2222 Remove any word part to the right of the cursor when choosing a
2223 completion list item.
2225 Characters to type for autocompletion
2226 Number of characters of a word to type before autocompletion is
2229 Completion list height
2230 The number of rows to display for the autocompletion window.
2232 Max. symbol name suggestions
2233 The maximum number of items in the autocompletion list.
2235 Symbol list update frequency
2236 The minimum delay (in milliseconds) between two symbol list updates.
2238 This option determines how frequently the tag list is updated for the
2239 current document. The smaller the delay, the more up-to-date the symbol
2240 list (and then the completions); but rebuilding the symbol list has a
2241 cost in performance, especially with large files.
2243 The default value is 250ms, which means the symbol list will be updated
2244 at most four times per second, even if the document changes continuously.
2246 A value of 0 disables automatic updates, so the symbol list will only be
2247 updated upon document saving.
2250 Auto-close quotes and brackets
2251 ``````````````````````````````
2253 Geany can automatically insert a closing bracket and quote characters when
2254 you open them. For instance, you type a ``(`` and Geany will automatically
2255 insert ``)``. With the following options, you can define for which
2256 characters this should work.
2259 Auto-close parenthesis when typing an opening one
2262 Auto-close curly brackets (braces) when typing an opening one
2265 Auto-close square brackets when typing an opening one
2268 Auto-close single quotes when typing an opening one
2271 Auto-close double quotes when typing an opening one
2274 Editor Display preferences
2275 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2277 This is for visual elements displayed in the editor window.
2279 .. image:: ./images/pref_dialog_edit_display.png
2284 Invert syntax highlighting colors
2285 Invert all colors, by default this makes white text on a black
2288 Show indendation guides
2289 Show vertical lines to help show how much leading indentation there
2293 Mark all tabs with an arrow "-->" symbol and spaces with dots to
2294 show which kinds of whitespace are used.
2297 Display a symbol everywhere that a carriage return or line feed
2301 Show or hide the Line Number margin.
2304 Show or hide the small margin right of the line numbers, which is used
2307 Stop scrolling at last line
2308 When enabled Geany stops scrolling when at the last line of the document.
2309 Otherwise you can scroll one more page even if there are no real lines.
2315 The long line marker helps to indicate overly-long lines, or as a hint
2316 to the user for when to break the line.
2320 Show a thin vertical line in the editor window at the given column
2323 Change the background color of characters after the given column
2324 position to the color set below. (This is recommended over the
2325 *Line* setting if you use proportional fonts).
2327 Don't mark long lines at all.
2330 Set this value to a value greater than zero to specify the column
2331 where it should appear.
2333 Long line marker color
2334 Set the color of the long line marker.
2340 Virtual space is space beyond the end of each line.
2341 The cursor may be moved into virtual space but no real space will be
2342 added to the document until there is some text typed or some other
2343 text insertion command is used.
2346 Do not show virtual spaces
2348 Only for rectangular selections
2349 Only show virtual spaces beyond the end of lines when drawing a rectangular selection
2352 Always show virtual spaces beyond the end of lines
2358 .. image:: ./images/pref_dialog_files.png
2363 Open new documents from the command-line
2364 Whether to create new documents when passing filenames that don't
2365 exist from the command-line.
2367 Default encoding (new files)
2368 The type of file encoding you wish to use when creating files.
2370 Used fixed encoding when opening files
2371 Assume all files you are opening are using the type of encoding specified below.
2373 Default encoding (existing files)
2374 Opens all files with the specified encoding instead of auto-detecting it.
2375 Use this option when it's not possible for Geany to detect the exact encoding.
2377 Default end of line characters
2378 The end of line characters to which should be used for new files.
2379 On Windows systems, you generally want to use CR/LF which are the common
2380 characters to mark line breaks.
2381 On Unix-like systems, LF is default and CR is used on MAC systems.
2385 Perform formatting operations when a document is saved. These
2386 can each be undone with the Undo command.
2388 Ensure newline at file end
2389 Add a newline at the end of the document if one is missing.
2391 Ensure consistent line endings
2392 Ensures that newline characters always get converted before
2393 saving, avoiding mixed line endings in the same file.
2395 .. _Strip trailing spaces:
2397 Strip trailing spaces
2398 Remove any whitespace at the end of each document line.
2401 This does not apply to Diff documents, e.g. patch files.
2403 Replace tabs with spaces
2404 Replace all tabs in the document with the equivalent number of spaces.
2407 It is better to use spaces to indent than use this preference - see
2413 Recent files list length
2414 The number of files to remember in the recently used files list.
2417 The number of seconds to periodically check the current document's
2418 file on disk in case it has changed. Setting it to 0 will disable
2422 These checks are only performed on local files. Remote files are
2423 not checked for changes due to performance issues
2424 (remote files are files in ``~/.gvfs/``).
2430 .. image:: ./images/pref_dialog_tools.png
2436 The command to execute a script in a terminal. Occurrences of %c
2437 in the command are substituted with the run script name, see
2438 `Terminal emulators`_.
2441 The location of your web browser executable.
2444 The location of the grep executable.
2447 For Windows users: at the time of writing it is recommended to use
2448 the grep.exe from the UnxUtils project
2449 (http://sourceforge.net/projects/unxutils). The grep.exe from the
2450 Mingw project for instance might not work with Geany at the moment.
2456 Set this to a command to execute on the current word.
2457 You can use the "%s" wildcard to pass the current word below the cursor
2458 to the specified command.
2461 Template preferences
2462 ^^^^^^^^^^^^^^^^^^^^
2464 This data is used as meta data for various template text to insert into
2465 a document, such as the file header. You only need to set fields that
2466 you want to use in your template files.
2468 .. image:: ./images/pref_dialog_templ.png
2474 The name of the developer who will be creating files.
2477 The initials of the developer.
2480 The email address of the developer.
2483 You may wish to add anti-spam markup, e.g. ``name<at>site<dot>ext``.
2486 The company the developer is working for.
2489 The initial version of files you will be creating.
2492 Specify a format for the {year} wildcard. You can use any conversion specifiers
2493 which can be used with the ANSI C strftime function. For details please see
2494 http://man.cx/strftime.
2497 Specify a format for the {date} wildcard. You can use any conversion specifiers
2498 which can be used with the ANSI C strftime function. For details please see
2499 http://man.cx/strftime.
2502 Specify a format for the {datetime} wildcard. You can use any conversion specifiers
2503 which can be used with the ANSI C strftime function. For details please see
2504 http://man.cx/strftime.
2507 Keybinding preferences
2508 ^^^^^^^^^^^^^^^^^^^^^^
2510 .. image:: ./images/pref_dialog_keys.png
2512 There are some commands listed in the keybinding dialog that are not, by default,
2513 bound to a key combination, and may not be available as a menu item.
2516 For more information see the section `Keybindings`_.
2519 Printing preferences
2520 ^^^^^^^^^^^^^^^^^^^^
2522 .. image:: ./images/pref_dialog_printing.png
2524 Use external command for printing
2525 Use a system command to print your file out.
2527 Use native GTK printing
2528 Let the GTK GUI toolkit handle your print request.
2531 Print the line numbers on the left of your paper.
2534 Print the page number on the bottom right of your paper.
2537 Print a header on every page that is sent to the printer.
2539 Use base name of the printed file
2540 Don't use the entire path for the header, only the filename.
2543 How the date should be printed. You can use the same format
2544 specifiers as in the ANSI C function strftime(). For details please
2545 see http://man.cx/strftime.
2551 .. image:: ./images/pref_dialog_various.png
2553 Rarely used preferences, explained in the table below. A few of them require
2554 restart to take effect, and a few other will only affect newly opened or created
2555 documents before restart.
2557 ================================ =========================================== ========== ===========
2558 Key Description Default Applies
2559 ================================ =========================================== ========== ===========
2561 use_gtk_word_boundaries Whether to look for the end of a word true to new
2562 when using word-boundary related documents
2563 Scintilla commands (see `Scintilla
2564 keyboard commands`_).
2565 brace_match_ltgt Whether to highlight <, > angle brackets. false immediately
2566 complete_snippets_whilst_editing Whether to allow completion of snippets false immediately
2567 when editing an existing line (i.e. there
2568 is some text after the current cursor
2569 position on the line). Only used when the
2570 keybinding `Complete snippet` is set to
2572 show_editor_scrollbars Whether to display scrollbars. If set to true immediately
2573 false, the horizontal and vertical
2574 scrollbars are hidden completely.
2575 indent_hard_tab_width The size of a tab character. Don't change 8 immediately
2576 it unless you really need to; use the
2577 indentation settings instead.
2578 **Interface related**
2579 show_symbol_list_expanders Whether to show or hide the small true to new
2580 expander icons on the symbol list documents
2582 allow_always_save Whether files can be saved always, even false immediately
2583 if they don't have any changes.
2584 By default, the Save button and menu
2585 item are disabled when a file is
2586 unchanged. When setting this option to
2587 true, the Save button and menu item are
2588 always active and files can be saved.
2589 compiler_tab_autoscroll Whether to automatically scroll to the true immediately
2590 last line of the output in the Compiler
2592 statusbar_template The status bar statistics line format. See below. immediately
2593 (See `Statusbar Templates`_ for details).
2594 new_document_after_close Whether to open a new document after all false immediately
2595 documents have been closed.
2596 msgwin_status_visible Whether to show the Status tab in the true immediately
2598 msgwin_compiler_visible Whether to show the Compiler tab in the true immediately
2600 msgwin_messages_visible Whether to show the Messages tab in the true immediately
2602 msgwin_scribble_visible Whether to show the Scribble tab in the true immediately
2605 emulation Terminal emulation mode. Only change this xterm immediately
2606 if you have VTE termcap files other than
2607 ``vte/termcap/xterm``.
2608 send_selection_unsafe By default, Geany strips any trailing false immediately
2609 newline characters from the current
2610 selection before sending it to the terminal
2611 to not execute arbitrary code. This is
2612 mainly a security feature.
2613 If, for whatever reasons, you really want
2614 it to be executed directly, set this option
2616 send_cmd_prefix String with which prefix the commands sent Empty immediately
2617 to the shell. This may be used to tell
2618 some shells (BASH with ``HISTCONTROL`` set
2619 to ``ignorespace``, ZSH with
2620 ``HIST_IGNORE_SPACE`` enabled, etc.) from
2621 putting these commands in their history by
2622 setting this to a space. Note that leading
2623 spaces must be escaped using `\s` in the
2626 use_atomic_file_saving Defines the mode how Geany saves files to false immediately
2627 disk. If disabled, Geany directly writes
2628 the content of the document to disk. This
2629 might cause loss of data when there is
2630 no more free space on disk to save the
2631 file. When set to true, Geany first saves
2632 the contents into a temporary file and if
2633 this succeeded, the temporary file is
2634 moved to the real file to save.
2635 This gives better error checking in case of
2636 no more free disk space. But it also
2637 destroys hard links of the original file
2638 and its permissions (e.g. executable flags
2639 are reset). Use this with care as it can
2640 break things seriously.
2641 The better approach would be to ensure your
2642 disk won't run out of free space.
2643 use_gio_unsafe_file_saving Whether to use GIO as the unsafe file true immediately
2644 saving backend. It is better on most
2645 situations but is known not to work
2646 correctly on some complex setups.
2647 gio_unsafe_save_backup Make a backup when using GIO unsafe file false immediately
2648 saving. Backup is named `filename~`.
2649 **Filetype related**
2650 extract_filetype_regex Regex to extract filetype name from file See below. immediately
2651 via capture group one.
2653 find_selection_type See `Find selection`_. 0 immediately
2655 replace_and_find_by_default Set ``Replace & Find`` button as default so true immediately
2656 it will be activated when the Enter key is
2657 pressed while one of the text fields has
2659 **Build Menu related**
2660 number_ft_menu_items The maximum number of menu items in the 2 on restart
2661 filetype section of the Build menu.
2662 number_non_ft_menu_items The maximum number of menu items in the 3 on restart
2663 independent section of the Build menu.
2664 number_exec_menu_items The maximum number of menu items in the 2 on restart
2665 execute section of the Build menu.
2666 ================================ =========================================== ========== ===========
2668 The extract_filetype_regex has the default value GEANY_DEFAULT_FILETYPE_REGEX.
2673 The default statusbar template is (note ``\t`` = tab):
2675 ``line: %l / %L\t col: %c\t sel: %s\t %w %t %mmode: %M encoding: %e filetype: %f scope: %S``
2677 Settings the preference to an empty string will also cause Geany to use this
2680 The following format characters are available for the statusbar template:
2682 ============ ===========================================================
2683 Placeholder Description
2684 ============ ===========================================================
2685 ``%l`` The current line number starting at 1
2686 ``%L`` The total number of lines
2687 ``%c`` The current column number starting at 0
2688 ``%C`` The current column number starting at 1
2689 ``%s`` The number of selected characters or if only whole lines
2690 selected, the number of selected lines.
2691 ``%w`` Shows ``RO`` when the document is in read-only mode,
2692 otherwise shows whether the editor is in overtype (OVR)
2693 or insert (INS) mode.
2694 ``%t`` Shows the indentation mode, either tabs (TAB),
2695 spaces (SP) or both (T/S).
2696 ``%m`` Shows whether the document is modified (MOD) or nothing.
2697 ``%M`` The name of the document's line-endings (ex. ``Unix (LF)``)
2698 ``%e`` The name of the document's encoding (ex. UTF-8).
2699 ``%f`` The filetype of the document (ex. None, Python, C, etc).
2700 ``%S`` The name of the scope where the caret is located.
2701 ``%p`` The caret position in the entire document starting at 0.
2702 ``%r`` Shows whether the document is read-only (RO) or nothing.
2703 ``%Y`` The Scintilla style number at the caret position. This is
2704 useful if you're debugging color schemes or related code.
2705 ============ ===========================================================
2707 Terminal (VTE) preferences
2708 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2710 See also: `Virtual terminal emulator widget (VTE)`_.
2712 .. image:: ./images/pref_dialog_vte.png
2718 Select the font that will be used in the terminal emulation control.
2721 Select the font color.
2724 Select the background color of the terminal.
2727 Select the background image to show behind the terminal's text.
2730 The number of lines buffered so that you can scroll though the history.
2733 The location of the shell on your system.
2736 Scroll the terminal to the prompt line when pressing a key.
2739 Scroll the output down.
2742 Let the terminal cursor blink.
2744 Override Geany keybindings
2745 Allow the VTE to receive keyboard shortcuts (apart from focus commands).
2747 Disable menu shortcut key (F10 by default)
2748 Disable the menu shortcut when you are in the virtual terminal.
2750 Follow path of the current file
2751 Make the path of the terminal change according to the path of the
2754 Execute programs in VTE
2755 Execute programs in the virtual terminal instead of using the external
2756 terminal tool. Note that if you run multiple execute commands at once
2757 the output may become mixed together in the VTE.
2759 Don't use run script
2760 Don't use the simple run script which is usually used to display
2761 the exit status of the executed program.
2762 This can be useful if you already have a program running in the VTE
2763 like a Python console (e.g. ipython). Use this with care.
2769 Project management is optional in Geany. Currently it can be used for:
2771 * Storing and opening session files on a project basis.
2772 * Overriding default settings with project equivalents.
2773 * Configuring the Build menu on a project basis.
2775 A list of session files can be stored and opened with the project
2776 when the *Use project-based session files* preference is enabled,
2777 in the `Projects`_ group of the `General Miscellaneous preferences`_ tab
2778 of the `Preferences`_ dialog.
2780 As long as a project is open, the Build menu will use
2781 the items defined in project's settings, instead of the defaults.
2782 See `Build Menu Configuration`_ for information on configuring the menu.
2784 The current project's settings are saved when it is closed, or when
2785 Geany is shutdown. When restarting Geany, the previously opened project
2786 file that was in use at the end of the last session will be reopened.
2788 The project menu items are detailed below.
2794 To create a new project, fill in the *Name* field. By default this
2795 will setup a new project file ``~/projects/name.geany``. Usually it's
2796 best to store all your project files in the same directory (they are
2797 independent of any source directory trees).
2799 The Base path text field is setup to use ``~/projects/name``. This
2800 can safely be set to any existing path -- it will not touch the file
2801 structure contained in it.
2807 You can set an optional description for the project. Currently it's
2808 only used for a template wildcard - see `Template wildcards`_.
2810 The *Base path* field is used as the directory to run the Build menu commands.
2811 The specified path can be an absolute path or it is considered to be
2812 relative to the project's file name.
2814 The *File patterns* field allows to specify a list of file patterns for the
2815 project, which can be used in the `Find in files`_ dialog.
2817 The *Indentation* tab allows you to override the default
2818 `Indentation`_ settings.
2824 The Open command displays a standard file chooser, starting in
2825 ``~/projects``. Choose a project file named with the ``.geany``
2828 When project session support is enabled, Geany will close the currently
2829 open files and open the session files associated with the project.
2835 Project file settings are saved when the project is closed.
2837 When project session support is enabled, Geany will close the project
2838 session files and open any previously closed default session files.
2843 After editing code with Geany, the next step is to compile, link, build,
2844 interpret, run etc. As Geany supports many languages each with a different
2845 approach to such operations, and as there are also many language independent
2846 software building systems, Geany does not have a built-in build system, nor
2847 does it limit which system you can use. Instead the build menu provides
2848 a configurable and flexible means of running any external commands to
2849 execute your preferred build system.
2851 This section provides a description of the default configuration of the
2852 build menu and then covers how to configure it, and where the defaults fit in.
2854 Running the commands from within Geany has two benefits:
2856 * The current file is automatically saved before the command is run.
2857 * The output is captured in the Compiler notebook tab and parsed for
2860 Warnings and errors that can be parsed for line numbers will be shown in
2861 red in the Compiler tab and you can click on them to switch to the relevant
2862 source file (or open it) and mark the line number. Also lines with
2863 warnings or errors are marked in the source, see `Indicators`_ below.
2866 If Geany's default error message parsing does not parse errors for
2867 the tool you're using, you can set a custom regex in the Build Commands
2868 Dialog, see `Build Menu Configuration`_.
2873 Indicators are red squiggly underlines which are used to highlight
2874 errors which occurred while compiling the current file. So you can
2875 easily see where your code failed to compile. You can remove them by
2876 selecting *Remove Error Indicators* in the Document menu.
2878 If you do not like this feature, you can disable it - see `Editor Features
2882 Default build menu items
2883 ^^^^^^^^^^^^^^^^^^^^^^^^
2884 Depending on the current file's filetype, the default Build menu will contain
2885 the following items:
2891 * Make Custom Target
2896 * Set Build Menu Commands
2902 The Compile command has different uses for different kinds of files.
2904 For compilable languages such as C and C++, the Compile command is
2905 set up to compile the current source file into a binary object file.
2907 Java source files will be compiled to class file bytecode.
2909 Interpreted languages such as Perl, Python, Ruby will compile to
2910 bytecode if the language supports it, or will run a syntax check,
2911 or if that is not available will run the file in its language interpreter.
2916 For compilable languages such as C and C++, the Build command will link
2917 the current source file's equivalent object file into an executable. If
2918 the object file does not exist, the source will be compiled and linked
2919 in one step, producing just the executable binary.
2921 Interpreted languages do not use the Build command.
2924 If you need complex settings for your build system, or several
2925 different settings, then writing a Makefile and using the Make
2926 commands is recommended; this will also make it easier for users to
2927 build your software.
2932 Source code linters are often used to find code that doesn't correspond to
2933 certain style guidelines: non-portable code, common or hard to find
2934 errors, code "smells", variables used before being set, unused functions,
2935 division by zero, constant conditions, etc. Linters inspect the code and
2936 issue warnings much like the compilers do. This is formally referred to as
2937 static code analysis.
2939 Some common linters are pre-configured for you in the Build menu (``pep8``
2940 for Python, ``cppcheck`` for C/C++, JSHint for JavaScript, ``xmllint`` for
2941 XML, ``hlint`` for Haskell, ``shellcheck`` for shell code, ...), but all
2942 these are standalone tools you need to obtain before using.
2947 This runs "make" in the same directory as the
2953 This is similar to running 'Make' but you will be prompted for
2954 the make target name to be passed to the Make tool. For example,
2955 typing 'clean' in the dialog prompt will run "make clean".
2961 Make object will run "make current_file.o" in the same directory as
2962 the current file, using the filename for 'current_file'. It is useful
2963 for building just the current file without building the whole project.
2968 The next error item will move to the next detected error in the file.
2972 The previous error item will move to the previous detected error in the file.
2977 Execute will run the corresponding executable file, shell script or
2978 interpreted script in a terminal window. The command set in the
2979 "Set Build Commands" dialog is run in a script to ensure the terminal
2980 stays open after execution completes. Note: see `Terminal emulators`_
2981 below for the command format. Alternatively the built-in VTE can be used
2982 if it is available - see `Virtual terminal emulator widget (VTE)`_.
2984 After your program or script has finished executing, the run script will
2985 prompt you to press the return key. This allows you to review any text
2986 output from the program before the terminal window is closed.
2989 The execute command output is not parsed for errors.
2992 Stopping running processes
2993 ``````````````````````````
2995 When there is a running program, the Execute menu item in the menu and
2996 the Run button in the toolbar
2997 each become a stop button so you can stop the current running program (and
2998 any child processes). This works by sending the SIGQUIT signal to the process.
3000 Depending on the process you started it is possible that the process
3001 cannot be stopped. For example this can happen when the process creates
3002 more than one child process.
3008 The Terminal field of the tools preferences tab requires a command to
3009 execute the terminal program and to pass it the name of the Geany run
3010 script that it should execute in a Bourne compatible shell (eg /bin/sh).
3011 The marker "%c" is substituted with the name of the Geany run script,
3012 which is created in the working directory set in the Build commands
3013 dialog, see `Build menu commands dialog`_ for details.
3015 As an example the default (Linux) command is::
3017 xterm -e "/bin/sh %c"
3023 By default Compile, Build and Execute are fairly basic commands. You
3024 may wish to customise them using *Set Build Commands*.
3026 E.g. for C you can add any include paths and compile flags for the
3027 compiler, any library names and paths for the linker, and any
3028 arguments you want to use when running Execute.
3030 Build menu configuration
3031 ^^^^^^^^^^^^^^^^^^^^^^^^
3033 The build menu has considerable flexibility and configurability, allowing
3034 both menu labels the commands they execute and the directory they execute
3035 in to be configured.
3037 For example, if you change one of the default make commands to run say 'waf'
3038 you can also change the label to match.
3040 These settings are saved automatically when Geany is shut down.
3042 The build menu is divided into four groups of items each with different
3045 * Filetype build commands - are configurable and depend on the filetype of the
3046 current document; they capture output in the compiler tab and parse it for
3048 * Independent build commands - are configurable and mostly don't depend on the
3049 filetype of the current document; they also capture output in the
3050 compiler tab and parse it for errors.
3051 * Execute commands - are configurable and intended for executing your
3052 program or other long running programs. The output is not parsed for errors
3053 and is directed to the terminal command selected in preferences.
3054 * Fixed commands - these perform built-in actions:
3056 * Go to the next error.
3057 * Go to the previous error.
3058 * Show the build menu commands dialog.
3060 The maximum numbers of items in each of the configurable groups can be
3061 configured in the `Various preferences`_. Even though the maximum number of
3062 items may have been increased, only those menu items that have values
3063 configured are shown in the menu.
3065 The groups of menu items obtain their configuration from four potential
3066 sources. The highest priority source that has the menu item defined will
3067 be used. The sources in decreasing priority are:
3069 * A project file if open
3070 * The user preferences
3071 * The system filetype definitions
3074 The detailed relationships between sources and the configurable menu item groups
3075 is shown in the following table.
3077 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3078 | Group | Project File | Preferences | System Filetype | Defaults |
3079 +==============+=====================+==========================+===================+===============================+
3080 | Filetype | Loads From: project | Loads From: | Loads From: | None |
3081 | | file | filetypes.xxx file in | filetypes.xxx in | |
3082 | | | ~/.config/geany/filedefs | Geany install | |
3083 | | Saves To: project | | | |
3084 | | file | Saves to: as above, | Saves to: as user | |
3085 | | | creating if needed. | preferences left. | |
3086 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3087 | Filetype | Loads From: project | Loads From: | Loads From: | 1: |
3088 | Independent | file | geany.conf file in | filetypes.xxx in | Label: _Make |
3089 | | | ~/.config/geany | Geany install | Command: make |
3090 | | Saves To: project | | | |
3091 | | file | Saves to: as above, | Saves to: as user | 2: |
3092 | | | creating if needed. | preferences left. | Label: Make Custom _Target |
3093 | | | | | Command: make |
3096 | | | | | Label: Make _Object |
3097 | | | | | Command: make %e.o |
3098 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3099 | Execute | Loads From: project | Loads From: | Loads From: | Label: _Execute |
3100 | | file or else | geany.conf file in | filetypes.xxx in | Command: ./%e |
3101 | | filetype defined in | ~/.config/geany or else | Geany install | |
3102 | | project file | filetypes.xxx file in | | |
3103 | | | ~/.config/geany/filedefs | Saves To: as user | |
3104 | | Saves To: | | preferences left. | |
3105 | | project file | Saves To: | | |
3106 | | | filetypes.xxx file in | | |
3107 | | | ~/.config/geany/filedefs | | |
3108 +--------------+---------------------+--------------------------+-------------------+-------------------------------+
3110 The following notes on the table reference cells by coordinate as (group,source):
3112 * General - for filetypes.xxx substitute the appropriate extension for
3113 the filetype of the current document for xxx - see `filenames`_.
3115 * System Filetypes - Labels loaded from these sources are locale sensitive
3116 and can contain translations.
3118 * (Filetype, Project File) and (Filetype, Preferences) - preferences use a full
3119 filetype file so that users can configure all other filetype preferences
3120 as well. Projects can only configure menu items per filetype. Saving
3121 in the project file means that there is only one file per project not
3124 * (Filetype-Independent, System Filetype) - although conceptually strange, defining
3125 filetype-independent commands in a filetype file, this provides the ability to
3126 define filetype dependent default menu items.
3128 * (Execute, Project File) and (Execute, Preferences) - the project independent
3129 execute and preferences independent execute commands can only be set by hand
3130 editing the appropriate file, see `Preferences file format`_ and `Project file
3133 Build menu commands dialog
3134 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3136 Most of the configuration of the build menu is done through the Build Menu
3137 Commands Dialog. You edit the configuration sourced from preferences in the
3138 dialog opened from the Build->Build Menu Commands item and you edit the
3139 configuration from the project in the build tab of the project preferences
3140 dialog. Both use the same form shown below.
3142 .. image:: ./images/build_menu_commands_dialog.png
3144 The dialog is divided into three sections:
3146 * Filetype build commands (selected based on the current document's filetype).
3147 * Independent build commands (available regardless of filetype).
3148 * Filetype execute commands.
3150 The filetype and independent sections also each contain a field for the regular
3151 expression used for parsing command output for error and warning messages.
3153 The columns in the first three sections allow setting of the label, command,
3154 and working directory to run the command in.
3156 An item with an empty label will not be shown in the menu.
3158 An empty working directory will default to the directory of the current document.
3159 If there is no current document then the command will not run.
3161 The dialog will always show the command selected by priority, not just the
3162 commands configured in this configuration source. This ensures that you always
3163 see what the menu item is going to do if activated.
3165 If the current source of the menu item is higher priority than the
3166 configuration source you are editing then the command will be shown
3167 in the dialog but will be insensitive (greyed out). This can't happen
3168 with the project source but can with the preferences source dialog.
3170 The clear buttons remove the definition from the configuration source you are editing.
3171 When you do this the command from the next lower priority source will be shown.
3172 To hide lower priority menu items without having anything show in the menu
3173 configure with a nothing in the label but at least one character in the command.
3175 Substitutions in commands and working directories
3176 `````````````````````````````````````````````````
3178 The first occurence of each of the following character sequences in each of the
3179 command and working directory fields is substituted by the items specified below
3180 before the command is run.
3182 * %d - substituted by the absolute path to the directory of the current file.
3183 * %e - substituted by the name of the current file without the extension or path.
3184 * %f - substituted by the name of the current file without the path.
3185 * %p - if a project is open, substituted by the base path from the project.
3188 If the basepath set in the project preferences is not an absolute path , then it is
3189 taken as relative to the directory of the project file. This allows a project file
3190 stored in the source tree to specify all commands and working directories relative
3191 to the tree itself, so that the whole tree including the project file, can be moved
3192 and even checked into and out of version control without having to re-configure the
3195 Build menu keyboard shortcuts
3196 `````````````````````````````
3198 Keyboard shortcuts can be defined for the first two filetype menu items, the first three
3199 independent menu items, the first two execute menu items and the fixed menu items.
3200 In the keybindings configuration dialog (see `Keybinding preferences`_)
3201 these items are identified by the default labels shown in the `Build Menu`_ section above.
3203 It is currently not possible to bind keyboard shortcuts to more than these menu items.
3205 You can also use underlines in the labels to set mnemonic characters.
3210 The configurable Build Menu capability was introduced in Geany 0.19 and
3211 required a new section to be added to the configuration files (See
3212 `Preferences file format`_). Geany will still load older format project,
3213 preferences and filetype file settings and will attempt to map them into the new
3214 configuration format. There is not a simple clean mapping between the formats.
3215 The mapping used produces the most sensible results for the majority of cases.
3216 However, if they do not map the way you want, you may have to manually
3217 configure some settings using the Build Commands
3218 Dialog or the Build tab of the project preferences dialog.
3220 Any setting configured in either of these dialogs will override settings mapped from
3221 older format configuration files.
3226 Since Geany 0.13 there has been printing support using GTK's printing API.
3227 The printed page(s) will look nearly the same as on your screen in Geany.
3228 Additionally, there are some options to modify the printed page(s).
3231 The background text color is set to white, except for text with
3232 a white foreground. This allows dark color schemes to save ink
3235 You can define whether to print line numbers, page numbers at the bottom of
3236 each page and whether to print a page header on each page. This header
3237 contains the filename of the printed document, the current page number and
3238 the date and time of printing. By default, the file name of the document
3239 with full path information is added to the header. If you prefer to add
3240 only the basename of the file(without any path information) you can set it
3241 in the preferences dialog. You can also adjust the format of the date and
3242 time added to the page header. The available conversion specifiers are the
3243 same as the ones which can be used with the ANSI C strftime function.
3245 All of these settings can also be changed in the print dialog just before
3246 actual printing is done.
3247 On Unix-like systems the provided print dialog offers a print preview. The
3248 preview file is opened with a PDF viewer and by default GTK uses ``evince``
3249 for print preview. If you have not installed evince or just want to use
3250 another PDF viewer, you can change the program to use in the file
3251 ``.gtkrc-2.0`` (usually found in your home directory). Simply add a line
3254 gtk-print-preview-command = "epdfview %f"
3256 at the end of the file. Of course, you can also use xpdf, kpdf or whatever
3257 as the print preview command.
3259 Geany also provides an alternative basic printing support using a custom
3260 print command. However, the printed document contains no syntax highlighting.
3261 You can adjust the command to which the filename is passed in the preferences
3262 dialog. The default command is::
3266 ``%f`` will be substituted by the filename of the current file. Geany
3267 will not show errors from the command itself, so you should make
3268 sure that it works before(e.g. by trying to execute it from the
3271 A nicer example, which many prefer is::
3273 % a2ps -1 --medium=A4 -o - %f | xfprint4
3275 But this depends on a2ps and xfprint4. As a replacement for xfprint4,
3276 gtklp or similar programs can be used.
3283 Plugins are loaded at startup, if the *Enable plugin support*
3284 general preference is set. There is also a command-line option,
3285 ``-p``, which prevents plugins being loaded. Plugins are scanned in
3286 the following directories:
3288 * ``$prefix/lib/geany`` on Unix-like systems (see `Installation prefix`_)
3289 * The ``lib`` subfolder of the installation path on Windows.
3290 * The ``plugins`` subfolder of the user configuration directory - see
3291 `Configuration file paths`_.
3292 * The `Extra plugin path` preference (usually blank) - see `Paths`_.
3294 Most plugins add menu items to the *Tools* menu when they are loaded.
3296 See also `Plugin documentation`_ for information about single plugins
3297 which are included in Geany.
3301 The Plugin Manager dialog lets you choose which plugins
3302 should be loaded at startup. You can also load and unload plugins on the
3303 fly using this dialog. Once you click the checkbox for a specific plugin
3304 in the dialog, it is loaded or unloaded according to its previous state.
3305 By default, no plugins are loaded at startup until you select some.
3306 You can also configure some plugin specific options if the plugin
3313 Geany supports the default keyboard shortcuts for the Scintilla
3314 editing widget. For a list of these commands, see `Scintilla
3315 keyboard commands`_. The Scintilla keyboard shortcuts will be overridden
3316 by any custom keybindings with the same keyboard shortcut.
3322 There are some non-configurable bindings to switch between documents,
3323 listed below. These can also be overridden by custom keybindings.
3325 =============== ==================================
3327 =============== ==================================
3328 Alt-[1-9] Select left-most tab, from 1 to 9.
3329 Alt-0 Select right-most tab.
3330 =============== ==================================
3332 See also `Notebook tab keybindings`_.
3335 Configurable keybindings
3336 ^^^^^^^^^^^^^^^^^^^^^^^^
3338 For all actions listed below you can define your own keybindings. Open
3339 the Preferences dialog, select the desired action and click on
3340 change. In the resulting dialog you can press the key combination you
3341 want to assign to the action and it will be saved when you press OK.
3342 You can define only one key combination for each action and each key
3343 combination can only be defined for one action.
3345 The following tables list all customizable keyboard shortcuts, those
3346 which are common to many applications are marked with (C) after the
3351 =============================== ========================= ==================================================
3352 Action Default shortcut Description
3353 =============================== ========================= ==================================================
3354 New Ctrl-N (C) Creates a new file.
3356 Open Ctrl-O (C) Opens a file.
3358 Open selected file Ctrl-Shift-O Opens the selected filename.
3360 Re-open last closed tab Re-opens the last closed document tab.
3362 Save Ctrl-S (C) Saves the current file.
3364 Save As Saves the current file under a new name.
3366 Save all Ctrl-Shift-S Saves all open files.
3368 Close all Ctrl-Shift-W Closes all open files.
3370 Close Ctrl-W (C) Closes the current file.
3372 Reload file Ctrl-R (C) Reloads the current file. All unsaved changes
3375 Print Ctrl-P (C) Prints the current file.
3377 Quit Ctrl-Q (C) Quits Geany.
3378 =============================== ========================= ==================================================
3383 =============================== ========================= ==================================================
3384 Action Default shortcut Description
3385 =============================== ========================= ==================================================
3386 Undo Ctrl-Z (C) Un-does the last action.
3388 Redo Ctrl-Y Re-does the last action.
3390 Delete current line(s) Ctrl-K Deletes the current line (and any lines with a
3393 Delete to line end Ctrl-Shift-Delete Deletes from the current caret position to the
3394 end of the current line.
3396 Duplicate line or selection Ctrl-D Duplicates the current line or selection.
3398 Transpose current line Transposes the current line with the previous one.
3400 Scroll to current line Ctrl-Shift-L Scrolls the current line into the centre of the
3401 view. The cursor position and or an existing
3402 selection will not be changed.
3404 Scroll up by one line Alt-Up Scrolls the view.
3406 Scroll down by one line Alt-Down Scrolls the view.
3408 Complete word Ctrl-Space Shows the autocompletion list. If already showing
3409 tag completion, it shows document word completion
3410 instead, even if it is not enabled for automatic
3411 completion. Likewise if no tag suggestions are
3412 available, it shows document word completion.
3414 Show calltip Ctrl-Shift-Space Shows a calltip for the current function or
3417 Show macro list Ctrl-Return Shows a list of available macros and variables in
3420 Complete snippet Tab If you type a construct like if or for and press
3421 this key, it will be completed with a matching
3424 Suppress snippet completion If you type a construct like if or for and press
3425 this key, it will not be completed, and a space or
3426 tab will be inserted, depending on what the
3427 construct completion keybinding is set to. For
3428 example, if you have set the construct completion
3429 keybinding to space, then setting this to
3430 Shift+space will prevent construct completion and
3433 Context Action Executes a command and passes the current word
3434 (near the cursor position) or selection as an
3435 argument. See the section called `Context
3438 Move cursor in snippet Jumps to the next defined cursor positions in a
3439 completed snippets if multiple cursor positions
3442 Word part completion Tab When the autocompletion list is visible, complete
3443 the currently selected item up to the next word
3446 Move line(s) up Alt-PageUp Move the current line or selected lines up by
3449 Move line(s) down Alt-PageDown Move the current line or selected lines down by
3451 =============================== ========================= ==================================================
3454 Clipboard keybindings
3455 `````````````````````
3456 =============================== ========================= ==================================================
3457 Action Default shortcut Description
3458 =============================== ========================= ==================================================
3459 Cut Ctrl-X (C) Cut the current selection to the clipboard.
3461 Copy Ctrl-C (C) Copy the current selection to the clipboard.
3463 Paste Ctrl-V (C) Paste the clipboard text into the current document.
3465 Cut current line(s) Ctrl-Shift-X Cuts the current line (and any lines with a
3466 selection) to the clipboard.
3468 Copy current line(s) Ctrl-Shift-C Copies the current line (and any lines with a
3469 selection) to the clipboard.
3470 =============================== ========================= ==================================================
3475 =============================== ========================= ==================================================
3476 Action Default shortcut Description
3477 =============================== ========================= ==================================================
3478 Select all Ctrl-A (C) Makes a selection of all text in the current
3481 Select current word Alt-Shift-W Selects the current word under the cursor.
3483 Select current paragraph Alt-Shift-P Selects the current paragraph under the cursor
3484 which is defined by two empty lines around it.
3486 Select current line(s) Alt-Shift-L Selects the current line under the cursor (and any
3487 partially selected lines).
3489 Select to previous word part (Extend) selection to previous word part boundary.
3491 Select to next word part (Extend) selection to next word part boundary.
3492 =============================== ========================= ==================================================
3497 =============================== ========================= ==================================================
3498 Action Default shortcut Description
3499 =============================== ========================= ==================================================
3500 Insert date Shift-Alt-D Inserts a customisable date.
3502 Insert alternative whitespace Inserts a tab character when spaces should
3503 be used for indentation and inserts space
3504 characters of the amount of a tab width when
3505 tabs should be used for indentation.
3507 Insert New Line Before Current Inserts a new line with indentation.
3509 Insert New Line After Current Inserts a new line with indentation.
3510 =============================== ========================= ==================================================
3515 =============================== ========================= ==================================================
3516 Action Default shortcut Description
3517 =============================== ========================= ==================================================
3518 Toggle case of selection Ctrl-Alt-U Changes the case of the selection. A lowercase
3519 selection will be changed into uppercase and vice
3520 versa. If the selection contains lower- and
3521 uppercase characters, all will be converted to
3524 Comment line Comments current line or selection.
3526 Uncomment line Uncomments current line or selection.
3528 Toggle line commentation Ctrl-E Comments a line if it is not commented or removes
3529 a comment if the line is commented.
3531 Increase indent Ctrl-I Indents the current line or selection by one tab
3532 or with spaces in the amount of the tab width
3535 Decrease indent Ctrl-U Removes one tab or the amount of spaces of
3536 the tab width setting from the indentation of the
3537 current line or selection.
3539 Increase indent by one space Indents the current line or selection by one
3542 Decrease indent by one space Deindents the current line or selection by one
3545 Smart line indent Indents the current line or all selected lines
3546 with the same indentation as the previous line.
3548 Send to Custom Command 1 (2,3) Ctrl-1 (2,3) Passes the current selection to a configured
3549 external command (available for the first
3550 three configured commands, see
3551 `Sending text through custom commands`_ for
3554 Send Selection to Terminal Sends the current selection or the current
3555 line (if there is no selection) to the
3556 embedded Terminal (VTE).
3558 Reflow lines/block Reformat selected lines or current
3559 (indented) text block,
3560 breaking lines at the long line marker or the
3561 line breaking column if line breaking is
3562 enabled for the current document.
3563 =============================== ========================= ==================================================
3566 Settings keybindings
3567 ````````````````````
3568 =============================== ========================= ==================================================
3569 Action Default shortcut Description
3570 =============================== ========================= ==================================================
3571 Preferences Ctrl-Alt-P Opens preferences dialog.
3573 Plugin Preferences Opens plugin preferences dialog.
3574 =============================== ========================= ==================================================
3579 =============================== ========================= ==================================================
3580 Action Default shortcut Description
3581 =============================== ========================= ==================================================
3582 Find Ctrl-F (C) Opens the Find dialog.
3584 Find Next Ctrl-G Finds next result.
3586 Find Previous Ctrl-Shift-G Finds previous result.
3588 Find Next Selection Finds next occurence of selected text.
3590 Find Previous Selection Finds previous occurence of selected text.
3592 Replace Ctrl-H (C) Opens the Replace dialog.
3594 Find in files Ctrl-Shift-F Opens the Find in files dialog.
3596 Next message Jumps to the line with the next message in
3597 the Messages window.
3599 Previous message Jumps to the line with the previous message
3600 in the Messages window.
3602 Find Usage Ctrl-Shift-E Finds all occurrences of the current word (near
3603 the keyboard cursor) or selection in all open
3604 documents and displays them in the messages
3607 Find Document Usage Ctrl-Shift-D Finds all occurrences of the current word (near
3608 the keyboard cursor) or selection in the current
3609 document and displays them in the messages
3612 Mark All Ctrl-Shift-M Highlight all matches of the current
3613 word/selection in the current document
3614 with a colored box. If there's nothing to
3615 find, or the cursor is next to an existing match,
3616 the highlighted matches will be cleared.
3617 =============================== ========================= ==================================================
3622 =============================== ========================= ==================================================
3623 Action Default shortcut Description
3624 =============================== ========================= ==================================================
3625 Navigate forward a location Alt-Right (C) Switches to the next location in the navigation
3626 history. See the section called `Code Navigation
3629 Navigate back a location Alt-Left (C) Switches to the previous location in the
3630 navigation history. See the section called
3631 `Code navigation history`_.
3633 Go to line Ctrl-L Focuses the Go to Line entry (if visible) or
3634 shows the Go to line dialog.
3636 Goto matching brace Ctrl-B If the cursor is ahead or behind a brace, then it
3637 is moved to the brace which belongs to the current
3638 one. If this keyboard shortcut is pressed again,
3639 the cursor is moved back to the first brace.
3641 Toggle marker Ctrl-M Set a marker on the current line, or clear the
3642 marker if there already is one.
3644 Goto next marker Ctrl-. Goto the next marker in the current document.
3646 Goto previous marker Ctrl-, Goto the previous marker in the current document.
3648 Go to tag definition Ctrl-T Jump to the definition of the current word or
3649 selection. See `Go to tag definition`_.
3651 Go to tag declaration Ctrl-Shift-T Jump to the declaration of the current word or
3652 selection. See `Go to tag declaration`_.
3654 Go to Start of Line Home Move the caret to the start of the line.
3655 Behaves differently if smart_home_key_ is set.
3657 Go to End of Line End Move the caret to the end of the line.
3659 Go to Start of Display Line Alt-Home Move the caret to the start of the display line.
3660 This is useful when you use line wrapping and
3661 want to jump to the start of the wrapped, virtual
3662 line, not the real start of the whole line.
3663 If the line is not wrapped, it behaves like
3664 `Go to Start of Line`.
3666 Go to End of Display Line Alt-End Move the caret to the end of the display line.
3667 If the line is not wrapped, it behaves like
3668 `Go to End of Line`.
3670 Go to Previous Word Part Ctrl-/ Goto the previous part of the current word.
3672 Go to Next Word Part Ctrl-\\ Goto the next part of the current word.
3673 =============================== ========================= ==================================================
3677 =============================== ========================= ==================================================
3678 Action Default shortcut Description
3679 =============================== ========================= ==================================================
3680 Fullscreen F11 (C) Switches to fullscreen mode.
3682 Toggle Messages Window Toggles the message window (status and compiler
3683 messages) on and off.
3685 Toggle Sidebar Shows or hides the sidebar.
3687 Toggle all additional widgets Hide and show all additional widgets like the
3688 notebook tabs, the toolbar, the messages window
3691 Zoom In Ctrl-+ (C) Zooms in the text.
3693 Zoom Out Ctrl-- (C) Zooms out the text.
3695 Zoom Reset Ctrl-0 Reset any previous zoom on the text.
3696 =============================== ========================= ==================================================
3700 ================================ ========================= ==================================================
3701 Action Default shortcut Description
3702 ================================ ========================= ==================================================
3703 Switch to Editor F2 Switches to editor widget.
3704 Also reshows the document statistics line
3705 (after a short timeout).
3707 Switch to Search Bar F7 Switches to the search bar in the toolbar (if
3710 Switch to Message Window Focus the Message Window's current tab.
3712 Switch to Compiler Focus the Compiler message window tab.
3714 Switch to Messages Focus the Messages message window tab.
3716 Switch to Scribble F6 Switches to scribble widget.
3718 Switch to VTE F4 Switches to VTE widget.
3720 Switch to Sidebar Focus the Sidebar.
3722 Switch to Sidebar Symbol List Focus the Symbol list tab in the Sidebar
3725 Switch to Sidebar Document List Focus the Document list tab in the Sidebar
3727 ================================ ========================= ==================================================
3730 Notebook tab keybindings
3731 ````````````````````````
3732 =============================== ========================= ==================================================
3733 Action Default shortcut Description
3734 =============================== ========================= ==================================================
3735 Switch to left document Ctrl-PageUp (C) Switches to the previous open document.
3737 Switch to right document Ctrl-PageDown (C) Switches to the next open document.
3739 Switch to last used document Ctrl-Tab Switches to the previously shown document (if it's
3741 Holding Ctrl (or another modifier if the keybinding
3742 has been changed) will show a dialog, then repeated
3743 presses of the keybinding will switch to the 2nd-last
3744 used document, 3rd-last, etc. Also known as
3745 Most-Recently-Used documents switching.
3747 Move document left Ctrl-Shift-PageUp Changes the current document with the left hand
3750 Move document right Ctrl-Shift-PageDown Changes the current document with the right hand
3753 Move document first Moves the current document to the first position.
3755 Move document last Moves the current document to the last position.
3756 =============================== ========================= ==================================================
3759 Document keybindings
3760 ````````````````````
3761 ==================================== ==================== ==================================================
3762 Action Default shortcut Description
3763 ==================================== ==================== ==================================================
3764 Clone See `Cloning documents`_.
3766 Replace tabs with space Replaces all tabs with the right amount of spaces.
3768 Replace spaces with tabs Replaces leading spaces with tab characters.
3770 Toggle current fold Toggles the folding state of the current code block.
3772 Fold all Folds all contractible code blocks.
3774 Unfold all Unfolds all contracted code blocks.
3776 Reload symbol list Ctrl-Shift-R Reloads the tag/symbol list.
3778 Toggle Line wrapping Enables or disables wrapping of long lines.
3780 Toggle Line breaking Enables or disables automatic breaking of long
3781 lines at a configurable column.
3783 Remove Markers Remove any markers on lines or words which
3784 were set by using 'Mark All' in the
3785 search dialog or by manually marking lines.
3787 Remove Error Indicators Remove any error indicators in the
3790 Remove Markers and Error Indicators Combines ``Remove Markers`` and
3791 ``Remove Error Indicators``.
3792 ==================================== ==================== ==================================================
3797 =============================== ========================= ==================================================
3798 Action Default shortcut Description
3799 =============================== ========================= ==================================================
3800 New Create a new project.
3801 Open Opens a project file.
3802 Properties Shows project properties.
3803 Close Close the current project.
3804 =============================== ========================= ==================================================
3809 =============================== ========================= ==================================================
3810 Action Default shortcut Description
3811 =============================== ========================= ==================================================
3812 Compile F8 Compiles the current file.
3814 Build F9 Builds (compiles if necessary and links) the
3817 Make all Shift-F9 Builds the current file with the Make tool.
3819 Make custom target Ctrl-Shift-F9 Builds the current file with the Make tool and a
3822 Make object Shift-F8 Compiles the current file with the Make tool.
3824 Next error Jumps to the line with the next error from the
3827 Previous error Jumps to the line with the previous error from
3828 the last build process.
3830 Run F5 Executes the current file in a terminal emulation.
3832 Set Build Commands Opens the build commands dialog.
3833 =============================== ========================= ==================================================
3838 =============================== ========================= ==================================================
3839 Action Default shortcut Description
3840 =============================== ========================= ==================================================
3841 Show Color Chooser Opens the Color Chooser dialog.
3842 =============================== ========================= ==================================================
3847 =============================== ========================= ==================================================
3848 Action Default shortcut Description
3849 =============================== ========================= ==================================================
3850 Help F1 (C) Opens the manual.
3851 =============================== ========================= ==================================================
3859 You must use UTF-8 encoding *without BOM* for configuration files.
3862 Configuration file paths
3863 ------------------------
3864 Geany has default configuration files installed for the system and
3865 also per-user configuration files.
3867 The system files should not normally be edited because they will be
3868 overwritten when upgrading Geany.
3870 The user configuration directory can be overridden with the ``-c``
3871 switch, but this is not normally done. See `Command line options`_.
3874 Any missing subdirectories in the user configuration directory
3875 will be created when Geany starts.
3877 You can check the paths Geany is using with *Help->Debug Messages*.
3878 Near the top there should be 2 lines with something like::
3880 Geany-INFO: System data dir: /usr/share/geany
3881 Geany-INFO: User config dir: /home/username/.config/geany
3884 Paths on Unix-like systems
3885 ^^^^^^^^^^^^^^^^^^^^^^^^^^
3886 The system path is ``$prefix/share/geany``, where ``$prefix`` is the
3887 path where Geany is installed (see `Installation prefix`_).
3889 The user configuration directory is normally:
3890 ``/home/username/.config/geany``
3894 The system path is the ``data`` subfolder of the installation path
3897 The user configuration directory might vary, but on Windows XP it's:
3898 ``C:\Documents and Settings\UserName\Application Data\geany``
3899 On Windows 7 and above you most likely will find it at:
3900 ``C:\users\UserName\Roaming\geany``
3905 There's a *Configuration files* submenu in the *Tools* menu that
3906 contains items for some of the available user configuration files.
3907 Clicking on one opens it in the editor for you to update. Geany will
3908 reload the file after you have saved it.
3911 Other configuration files not shown here will need to be opened
3912 manually, and will not be automatically reloaded when saved.
3913 (see *Reload Configuration* below).
3915 There's also a *Reload Configuration* item which can be used if you
3916 updated one of the other configuration files, or modified or added
3919 *Reload Configuration* is also necessary to update syntax highlighting colors.
3922 Syntax highlighting colors aren't updated in open documents after
3923 saving filetypes.common as this may take a significant
3927 Global configuration file
3928 -------------------------
3930 System administrators can add a global configuration file for Geany
3931 which will be used when starting Geany and a user configuration file
3934 The global configuration file is read from ``geany.conf`` in the
3935 system configuration path - see `Configuration file paths`_. It can
3936 contain any settings which are found in the usual configuration file
3937 created by Geany, but does not have to contain all settings.
3940 This feature is mainly intended for package maintainers or system
3941 admins who want to set up Geany in a multi user environment and
3942 set some sane default values for this environment. Usually users won't
3947 Filetype definition files
3948 -------------------------
3950 All color definitions and other filetype specific settings are
3951 stored in the filetype definition files. Those settings are colors
3952 for syntax highlighting, general settings like comment characters or
3953 word delimiter characters as well as compiler and linker settings.
3955 See also `Configuration file paths`_.
3959 Each filetype has a corresponding filetype definition file. The format
3960 for built-in filetype `Foo` is::
3964 The extension is normally just the filetype name in lower case.
3966 However there are some exceptions:
3968 =============== =========
3970 =============== =========
3974 Matlab/Octave matlab
3975 =============== =========
3977 There is also the `special file filetypes.common`_.
3979 For `custom filetypes`_, the filename for `Foo` is different::
3983 See the link for details.
3987 The system-wide filetype configuration files can be found in the
3988 system configuration path and are called ``filetypes.$ext``,
3989 where $ext is the name of the filetype. For every
3990 filetype there is a corresponding definition file. There is one
3991 exception: ``filetypes.common`` -- this file is for general settings,
3992 which are not specific to a certain filetype.
3995 It is not recommended that users edit the system-wide files,
3996 because they will be overridden when Geany is updated.
4000 To change the settings, copy a file from the system configuration
4001 path to the subdirectory ``filedefs`` in your user configuration
4002 directory. Then you can edit the file and the changes will still be
4003 available after an update of Geany.
4005 Alternatively, you can create the file yourself and add only the
4006 settings you want to change. All missing settings will be read from
4007 the corresponding system configuration file.
4011 At startup Geany looks for ``filetypes.*.conf`` files in the system and
4012 user filetype paths, adding any filetypes found with the name matching
4013 the '``*``' wildcard - e.g. ``filetypes.Bar.conf``.
4015 Custom filetypes are not as powerful as built-in filetypes, but
4016 support for the following has been implemented:
4018 * Recognizing and setting the filetype (after the user has manually updated
4019 the `filetype extensions`_ file).
4020 * `Filetype group membership`_.
4021 * Reading filetype settings in the ``[settings]`` section, including:
4022 * Using an existing syntax highlighting lexer (`lexer_filetype`_ key).
4023 * Using an existing tag parser (`tag_parser`_ key).
4024 * Build commands (``[build-menu]`` section).
4025 * Loading global tags files (sharing the ``tag_parser`` filetype's namespace).
4027 See `Filetype configuration`_ for details on each setting.
4029 Creating a custom filetype from an existing filetype
4030 ````````````````````````````````````````````````````
4031 Because most filetype settings will relate to the syntax
4032 highlighting (e.g. styling, keywords, ``lexer_properties``
4033 sections), it is best to copy an existing filetype file that uses
4034 the lexer you wish to use as the basis of a custom filetype, using
4035 the correct filename extension format shown above, e.g.::
4037 cp filetypes.foo filetypes.Bar.conf
4039 Then add the ``lexer_filetype=Foo`` setting (if not already present)
4040 and add/adjust other settings.
4043 The ``[styling]`` and ``[keywords]`` sections have key names
4044 specific to each filetype/lexer. You must follow the same
4045 names - in particular, some lexers only support one keyword
4049 Filetype configuration
4050 ^^^^^^^^^^^^^^^^^^^^^^
4052 As well as the sections listed below, each filetype file can contain
4053 a [build-menu] section as described in `[build-menu] section`_.
4058 In this section the colors for syntax highlighting are defined. The
4061 * ``key=foreground_color;background_color;bold_flag;italic_flag``
4063 Colors have to be specified as RGB hex values prefixed by
4064 0x or # similar to HTML/CSS hex triplets. For example, all of the following
4065 are valid values for pure red; 0xff0000, 0xf00, #ff0000, or #f00. The
4066 values are case-insensitive but it is a good idea to use lower-case.
4067 Note that you can also use *named colors* as well by substituting the
4068 color value with the name of a color as defined in the ``[named_colors]``
4069 section, see the `[named_colors] Section`_ for more information.
4071 Bold and italic are flags and should only be "true" or "false". If their
4072 value is something other than "true" or "false", "false" is assumed.
4074 You can omit fields to use the values from the style named ``"default"``.
4076 E.g. ``key=0xff0000;;true``
4078 This makes the key style have red foreground text, default background
4079 color text and bold emphasis.
4083 The second format uses a *named style* name to reference a style
4084 defined in filetypes.common.
4086 * ``key=named_style``
4087 * ``key2=named_style2,bold,italic``
4089 The bold and italic parts are optional, and if present are used to
4090 toggle the bold or italic flags to the opposite of the named style's
4091 flags. In contrast to style definition booleans, they are a literal
4092 ",bold,italic" and commas are used instead of semi-colons.
4094 E.g. ``key=comment,italic``
4096 This makes the key style match the ``"comment"`` named style, but with
4099 To define named styles, see the filetypes.common `[named_styles]
4102 Reading styles from another filetype
4103 ************************************
4104 You can automatically copy all of the styles from another filetype
4105 definition file by using the following syntax for the ``[styling]``
4110 Where Foo is a filetype name. The corresponding ``[styling]``
4111 section from ``filetypes.foo`` will be read.
4113 This is useful when the same lexer is being used for multiple
4114 filetypes (e.g. C/C++/C#/Java/etc). For example, to make the C++
4115 styling the same as the C styling, you would put the following in
4124 This section contains keys for different keyword lists specific to
4125 the filetype. Some filetypes do not support keywords, so adding a
4126 new key will not work. You can only add or remove keywords to/from
4130 The keywords list must be in one line without line ending characters.
4133 [lexer_properties] section
4134 ``````````````````````````
4135 Here any special properties for the Scintilla lexer can be set in the
4136 format ``key.name.field=some.value``.
4138 Properties Geany uses are listed in the system filetype files. To find
4139 other properties you need Geany's source code::
4141 egrep -o 'GetProperty\w*\("([^"]+)"[^)]+\)' scintilla/Lex*.cxx
4148 This is the default file extension used when saving files, not
4149 including the period character (``.``). The extension used should
4150 match one of the patterns associated with that filetype (see
4151 `Filetype extensions`_).
4153 *Example:* ``extension=cxx``
4156 These characters define word boundaries when making selections
4157 and searching using word matching options.
4159 *Example:* (look at system filetypes.\* files)
4162 This overrides the *whitespace_chars* filetypes.common setting.
4165 A character or string which is used to comment code. If you want to use
4166 multiline comments only, don't set this but rather comment_open and
4169 Single-line comments are used in priority over multiline comments to
4170 comment a line, e.g. with the `Comment/Uncomment line` command.
4172 *Example:* ``comment_single=//``
4175 A character or string which is used to comment code. You need to also
4176 set comment_close to really use multiline comments. If you want to use
4177 single-line comments, prefer setting comment_single.
4179 Multiline comments are used in priority over single-line comments to
4180 comment a block, e.g. template comments.
4182 *Example:* ``comment_open=/*``
4185 If multiline comments are used, this is the character or string to
4188 *Example:* ``comment_close=*/``
4191 Set this to false if a comment character or string should start at
4192 column 0 of a line. If set to true it uses any indentation of the
4195 Note: Comment indentation
4197 ``comment_use_indent=true`` would generate this if a line is
4198 commented (e.g. with Ctrl-D)::
4202 ``comment_use_indent=false`` would generate this if a line is
4203 commented (e.g. with Ctrl-D)::
4205 # command_example();
4208 Note: This setting only works for single line comments (like '//',
4211 *Example:* ``comment_use_indent=true``
4214 A command which can be executed on the current word or the current
4217 Example usage: Open the API documentation for the
4218 current function call at the cursor position.
4221 be set for every filetype or if not set, a global command will
4222 be used. The command itself can be specified without the full
4223 path, then it is searched in $PATH. But for security reasons,
4224 it is recommended to specify the full path to the command. The
4225 wildcard %s will be replaced by the current word at the cursor
4226 position or by the current selection.
4228 Hint: for PHP files the following could be quite useful:
4229 context_action_cmd=firefox "http://www.php.net/%s"
4231 *Example:* ``context_action_cmd=devhelp -s "%s"``
4236 The TagManager language name, e.g. "C". Usually the same as the
4242 A filetype name to setup syntax highlighting from another filetype.
4243 This must not be recursive, i.e. it should be a filetype name that
4244 doesn't use the *lexer_filetype* key itself, e.g.::
4249 The second line is wrong, because ``filetypes.cpp`` itself uses
4250 ``lexer_filetype=C``, which would be recursive.
4252 symbol_list_sort_mode
4253 What the default symbol list sort order should be.
4255 ===== =====================================
4257 ===== =====================================
4259 1 Sort tags by appearance (line number)
4260 ===== =====================================
4262 .. _xml_indent_tags:
4265 If this setting is set to *true*, a new line after a line ending with an
4266 unclosed XML/HTML tag will be automatically indented. This only applies
4267 to filetypes for which the HTML or XML lexer is used. Such filetypes have
4268 this setting in their system configuration files.
4271 The MIME type for this file type, e.g. "text/x-csrc". This is used
4272 for example to chose the icon to display for this file type.
4275 [indentation] section
4276 `````````````````````
4278 This section allows definition of default indentation settings specific to
4279 the file type, overriding the ones configured in the preferences. This can
4280 be useful for file types requiring specific indentation settings (e.g. tabs
4281 only for Makefile). These settings don't override auto-detection if activated.
4284 The forced indentation width.
4287 The forced indentation type.
4289 ===== =======================
4290 Value Indentation type
4291 ===== =======================
4294 2 Mixed (tabs and spaces)
4295 ===== =======================
4298 [build_settings] section
4299 ````````````````````````
4301 As of Geany 0.19 this section is supplemented by the `[build-menu] section`_.
4302 Values that are set in the [build-menu] section will override those in this section.
4305 This is a regular expression to parse a filename
4306 and line number from build output. If undefined, Geany will fall
4307 back to its default error message parsing.
4309 Only the first two matches will be read by Geany. Geany will look for
4310 a match that is purely digits, and use this for the line number. The
4311 remaining match will be used as the filename.
4313 *Example:* ``error_regex=(.+):([0-9]+):[0-9]+``
4315 This will parse a message such as:
4316 ``test.py:7:24: E202 whitespace before ']'``
4320 If any build menu item settings have been configured in the Build Menu Commands
4321 dialog or the Build tab of the project preferences dialog then these
4322 settings are stored in the [build-menu] section and override the settings in
4323 this section for that item.
4326 This item specifies the command to compile source code files. But
4327 it is also possible to use it with interpreted languages like Perl
4328 or Python. With these filetypes you can use this option as a kind of
4329 syntax parser, which sends output to the compiler message window.
4331 You should quote the filename to also support filenames with
4332 spaces. The following wildcards for filenames are available:
4334 * %f -- complete filename without path
4335 * %e -- filename without path and without extension
4337 *Example:* ``compiler=gcc -Wall -c "%f"``
4340 This item specifies the command to link the file. If the file is not
4341 already compiled, it will be compiled while linking. The -o option
4342 is automatically added by Geany. This item works well with GNU gcc,
4343 but may be problematic with other compilers (esp. with the linker).
4345 *Example:* ``linker=gcc -Wall "%f"``
4348 Use this item to execute your file. It has to have been built
4349 already. Use the %e wildcard to have only the name of the executable
4350 (i.e. without extension) or use the %f wildcard if you need the
4351 complete filename, e.g. for shell scripts.
4353 *Example:* ``run_cmd="./%e"``
4356 Special file filetypes.common
4357 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4359 There is a special filetype definition file called
4360 filetypes.common. This file defines some general non-filetype-specific
4363 You can open the user filetypes.common with the
4364 *Tools->Configuration Files->filetypes.common* menu item. This adds
4365 the default settings to the user file if the file doesn't exist.
4366 Alternatively the file can be created manually, adding only the
4367 settings you want to change. All missing settings will be read from
4371 See the `Filetype configuration`_ section for how to define styles.
4374 [named_styles] section
4375 ``````````````````````
4376 Named styles declared here can be used in the [styling] section of any
4381 *In filetypes.common*::
4384 foo=0xc00000;0xffffff;false;true
4392 This saves copying and pasting the whole style definition into several
4396 You can define aliases for named styles, as shown with the ``bar``
4397 entry in the above example, but they must be declared after the
4401 [named_colors] section
4402 ``````````````````````
4403 Named colors declared here can be used in the ``[styling]`` or
4404 ``[named_styles]`` section of any filetypes.* file or color scheme.
4409 my_red_color=#FF0000
4410 my_blue_color=#0000FF
4413 foo=my_red_color;my_blue_color;false;true
4415 This allows to define a color pallete by name so that to change a color
4416 scheme-wide only involves changing the hex value in a single location.
4421 This is the default style. It is used for styling files without a
4424 *Example:* ``default=0x000000;0xffffff;false;false``
4427 The style for coloring selected text. The format is:
4431 * Use foreground color
4432 * Use background color
4434 The colors are only set if the 3rd or 4th argument is true. When
4435 the colors are not overridden, the default is a dark grey
4436 background with syntax highlighted foreground text.
4438 *Example:* ``selection=0xc0c0c0;0x00007F;true;true``
4441 The style for brace highlighting when a matching brace was found.
4443 *Example:* ``brace_good=0xff0000;0xFFFFFF;true;false``
4446 The style for brace highlighting when no matching brace was found.
4448 *Example:* ``brace_bad=0x0000ff;0xFFFFFF;true;false``
4451 The style for coloring the caret(the blinking cursor). Only first
4452 and third argument is interpreted.
4453 Set the third argument to true to change the caret into a block caret.
4455 *Example:* ``caret=0x000000;0x0;false;false``
4458 The width for the caret(the blinking cursor). Only the first
4459 argument is interpreted. The width is specified in pixels with
4460 a maximum of three pixel. Use the width 0 to make the caret
4463 *Example:* ``caret=1;0;false;false``
4466 The style for coloring the background of the current line. Only
4467 the second and third arguments are interpreted. The second argument
4468 is the background color. Use the third argument to enable or
4469 disable background highlighting for the current line (has to be
4472 *Example:* ``current_line=0x0;0xe5e5e5;true;false``
4475 The style for coloring the indentation guides. Only the first and
4476 second arguments are interpreted.
4478 *Example:* ``indent_guide=0xc0c0c0;0xffffff;false;false``
4481 The style for coloring the white space if it is shown. The first
4482 both arguments define the foreground and background colors, the
4483 third argument sets whether to use the defined foreground color
4484 or to use the color defined by each filetype for the white space.
4485 The fourth argument defines whether to use the background color.
4487 *Example:* ``white_space=0xc0c0c0;0xffffff;true;true``
4490 Line number margin foreground and background colors.
4492 .. _Folding Settings:
4495 Fold margin foreground and background colors.
4497 fold_symbol_highlight
4498 Highlight color of folding symbols.
4501 The style of folding icons. Only first and second arguments are
4504 Valid values for the first argument are:
4511 Valid values for the second argument are:
4514 * 1 -- for straight lines
4515 * 2 -- for curved lines
4517 *Default:* ``folding_style=1;1;``
4519 *Arrows:* ``folding_style=3;0;``
4522 Draw a thin horizontal line at the line where text is folded. Only
4523 first argument is used.
4525 Valid values for the first argument are:
4527 * 0 -- disable, do not draw a line
4528 * 1 -- draw the line above folded text
4529 * 2 -- draw the line below folded text
4531 *Example:* ``folding_horiz_line=0;0;false;false``
4534 First argument: drawing of visual flags to indicate a line is wrapped.
4535 This is a bitmask of the values:
4537 * 0 -- No visual flags
4538 * 1 -- Visual flag at end of subline of a wrapped line
4539 * 2 -- Visual flag at begin of subline of a wrapped line. Subline is
4540 indented by at least 1 to make room for the flag.
4542 Second argument: wether the visual flags to indicate a line is wrapped
4543 are drawn near the border or near the text. This is a bitmask of the values:
4545 * 0 -- Visual flags drawn near border
4546 * 1 -- Visual flag at end of subline drawn near text
4547 * 2 -- Visual flag at begin of subline drawn near text
4549 Only first and second arguments are interpreted.
4551 *Example:* ``line_wrap_visuals=3;0;false;false``
4554 First argument: sets the size of indentation of sublines for wrapped lines
4555 in terms of the width of a space, only used when the second argument is ``0``.
4557 Second argument: wrapped sublines can be indented to the position of their
4558 first subline or one more indent level. Possible values:
4560 * 0 - Wrapped sublines aligned to left of window plus amount set by the first argument
4561 * 1 - Wrapped sublines are aligned to first subline indent (use the same indentation)
4562 * 2 - Wrapped sublines are aligned to first subline indent plus one more level of indentation
4564 Only first and second arguments are interpreted.
4566 *Example:* ``line_wrap_indent=0;1;false;false``
4569 Translucency for the current line (first argument) and the selection
4570 (second argument). Values between 0 and 256 are accepted.
4572 Note for Windows 95, 98 and ME users:
4573 keep this value at 256 to disable translucency otherwise Geany might crash.
4575 Only the first and second arguments are interpreted.
4577 *Example:* ``translucency=256;256;false;false``
4580 The style for a highlighted line (e.g when using Goto line or goto tag).
4581 The foreground color (first argument) is only used when the Markers margin
4582 is enabled (see View menu).
4584 Only the first and second arguments are interpreted.
4586 *Example:* ``marker_line=0x000000;0xffff00;false;false``
4589 The style for a marked search results (when using "Mark" in Search dialogs).
4590 The second argument sets the background color for the drawn rectangle.
4592 Only the second argument is interpreted.
4594 *Example:* ``marker_search=0x000000;0xb8f4b8;false;false``
4597 The style for a marked line (e.g when using the "Toggle Marker" keybinding
4598 (Ctrl-M)). The foreground color (first argument) is only used
4599 when the Markers margin is enabled (see View menu).
4601 Only the first and second arguments are interpreted.
4603 *Example:* ``marker_mark=0x000000;0xb8f4b8;false;false``
4606 Translucency for the line marker (first argument) and the search marker
4607 (second argument). Values between 0 and 256 are accepted.
4609 Note for Windows 95, 98 and ME users:
4610 keep this value at 256 to disable translucency otherwise Geany might crash.
4612 Only the first and second arguments are interpreted.
4614 *Example:* ``marker_translucency=256;256;false;false``
4617 Amount of space to be drawn above and below the line's baseline.
4618 The first argument defines the amount of space to be drawn above the line, the second
4619 argument defines the amount of space to be drawn below.
4621 Only the first and second arguments are interpreted.
4623 *Example:* ``line_height=0;0;false;false``
4626 The style for coloring the calltips. The first two arguments
4627 define the foreground and background colors, the third and fourth
4628 arguments set whether to use the defined colors.
4630 *Example:* ``calltips=0xc0c0c0;0xffffff;false;false``
4636 Characters to treat as whitespace. These characters are ignored
4637 when moving, selecting and deleting across word boundaries
4638 (see `Scintilla keyboard commands`_).
4640 This should include space (\\s) and tab (\\t).
4642 *Example:* ``whitespace_chars=\s\t!\"#$%&'()*+,-./:;<=>?@[\\]^`{|}~``
4650 To change the default filetype extension used when saving a new file,
4651 see `Filetype definition files`_.
4653 You can override the list of file extensions that Geany uses to detect
4654 filetypes using the user ``filetype_extensions.conf`` file. Use the
4655 *Tools->Configuration Files->filetype_extensions.conf* menu item. See
4656 also `Configuration file paths`_.
4658 You should only list lines for filetype extensions that you want to
4659 override in the user configuration file and remove or comment out
4660 others. The patterns are listed after the ``=`` sign, using a
4661 semi-colon separated list of patterns which should be matched for
4664 For example, to override the filetype extensions for Make, the file
4668 Make=Makefile*;*.mk;Buildfile;
4670 Filetype group membership
4671 ^^^^^^^^^^^^^^^^^^^^^^^^^
4672 Group membership is also stored in ``filetype_extensions.conf``. This
4673 file is used to store information Geany needs at startup, whereas the
4674 separate filetype definition files hold information only needed when
4675 a document with their filetype is used.
4677 The format looks like::
4686 The key names cannot be configured.
4689 Group membership is only read at startup.
4691 Preferences file format
4692 -----------------------
4694 The user preferences file ``geany.conf`` holds settings for all the items configured
4695 in the preferences dialog. This file should not be edited while Geany is running
4696 as the file will be overwritten when the preferences in Geany are changed or Geany
4700 [build-menu] section
4701 ^^^^^^^^^^^^^^^^^^^^
4703 The [build-menu] section contains the configuration of the build menu.
4704 This section can occur in filetype, preferences and project files and
4705 always has the format described here. Different menu items are loaded
4706 from different files, see the table in the `Build Menu Configuration`_
4707 section for details. All the settings can be configured from the dialogs
4708 except the execute command in filetype files and filetype definitions in
4709 the project file, so these are the only ones which need hand editing.
4711 The build-menu section stores one entry for each setting for each menu item that
4712 is configured. The keys for these settings have the format:
4718 * GG - is the menu item group,
4721 - NF for independent (non-filetype)
4724 * NN - is a two decimal digit number of the item within the group,
4726 * FF - is the field,
4730 - WD for working directory
4736 The project file contains project related settings and possibly a
4737 record of the current session files.
4740 [build-menu] additions
4741 ^^^^^^^^^^^^^^^^^^^^^^
4743 The project file also can have extra fields in the [build-menu] section
4744 in addition to those listed in `[build-menu] section`_ above.
4746 When filetype menu items are configured for the project they are stored
4747 in the project file.
4749 The ``filetypes`` entry is a list of the filetypes which exist in the
4752 For each filetype the entries for that filetype have the format defined in
4753 `[build-menu] section`_ but the key is prefixed by the name of the filetype
4754 as it appears in the ``filetypes`` entry, eg the entry for the label of
4755 filetype menu item 0 for the C filetype would be
4763 Geany supports the following templates:
4767 * Function description
4772 To use these templates, just open the Edit menu or open the popup menu
4773 by right-clicking in the editor widget, and choose "Insert Comments"
4774 and insert templates as you want.
4776 Some templates (like File header or ChangeLog entry) will always be
4777 inserted at the top of the file.
4779 To insert a function description, the cursor must be inside
4780 of the function, so that the function name can be determined
4781 automatically. The description will be positioned correctly one line
4782 above the function, just check it out. If the cursor is not inside
4783 of a function or the function name cannot be determined, the inserted
4784 function description won't contain the correct function name but "unknown"
4788 Geany automatically reloads template information when it notices you
4789 save a file in the user's template configuration directory. You can
4790 also force this by selecting *Tools->Reload Configuration*.
4796 Meta data can be used with all templates, but by default user set
4797 meta data is only used for the ChangeLog and File header templates.
4799 In the configuration dialog you can find a tab "Templates" (see
4800 `Template preferences`_). You can define the default values
4801 which will be inserted in the templates.
4807 File templates are templates used as the basis of a new file. To
4808 use them, choose the *New (with Template)* menu item from the *File*
4811 By default, file templates are installed for some filetypes. Custom
4812 file templates can be added by creating the appropriate template file. You can
4813 also edit the default file templates.
4815 The file's contents are just the text to place in the document, with
4816 optional template wildcards like ``{fileheader}``. The fileheader
4817 wildcard can be placed anywhere, but it's usually put on the first
4818 line of the file, followed by a blank line.
4820 Adding file templates
4821 `````````````````````
4823 File templates are read from ``templates/files`` under the
4824 `Configuration file paths`_.
4826 The filetype to use is detected from the template file's extension, if
4827 any. For example, creating a file ``module.c`` would add a menu item
4828 which created a new document with the filetype set to 'C'.
4830 The template file is read from disk when the corresponding menu item is
4834 Customizing templates
4835 ^^^^^^^^^^^^^^^^^^^^^
4837 Each template can be customized to your needs. The templates are
4838 stored in the ``~/.config/geany/templates/`` directory (see the section called
4839 `Command line options`_ for further information about the configuration
4840 directory). Just open the desired template with an editor (ideally,
4841 Geany ;-) ) and edit the template to your needs. There are some
4842 wildcards which will be automatically replaced by Geany at startup.
4848 All wildcards must be enclosed by "{" and "}", e.g. {date}.
4850 **Wildcards for character escaping**
4852 ============== ============================================= =======================================
4853 Wildcard Description Available in
4854 ============== ============================================= =======================================
4855 ob { Opening Brace (used to prevent other file templates, file header, snippets.
4856 wildcards being expanded).
4857 cb } Closing Brace. file templates, file header, snippets.
4858 pc \% Percent (used to escape e.g. %block% in
4859 snippets). snippets.
4860 ============== ============================================= =======================================
4862 **Global wildcards**
4864 These are configurable, see `Template preferences`_.
4866 ============== ============================================= =======================================
4867 Wildcard Description Available in
4868 ============== ============================================= =======================================
4869 developer The name of the developer. file templates, file header,
4870 function description, ChangeLog entry,
4873 initial The developer's initials, e.g. "ET" for file templates, file header,
4874 Enrico Tröger or "JFD" for John Foobar Doe. function description, ChangeLog entry,
4877 mail The email address of the developer. file templates, file header,
4878 function description, ChangeLog entry,
4881 company The company the developer is working for. file templates, file header,
4882 function description, ChangeLog entry,
4885 version The initial version of a new file. file templates, file header,
4886 function description, ChangeLog entry,
4888 ============== ============================================= =======================================
4890 **Date & time wildcards**
4892 The format for these wildcards can be changed in the preferences
4893 dialog, see `Template preferences`_. You can use any conversion
4894 specifiers which can be used with the ANSI C strftime function.
4895 For details please see http://man.cx/strftime.
4897 ============== ============================================= =======================================
4898 Wildcard Description Available in
4899 ============== ============================================= =======================================
4900 year The current year. Default format is: YYYY. file templates, file header,
4901 function description, ChangeLog entry,
4904 date The current date. Default format: file templates, file header,
4905 YYYY-MM-DD. function description, ChangeLog entry,
4908 datetime The current date and time. Default format: file templates, file header,
4909 DD.MM.YYYY HH:mm:ss ZZZZ. function description, ChangeLog entry,
4911 ============== ============================================= =======================================
4913 **Dynamic wildcards**
4915 ============== ============================================= =======================================
4916 Wildcard Description Available in
4917 ============== ============================================= =======================================
4918 untitled The string "untitled" (this will be file templates, file header,
4919 translated to your locale), used in function description, ChangeLog entry,
4920 file templates. bsd, gpl, snippets.
4922 geanyversion The actual Geany version, e.g. file templates, file header,
4923 "Geany |(version)|". function description, ChangeLog entry,
4926 filename The filename of the current file. file header, snippets, file
4927 For new files, it's only replaced when templates.
4928 first saving if found on the first 4 lines
4931 project The current project's name, if any. file header, snippets, file templates.
4933 description The current project's description, if any. file header, snippets, file templates.
4935 functionname The function name of the function at the function description.
4936 cursor position. This wildcard will only be
4937 replaced in the function description
4940 command:path Executes the specified command and replace file templates, file header,
4941 the wildcard with the command's standard function description, ChangeLog entry,
4942 output. See `Special {command:} wildcard`_ bsd, gpl, snippets.
4944 ============== ============================================= =======================================
4946 **Template insertion wildcards**
4948 ============== ============================================= =======================================
4949 Wildcard Description Available in
4950 ============== ============================================= =======================================
4951 gpl This wildcard inserts a short GPL notice. file header.
4953 bsd This wildcard inserts a BSD licence notice. file header.
4955 fileheader The file header template. This wildcard snippets, file templates.
4956 will only be replaced in file templates.
4957 ============== ============================================= =======================================
4960 Special {command:} wildcard
4961 ***************************
4963 The {command:} wildcard is a special one because it can execute
4964 a specified command and put the command's output (stdout) into
4973 Linux localhost 2.6.9-023stab046.2-smp #1 SMP Mon Dec 10 15:04:55 MSK 2007 x86_64 GNU/Linux
4975 Using this wildcard you can insert nearly any arbitrary text into the
4978 In the environment of the executed command the variables
4979 ``GEANY_FILENAME``, ``GEANY_FILETYPE`` and ``GEANY_FUNCNAME`` are set.
4980 The value of these variables is filled in only if Geany knows about it.
4981 For example, ``GEANY_FUNCNAME`` is only filled within the function
4982 description template. However, these variables are ``always`` set,
4983 just maybe with an empty value.
4984 You can easily access them e.g. within an executed shell script using::
4990 If the specified command could not be found or not executed, the wildcard is substituted
4991 by an empty string. In such cases, you can find the occurred error message on Geany's
4992 standard error and in the Help->Debug Messages dialog.
4995 Customizing the toolbar
4996 -----------------------
4998 You can add, remove and reorder the elements in the toolbar by using
4999 the toolbar editor, or by manually editing the configuration file
5002 The toolbar editor can be opened from the preferences editor on the Toolbar tab or
5003 by right-clicking on the toolbar itself and choosing it from the menu.
5005 Manually editing the toolbar layout
5006 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5008 To override the system-wide configuration file, copy it to your user
5009 configuration directory (see `Configuration file paths`_).
5013 % cp /usr/local/share/geany/ui_toolbar.xml /home/username/.config/geany/
5015 Then edit it and add any of the available elements listed in the file or remove
5016 any of the existing elements. Of course, you can also reorder the elements as
5017 you wish and add or remove additional separators.
5018 This file must be valid XML, otherwise the global toolbar UI definition
5019 will be used instead.
5021 Your changes are applied once you save the file.
5024 (1) You cannot add new actions which are not listed below.
5025 (2) Everything you add or change must be inside the /ui/toolbar/ path.
5028 Available toolbar elements
5029 ^^^^^^^^^^^^^^^^^^^^^^^^^^
5031 ================== ==============================================================================
5032 Element name Description
5033 ================== ==============================================================================
5034 New Create a new file
5035 Open Open an existing file
5036 Save Save the current file
5037 SaveAll Save all open files
5038 Reload Reload the current file from disk
5039 Close Close the current file
5040 CloseAll Close all open files
5041 Print Print the current file
5042 Cut Cut the current selection
5043 Copy Copy the current selection
5044 Paste Paste the contents of the clipboard
5045 Delete Delete the current selection
5046 Undo Undo the last modification
5047 Redo Redo the last modification
5048 NavBack Navigate back a location
5049 NavFor Navigate forward a location
5050 Compile Compile the current file
5051 Build Build the current file, includes a submenu for Make commands. Geany
5052 remembers the last chosen action from the submenu and uses this as default
5053 action when the button itself is clicked.
5054 Run Run or view the current file
5055 Color Open a color chooser dialog, to interactively pick colors from a palette
5056 ZoomIn Zoom in the text
5057 ZoomOut Zoom out the text
5058 UnIndent Decrease indentation
5059 Indent Increase indentation
5060 Replace Replace text in the current document
5061 SearchEntry The search field belonging to the 'Search' element (can be used alone)
5062 Search Find the entered text in the current file (only useful if you also
5064 GotoEntry The goto field belonging to the 'Goto' element (can be used alone)
5065 Goto Jump to the entered line number (only useful if you also use 'GotoEntry')
5066 Preferences Show the preferences dialog
5068 ================== ==============================================================================
5072 Plugin documentation
5073 ====================
5078 The HTML Characters plugin helps when working with special
5079 characters in XML/HTML, e.g. German Umlauts ü and ä.
5082 Insert entity dialog
5083 ^^^^^^^^^^^^^^^^^^^^
5085 When the plugin is enabled, you can insert special character
5086 entities using *Tools->Insert Special HTML Characters*.
5088 This opens up a dialog where you can find a huge amount of special
5089 characters sorted by category that you might like to use inside your
5090 document. You can expand and collapse the categories by clicking on
5091 the little arrow on the left hand side. Once you have found the
5092 desired character click on it and choose "Insert". This will insert
5093 the entity for the character at the current cursor position. You
5094 might also like to double click the chosen entity instead.
5097 Replace special chars by its entity
5098 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5100 To help make a XML/HTML document valid the plugin supports
5101 replacement of special chars known by the plugin. Both bulk
5102 replacement and immediate replacement during typing are supported.
5104 A few characters will not be replaced. These are
5115 You can activate/deactivate this feature using the *Tools->HTML
5116 Replacement->Auto-replace Special Characters* menu item. If it's
5117 activated, all special characters (beside the given exceptions from
5118 above) known by the plugin will be replaced by their entities.
5120 You could also set a keybinding for the plugin to toggle the status
5127 After inserting a huge amount of text, e.g. by using copy & paste, the
5128 plugin allows bulk replacement of all known characters (beside the
5129 mentioned exceptions). You can find the function under the same
5130 menu at *Tools->HTML Replacement->Replace Characters in Selection*, or
5131 configure a keybinding for the plugin.
5140 This plugin provides an option to automatically save documents.
5141 You can choose to save the current document, or all of your documents, at
5148 You can save the current document when the editor's focus goes out.
5149 Every pop-up, menu dialogs, or anything else that can make the editor lose the focus,
5150 will make the current document to be saved.
5155 This plugin sets on every new file (*File->New* or *File->New (with template)*)
5156 a randomly chosen filename and set its filetype appropriate to the used template
5157 or when no template was used, to a configurable default filetype.
5158 This enables you to quickly compile, build and/or run the new file without the
5159 need to give it an explicit filename using the Save As dialog. This might be
5160 useful when you often create new files just for testing some code or something
5167 This plugin creates a backup copy of the current file in Geany when it is
5168 saved. You can specify the directory where the backup copy is saved and
5169 you can configure the automatically added extension in the configure dialog
5170 in Geany's plugin manager.
5172 After the plugin was loaded in Geany's plugin manager, every file is
5173 copied into the configured backup directory when the file is saved in Geany.
5177 Contributing to this document
5178 =============================
5180 This document (``geany.txt``) is written in `reStructuredText`__
5181 (or "reST"). The source file for it is located in Geany's ``doc``
5182 subdirectory. If you intend on making changes, you should grab the
5183 source right from Git to make sure you've got the newest version.
5184 First, you need to configure the build system to generate the HTML
5185 documentation passing the *--enable-html-docs* option to the *configure*
5186 script. Then after editing the file, run ``make`` (from the root build
5187 directory or from the *doc* subdirectory) to build the HTML documentation
5188 and see how your changes look. This regenerates the ``geany.html`` file
5189 inside the *doc* subdirectory. To generate a PDF file, configure with
5190 *--enable-pdf-docs* and run ``make`` as for the HTML version. The generated
5191 PDF file is named geany-|(version)|.pdf and is located inside the *doc*
5194 __ http://docutils.sourceforge.net/rst.html
5196 After you are happy with your changes, create a patch e.g. by using::
5198 % git diff geany.txt > foo.patch
5200 or even better, by creating a Git-formatted patch which will keep authoring
5201 and description data, by first committing your changes (doing so in a fresh
5202 new branch is recommended for `master` not to diverge from upstream) and then
5203 using git format-patch::
5205 % git checkout -b my-documentation-changes # create a fresh branch
5206 % git commit geany.txt
5207 Write a good commit message...
5208 % git format-patch HEAD^
5209 % git checkout master # go back to master
5211 and then submit that file to the mailing list for review.
5213 Also you can clone the Geany repository at GitHub and send a pull request.
5215 Note, you will need the Python docutils software package installed
5216 to build the docs. The package is named ``python-docutils`` on Debian
5222 Scintilla keyboard commands
5223 ===========================
5225 Copyright © 1998, 2006 Neil Hodgson <neilh(at)scintilla(dot)org>
5227 This appendix is distributed under the terms of the License for
5228 Scintilla and SciTE. A copy of this license can be found in the file
5229 ``scintilla/License.txt`` included with the source code of this
5230 program and in the appendix of this document. See `License for
5231 Scintilla and SciTE`_.
5240 Keyboard commands for Scintilla mostly follow common Windows and GTK+
5241 conventions. All move keys (arrows, page up/down, home and end)
5242 allows to extend or reduce the stream selection when holding the
5243 Shift key, and the rectangular selection when holding the
5244 appropriate keys (see `Column mode editing (rectangular selections)`_).
5246 Some keys may not be available with some national keyboards
5247 or because they are taken by the system such as by a window manager
5248 or GTK. Keyboard equivalents of menu commands are listed in the
5249 menus. Some less common commands with no menu equivalent are:
5251 ============================================= ======================
5253 ============================================= ======================
5254 Magnify text size. Ctrl-Keypad+
5255 Reduce text size. Ctrl-Keypad-
5256 Restore text size to normal. Ctrl-Keypad/
5258 Dedent block. Shift-Tab
5259 Delete to start of word. Ctrl-BackSpace
5260 Delete to end of word. Ctrl-Delete
5261 Delete to start of line. Ctrl-Shift-BackSpace
5262 Go to start of document. Ctrl-Home
5263 Extend selection to start of document. Ctrl-Shift-Home
5264 Go to start of display line. Alt-Home
5265 Extend selection to start of display line. Alt-Shift-Home
5266 Go to end of document. Ctrl-End
5267 Extend selection to end of document. Ctrl-Shift-End
5268 Extend selection to end of display line. Alt-Shift-End
5269 Previous paragraph. Shift extends selection. Ctrl-Up
5270 Next paragraph. Shift extends selection. Ctrl-Down
5271 Previous word. Shift extends selection. Ctrl-Left
5272 Next word. Shift extends selection. Ctrl-Right
5273 ============================================= ======================
5284 * Double-click on empty space in the notebook tab bar to open a
5286 * Middle-click on a document's notebook tab to close the document.
5287 * Hold `Ctrl` and click on any notebook tab to switch to the last used
5289 * Double-click on a document's notebook tab to toggle all additional
5290 widgets (to show them again use the View menu or the keyboard
5291 shortcut). The interface pref must be enabled for this to work.
5296 * Alt-scroll wheel moves up/down a page.
5297 * Ctrl-scroll wheel zooms in/out.
5298 * Shift-scroll wheel scrolls 8 characters right/left.
5299 * Ctrl-click on a word in a document to perform *Go to Tag Definition*.
5300 * Ctrl-click on a bracket/brace to perform *Go to Matching Brace*.
5305 * Double-click on a symbol-list group to expand or compact it.
5310 * Scrolling the mouse wheel over a notebook tab bar will switch
5313 The following are derived from X-Windows features (but GTK still supports
5316 * Middle-click pastes the last selected text.
5317 * Middle-click on a scrollbar moves the scrollbar to that
5318 position without having to drag it.
5322 Compile-time options
5323 ====================
5325 There are some options which can only be changed at compile time,
5326 and some options which are used as the default for configurable
5327 options. To change these options, edit the appropriate source file
5328 in the ``src`` subdirectory. Look for a block of lines starting with
5329 ``#define GEANY_*``. Any definitions which are not listed here should
5333 Most users should not need to change these options.
5338 ============================== ============================================ ==================
5339 Option Description Default
5340 ============================== ============================================ ==================
5341 GEANY_STRING_UNTITLED A string used as the default name for new untitled
5342 files. Be aware that the string can be
5343 translated, so change it only if you know
5345 GEANY_WINDOW_MINIMAL_WIDTH The minimal width of the main window. 620
5346 GEANY_WINDOW_MINIMAL_HEIGHT The minimal height of the main window. 440
5347 GEANY_WINDOW_DEFAULT_WIDTH The default width of the main window at the 900
5349 GEANY_WINDOW_DEFAULT_HEIGHT The default height of the main window at the 600
5351 **Windows specific**
5352 GEANY_USE_WIN32_DIALOG Set this to 1 if you want to use the default 0
5353 Windows file open and save dialogs instead
5354 GTK's file open and save dialogs. The
5355 default Windows file dialogs are missing
5356 some nice features like choosing a filetype
5357 or an encoding. *Do not touch this setting
5358 when building on a non-Win32 system.*
5359 ============================== ============================================ ==================
5364 ============================== ============================================ ==================
5365 Option Description Default
5366 ============================== ============================================ ==================
5367 GEANY_PROJECT_EXT The default filename extension for Geany geany
5368 project files. It is used when creating new
5369 projects and as filter mask for the project
5371 ============================== ============================================ ==================
5376 ============================== ============================================ ==================
5377 Option Description Default
5378 ============================== ============================================ ==================
5379 GEANY_FILETYPE_SEARCH_LINES The number of lines to search for the 2
5380 filetype with the extract filetype regex.
5381 ============================== ============================================ ==================
5386 ============================== ============================================ ==================
5387 Option Description Default
5388 ============================== ============================================ ==================
5389 GEANY_WORDCHARS These characters define word boundaries when a string with:
5390 making selections and searching using word a-z, A-Z, 0-9 and
5391 matching options. underscore.
5392 ============================== ============================================ ==================
5397 These are default settings that can be overridden in the `Preferences`_ dialog.
5399 ============================== ============================================ ==================
5400 Option Description Default
5401 ============================== ============================================ ==================
5402 GEANY_MIN_SYMBOLLIST_CHARS How many characters you need to type to 4
5403 trigger the autocompletion list.
5404 GEANY_DISK_CHECK_TIMEOUT Time in seconds between checking a file for 30
5406 GEANY_DEFAULT_TOOLS_MAKE The make tool. This can also include a path. "make"
5407 GEANY_DEFAULT_TOOLS_TERMINAL A terminal emulator command, see See below.
5408 `Terminal emulators`_.
5409 GEANY_DEFAULT_TOOLS_BROWSER A web browser. This can also include a path. "firefox"
5410 GEANY_DEFAULT_TOOLS_PRINTCMD A printing tool. It should be able to accept "lpr"
5411 and process plain text files. This can also
5413 GEANY_DEFAULT_TOOLS_GREP A grep tool. It should be compatible with "grep"
5414 GNU grep. This can also include a path.
5415 GEANY_DEFAULT_MRU_LENGTH The length of the "Recent files" list. 10
5416 GEANY_DEFAULT_FONT_SYMBOL_LIST The font used in sidebar to show symbols and "Sans 9"
5418 GEANY_DEFAULT_FONT_MSG_WINDOW The font used in the messages window. "Sans 9"
5419 GEANY_DEFAULT_FONT_EDITOR The font used in the editor window. "Monospace 10"
5420 GEANY_TOGGLE_MARK A string which is used to mark a toggled "~ "
5422 GEANY_MAX_AUTOCOMPLETE_WORDS How many autocompletion suggestions should 30
5424 GEANY_DEFAULT_FILETYPE_REGEX The default regex to extract filetypes from See below.
5426 ============================== ============================================ ==================
5428 The GEANY_DEFAULT_FILETYPE_REGEX default value is -\\*-\\s*([^\\s]+)\\s*-\\*- which finds Emacs filetypes.
5430 The GEANY_DEFAULT_TOOLS_TERMINAL default value on Windows is::
5434 and on any non-Windows system is::
5436 xterm -e "/bin/sh %c"
5442 ============================== ============================================ ==================
5443 Option Description Default
5444 ============================== ============================================ ==================
5445 GEANY_BUILD_ERR_HIGHLIGHT_MAX Amount of build error indicators to 50
5446 be shown in the editor window.
5447 This affects the special coloring
5448 when Geany detects a compiler output line as
5449 an error message and then highlights the
5450 corresponding line in the source code.
5451 Usually only the first few messages are
5452 interesting because following errors are
5454 All errors in the Compiler window are parsed
5455 and unaffected by this value.
5456 PRINTBUILDCMDS Every time a build menu item priority FALSE
5457 calculation is run, print the state of the
5458 menu item table in the form of the table
5459 in `Build Menu Configuration`_. May be
5460 useful to debug configuration file
5461 overloading. Warning produces a lot of
5462 output. Can also be enabled/disabled by the
5463 debugger by setting printbuildcmds to 1/0
5464 overriding the compile setting.
5465 ============================== ============================================ ==================
5469 GNU General Public License
5470 ==========================
5474 GNU GENERAL PUBLIC LICENSE
5475 Version 2, June 1991
5477 Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5478 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
5479 Everyone is permitted to copy and distribute verbatim copies
5480 of this license document, but changing it is not allowed.
5484 The licenses for most software are designed to take away your
5485 freedom to share and change it. By contrast, the GNU General Public
5486 License is intended to guarantee your freedom to share and change free
5487 software--to make sure the software is free for all its users. This
5488 General Public License applies to most of the Free Software
5489 Foundation's software and to any other program whose authors commit to
5490 using it. (Some other Free Software Foundation software is covered by
5491 the GNU Library General Public License instead.) You can apply it to
5494 When we speak of free software, we are referring to freedom, not
5495 price. Our General Public Licenses are designed to make sure that you
5496 have the freedom to distribute copies of free software (and charge for
5497 this service if you wish), that you receive source code or can get it
5498 if you want it, that you can change the software or use pieces of it
5499 in new free programs; and that you know you can do these things.
5501 To protect your rights, we need to make restrictions that forbid
5502 anyone to deny you these rights or to ask you to surrender the rights.
5503 These restrictions translate to certain responsibilities for you if you
5504 distribute copies of the software, or if you modify it.
5506 For example, if you distribute copies of such a program, whether
5507 gratis or for a fee, you must give the recipients all the rights that
5508 you have. You must make sure that they, too, receive or can get the
5509 source code. And you must show them these terms so they know their
5512 We protect your rights with two steps: (1) copyright the software, and
5513 (2) offer you this license which gives you legal permission to copy,
5514 distribute and/or modify the software.
5516 Also, for each author's protection and ours, we want to make certain
5517 that everyone understands that there is no warranty for this free
5518 software. If the software is modified by someone else and passed on, we
5519 want its recipients to know that what they have is not the original, so
5520 that any problems introduced by others will not reflect on the original
5521 authors' reputations.
5523 Finally, any free program is threatened constantly by software
5524 patents. We wish to avoid the danger that redistributors of a free
5525 program will individually obtain patent licenses, in effect making the
5526 program proprietary. To prevent this, we have made it clear that any
5527 patent must be licensed for everyone's free use or not licensed at all.
5529 The precise terms and conditions for copying, distribution and
5530 modification follow.
5532 GNU GENERAL PUBLIC LICENSE
5533 TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
5535 0. This License applies to any program or other work which contains
5536 a notice placed by the copyright holder saying it may be distributed
5537 under the terms of this General Public License. The "Program", below,
5538 refers to any such program or work, and a "work based on the Program"
5539 means either the Program or any derivative work under copyright law:
5540 that is to say, a work containing the Program or a portion of it,
5541 either verbatim or with modifications and/or translated into another
5542 language. (Hereinafter, translation is included without limitation in
5543 the term "modification".) Each licensee is addressed as "you".
5545 Activities other than copying, distribution and modification are not
5546 covered by this License; they are outside its scope. The act of
5547 running the Program is not restricted, and the output from the Program
5548 is covered only if its contents constitute a work based on the
5549 Program (independent of having been made by running the Program).
5550 Whether that is true depends on what the Program does.
5552 1. You may copy and distribute verbatim copies of the Program's
5553 source code as you receive it, in any medium, provided that you
5554 conspicuously and appropriately publish on each copy an appropriate
5555 copyright notice and disclaimer of warranty; keep intact all the
5556 notices that refer to this License and to the absence of any warranty;
5557 and give any other recipients of the Program a copy of this License
5558 along with the Program.
5560 You may charge a fee for the physical act of transferring a copy, and
5561 you may at your option offer warranty protection in exchange for a fee.
5563 2. You may modify your copy or copies of the Program or any portion
5564 of it, thus forming a work based on the Program, and copy and
5565 distribute such modifications or work under the terms of Section 1
5566 above, provided that you also meet all of these conditions:
5568 a) You must cause the modified files to carry prominent notices
5569 stating that you changed the files and the date of any change.
5571 b) You must cause any work that you distribute or publish, that in
5572 whole or in part contains or is derived from the Program or any
5573 part thereof, to be licensed as a whole at no charge to all third
5574 parties under the terms of this License.
5576 c) If the modified program normally reads commands interactively
5577 when run, you must cause it, when started running for such
5578 interactive use in the most ordinary way, to print or display an
5579 announcement including an appropriate copyright notice and a
5580 notice that there is no warranty (or else, saying that you provide
5581 a warranty) and that users may redistribute the program under
5582 these conditions, and telling the user how to view a copy of this
5583 License. (Exception: if the Program itself is interactive but
5584 does not normally print such an announcement, your work based on
5585 the Program is not required to print an announcement.)
5587 These requirements apply to the modified work as a whole. If
5588 identifiable sections of that work are not derived from the Program,
5589 and can be reasonably considered independent and separate works in
5590 themselves, then this License, and its terms, do not apply to those
5591 sections when you distribute them as separate works. But when you
5592 distribute the same sections as part of a whole which is a work based
5593 on the Program, the distribution of the whole must be on the terms of
5594 this License, whose permissions for other licensees extend to the
5595 entire whole, and thus to each and every part regardless of who wrote it.
5597 Thus, it is not the intent of this section to claim rights or contest
5598 your rights to work written entirely by you; rather, the intent is to
5599 exercise the right to control the distribution of derivative or
5600 collective works based on the Program.
5602 In addition, mere aggregation of another work not based on the Program
5603 with the Program (or with a work based on the Program) on a volume of
5604 a storage or distribution medium does not bring the other work under
5605 the scope of this License.
5607 3. You may copy and distribute the Program (or a work based on it,
5608 under Section 2) in object code or executable form under the terms of
5609 Sections 1 and 2 above provided that you also do one of the following:
5611 a) Accompany it with the complete corresponding machine-readable
5612 source code, which must be distributed under the terms of Sections
5613 1 and 2 above on a medium customarily used for software interchange; or,
5615 b) Accompany it with a written offer, valid for at least three
5616 years, to give any third party, for a charge no more than your
5617 cost of physically performing source distribution, a complete
5618 machine-readable copy of the corresponding source code, to be
5619 distributed under the terms of Sections 1 and 2 above on a medium
5620 customarily used for software interchange; or,
5622 c) Accompany it with the information you received as to the offer
5623 to distribute corresponding source code. (This alternative is
5624 allowed only for noncommercial distribution and only if you
5625 received the program in object code or executable form with such
5626 an offer, in accord with Subsection b above.)
5628 The source code for a work means the preferred form of the work for
5629 making modifications to it. For an executable work, complete source
5630 code means all the source code for all modules it contains, plus any
5631 associated interface definition files, plus the scripts used to
5632 control compilation and installation of the executable. However, as a
5633 special exception, the source code distributed need not include
5634 anything that is normally distributed (in either source or binary
5635 form) with the major components (compiler, kernel, and so on) of the
5636 operating system on which the executable runs, unless that component
5637 itself accompanies the executable.
5639 If distribution of executable or object code is made by offering
5640 access to copy from a designated place, then offering equivalent
5641 access to copy the source code from the same place counts as
5642 distribution of the source code, even though third parties are not
5643 compelled to copy the source along with the object code.
5645 4. You may not copy, modify, sublicense, or distribute the Program
5646 except as expressly provided under this License. Any attempt
5647 otherwise to copy, modify, sublicense or distribute the Program is
5648 void, and will automatically terminate your rights under this License.
5649 However, parties who have received copies, or rights, from you under
5650 this License will not have their licenses terminated so long as such
5651 parties remain in full compliance.
5653 5. You are not required to accept this License, since you have not
5654 signed it. However, nothing else grants you permission to modify or
5655 distribute the Program or its derivative works. These actions are
5656 prohibited by law if you do not accept this License. Therefore, by
5657 modifying or distributing the Program (or any work based on the
5658 Program), you indicate your acceptance of this License to do so, and
5659 all its terms and conditions for copying, distributing or modifying
5660 the Program or works based on it.
5662 6. Each time you redistribute the Program (or any work based on the
5663 Program), the recipient automatically receives a license from the
5664 original licensor to copy, distribute or modify the Program subject to
5665 these terms and conditions. You may not impose any further
5666 restrictions on the recipients' exercise of the rights granted herein.
5667 You are not responsible for enforcing compliance by third parties to
5670 7. If, as a consequence of a court judgment or allegation of patent
5671 infringement or for any other reason (not limited to patent issues),
5672 conditions are imposed on you (whether by court order, agreement or
5673 otherwise) that contradict the conditions of this License, they do not
5674 excuse you from the conditions of this License. If you cannot
5675 distribute so as to satisfy simultaneously your obligations under this
5676 License and any other pertinent obligations, then as a consequence you
5677 may not distribute the Program at all. For example, if a patent
5678 license would not permit royalty-free redistribution of the Program by
5679 all those who receive copies directly or indirectly through you, then
5680 the only way you could satisfy both it and this License would be to
5681 refrain entirely from distribution of the Program.
5683 If any portion of this section is held invalid or unenforceable under
5684 any particular circumstance, the balance of the section is intended to
5685 apply and the section as a whole is intended to apply in other
5688 It is not the purpose of this section to induce you to infringe any
5689 patents or other property right claims or to contest validity of any
5690 such claims; this section has the sole purpose of protecting the
5691 integrity of the free software distribution system, which is
5692 implemented by public license practices. Many people have made
5693 generous contributions to the wide range of software distributed
5694 through that system in reliance on consistent application of that
5695 system; it is up to the author/donor to decide if he or she is willing
5696 to distribute software through any other system and a licensee cannot
5699 This section is intended to make thoroughly clear what is believed to
5700 be a consequence of the rest of this License.
5702 8. If the distribution and/or use of the Program is restricted in
5703 certain countries either by patents or by copyrighted interfaces, the
5704 original copyright holder who places the Program under this License
5705 may add an explicit geographical distribution limitation excluding
5706 those countries, so that distribution is permitted only in or among
5707 countries not thus excluded. In such case, this License incorporates
5708 the limitation as if written in the body of this License.
5710 9. The Free Software Foundation may publish revised and/or new versions
5711 of the General Public License from time to time. Such new versions will
5712 be similar in spirit to the present version, but may differ in detail to
5713 address new problems or concerns.
5715 Each version is given a distinguishing version number. If the Program
5716 specifies a version number of this License which applies to it and "any
5717 later version", you have the option of following the terms and conditions
5718 either of that version or of any later version published by the Free
5719 Software Foundation. If the Program does not specify a version number of
5720 this License, you may choose any version ever published by the Free Software
5723 10. If you wish to incorporate parts of the Program into other free
5724 programs whose distribution conditions are different, write to the author
5725 to ask for permission. For software which is copyrighted by the Free
5726 Software Foundation, write to the Free Software Foundation; we sometimes
5727 make exceptions for this. Our decision will be guided by the two goals
5728 of preserving the free status of all derivatives of our free software and
5729 of promoting the sharing and reuse of software generally.
5733 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
5734 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
5735 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
5736 PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
5737 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
5738 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
5739 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
5740 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
5741 REPAIR OR CORRECTION.
5743 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
5744 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
5745 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
5746 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
5747 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
5748 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
5749 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
5750 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
5751 POSSIBILITY OF SUCH DAMAGES.
5753 END OF TERMS AND CONDITIONS
5755 How to Apply These Terms to Your New Programs
5757 If you develop a new program, and you want it to be of the greatest
5758 possible use to the public, the best way to achieve this is to make it
5759 free software which everyone can redistribute and change under these terms.
5761 To do so, attach the following notices to the program. It is safest
5762 to attach them to the start of each source file to most effectively
5763 convey the exclusion of warranty; and each file should have at least
5764 the "copyright" line and a pointer to where the full notice is found.
5766 <one line to give the program's name and a brief idea of what it does.>
5767 Copyright (C) <year> <name of author>
5769 This program is free software; you can redistribute it and/or modify
5770 it under the terms of the GNU General Public License as published by
5771 the Free Software Foundation; either version 2 of the License, or
5772 (at your option) any later version.
5774 This program is distributed in the hope that it will be useful,
5775 but WITHOUT ANY WARRANTY; without even the implied warranty of
5776 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
5777 GNU General Public License for more details.
5779 You should have received a copy of the GNU General Public License along
5780 with this program; if not, write to the Free Software Foundation, Inc.,
5781 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
5784 Also add information on how to contact you by electronic and paper mail.
5786 If the program is interactive, make it output a short notice like this
5787 when it starts in an interactive mode:
5789 Gnomovision version 69, Copyright (C) year name of author
5790 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
5791 This is free software, and you are welcome to redistribute it
5792 under certain conditions; type `show c' for details.
5794 The hypothetical commands `show w' and `show c' should show the appropriate
5795 parts of the General Public License. Of course, the commands you use may
5796 be called something other than `show w' and `show c'; they could even be
5797 mouse-clicks or menu items--whatever suits your program.
5799 You should also get your employer (if you work as a programmer) or your
5800 school, if any, to sign a "copyright disclaimer" for the program, if
5801 necessary. Here is a sample; alter the names:
5803 Yoyodyne, Inc., hereby disclaims all copyright interest in the program
5804 `Gnomovision' (which makes passes at compilers) written by James Hacker.
5806 <signature of Ty Coon>, 1 April 1989
5807 Ty Coon, President of Vice
5809 This General Public License does not permit incorporating your program into
5810 proprietary programs. If your program is a subroutine library, you may
5811 consider it more useful to permit linking proprietary applications with the
5812 library. If this is what you want to do, use the GNU Library General
5813 Public License instead of this License.
5818 License for Scintilla and SciTE
5819 ===============================
5821 Copyright 1998-2003 by Neil Hodgson <neilh(at)scintilla(dot)org>
5825 Permission to use, copy, modify, and distribute this software and
5826 its documentation for any purpose and without fee is hereby granted,
5827 provided that the above copyright notice appear in all copies and
5828 that both that copyright notice and this permission notice appear in
5829 supporting documentation.
5831 NEIL HODGSON DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
5832 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN
5833 NO EVENT SHALL NEIL HODGSON BE LIABLE FOR ANY SPECIAL, INDIRECT OR
5834 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
5835 OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
5836 OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE
5837 USE OR PERFORMANCE OF THIS SOFTWARE.